Documentation

UserController extends BaseController
in package

Controller for user authentication operations.

Handles login, registration, and logout functionality.

Tags
since
3.0.0

Table of Contents

Properties

$flash  : FlashMessageService
Flash message service.
$formData  : AuthFormDataManager
Auth form data manager.
$userFacade  : UserFacade
User facade instance.

Methods

__construct()  : mixed
Create a new UserController.
forgotPassword()  : void
Process the forgot password form submission.
forgotPasswordForm()  : void
Display the forgot password form.
login()  : void
Process the login form submission.
loginForm()  : void
Display the login form.
logout()  : void
Log out the current user.
register()  : void
Process the registration form submission.
registerForm()  : void
Display the registration form.
resetPassword()  : void
Process the reset password form submission.
resetPasswordForm()  : void
Display the reset password form.
tryRestoreFromRememberCookie()  : bool
Try to restore session from remember-me cookie.
endRender()  : void
End page rendering with standard LWT footer.
execute()  : int
Execute an INSERT/UPDATE/DELETE query.
get()  : string
Get a string GET parameter.
getMarkedIds()  : array<string|int, int>
Get IDs from marked checkboxes.
getValue()  : mixed
Get a single value from the database.
hasParam()  : bool
Check if a parameter exists in the request.
isGet()  : bool
Check if the request is a GET request.
isPost()  : bool
Check if the request is a POST request.
json()  : JsonResponse
Return JSON response.
message()  : void
Display a message (success/error) to the user using Bulma notifications.
param()  : string
Get a string request parameter (GET, POST, or REQUEST).
paramArray()  : array<string|int, mixed>
Get an array request parameter.
paramInt()  : int|null
Get an integer request parameter.
post()  : string
Get a string POST parameter.
query()  : mysqli_result|bool
Execute a database query using the LWT query wrapper.
redirect()  : RedirectResponse
Redirect to another URL.
render()  : void
Start page rendering with standard LWT header.
requireInt()  : int
Get a required integer request parameter.
clearRememberCookie()  : void
Clear the "remember me" cookie.
createDefaultFacade()  : UserFacade
Create a default UserFacade instance.
isRegistrationEnabled()  : bool
Check if user registration is enabled.
setRememberCookie()  : void
Set a "remember me" cookie with persistent token storage.

Properties

Methods

forgotPassword()

Process the forgot password form submission.

public forgotPassword() : void

POST /password/forgot

forgotPasswordForm()

Display the forgot password form.

public forgotPasswordForm() : void

GET /password/forgot

login()

Process the login form submission.

public login() : void

POST /login

loginForm()

Display the login form.

public loginForm() : void

GET /login

logout()

Log out the current user.

public logout() : void

GET /logout

register()

Process the registration form submission.

public register() : void

POST /register

registerForm()

Display the registration form.

public registerForm() : void

GET /register

resetPassword()

Process the reset password form submission.

public resetPassword() : void

POST /password/reset

resetPasswordForm()

Display the reset password form.

public resetPasswordForm() : void

GET /password/reset?token=xxx

tryRestoreFromRememberCookie()

Try to restore session from remember-me cookie.

public tryRestoreFromRememberCookie() : bool

This method is called during session bootstrap to check if the user has a valid remember-me cookie and restore their session.

Return values
bool —

True if session was restored, false otherwise

endRender()

End page rendering with standard LWT footer.

protected endRender() : void

execute()

Execute an INSERT/UPDATE/DELETE query.

protected execute(string $sql) : int
Parameters
$sql : string

SQL query

Tags
psalm-suppress

PossiblyUnusedReturnValue

Return values
int —

Number of affected rows

get()

Get a string GET parameter.

protected get(string $key[, string $default = '' ]) : string
Parameters
$key : string

Parameter name

$default : string = ''

Default value if not set

Return values
string —

Parameter value or default

getMarkedIds()

Get IDs from marked checkboxes.

