API Documentation

Zend/Oauth/Client.php

Show: inherited
Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Oauth  
Version
$Id: Client.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Oauth_Client

Package: Zend\Oauth

Parent(s)
\Zend_Http_Client
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotected\Zend_Oauth_Config  $_config= 'null'

Holds the current OAuth Configuration set encapsulated in an instance of Zend_Oauth_Config; it's not a Zend_Config instance since that level of abstraction is unnecessary and doesn't let me escape the accessors and mutators anyway!

Default valuenullDetails
Type
\Zend_Oauth_Config
Propertyprotectedbool  $_streamingRequest= 'null'

True if this request is being made with data supplied by a stream object instead of a raw encoded string.

Default valuenullDetails
Type
bool
Propertypublic  $supportsRevisionA= 'false'
static

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

Default valuefalseDetails
Type

Methods

methodpublic__call( string $method, array $args ) : mixed

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
Name Type Description
$method string
$args array
Returns
Type Description
mixed
Throws
Exception Description
\Zend_Oauth_Exception if method does not exist in config object
methodpublic__construct( array|\Zend_Config $oauthOptions, string $uri = null, array|\Zend_Config $config = null ) : void

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
Name Type Description
$oauthOptions array|\Zend_Config
$uri string
$config array|\Zend_Config
methodprotected_getSignableParametersAsQueryString( ) : string

Collect all signable parameters into a single array across query string and POST body. These are returned as a properly formatted single query string.

Returns
Type Description
string
methodprotected_prepareBody( ) : string

Prepare the request body (for POST and PUT requests)

Returns
Type Description
string
Throws
Exception Description
\Zend_Http_Client_Exception
methodpublicgetStreamingRequest( ) : boolean

Check whether the client is set to perform streaming requests.

Returns
Type Description
boolean True if yes, false otherwise.
methodpublicprepareOauth( ) : void

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.

Throws
Exception Description
\Zend_Oauth_Exception If POSTBODY scheme requested, but GET request method used; or if invalid request scheme provided
methodpublicrequest( string $method = null ) : \Zend_Http_Response

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
Name Type Description
$method string
Returns
Type Description
\Zend_Http_Response
methodpublicresetParameters(  $clearAll = false ) : \Zend_Http_Client

Clear all custom parameters we set.

Parameters
Name Type Description
$clearAll
Returns
Type Description
\Zend_Http_Client
methodpublicsetAdapter( \Zend_Http_Client_Adapter_Interface $adapter ) : void

Load the connection adapter

Parameters
Name Type Description
$adapter \Zend_Http_Client_Adapter_Interface
methodpublicsetMethod( string $method = self::GET ) : \Zend_Http_Client

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
Name Type Description
$method string
Returns
Type Description
\Zend_Http_Client
methodpublicsetRawDataStream( string $data, string $enctype = null ) : \Zend_Http_Client

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
Name Type Description
$data string

The request data

$enctype string

The encoding type

Returns
Type Description
\Zend_Http_Client
methodpublicsetStreamingRequest( boolean $value ) : void

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

Parameters
Name Type Description
$value boolean

The value to set.

Documentation was generated by DocBlox 0.15.1.