PHP Класс Google\Spreadsheet\DefaultServiceRequest

Автор: Asim Liaquat ([email protected])
Наследование: implements Google\Spreadsheet\ServiceRequestInterface
Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$accessToken Google\Spreadsheet\Request Request object
$curlParams array cURL parameters
$headers array Request headers
$serviceUrl string Service url
$sslVerifyPeer boolean SSL verify peer
$tokenType string Token type (defaults to OAuth for BC)
$userAgent string User agent

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

Метод Описание
__construct ( string $accessToken, string $tokenType = "OAuth" ) Initializes the service request object.
addCurlParam ( string $name, mixed $value ) : DefaultServiceRequest Add an extra curl parameter or override an existing one
addHeader ( string $name, string $value ) : Google\Spreadsheet\DefaultServiceRequest Add a header to the headers array
delete ( string $url ) : string Perform a delete request
get ( string $url ) : string Perform a get request
getCurlParams ( ) : array Get currently set curl params
getHeaders ( ) : array Get request headers
getServiceUrl ( ) : string Get the hostname of the spreadsheet service
getSslVerifyPeer ( ) : boolean Get the value for verifying the peers ssl certificate.
getUserAgent ( ) : string Get the user agent
post ( string $url, mixed $postData ) : string Perform a post request
put ( string $url, mixed $postData ) : string Perform a put request
removeHeader ( string $name ) : Google\Spreadsheet\DefaultServiceRequest
setHeaders ( array $headers ) : Google\Spreadsheet\DefaultServiceRequest Set optional request headers.
setSslVerifyPeer ( boolean $sslVerifyPeer ) : DefaultServiceRequest Verify the peer"s ssl certificate
setUserAgent ( string $userAgent ) : Google\Spreadsheet\DefaultServiceRequest Set the user agent. It is a good ides to leave this as is.

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

Метод Описание
execute ( $ch ) : string Executes the api request.
initRequest ( string $url, array $requestHeaders = [] ) : resource Initialize the curl session

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

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

Initializes the service request object.
public __construct ( string $accessToken, string $tokenType = "OAuth" )
$accessToken string
$tokenType string

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

Add an extra curl parameter or override an existing one
public addCurlParam ( string $name, mixed $value ) : DefaultServiceRequest
$name string 'CURLOPT_*' constant
$value mixed
Результат DefaultServiceRequest

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

Add a header to the headers array
public addHeader ( string $name, string $value ) : Google\Spreadsheet\DefaultServiceRequest
$name string
$value string
Результат Google\Spreadsheet\DefaultServiceRequest

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

Perform a delete request
public delete ( string $url ) : string
$url string
Результат string

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

Executes the api request.
protected execute ( $ch ) : string
Результат string the xml response

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

Perform a get request
public get ( string $url ) : string
$url string
Результат string

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

Get currently set curl params
public getCurlParams ( ) : array
Результат array

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

Get request headers
public getHeaders ( ) : array
Результат array

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

Get the hostname of the spreadsheet service
public getServiceUrl ( ) : string
Результат string

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

Get the value for verifying the peers ssl certificate.
public getSslVerifyPeer ( ) : boolean
Результат boolean

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

Get the user agent
public getUserAgent ( ) : string
Результат string

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

Initialize the curl session
protected initRequest ( string $url, array $requestHeaders = [] ) : resource
$url string
$requestHeaders array
Результат resource

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

Perform a post request
public post ( string $url, mixed $postData ) : string
$url string
$postData mixed
Результат string

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

Perform a put request
public put ( string $url, mixed $postData ) : string
$url string
$postData mixed
Результат string

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

public removeHeader ( string $name ) : Google\Spreadsheet\DefaultServiceRequest
$name string
Результат Google\Spreadsheet\DefaultServiceRequest

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

Set optional request headers.
public setHeaders ( array $headers ) : Google\Spreadsheet\DefaultServiceRequest
$headers array associative array of key value pairs
Результат Google\Spreadsheet\DefaultServiceRequest

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

Verify the peer"s ssl certificate
public setSslVerifyPeer ( boolean $sslVerifyPeer ) : DefaultServiceRequest
$sslVerifyPeer boolean
Результат DefaultServiceRequest

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

Set the user agent. It is a good ides to leave this as is.
public setUserAgent ( string $userAgent ) : Google\Spreadsheet\DefaultServiceRequest
$userAgent string
Результат Google\Spreadsheet\DefaultServiceRequest

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

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

Request object
protected Request,Google\Spreadsheet $accessToken
Результат Google\Spreadsheet\Request

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

cURL parameters
protected array $curlParams
Результат array

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

Request headers
protected array $headers
Результат array

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

Service url
protected string $serviceUrl
Результат string

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

SSL verify peer
protected bool $sslVerifyPeer
Результат boolean

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

Token type (defaults to OAuth for BC)
protected string $tokenType
Результат string

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

User agent
protected string $userAgent
Результат string