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.

\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!

bool
$_streamingRequest= 'null'
True if this request is being made with data supplied by a stream object instead of a raw encoded string.
null
Details
__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.
Name | Type | Description |
---|---|---|
$method | string | |
$args | array |
Type | Description |
---|---|
mixed |
Exception | Description |
---|---|
\Zend_Oauth_Exception | if method does not exist in config object |

__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.
Name | Type | Description |
---|---|---|
$oauthOptions | array|\Zend_Config | |
$uri | string | |
$config | array|\Zend_Config |

_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.
Type | Description |
---|---|
string |

getStreamingRequest(
)
:
boolean
Check whether the client is set to perform streaming requests.
Type | Description |
---|---|
boolean | True if yes, false otherwise. |

prepareOauth(
)
:
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.
Exception | Description |
---|---|
\Zend_Oauth_Exception | If POSTBODY scheme requested, but GET request method used; or if invalid request scheme provided |

request(
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.

setAdapter(
\Zend_Http_Client_Adapter_Interface $adapter
)
:
void
Load the connection adapter
Name | Type | Description |
---|---|---|
$adapter | \Zend_Http_Client_Adapter_Interface |

setMethod(
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.
Name | Type | Description |
---|---|---|
$method | string |
Type | Description |
---|---|
\Zend_Http_Client |

setRawDataStream(
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().
Name | Type | Description |
---|---|---|
$data | string | The request data |
$enctype | string | The encoding type |
Type | Description |
---|---|
\Zend_Http_Client |