PHP Трейт Zendesk\API\Traits\Utility\ChainedParametersTrait

An example would be a call $client->ticket(2)->comments(3)->author(); would create an Author object with chained parameters (An Array): [ 'Zendesk\API\Tickets' => 2, 'Zendesk\API\Comments' => 3 ]
Показать файл Открыть проект

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

Свойство Тип Описание
$chainedParameters array

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

Метод Описание
addChainedParametersToParams ( array $params, array $map ) : array A helper method to add the chained parameters to the existing parameters.
getChainedParameter ( $name, null $default = null ) Returns the named chained parameter
getChainedParameters ( ) : array Returns chained parameters
getLatestChainedParameter ( array $excludes = [] ) : array Returns the named chained parameter
setChainedParameters ( $params ) Sets the chained parameters

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

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

A helper method to add the chained parameters to the existing parameters.
public addChainedParametersToParams ( array $params, array $map ) : array
$params array The existing parameters
$map array An array describing what parameter key corresponds to which classId e.g. ['ticket_id' => 'Zendesk\API\Ticket'] normal usage would be ['id' => $this::class]
Результат array

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

Returns the named chained parameter
public getChainedParameter ( $name, null $default = null )
$name
$default null

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

Returns chained parameters
public getChainedParameters ( ) : array
Результат array

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

Returns the named chained parameter
public getLatestChainedParameter ( array $excludes = [] ) : array
$excludes array Pass an array of classnames to exclude from query
Результат array

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

Sets the chained parameters
public setChainedParameters ( $params )
$params

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

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

protected array $chainedParameters
Результат array