PHP Класс Locker\Request

Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
$params Stores/caches params.

Открытые методы

Метод Описание
all ( ) : AssocArray Gets the stored/cached params.
getContent ( )
getParam ( String $key, mixed $default = null ) : mixed Gets a param from the stored/cached params.
getParams ( ) : AssocArray Gets all params (merges payload params with request params).
getPassword ( ) : String Gets the password from the basic auth.
getPayload ( ) : AssocArray Gets the stored/cached params.
getPayloadParams ( ) : AssocArray Gets the data stored in the request payload.
getUser ( ) : String Gets the user from the basic auth.
hasParam ( String $key ) : boolean Determines if the param is set.
header ( $key, $default = null ) : mixed Gets a header from the request headers.

Приватные методы

Метод Описание
getAuth ( ) : AssocArray Gets the authentication details from the stored/cached params.
getDecodedAuth ( String $auth ) : AssocArray Gets decoded authentication details.
getNullAuth ( ) : AssocArray Gets the null authentication details.
getSplitAuth ( ) : boolean Determines if the auth param is split by a space.
splitAuthParam ( String $authParam, String $delimeter ) : String[] Gets the authentication details split by a delimeter.

Описание методов

all() публичный Метод

Gets the stored/cached params.
public all ( ) : AssocArray
Результат AssocArray Stored/cached params.

getContent() публичный Метод

public getContent ( )

getParam() публичный Метод

Gets a param from the stored/cached params.
public getParam ( String $key, mixed $default = null ) : mixed
$key String Param to be retrieved.
$default mixed Value to be returned if the param is not set.
Результат mixed Value of the param.

getParams() публичный Метод

Gets all params (merges payload params with request params).
public getParams ( ) : AssocArray
Результат AssocArray params.

getPassword() публичный Метод

Gets the password from the basic auth.
public getPassword ( ) : String
Результат String password in the basic auth.

getPayload() публичный Метод

Gets the stored/cached params.
public getPayload ( ) : AssocArray
Результат AssocArray Stored/cached params.

getPayloadParams() публичный Метод

Gets the data stored in the request payload.
public getPayloadParams ( ) : AssocArray
Результат AssocArray params from the payload.

getUser() публичный Метод

Gets the user from the basic auth.
public getUser ( ) : String
Результат String user in the basic auth.

hasParam() публичный Метод

Determines if the param is set.
public hasParam ( String $key ) : boolean
$key String Param to be checked.
Результат boolean True if the param exists, false if it doesn't.

header() публичный Метод

Gets a header from the request headers.
public header ( $key, $default = null ) : mixed
$key Header to be returned.
$default Value to be returned if the header is not set.
Результат mixed Value of the header.

Описание свойств

$params защищенное свойство

Stores/caches params.
protected $params