Inheritance diagram for Zend_Oauth_Client:

Public Member Functions
	__construct ($oauthOptions, $uri=null, $config=null)

	setAdapter ($adapter)

	setStreamingRequest ($value)

	getStreamingRequest ()

	resetParameters ($clearAll=false)

	setRawDataStream ($data, $enctype=null)

	setMethod ($method=self::GET)

	request ($method=null)

	prepareOauth ()

	__call ($method, array $args)

Public Member Functions inherited from Zend_Http_Client
	__construct ($uri=null, $config=null)

	setUri ($uri)

	getUri ($as_string=false)

	setConfig ($config=array())

	setMethod ($method=self::GET)

	setHeaders ($name, $value=null)

	getHeader ($key)

	setParameterGet ($name, $value=null)

	setParameterPost ($name, $value=null)

	getRedirectionsCount ()

	setAuth ($user, $password='', $type=self::AUTH_BASIC)

	setCookieJar ($cookiejar=true)

	getCookieJar ()

	setCookie ($cookie, $value=null)

	setFileUpload ($filename, $formname, $data=null, $ctype=null)

	setEncType ($enctype=self::ENC_URLENCODED)

	setRawData ($data, $enctype=null)

	setUnmaskStatus ($status=true)

	getUnmaskStatus ()

	resetParameters ($clearAll=false)

	getLastRequest ()

	getLastResponse ()

	setAdapter ($adapter)

	getAdapter ()

	setStream ($streamfile=true)

	getStream ()

	request ($method=null)

Static Public Attributes
static	$supportsRevisionA = false

Protected Member Functions
	_prepareBody ()

	_getSignableParametersAsQueryString ()

Protected Member Functions inherited from Zend_Http_Client
	_setParameter ($type, $name, $value)

	_openTempStream ()

	_prepareHeaders ()

	_prepareBody ()

	_getParametersRecursive ($parray, $urlencode=false)

	_detectFileMimeType ($file)

	_validateHeaderValue ($value, $recurse=true)

Protected Attributes
	$_config = null

	$_streamingRequest = null

Protected Attributes inherited from Zend_Http_Client
	$config

	$adapter = null

	$uri = null

	$headers = array()

	$method = self::GET

	$paramsGet = array()

	$paramsPost = array()

	$enctype = null

	$raw_post_data = null

	$auth

	$files = array()

	$body_field_order = array()

	$cookiejar = null

	$last_request = null

	$last_response = null

	$redirectCounter = 0

	$_unmaskStatus = false

	$_queryBracketsEscaped = true

Additional Inherited Members
Static Public Member Functions inherited from Zend_Http_Client
static	encodeFormData ($boundary, $name, $value, $filename=null, $headers=array())

static	encodeAuthHeader ($user, $password, $type=self::AUTH_BASIC)

Data Fields inherited from Zend_Http_Client
const	GET = 'GET'

const	POST = 'POST'

const	PUT = 'PUT'

const	HEAD = 'HEAD'

const	DELETE = 'DELETE'

const	TRACE = 'TRACE'

const	OPTIONS = 'OPTIONS'

const	CONNECT = 'CONNECT'

const	MERGE = 'MERGE'

const	PATCH = 'PATCH'

const	AUTH_BASIC = 'basic'

const	HTTP_1 = '1.1'

const	HTTP_0 = '1.0'

const	CONTENT_TYPE = 'Content-Type'

const	CONTENT_LENGTH = 'Content-Length'

const	ENC_URLENCODED = 'application/x-www-form-urlencoded'

const	ENC_FORMDATA = 'multipart/form-data'

const	VTYPE_SCALAR = 'SCALAR'

const	VTYPE_FILE = 'FILE'

Static Protected Member Functions inherited from Zend_Http_Client
static	_flattenParametersArray ($parray, $prefix=null)

Static Protected Attributes inherited from Zend_Http_Client
static	$_fileInfoDb = null

Detailed Description

Definition at line 40 of file Client.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	$oauthOptions,
		$uri = `null`,
		$config = `null`
	)

Constructor; creates a new HTTP Client instance which itself is just a typical Zend_Http_Client subclass with some OAuth icing to assist in automating OAuth parameter generation, addition and cryptographioc signing of requests.

Parameters

array \| Zend_Config	$oauthOptions
string	$uri
array \| Zend_Config	$config

Returns: void

