PHP Класс seregazhuk\PinterestBot\Api\Providers\Provider

Наследование: use trait seregazhuk\PinterestBot\Helpers\Providers\ProviderHelper
Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$loginRequiredFor array List of methods that require logged status.
$request seregazhuk\PinterestBot\Api\Request Instance of the API Request.
$response seregazhuk\PinterestBot\Api\Response

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

Метод Описание
__construct ( Request $request, Response $response )
checkMethodRequiresLogin ( string $method ) : boolean
getEntityIdName ( ) : string
getPaginatedData ( array $data, string $url, array $bookmarks = [] ) : Response Executes pagination GET request.
isLoggedIn ( ) : boolean

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

Метод Описание
execGetRequest ( array $requestOptions = [], string $resourceUrl = '' ) : array | boolean Executes a GET request to Pinterest API.
execGetRequestWithPagination ( array $requestOptions, string $resourceUrl, array $bookmarks = [] ) : Response Executes a GET request to Pinterest API with pagination.
execPostRequest ( array $requestOptions, string $resourceUrl, boolean $returnResponse = false ) : Response | boolean Executes a POST request to Pinterest API.
execute ( $url, string $postString = "" )
processResult ( string $res ) : Response

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

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

public __construct ( Request $request, Response $response )
$request seregazhuk\PinterestBot\Api\Request
$response seregazhuk\PinterestBot\Api\Response

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

public checkMethodRequiresLogin ( string $method ) : boolean
$method string
Результат boolean

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

Executes a GET request to Pinterest API.
protected execGetRequest ( array $requestOptions = [], string $resourceUrl = '' ) : array | boolean
$requestOptions array
$resourceUrl string
Результат array | boolean

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

Executes a GET request to Pinterest API with pagination.
protected execGetRequestWithPagination ( array $requestOptions, string $resourceUrl, array $bookmarks = [] ) : Response
$requestOptions array
$resourceUrl string
$bookmarks array
Результат seregazhuk\PinterestBot\Api\Response

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

Executes a POST request to Pinterest API.
protected execPostRequest ( array $requestOptions, string $resourceUrl, boolean $returnResponse = false ) : Response | boolean
$requestOptions array
$resourceUrl string
$returnResponse boolean
Результат seregazhuk\PinterestBot\Api\Response | boolean

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

protected execute ( $url, string $postString = "" )
$url
$postString string

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

public getEntityIdName ( ) : string
Результат string

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

Executes pagination GET request.
public getPaginatedData ( array $data, string $url, array $bookmarks = [] ) : Response
$data array
$url string
$bookmarks array
Результат seregazhuk\PinterestBot\Api\Response

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

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

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

protected processResult ( string $res ) : Response
$res string
Результат seregazhuk\PinterestBot\Api\Response

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

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

List of methods that require logged status.
protected array $loginRequiredFor
Результат array

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

Instance of the API Request.
protected Request,seregazhuk\PinterestBot\Api $request
Результат seregazhuk\PinterestBot\Api\Request

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

protected Response,seregazhuk\PinterestBot\Api $response
Результат seregazhuk\PinterestBot\Api\Response