PHP 클래스 Zendesk\API\HttpClient

상속: use trait Zendesk\API\Traits\Utility\InstantiatorTrait
파일 보기 프로젝트 열기: zendesk/zendesk_api_client_php 1 사용 예제들

공개 프로퍼티들

프로퍼티 타입 설명
$embeddable Zendesk\API\Resources\Embeddable
$guzzle GuzzleHttp\Client
$helpCenter Zendesk\API\Resources\HelpCenter
$voice Zendesk\API\Resources\Voice

보호된 프로퍼티들

프로퍼티 타입 설명
$apiBasePath This is appended between the full base domain and the resource endpoint
$apiUrl string
$auth Zendesk\API\Utilities\Auth
$debug Zendesk\API\Debug
$hostname string
$port integer
$scheme string
$sideload array | null
$subdomain string

공개 메소드들

메소드 설명
__construct ( string $subdomain, string $username = '', string $scheme = "https", string $hostname = "zendesk.com", integer $port = 443, Client $guzzle = null )
delete ( $endpoint ) : null This is a helper method to do a delete request.
get ( $endpoint, array $queryParams = [] ) : stdClass This is a helper method to do a get request.
getApiBasePath ( ) : string Returns the api base path
getApiUrl ( ) : string Returns the generated api URL
getAuth ( ) : Auth
getDebug ( ) : Zendesk\API\Debug Returns debug information in an object
getHeaders ( ) : array
getSideload ( array $params = [] ) : array | null Sideload getter
getSubdomain ( ) : string Returns the supplied subdomain
getUserAgent ( ) : string Return the user agent string
getValidSubResources ( ) : array
post ( $endpoint, array $postData = [] ) : stdClass This is a helper method to do a post request.
put ( $endpoint, array $putData = [] ) : stdClass This is a helper method to do a put request.
setApiBasePath ( string $apiBasePath ) Sets the api base path
setAuth ( $strategy, array $options ) Configure the authorization method
setDebug ( mixed $lastRequestHeaders, mixed $lastRequestBody, mixed $lastResponseCode, string $lastResponseHeaders, mixed $lastResponseError ) Set debug information as an object
setHeader ( string $key, string $value ) : HttpClient
setSideload ( array $fields = null ) : HttpClient Sideload setter

메소드 상세

__construct() 공개 메소드

public __construct ( string $subdomain, string $username = '', string $scheme = "https", string $hostname = "zendesk.com", integer $port = 443, Client $guzzle = null )
$subdomain string
$username string
$scheme string
$hostname string
$port integer
$guzzle GuzzleHttp\Client

delete() 공개 메소드

This is a helper method to do a delete request.
public delete ( $endpoint ) : null
$endpoint
리턴 null

get() 공개 메소드

This is a helper method to do a get request.
public get ( $endpoint, array $queryParams = [] ) : stdClass
$endpoint
$queryParams array
리턴 stdClass | null

getApiBasePath() 공개 메소드

Returns the api base path
public getApiBasePath ( ) : string
리턴 string

getApiUrl() 공개 메소드

Returns the generated api URL
public getApiUrl ( ) : string
리턴 string

getAuth() 공개 메소드

public getAuth ( ) : Auth
리턴 Zendesk\API\Utilities\Auth

getDebug() 공개 메소드

Returns debug information in an object
public getDebug ( ) : Zendesk\API\Debug
리턴 Zendesk\API\Debug

getHeaders() 공개 메소드

public getHeaders ( ) : array
리턴 array

getSideload() 공개 메소드

Sideload getter
public getSideload ( array $params = [] ) : array | null
$params array
리턴 array | null

getSubdomain() 공개 메소드

Returns the supplied subdomain
public getSubdomain ( ) : string
리턴 string

getUserAgent() 공개 메소드

Return the user agent string
public getUserAgent ( ) : string
리턴 string

getValidSubResources() 공개 정적인 메소드

public static getValidSubResources ( ) : array
리턴 array

post() 공개 메소드

This is a helper method to do a post request.
public post ( $endpoint, array $postData = [] ) : stdClass
$endpoint
$postData array
리턴 stdClass | null

put() 공개 메소드

This is a helper method to do a put request.
public put ( $endpoint, array $putData = [] ) : stdClass
$endpoint
$putData array
리턴 stdClass | null

setApiBasePath() 공개 메소드

Sets the api base path
public setApiBasePath ( string $apiBasePath )
$apiBasePath string

setAuth() 공개 메소드

Configure the authorization method
public setAuth ( $strategy, array $options )
$strategy
$options array

setDebug() 공개 메소드

Set debug information as an object
public setDebug ( mixed $lastRequestHeaders, mixed $lastRequestBody, mixed $lastResponseCode, string $lastResponseHeaders, mixed $lastResponseError )
$lastRequestHeaders mixed
$lastRequestBody mixed
$lastResponseCode mixed
$lastResponseHeaders string
$lastResponseError mixed

setHeader() 공개 메소드

public setHeader ( string $key, string $value ) : HttpClient
$key string The name of the header to set
$value string The value to set in the header
리턴 HttpClient

setSideload() 공개 메소드

Sideload setter
public setSideload ( array $fields = null ) : HttpClient
$fields array
리턴 HttpClient

프로퍼티 상세

$apiBasePath 보호되어 있는 프로퍼티

This is appended between the full base domain and the resource endpoint
protected $apiBasePath

$apiUrl 보호되어 있는 프로퍼티

protected string $apiUrl
리턴 string

$auth 보호되어 있는 프로퍼티

protected Auth,Zendesk\API\Utilities $auth
리턴 Zendesk\API\Utilities\Auth

$debug 보호되어 있는 프로퍼티

protected Debug,Zendesk\API $debug
리턴 Zendesk\API\Debug

$embeddable 공개적으로 프로퍼티

public Embeddable,Zendesk\API\Resources $embeddable
리턴 Zendesk\API\Resources\Embeddable

$guzzle 공개적으로 프로퍼티

public Client,GuzzleHttp $guzzle
리턴 GuzzleHttp\Client

$helpCenter 공개적으로 프로퍼티

public HelpCenter,Zendesk\API\Resources $helpCenter
리턴 Zendesk\API\Resources\HelpCenter

$hostname 보호되어 있는 프로퍼티

protected string $hostname
리턴 string

$port 보호되어 있는 프로퍼티

protected int $port
리턴 integer

$scheme 보호되어 있는 프로퍼티

protected string $scheme
리턴 string

$sideload 보호되어 있는 프로퍼티

protected array|null $sideload
리턴 array | null

$subdomain 보호되어 있는 프로퍼티

protected string $subdomain
리턴 string

$voice 공개적으로 프로퍼티

public Voice,Zendesk\API\Resources $voice
리턴 Zendesk\API\Resources\Voice