Definition at line 77 of file Client.php.

     {
         if ($config instanceof Zend_Config && !isset($config->rfc3986_strict)) {
             $config                   = $config->toArray();
             $config['rfc3986_strict'] = true;
         } else if (null === $config ||
                    (is_array($config) && !isset($config['rfc3986_strict']))) {
             $config['rfc3986_strict'] = true;
         }
         parent::__construct($uri, $config);
         $this->_config = new Zend_Oauth_Config;
         if ($oauthOptions !== null) {
             if ($oauthOptions instanceof Zend_Config) {
                 $oauthOptions = $oauthOptions->toArray();
             }
             $this->_config->setOptions($oauthOptions);
         }
     }

Member Function Documentation

◆ __call()

__call	(		$method,
		array	$args
	)

Simple Proxy to the current Zend_Oauth_Config method. It's that instance which holds all configuration methods and values this object also presents as it's API.

Parameters

string	$method
array	$args

Returns: mixed

Exceptions

Zend_Oauth_Exception if method does not exist in config object

Definition at line 321 of file Client.php.

     {
         if (!method_exists($this->_config, $method)) {
             #require_once 'Zend/Oauth/Exception.php';
             throw new Zend_Oauth_Exception('Method does not exist: ' . $method);
         }
         return call_user_func_array(array($this->_config,$method), $args);
     }

◆ _getSignableParametersAsQueryString()

_getSignableParametersAsQueryString ( )

protected

Collect all signable parameters into a single array across query string and POST body. Don't include POST parameters if content type is multipart POST.

Returns: array

Definition at line 299 of file Client.php.

     {
         $params = array();
         if (!empty($this->paramsGet)) {
             $params = array_merge($params, $this->paramsGet);
         }
         if ($this->enctype != self::ENC_FORMDATA && !empty($this->paramsPost)) {
             $params = array_merge($params, $this->paramsPost);
         }
         return $params;
     }

◆ _prepareBody()

_prepareBody ( )

protected

Prepare the request body (for POST and PUT requests)

Returns: string

Exceptions

Zend_Http_Client_Exception

Definition at line 143 of file Client.php.

     {
         if($this->_streamingRequest) {
             $this->setHeaders(self::CONTENT_LENGTH,
                 $this->raw_post_data->getTotalSize());
             return $this->raw_post_data;
         }
         else {
             return parent::_prepareBody();
         }
     }

◆ getStreamingRequest()

getStreamingRequest ( )

Check whether the client is set to perform streaming requests.

Returns: boolean True if yes, false otherwise.

Definition at line 128 of file Client.php.

     {
         if ($this->_streamingRequest) {
             return true;
         } else {
             return false;
         }
     }

◆ prepareOauth()

prepareOauth ( )

Performs OAuth preparation on the request before sending.

This primarily means taking a request, correctly encoding and signing all parameters, and applying the correct OAuth scheme to the method being used.

Returns: void

Exceptions

Zend_Oauth_Exception If POSTBODY scheme requested, but GET request method used; or if invalid request scheme provided

Definition at line 236 of file Client.php.

     {
         $requestScheme = $this->getRequestScheme();
         $requestMethod = $this->getRequestMethod();
         $query = null;
         if ($requestScheme == Zend_Oauth::REQUEST_SCHEME_HEADER) {
             $oauthHeaderValue = $this->getToken()->toHeader(
                 $this->getUri(true),
                 $this->_config,
                 $this->_getSignableParametersAsQueryString(),
                 $this->getRealm()
             );
             $this->setHeaders('Authorization', $oauthHeaderValue);
         } elseif ($requestScheme == Zend_Oauth::REQUEST_SCHEME_POSTBODY) {
             if ($requestMethod == self::GET) {
                 #require_once 'Zend/Oauth/Exception.php';
                 throw new Zend_Oauth_Exception(
                     'The client is configured to'
                     . ' pass OAuth parameters through a POST body but request method'
                     . ' is set to GET'
                 );
             }
             $raw = $this->getToken()->toQueryString(
                 $this->getUri(true),
                 $this->_config,
                 $this->_getSignableParametersAsQueryString()
             );
             $this->setRawData($raw, 'application/x-www-form-urlencoded');
             $this->paramsPost = array();
         } elseif ($requestScheme == Zend_Oauth::REQUEST_SCHEME_QUERYSTRING) {
             $params = $this->paramsGet;
             $query = $this->getUri()->getQuery();
             if ($query) {
                 $queryParts = explode('&', $this->getUri()->getQuery());
                 foreach ($queryParts as $queryPart) {
                     $kvTuple = explode('=', $queryPart);
                     $params[urldecode($kvTuple[0])] =
                         (array_key_exists(1, $kvTuple) ? urldecode($kvTuple[1]) : null);
                 }
             }
             if (!empty($this->paramsPost)) {
                 $params = array_merge($params, $this->paramsPost);
                 $query  = $this->getToken()->toQueryString(
                     $this->getUri(true), $this->_config, $params
                 );
             }
             $query = $this->getToken()->toQueryString(
                 $this->getUri(true), $this->_config, $params
             );
             $this->getUri()->setQuery($query);
             $this->paramsGet = array();
         } else {
             #require_once 'Zend/Oauth/Exception.php';
             throw new Zend_Oauth_Exception('Invalid request scheme: ' . $requestScheme);
         }
     }

