PHP Класс seregazhuk\PinterestBot\Api\Response

Наследование: implements seregazhuk\PinterestBot\Interfaces\ResponseInterface
Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$clientInfo array | null
$data mixed
$lastError array | null

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

Метод Описание
fill ( $data )
getBookmarks ( ) : array Parse bookmarks from response.
getClientInfo ( ) : array | null
getData ( string $key = '', null $default = null ) : mixed
getLastError ( ) : array
getPaginationData ( ) : array Checks Pinterest API paginated response, and parses data with bookmarks info from it.
getResponseData ( null $key = null ) : array | boolean Check if specified data exists in response.
hasData ( string $key = '' ) : boolean
hasErrors ( ) : boolean Check for error info in api response and save it.
isEmpty ( ) : boolean Checks if response is empty.
isOk ( ) : boolean

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

Метод Описание
getValueByKey ( string $key = '', array $data, mixed $default = null ) : array | boolean | mixed
parseResponseData ( string $key ) : boolean | array Parse data from Pinterest Api response.

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

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

public fill ( $data )

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

Parse bookmarks from response.
public getBookmarks ( ) : array
Результат array

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

public getClientInfo ( ) : array | null
Результат array | null

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

public getData ( string $key = '', null $default = null ) : mixed
$key string
$default null
Результат mixed

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

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

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

Checks Pinterest API paginated response, and parses data with bookmarks info from it.
public getPaginationData ( ) : array
Результат array

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

Check if specified data exists in response.
public getResponseData ( null $key = null ) : array | boolean
$key null
Результат array | boolean

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

protected getValueByKey ( string $key = '', array $data, mixed $default = null ) : array | boolean | mixed
$key string
$data array
$default mixed
Результат array | boolean | mixed

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

public hasData ( string $key = '' ) : boolean
$key string
Результат boolean

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

Check for error info in api response and save it.
public hasErrors ( ) : boolean
Результат boolean

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

Checks if response is empty.
public isEmpty ( ) : boolean
Результат boolean

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

public isOk ( ) : boolean
Результат boolean

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

Data is stored in ['resource_response']['data'] array.
protected parseResponseData ( string $key ) : boolean | array
$key string
Результат boolean | array

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

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

protected array|null $clientInfo
Результат array | null

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

protected mixed $data
Результат mixed

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

protected array|null $lastError
Результат array | null