protected getMarkedIds(string|array<string|int, mixed> $marked) : array<string|int, int>
Parameters
$marked : string|array<string|int, mixed>

The 'marked' request parameter value

Tags
psalm-return

array

Return values
array<string|int, int> —

Array of integer IDs

getValue()

Get a single value from the database.

protected getValue(string $sql) : mixed
Parameters
$sql : string

SQL query (should return single value as 'value')

Return values
mixed —

The value or null

hasParam()

Check if a parameter exists in the request.

protected hasParam(string $key) : bool
Parameters
$key : string

Parameter name

Return values
bool —

True if the parameter exists

isGet()

Check if the request is a GET request.

protected isGet() : bool
Return values
bool

isPost()

Check if the request is a POST request.

protected isPost() : bool
Return values
bool

json()

Return JSON response.

protected json(mixed $data[, int $status = 200 ]) : JsonResponse

Return this from a controller method; the router will send it.

Parameters
$data : mixed

Data to encode as JSON

$status : int = 200

HTTP status code (default: 200)

Return values
JsonResponse

message()

Display a message (success/error) to the user using Bulma notifications.

protected message(string $message[, bool $autoHide = true ]) : void
Parameters
$message : string

The message to display

$autoHide : bool = true

Whether to auto-hide the message (default: true)

param()

Get a string request parameter (GET, POST, or REQUEST).

protected param(string $key[, string $default = '' ]) : string
Parameters
$key : string

Parameter name

$default : string = ''

Default value if not set

Return values
string —

Parameter value or default

paramArray()

Get an array request parameter.

protected paramArray(string $key[, array<string|int, mixed> $default = [] ]) : array<string|int, mixed>
Parameters
$key : string

Parameter name

$default : array<string|int, mixed> = []

Default value if not set

Return values
array<string|int, mixed> —

Parameter value or default

paramInt()

Get an integer request parameter.

protected paramInt(string $key[, int|null $default = null ][, int|null $min = null ][, int|null $max = null ]) : int|null
Parameters
$key : string

Parameter name

$default : int|null = null

Default value if not set

$min : int|null = null

Minimum allowed value

$max : int|null = null

Maximum allowed value

Return values
int|null —

Parameter value or default

post()

Get a string POST parameter.

protected post(string $key[, string $default = '' ]) : string
Parameters
$key : string

Parameter name

$default : string = ''

Default value if not set

Return values
string —

Parameter value or default

query()

Execute a database query using the LWT query wrapper.

protected query(string $sql) : mysqli_result|bool
Parameters
$sql : string

SQL query

Return values
mysqli_result|bool —

Query result

redirect()

Redirect to another URL.

protected redirect(string $url[, int $statusCode = 302 ]) : RedirectResponse

Return this from a controller method; the router will send it.

Parameters
$url : string

URL to redirect to

$statusCode : int = 302

HTTP status code (default: 302)

Return values
RedirectResponse

render()

Start page rendering with standard LWT header.

protected render(string $title[, bool $showMenu = true ]) : void
Parameters
$title : string

Page title

$showMenu : bool = true

Whether to show navigation menu (default: true)

requireInt()

Get a required integer request parameter.

protected requireInt(string $key[, int|null $min = null ][, int|null $max = null ]) : int
Parameters
$key : string

Parameter name

$min : int|null = null

Minimum allowed value

$max : int|null = null

Maximum allowed value

Tags
throws
InvalidArgumentException

If parameter is missing or invalid

Return values
int —

Parameter value

clearRememberCookie()

Clear the "remember me" cookie.

private clearRememberCookie() : void

isRegistrationEnabled()

Check if user registration is enabled.

private isRegistrationEnabled() : bool
Return values
bool

setRememberCookie()

Set a "remember me" cookie with persistent token storage.

private setRememberCookie(int $userId) : void

The token is stored in the database and set as a cookie. When the user returns, the token can be validated to restore the session.

Parameters
$userId : int

The user ID


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results