PHP Класс Nathanmac\Utilities\Parser\Parser

Автор: Nathan Macnamara ([email protected])
Показать файл Открыть проект Примеры использования класса

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

Метод Описание
all ( ) : array Alias to the payload function.
bson ( $payload ) : array BSON parser, helper function.
except ( string | array $keys ) : array Get all of the input except for a specified array of items.
get ( string $key = null, string $default = null ) : mixed | null Retrieve an payload item from the payload data, return default item if item not found.
getFormatClass ( $format = '' ) : string Autodetect the payload data type using content-type value.
has ( string | array $keys ) : boolean Determine if the payload contains a non-empty value for a given key.
json ( $payload ) : array JSON parser, helper function.
mask ( array $mask ) : array Mask input data with a given mapping.
msgpack ( $payload ) : array MSGPack parser, helper function.
only ( string | array $keys ) : array Get a subset of the items from the payload data.
parse ( string $payload, Nathanmac\Utilities\Parser\Formats\FormatInterface $format ) : array Parse payload string using given formatter.
payload ( string $format = '' ) : array Parse the HTTP payload data, autodetect format and return all data in array.
querystr ( $payload ) : array Query String parser, helper function.
registerFormat ( $format, $class ) : self Register Format Class.
serialize ( $payload ) : array Serialized Data parser, helper function.
xml ( $payload ) : array XML parser, helper function.
yaml ( $payload ) : array YAML parser, helper function.

Защищенные методы

Метод Описание
getPayload ( ) : string Return the payload data from the HTTP post request.

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

Метод Описание
buildArray ( $route, null $data = null ) : array | null Build the array structure for value.
getValueAtKey ( $key, $data ) : mixed Return a value from the array identified from the key.
hasValueAtKey ( $key, $data ) : boolean Array contains a value identified from the key, returns bool
processContentType ( string $contentType ) : boolean | string Process the content-type values
processMask ( array $mask ) : string Recursive processor for processing user masks.
removeValue ( &$array, $key ) Remove a value identified from the key

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

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

Alias to the payload function.
public all ( ) : array
Результат array

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

BSON parser, helper function.
public bson ( $payload ) : array
$payload
Результат array

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

Get all of the input except for a specified array of items.
public except ( string | array $keys ) : array
$keys string | array
Результат array

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

Retrieve an payload item from the payload data, return default item if item not found.
public get ( string $key = null, string $default = null ) : mixed | null
$key string
$default string
Результат mixed | null

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

Autodetect the payload data type using content-type value.
public getFormatClass ( $format = '' ) : string
Результат string Return the name of the formatter class.

getPayload() защищенный Метод

Return the payload data from the HTTP post request.
protected getPayload ( ) : string
Результат string

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

Determine if the payload contains a non-empty value for a given key.
public has ( string | array $keys ) : boolean
$keys string | array
Результат boolean

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

JSON parser, helper function.
public json ( $payload ) : array
$payload
Результат array

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

Mask input data with a given mapping.
public mask ( array $mask ) : array
$mask array
Результат array

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

MSGPack parser, helper function.
public msgpack ( $payload ) : array
$payload
Результат array

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

Get a subset of the items from the payload data.
public only ( string | array $keys ) : array
$keys string | array
Результат array

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

Parse payload string using given formatter.
public parse ( string $payload, Nathanmac\Utilities\Parser\Formats\FormatInterface $format ) : array
$payload string
$format Nathanmac\Utilities\Parser\Formats\FormatInterface
Результат array

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

Override the format by providing a content type.
public payload ( string $format = '' ) : array
$format string
Результат array

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

Query String parser, helper function.
public querystr ( $payload ) : array
$payload
Результат array

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

Register Format Class.
public registerFormat ( $format, $class ) : self
$format
$class
Результат self

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

Serialized Data parser, helper function.
public serialize ( $payload ) : array
$payload
Результат array

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

XML parser, helper function.
public xml ( $payload ) : array
$payload
Результат array

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

YAML parser, helper function.
public yaml ( $payload ) : array
$payload
Результат array