PHP Class Bolt\Controller\Backend\Users

Prior to v3.0 this functionality primarily existed in the monolithic Bolt\Controllers\Backend class.

Author: Gawain Lynch ([email protected])

Inheritance: extends BackendBase

Public Methods

Method	Description
admin ( ) : TemplateResponse	All users admin page.
edit ( Request $request, integer $id ) : TemplateResponse \| RedirectResponse	User edit route.
first ( Request $request ) : TemplateResponse \| RedirectResponse	Create the first user.
modify ( string $action, integer $id ) : RedirectResponse	Perform modification actions on users.
profile ( Request $request ) : TemplateResponse \| RedirectResponse	User profile page route.
viewRoles ( ) : TemplateResponse	Route to view the configured user roles.

Method	Description
addRoutes ( Silex\ControllerCollection $c )

Method	Description
firstPost ( Request $request, Form $form ) : RedirectResponse \| false	Handle a first user creation POST.
getEditableUser ( integer $id ) : Bolt\Storage\Entity\Users \| false	Get the user we want to edit (if any).
getUserEditFields ( FormBuilder $form, integer $id ) : FormBuilder	Get the editable fields for the user form.
getUserForm ( Bolt\Storage\Entity\Users $user, boolean $addusername = false ) : FormBuilder	Create a user form with the form builder.
notifyUserSave ( Request $request, string $displayName, string $email, boolean $firstuser )	Notify of save event.
notifyUserSetupEmail ( Request $request, string $displayName, string $email )	Send a welcome email to test mail settings.
setUserFormValidation ( FormBuilder $form, boolean $addusername = false ) : FormBuilder	Validate the user form.
validateUserForm ( Request $request, Form $form, boolean $firstUser = false ) : Bolt\Storage\Entity\Users \| false	Handle a POST from user edit or first user creation.

protected addRoutes ( Silex\ControllerCollection $c )
$c	Silex\ControllerCollection

All users admin page.

public admin ( ) : TemplateResponse
return	Bolt\Response\TemplateResponse

User edit route.

public edit ( Request $request, integer $id ) : TemplateResponse \| RedirectResponse
$request	Symfony\Component\HttpFoundation\Request	The Symfony Request
$id	integer	The user ID
return	Bolt\Response\TemplateResponse \| Symfony\Component\HttpFoundation\RedirectResponse

Create the first user.

public first ( Request $request ) : TemplateResponse \| RedirectResponse
$request	Symfony\Component\HttpFoundation\Request	The Symfony Request
return	Bolt\Response\TemplateResponse \| Symfony\Component\HttpFoundation\RedirectResponse

Perform modification actions on users.

public modify ( string $action, integer $id ) : RedirectResponse
$action	string	The action
$id	integer	The user ID
return	Symfony\Component\HttpFoundation\RedirectResponse

User profile page route.

public profile ( Request $request ) : TemplateResponse \| RedirectResponse
$request	Symfony\Component\HttpFoundation\Request	The Symfony Request
return	Bolt\Response\TemplateResponse \| Symfony\Component\HttpFoundation\RedirectResponse

Route to view the configured user roles.

public viewRoles ( ) : TemplateResponse
return	Bolt\Response\TemplateResponse