Documentation

ControllerUser

Class ControllerUser Controller for User Model

Tags
author

Guillaume ARNOUX

Table of Contents

$args  : array<string|int, mixed>
$container  : Container
$renderer  : UserView
$request  : Request
$response  : Response
$user  : User|null
__construct()  : mixed
ControllerUser constructor
auth2FA()  : Response
Control the 2FA login action
creators()  : Response
Control the creators page render
home()  : Response
Control the home page render
process()  : Response
Process request for the user model
publicLists()  : Response
Control the public lists page render
createApiKey()  : Response
Control the user api key generation
delete()  : Response
Control delete account action
deleteAvatar()  : Response
Control delete avatar action
forgot_password()  : Response
Control the forgot password action
login()  : Response
Control the login action
logout()  : Response
Control the logout action
profile()  : Response
Control the display of the user's profile
register()  : Response
Control the register action
reset_password()  : Response
Control the reset password action

Properties

Methods

__construct()

ControllerUser constructor

public __construct(Container $c, Request $request, Response $response, array<string|int, mixed> $args) : mixed
Parameters
$c : Container
$request : Request
$response : Response
$args : array<string|int, mixed>
Return values
mixed

auth2FA()

Control the 2FA login action

public auth2FA() : Response
Tags
throws
ForbiddenException
throws
MethodNotAllowedException
throws
NotFoundException
Return values
Response

process()

Process request for the user model

public process() : Response
Tags
throws
ForbiddenException
throws
MethodNotAllowedException
throws
NotFoundException
Return values
Response

publicLists()

Control the public lists page render

public publicLists() : Response
Tags
throws
ForbiddenException

error while render

Return values
Response

createApiKey()

Control the user api key generation

private createApiKey() : Response
Tags
throws
ForbiddenException
throws
MethodNotAllowedException
throws
Exception

when generating the api key

Return values
Response

delete()

Control delete account action

private delete() : Response
Tags
throws
ForbiddenException
throws
MethodNotAllowedException
Return values
Response

deleteAvatar()

Control delete avatar action

private deleteAvatar() : Response
Return values
Response

forgot_password()

Control the forgot password action

private forgot_password() : Response
Tags
throws
ForbiddenException
throws
MethodNotAllowedException
Return values
Response

logout()

Control the logout action

private logout() : Response
Return values
Response

profile()

Control the display of the user's profile

private profile() : Response
Tags
throws
ForbiddenException
throws
MethodNotAllowedException
Return values
Response

register()

Control the register action

private register() : Response
Tags
throws
ForbiddenException
throws
MethodNotAllowedException
Return values
Response

reset_password()

Control the reset password action

private reset_password() : Response
Tags
throws
ForbiddenException
throws
MethodNotAllowedException
Return values
Response

Search results