Request
extends Request
in package
Uses
Microable
This method extends the Symfony request class to add more functionality to the request object.
All methods on the request object are still available in this class. But more methods have been added to the request object.
Tags
Table of Contents
Properties
- $auth : ContextUserObject|null
- $authenticated : bool
- $macros : array<string|int, mixed>
- $app : PioniaApplication
- $auth : ContextUserObject|null
- $authenticated : bool
Methods
- __call() : mixed
- Dynamically handle calls to the class.
- __callStatic() : mixed
- Dynamically handle calls to the class.
- flushMacros() : void
- Remove all the macros we had registered
- getApplication() : PioniaApplication
- getAuth() : ContextUserObject|null
- The currently logged user in context object
- getData() : Arrayable
- Merges data sent from the client as json and form data as one array where one can access all the request data.
- getFileByName() : FileBag|null
- Returns the file from the request if the request was submitted as form data
- hasMacro() : bool
- Check if we have a method in the balonables
- isAuthenticated() : bool
- This method checks if the request is authenticated
- macro() : void
- Add a new mixable to the macros
- mixin() : void
- Mix another object into the class.
- setApplication() : void
- setAuthenticationContext() : $this
- This method sets the authentication context for the request
- setArrayContext() : $this
- This method add data to the context object
Properties
$auth
public
ContextUserObject|null
$auth
The currently logged user in context object
$authenticated
public
bool
$authenticated
Whether the request is authenticated or not
$macros
protected
static array<string|int, mixed>
$macros
= []
$app
private
PioniaApplication
$app
$auth
private
ContextUserObject|null
$auth
= null
$authenticated
private
bool
$authenticated
= false
Methods
__call()
Dynamically handle calls to the class.
public
__call(string $method, array<string|int, mixed> $parameters) : mixed
Parameters
- $method : string
- $parameters : array<string|int, mixed>
Tags
__callStatic()
Dynamically handle calls to the class.
public
static __callStatic(string $method, array<string|int, mixed> $parameters) : mixed
Parameters
- $method : string
- $parameters : array<string|int, mixed>
Tags
flushMacros()
Remove all the macros we had registered
public
static flushMacros() : void
getApplication()
public
getApplication() : PioniaApplication
Return values
PioniaApplicationgetAuth()
The currently logged user in context object
public
getAuth() : ContextUserObject|null
Return values
ContextUserObject|null —The currently logged in user object or null if no user is logged in
getData()
Merges data sent from the client as json and form data as one array where one can access all the request data.
public
getData() : Arrayable
This implies that this request is safe for both json and form data scenarios
Return values
ArrayablegetFileByName()
Returns the file from the request if the request was submitted as form data
public
getFileByName( $fileName) : FileBag|null
Parameters
Return values
FileBag|nullhasMacro()
Check if we have a method in the balonables
public
static hasMacro(string $name) : bool
Parameters
- $name : string
Return values
boolisAuthenticated()
This method checks if the request is authenticated
public
isAuthenticated() : bool
Return values
bool —Whether the request is authenticated or not
macro()
Add a new mixable to the macros
public
static macro(string $key, $value) : void
Parameters
mixin()
Mix another object into the class.
public
static mixin(object $mixin[, bool $replace = true ]) : void
Parameters
- $mixin : object
- $replace : bool = true
Tags
setApplication()
public
setApplication(PioniaApplication $application) : void
Parameters
- $application : PioniaApplication
setAuthenticationContext()
This method sets the authentication context for the request
public
setAuthenticationContext(ContextUserObject $userObject) : $this
Parameters
- $userObject : ContextUserObject
Return values
$thissetArrayContext()
This method add data to the context object
private
setArrayContext(array<string|int, mixed> $contextData) : $this
Parameters
- $contextData : array<string|int, mixed>
-
The context data to be added to the request