Controller
in package
Tags
Table of Contents
Properties
- $forceHTTPS : int
- Should enforce HTTPS access for all methods in this controller.
- $helpers : array<int, string>
- Helpers that will be automatically loaded on class instantiation.
- $logger : LoggerInterface
- Instance of logger to use.
- $request : CLIRequest|IncomingRequest
- Instance of the main Request object.
- $response : ResponseInterface
- Instance of the main response object.
- $validator : ValidationInterface|null
- Once validation has been run, will hold the Validation instance.
Methods
- initController() : void
- Constructor.
- cachePage() : void
- How long to cache the current page for.
- forceHTTPS() : void
- A convenience method to use when you need to ensure that a single method is reached only via HTTPS. If it isn't, then a redirect will happen back to this method and HSTS header will be sent to have modern browsers transform requests automatically.
- validate() : bool
- A shortcut to performing validation on Request data.
- validateData() : bool
- A shortcut to performing validation on any input data.
- setValidator() : void
Properties
$forceHTTPS
Should enforce HTTPS access for all methods in this controller.
protected
int
$forceHTTPS
= 0
Number of seconds to set HSTS header
$helpers
Helpers that will be automatically loaded on class instantiation.
protected
array<int, string>
$helpers
= []
$logger
Instance of logger to use.
protected
LoggerInterface
$logger
$request
Instance of the main Request object.
protected
CLIRequest|IncomingRequest
$request
$response
Instance of the main response object.
protected
ResponseInterface
$response
$validator
Once validation has been run, will hold the Validation instance.
protected
ValidationInterface|null
$validator
Methods
initController()
Constructor.
public
initController(RequestInterface $request, ResponseInterface $response, LoggerInterface $logger) : void
Parameters
- $request : RequestInterface
- $response : ResponseInterface
- $logger : LoggerInterface
Tags
cachePage()
How long to cache the current page for.
protected
cachePage(int $time) : void
Parameters
- $time : int
Tags
forceHTTPS()
A convenience method to use when you need to ensure that a single method is reached only via HTTPS. If it isn't, then a redirect will happen back to this method and HSTS header will be sent to have modern browsers transform requests automatically.
protected
forceHTTPS([int $duration = 31536000 ]) : void
Parameters
- $duration : int = 31536000
-
The number of seconds this link should be considered secure for. Only with HSTS header. Default value is 1 year.
Tags
validate()
A shortcut to performing validation on Request data.
protected
validate(array<string|int, mixed>|string $rules[, array<string|int, mixed> $messages = [] ]) : bool
Parameters
- $rules : array<string|int, mixed>|string
- $messages : array<string|int, mixed> = []
-
An array of custom error messages
Return values
boolvalidateData()
A shortcut to performing validation on any input data.
protected
validateData(array<string|int, mixed> $data, array<string|int, mixed>|string $rules[, array<string|int, mixed> $messages = [] ][, string|null $dbGroup = null ]) : bool
Parameters
- $data : array<string|int, mixed>
-
The data to validate
- $rules : array<string|int, mixed>|string
- $messages : array<string|int, mixed> = []
-
An array of custom error messages
- $dbGroup : string|null = null
-
The database group to use
Return values
boolsetValidator()
private
setValidator(array<string|int, mixed>|string $rules, array<string|int, mixed> $messages) : void
Parameters
- $rules : array<string|int, mixed>|string
- $messages : array<string|int, mixed>