category |
Zend |
package |
Zend_Oauth |
copyright |
Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) |
license |
New BSD License |
inherited_from |
\Zend_Oauth_Http |
Methods
Constructor
__construct(\Zend_Oauth_Consumer $consumer, null|array $parameters = null
, null|\Zend_Oauth_Http_Utility $utility = null
) : void
Inherited
Parameters
$consumer
\Zend_Oauth_Consumer
$parameters
null
array
$utility
null
\Zend_Oauth_Http_Utility
Assemble all parameters for inclusion in a redirect URL.
assembleParams() : array
Return the Consumer instance in use.
getConsumer() : \Zend_Oauth_Consumer
Inherited
Returns
\Zend_Oauth_Consumer
Preferred HTTP request method accessor.
getMethod() : string
Inherited
Accessor for an array of custom parameters.
getParameters() : array
Inherited
Return an instance of Zend_Http_Client configured to use the Query
String scheme for an OAuth driven HTTP request.
getRequestSchemeQueryStringClient(array $params, string $url) : \Zend_Http_Client
Inherited
Parameters
$params
array
$url
string
Returns
\Zend_Http_Client
Generate a redirect URL from the allowable parameters and configured
values.
getUrl() : string
Set a preferred HTTP request method.
setMethod(string $method) : \Zend_Oauth_Http
Inherited
Parameters
$method
string
Returns
\Zend_Oauth_Http
Mutator to set an array of custom parameters for the HTTP request.
setParameters(array $customServiceParameters) : \Zend_Oauth_Http
Inherited
Parameters
$customServiceParameters
array
Returns
\Zend_Oauth_Http
Commence a request cycle where the current HTTP method and OAuth
request scheme set an upper preferred HTTP request style and where
failures generate a new HTTP request style further down the OAuth
preference list for OAuth Request Schemes.
startRequestCycle(array $params) : \Zend_Http_Response
Inherited
On success, return the Request object that results for processing.
todo |
Remove cycling?; Replace with upfront do-or-die configuration |
Parameters
$params
array
Exceptions
\Zend_Oauth_Exception |
on HTTP request errors |
Returns
\Zend_Http_Response
Manages the switch from OAuth request scheme to another lower preference
scheme during a request cycle.
_assessRequestAttempt(\Zend_Http_Response $response = null
) : void
Inherited
Parameters
$response
Exceptions
\Zend_Oauth_Exception |
if unable to retrieve valid token response |
Properties
Reference to the Zend_Oauth_Consumer instance in use.
$_consumer : string
Instance of the general Zend_Oauth_Http_Utility class.
$_httpUtility : \Zend_Oauth_Http_Utility
Array of all custom service parameters to be sent in the HTTP request
in addition to the usual OAuth parameters.
$_parameters : array
Request Method for the HTTP Request.
$_preferredRequestMethod : string
Default
\Zend_Oauth::POST
OAuth specifies three request methods, this holds the current preferred
one which by default uses the Authorization Header approach for passing
OAuth parameters, and a POST body for non-OAuth custom parameters.
$_preferredRequestScheme : string