◆ request()

request ( $method = null )

Same as Zend_Http_Client::request() except just before the request is executed, we automatically append any necessary OAuth parameters and sign the request using the relevant signature method.

Parameters

string $method

Returns: Zend_Http_Response

Definition at line 217 of file Client.php.

     {
         if ($method !== null) {
             $this->setMethod($method);
         }
         $this->prepareOauth();
         return parent::request();
     }

◆ resetParameters()

resetParameters ( $clearAll = false )

Clear all custom parameters we set.

Returns: Zend_Http_Client

Definition at line 160 of file Client.php.

     {
         $this->_streamingRequest = false;
         return parent::resetParameters($clearAll);
     }

◆ setAdapter()

setAdapter ( $adapter )

Load the connection adapter

Parameters

Zend_Http_Client_Adapter_Interface $adapter

Returns: void

Definition at line 102 of file Client.php.

     {
         if ($adapter == null) {
             $this->adapter = $adapter;
         } else {
               parent::setAdapter($adapter);
         }
     }

◆ setMethod()

setMethod ( $method = self::GET )

Same as Zend_Http_Client::setMethod() except it also creates an Oauth specific reference to the method type. Might be defunct and removed in a later iteration.

Parameters

string $method

Returns: Zend_Http_Client

Definition at line 191 of file Client.php.

     {
         if ($method == self::GET) {
             $this->setRequestMethod(self::GET);
         } elseif($method == self::POST) {
             $this->setRequestMethod(self::POST);
         } elseif($method == self::PUT) {
             $this->setRequestMethod(self::PUT);
         } elseif($method == self::DELETE) {
             $this->setRequestMethod(self::DELETE);
         } elseif($method == self::HEAD) {
             $this->setRequestMethod(self::HEAD);
         } elseif($method == self::OPTIONS) {
             $this->setRequestMethod(self::OPTIONS);
         }
         return parent::setMethod($method);
     }

◆ setRawDataStream()

setRawDataStream	(	$data,
		$enctype = `null`
	)

Set the raw (already encoded) POST data from a stream source.

This is used to support POSTing from open file handles without caching the entire body into memory. It is a wrapper around Zend_Http_Client::setRawData().

Parameters

string	$data	The request data
string	$enctype	The encoding type

Returns: Zend_Http_Client

Definition at line 177 of file Client.php.

     {
         $this->_streamingRequest = true;
         return $this->setRawData($data, $enctype);
     }

◆ setStreamingRequest()

setStreamingRequest ( $value )

Set the streamingRequest variable which controls whether we are sending the raw (already encoded) POST data from a stream source.

Parameters

boolean $value The value to set.

Returns: void

Definition at line 118 of file Client.php.

     {
         $this->_streamingRequest = $value;
     }

Field Documentation

◆ $_config

$_config = null

protected

Definition at line 56 of file Client.php.

◆ $_streamingRequest

$_streamingRequest = null

protected

Definition at line 64 of file Client.php.

◆ $supportsRevisionA

$supportsRevisionA = false

static

Flag to indicate that the client has detected the server as supporting OAuth 1.0a

Definition at line 46 of file Client.php.

The documentation for this class was generated from the following file:

vendor/magento/zendframework1/library/Zend/Oauth/Client.php

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __call()

◆ _getSignableParametersAsQueryString()

◆ _prepareBody()

◆ getStreamingRequest()

◆ prepareOauth()

◆ request()

◆ resetParameters()

◆ setAdapter()

◆ setMethod()

◆ setRawDataStream()

◆ setStreamingRequest()

Field Documentation

◆ $_config

◆ $_streamingRequest

◆ $supportsRevisionA