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

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

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

Свойство Тип Описание
$csrfToken string
$filePathToUpload string
$httpClient seregazhuk\PinterestBot\Api\Contracts\HttpClient
$lastError array | null
$loggedIn boolean
$postFileData string
$requestHeaders array Common headers needed for every query.

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

Метод Описание
__construct ( seregazhuk\PinterestBot\Api\Contracts\HttpClient $http )
autoLogin ( string $username ) : boolean Load cookies for this username and check if it was logged in.
clearToken ( ) Clear token information.
createQuery ( array $data = [], array $bookmarks = [] ) : string Create request string.
createRequestData ( array $data = [], array $bookmarks = [] ) : array
exec ( string $resourceUrl, string $postString = '' ) : string Executes request to Pinterest API.
getHttpClient ( ) : seregazhuk\PinterestBot\Api\Contracts\HttpClient
getLastError ( ) : array | null
isLoggedIn ( ) : boolean Get current auth status.
login ( ) Mark client as logged.
logout ( ) Mark client as logged out.
setTokenFromCookies ( ) Trying to get csrf token from cookies.
upload ( string $pathToFile, string $url ) : string

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

Метод Описание
buildFilePostData ( string $delimiter )
getContentTypeHeader ( ) : array If we are uploading file, we should build boundary form data. Otherwise it is simple urlencoded form.
getDefaultHttpHeaders ( ) : array
getHttpHeaders ( ) : array
makeHeadersForUpload ( ) : array

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

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

public __construct ( seregazhuk\PinterestBot\Api\Contracts\HttpClient $http )
$http seregazhuk\PinterestBot\Api\Contracts\HttpClient

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

Load cookies for this username and check if it was logged in.
public autoLogin ( string $username ) : boolean
$username string
Результат boolean

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

protected buildFilePostData ( string $delimiter )
$delimiter string

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

Clear token information.
public clearToken ( )

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

Create request string.
public static createQuery ( array $data = [], array $bookmarks = [] ) : string
$data array
$bookmarks array
Результат string

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

public static createRequestData ( array $data = [], array $bookmarks = [] ) : array
$data array
$bookmarks array
Результат array

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

Executes request to Pinterest API.
public exec ( string $resourceUrl, string $postString = '' ) : string
$resourceUrl string
$postString string
Результат string

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

If we are uploading file, we should build boundary form data. Otherwise it is simple urlencoded form.
protected getContentTypeHeader ( ) : array
Результат array

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

protected getDefaultHttpHeaders ( ) : array
Результат array

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

public getHttpClient ( ) : seregazhuk\PinterestBot\Api\Contracts\HttpClient
Результат seregazhuk\PinterestBot\Api\Contracts\HttpClient

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

protected getHttpHeaders ( ) : array
Результат array

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

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

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

Get current auth status.
public isLoggedIn ( ) : boolean
Результат boolean

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

Mark client as logged.
public login ( )

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

Mark client as logged out.
public logout ( )

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

protected makeHeadersForUpload ( ) : array
Результат array

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

Trying to get csrf token from cookies.
public setTokenFromCookies ( )

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

public upload ( string $pathToFile, string $url ) : string
$pathToFile string
$url string
Результат string

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

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

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

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

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

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

protected HttpClient,seregazhuk\PinterestBot\Api\Contracts $httpClient
Результат seregazhuk\PinterestBot\Api\Contracts\HttpClient

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

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

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

protected bool $loggedIn
Результат boolean

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

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

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

Common headers needed for every query.
protected array $requestHeaders
Результат array