Oauth/Http/AccessToken.php
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: AccessToken.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Oauth_Http_AccessToken
- Parent(s)
- \Zend_Oauth_Http
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties


string $_consumer = null
null
Details- Type
- string
- Inherited_from
- \Zend_Oauth_Http::$$_consumer


\Zend_Http_Client $_httpClient = null
null
Details

\Zend_Oauth_Http_Utility $_httpUtility = null
null
Details- Type
- \Zend_Oauth_Http_Utility
- Inherited_from
- \Zend_Oauth_Http::$$_httpUtility


array $_parameters = array()
array()
Details- Type
- array
- Inherited_from
- \Zend_Oauth_Http::$$_parameters


string $_preferredRequestMethod = \Zend_Oauth::POST
\Zend_Oauth::POST
Details- Type
- string
- Inherited_from
- \Zend_Oauth_Http::$$_preferredRequestMethod


string $_preferredRequestScheme = null
null
Details- Type
- string
- Inherited_from
- \Zend_Oauth_Http::$$_preferredRequestScheme
Methods


__construct(\Zend_Oauth_Consumer $consumer, null | array $parameters = null, null | \Zend_Oauth_Http_Utility $utility = null) : void
Name | Type | Description |
---|---|---|
$consumer | \Zend_Oauth_Consumer | |
$parameters | null | array | |
$utility | null | \Zend_Oauth_Http_Utility |


_assessRequestAttempt(\Zend_Http_Response $response = null) : void
Manages the switch from OAuth request scheme to another lower preference scheme during a request cycle.
Inherited from: \Zend_Oauth_Http::_assessRequestAttempt()Name | Type | Description |
---|---|---|
$response | \Zend_Http_Response |
Exception | Description |
---|---|
\Zend_Oauth_Exception | if unable to retrieve valid token response |


_attemptRequest(array $params) : \Zend_Http_Response
Attempt a request based on the current configured OAuth Request Scheme and return the resulting HTTP Response.
Name | Type | Description |
---|---|---|
$params | array |
Type | Description |
---|---|
\Zend_Http_Response |


_cleanParamsOfIllegalCustomParameters(array $params) : array
Access Token requests specifically may not contain non-OAuth parameters.
So these should be striped out and excluded. Detection is easy since specified OAuth parameters start with "oauth_", Extension params start with "xouth_", and no other parameters should use these prefixes.
xouth params are not currently allowable.
Name | Type | Description |
---|---|---|
$params | array |
Type | Description |
---|---|
array |


_toAuthorizationHeader(array $params, string $realm = null) : string
Generates a valid OAuth Authorization header based on the provided parameters and realm.
Inherited from: \Zend_Oauth_Http::_toAuthorizationHeader()Name | Type | Description |
---|---|---|
$params | array | |
$realm | string |
Type | Description |
---|---|
string |


assembleParams() : array
Assemble all parameters for an OAuth Access Token request.
Type | Description |
---|---|
array |


execute() : \Zend_Oauth_Token_Access
Initiate a HTTP request to retrieve an Access Token.
Type | Description |
---|---|
\Zend_Oauth_Token_Access |


getParameters() : array
Accessor for an array of custom parameters.
Inherited from: \Zend_Oauth_Http::getParameters()Type | Description |
---|---|
array |


getRequestSchemeHeaderClient(array $params) : \Zend_Http_Client
Generate and return a HTTP Client configured for the Header Request Scheme specified by OAuth, for use in requesting an Access Token.
Name | Type | Description |
---|---|---|
$params | array |
Type | Description |
---|---|
\Zend_Http_Client |


getRequestSchemePostBodyClient(array $params) : \Zend_Http_Client
Generate and return a HTTP Client configured for the POST Body Request Scheme specified by OAuth, for use in requesting an Access Token.
Name | Type | Description |
---|---|---|
$params | array |
Type | Description |
---|---|
\Zend_Http_Client |


getRequestSchemeQueryStringClient(array $params, string $url) : \Zend_Http_Client
Generate and return a HTTP Client configured for the Query String Request Scheme specified by OAuth, for use in requesting an Access Token.
Name | Type | Description |
---|---|---|
$params | array | |
$url | string |
Type | Description |
---|---|
\Zend_Http_Client |


setMethod(string $method) : \Zend_Oauth_Http
Name | Type | Description |
---|---|---|
$method | string |
Type | Description |
---|---|
\Zend_Oauth_Http |


setParameters(array $customServiceParameters) : \Zend_Oauth_Http
Mutator to set an array of custom parameters for the HTTP request.
Inherited from: \Zend_Oauth_Http::setParameters()Name | Type | Description |
---|---|---|
$customServiceParameters | array |
Type | Description |
---|---|
\Zend_Oauth_Http |


startRequestCycle(array $params) : \Zend_Http_Response
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.
Inherited from: \Zend_Oauth_Http::startRequestCycle()On success, return the Request object that results for processing.
Name | Type | Description |
---|---|---|
$params | array |
Type | Description |
---|---|
\Zend_Http_Response |
Exception | Description |
---|---|
\Zend_Oauth_Exception | on HTTP request errors |