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

TOKEN_PARAM_KEY
= 'oauth_token'
- Inherited_from
- \Zend_Oauth_Token::TOKEN_PARAM_KEY

TOKEN_SECRET_PARAM_KEY
= 'oauth_token_secret'
- Inherited_from
- \Zend_Oauth_Token::TOKEN_SECRET_PARAM_KEY

TOKEN_PARAM_CALLBACK_CONFIRMED
= 'oauth_callback_confirmed'
- Inherited_from
- \Zend_Oauth_Token::TOKEN_PARAM_CALLBACK_CONFIRMED
Properties


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


array $_params = array()
array()
Details- Type
- array
- Inherited_from
- \Zend_Oauth_Token::$$_params


\Zend_Http_Response $_response = null
null
Details- Type
- \Zend_Http_Response
- Inherited_from
- \Zend_Oauth_Token::$$_response
Methods


__construct(null | \Zend_Http_Response $response = null, null | \Zend_Oauth_Http_Utility $utility = null) : void
Constructor; basic setup for any Token subclass.
Inherited from: \Zend_Oauth_Token::__construct()Name | Type | Description |
---|---|---|
$response | null | \Zend_Http_Response | |
$utility | null | \Zend_Oauth_Http_Utility |


__get( $key) : string
Generic accessor to enable access as public properties.
Inherited from: \Zend_Oauth_Token::__get()Name | Type | Description |
---|---|---|
$key |
Type | Description |
---|---|
string |


__set(string $key, string $value) : void
Generic mutator to enable access as public properties.
Inherited from: \Zend_Oauth_Token::__set()Name | Type | Description |
---|---|---|
$key | string | |
$value | string |


__sleep() : void
Limit serialisation stored data to the parameters
Inherited from: \Zend_Oauth_Token::__sleep()

__toString() : string
Convert Token to a string, specifically a raw encoded query string.
Inherited from: \Zend_Oauth_Token::__toString()Aliases to self::toString()
Type | Description |
---|---|
string |


__wakeup() : void
After serialisation, re-instantiate a HTTP utility class for use
Inherited from: \Zend_Oauth_Token::__wakeup()

_parseParameters(\Zend_Http_Response $response) : array
Parse a HTTP response body and collect returned parameters as raw url decoded key-value pairs in an associative array.
Inherited from: \Zend_Oauth_Token::_parseParameters()Name | Type | Description |
---|---|---|
$response | \Zend_Http_Response |
Type | Description |
---|---|
array |


getHttpClient(array $oauthOptions, null | string $uri = null, null | array | \Zend_Config $config = null, bool $excludeCustomParamsFromHeader = true) : \Zend_Oauth_Client
Get OAuth client
Name | Type | Description |
---|---|---|
$oauthOptions | array | |
$uri | null | string | |
$config | null | array | \Zend_Config | |
$excludeCustomParamsFromHeader | bool |
Type | Description |
---|---|
\Zend_Oauth_Client |


getParam(string $key) : mixed
token secret or other).
Name | Type | Description |
---|---|---|
$key | string |
Type | Description |
---|---|
mixed |


getResponse() : \Zend_Http_Response
Return the HTTP response object used to initialise this instance.
Inherited from: \Zend_Oauth_Token::getResponse()Type | Description |
---|---|
\Zend_Http_Response |


getTokenSecret() : string
Retrieve this Token's secret which may be used when signing requests with this Token.
Inherited from: \Zend_Oauth_Token::getTokenSecret()Type | Description |
---|---|
string |


isValid() : bool
Attempts to validate the Token parsed from the HTTP response - really it's just very basic existence checks which are minimal.
Inherited from: \Zend_Oauth_Token::isValid()Type | Description |
---|---|
bool |


setParam(string $key, string $value) : \Zend_Oauth_Token
token secret or other) and run a simple filter to remove any trailing newlines.
Name | Type | Description |
---|---|---|
$key | string | |
$value | string |
Type | Description |
---|---|
\Zend_Oauth_Token |


setParams(array $params) : \Zend_Oauth_Token
token secret or other) and run a simple filter to remove any trailing newlines.
Name | Type | Description |
---|---|---|
$params | array |
Type | Description |
---|---|
\Zend_Oauth_Token |


setToken(string $token) : \Zend_Oauth_Token
Name | Type | Description |
---|---|---|
$token | string |
Type | Description |
---|---|
\Zend_Oauth_Token |


setTokenSecret(string $secret) : \Zend_Oauth_Token
Sets the value for the this Token's secret which may be used when signing requests with this Token.
Inherited from: \Zend_Oauth_Token::setTokenSecret()Name | Type | Description |
---|---|---|
$secret | string |
Type | Description |
---|---|
\Zend_Oauth_Token |


toHeader(string $url, \Zend_Oauth_Config_ConfigInterface $config, null | array $customParams = null, null | string $realm = null) : string
Cast to HTTP header
Name | Type | Description |
---|---|---|
$url | string | |
$config | \Zend_Oauth_Config_ConfigInterface | |
$customParams | null | array | |
$realm | null | string |
Type | Description |
---|---|
string |


toQueryString(mixed $url, \Zend_Oauth_Config_ConfigInterface $config, null | array $params = null) : string
Cast to HTTP query string
Name | Type | Description |
---|---|---|
$url | mixed | |
$config | \Zend_Oauth_Config_ConfigInterface | |
$params | null | array |
Type | Description |
---|---|
string |


toString() : string
Convert Token to a string, specifically a raw encoded query string.
Inherited from: \Zend_Oauth_Token::toString()Type | Description |
---|---|
string |