PHP Класс Zendesk\API\Resources\ResourceAbstract

Наследование: use trait Zendesk\API\Traits\Utility\ChainedParametersTrait
Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$additionalRouteParams array
$apiBasePath string
$client Zendesk\API\HttpClient
$lastId integer
$objectName String
$objectNamePlural String
$resourceName String
$routes array

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

Метод Описание
__construct ( HttpClient $client )
getAdditionalRouteParams ( ) : array
getLastId ( ) : integer Saves an id for future methods in the chain
getResourceName ( ) : String
getRoute ( $name, array $params = [] ) : mixed Returns a route and replaces tokenized parts of the string with the passed params
getRoutes ( ) : array Return all routes for this resource
getValidSubResources ( ) : array This returns the valid relations of this resource. Definition of what is allowed to chain after this resource.
hasAnyKey ( array $params, array $mandatory ) : boolean Check that any parameter has been supplied
hasKeys ( array $params, array $mandatory ) : boolean Check that all parameters have been supplied
setAdditionalRouteParams ( array $additionalRouteParams )
setLastId ( integer $id ) Saves an id for future methods in the chain
setRoute ( $name, $route ) Add or override an existing route
setRoutes ( array $routes ) Wrapper for adding multiple routes via setRoute
sideload ( array $fields = [] ) Enable side-loading (beta) - flags until the next chain

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

Метод Описание
getResourceNameFromClass ( ) : string Return the resource name using the name of the class (used for endpoints)
setUpRoutes ( ) Sets up the available routes for the resource.

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

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

public __construct ( HttpClient $client )
$client Zendesk\API\HttpClient

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

public getAdditionalRouteParams ( ) : array
Результат array

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

Saves an id for future methods in the chain
public getLastId ( ) : integer
Результат integer

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

public getResourceName ( ) : String
Результат String

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

Return the resource name using the name of the class (used for endpoints)
protected getResourceNameFromClass ( ) : string
Результат string

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

Returns a route and replaces tokenized parts of the string with the passed params
public getRoute ( $name, array $params = [] ) : mixed
$name
$params array
Результат mixed

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

Return all routes for this resource
public getRoutes ( ) : array
Результат array

getValidSubResources() публичный статический Метод

Make sure to add in this method when adding new sub resources. Example: $client->ticket()->comments(); Where ticket would have a comments as a valid sub resource. The array would look like: ['comments' => '\Zendesk\API\Resources\TicketComments']
public static getValidSubResources ( ) : array
Результат array

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

Check that any parameter has been supplied
public hasAnyKey ( array $params, array $mandatory ) : boolean
$params array
$mandatory array
Результат boolean

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

Check that all parameters have been supplied
public hasKeys ( array $params, array $mandatory ) : boolean
$params array
$mandatory array
Результат boolean

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

public setAdditionalRouteParams ( array $additionalRouteParams )
$additionalRouteParams array

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

Saves an id for future methods in the chain
public setLastId ( integer $id )
$id integer

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

Add or override an existing route
public setRoute ( $name, $route )
$name
$route

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

Wrapper for adding multiple routes via setRoute
public setRoutes ( array $routes )
$routes array

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

Sets up the available routes for the resource.
protected setUpRoutes ( )

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

Enable side-loading (beta) - flags until the next chain
public sideload ( array $fields = [] )
$fields array

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

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

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

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

protected string $apiBasePath
Результат string

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

protected HttpClient,Zendesk\API $client
Результат Zendesk\API\HttpClient

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

protected int $lastId
Результат integer

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

protected String $objectName
Результат String

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

protected String $objectNamePlural
Результат String

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

protected String $resourceName
Результат String

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

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