Oauth/Http/AccessToken.php
- category
- Zend
- copyright
- Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- license
- http://framework.zend.com/license/new-bsd New BSD License
- package
- Zend_Oauth
- version
- $Id: AccessToken.php 20217 2010-01-12 16:01:57Z matthew $
- Classes
- Zend_Oauth_Http_AccessToken
Description
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_Http_AccessToken
- Extends from
- Zend_Oauth_Http
- category
- Zend
- copyright
- Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- license
- http://framework.zend.com/license/new-bsd New BSD License
- package
- Zend_Oauth
- Properties
- $_httpClient
- Methods
- execute
- assembleParams
- getRequestSchemeHeaderClient
- getRequestSchemePostBodyClient
- getRequestSchemeQueryStringClient
- _attemptRequest
- _cleanParamsOfIllegalCustomParameters
Description
Properties
$_httpClient
Zend_Http_Client $_httpClient = 'null'Singleton instance if required of the HTTP client
Details
- $_httpClient
-
Zend_Http_Client
- visibility
- protected
- default
- null
- final
- false
- static
- false
Methods
_attemptRequest
_attemptRequest(
array $params
)
:
Zend_Http_ResponseAttempt a request based on the current configured OAuth Request Scheme and return the resulting HTTP Response.
Arguments
- $params
- array
Output
Details
- visibility
- protected
- final
- false
- static
- false
_cleanParamsOfIllegalCustomParameters
_cleanParamsOfIllegalCustomParameters(
array $params
)
:
arrayAccess 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.
Arguments
- $params
- array
Output
- array
Details
- visibility
- protected
- final
- false
- static
- false
assembleParams
assembleParams(
)
:
arrayAssemble all parameters for an OAuth Access Token request.
Output
- array
Details
- visibility
- public
- final
- false
- static
- false
execute
execute(
)
:
Zend_Oauth_Token_AccessInitiate a HTTP request to retrieve an Access Token.
Output
Details
- visibility
- public
- final
- false
- static
- false
getRequestSchemeHeaderClient
getRequestSchemeHeaderClient(
array $params
)
:
Zend_Http_ClientGenerate and return a HTTP Client configured for the Header Request Scheme specified by OAuth, for use in requesting an Access Token.
Arguments
- $params
- array
Output
Details
- visibility
- public
- final
- false
- static
- false
getRequestSchemePostBodyClient
getRequestSchemePostBodyClient(
array $params
)
:
Zend_Http_ClientGenerate and return a HTTP Client configured for the POST Body Request Scheme specified by OAuth, for use in requesting an Access Token.
Arguments
- $params
- array
Output
Details
- visibility
- public
- final
- false
- static
- false
getRequestSchemeQueryStringClient
getRequestSchemeQueryStringClient(
array $params, string $url
)
:
Zend_Http_ClientGenerate and return a HTTP Client configured for the Query String Request Scheme specified by OAuth, for use in requesting an Access Token.
Arguments
- $params
- array
- $url
- string
Output
Details
- visibility
- public
- final
- false
- static
- false