Oauth/Token/Access.php

Show:

inherited

Classes
- \Zend_Oauth_Token_Access

Table of Contents

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 [email protected] 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
jump to top

Package: Zend\Oauth

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'

inheritedInherited from: \Zend_Oauth_Token::TOKEN_PARAM_KEY

Inherited_from: \Zend_Oauth_Token::TOKEN_PARAM_KEY

 
                TOKEN_SECRET_PARAM_KEY
                = 'oauth_token_secret'

inheritedInherited from: \Zend_Oauth_Token::TOKEN_SECRET_PARAM_KEY

Inherited_from: \Zend_Oauth_Token::TOKEN_SECRET_PARAM_KEY

 
                TOKEN_PARAM_CALLBACK_CONFIRMED
                = 'oauth_callback_confirmed'

inheritedInherited from: \Zend_Oauth_Token::TOKEN_PARAM_CALLBACK_CONFIRMED

Inherited_from: \Zend_Oauth_Token::TOKEN_PARAM_CALLBACK_CONFIRMED

Properties

\Zend_Oauth_Http_Utility $_httpUtility = null

inherited

Inherited from: \Zend_Oauth_Token::$$_httpUtility

Default valuenullDetails

Type: \Zend_Oauth_Http_Utility
Inherited_from: \Zend_Oauth_Token::$$_httpUtility

array $_params = array()

inherited

Token parameters

Inherited from: \Zend_Oauth_Token::$$_params

Default valuearray()Details

Type: array
Inherited_from: \Zend_Oauth_Token::$$_params

\Zend_Http_Response $_response = null

inherited

OAuth response object

Inherited from: \Zend_Oauth_Token::$$_response

Default valuenullDetails

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

inherited

Constructor; basic setup for any Token subclass.

Inherited from: \Zend_Oauth_Token::__construct()

Parameters

Name	Type	Description
$response	null \| \Zend_Http_Response
$utility	null \| \Zend_Oauth_Http_Utility

__get( $key) : string

inherited

Generic accessor to enable access as public properties.

Inherited from: \Zend_Oauth_Token::__get()

Parameters

Name	Type	Description
$key

Returns

Type	Description
string

__set(string $key, string $value) : void

inherited

Generic mutator to enable access as public properties.

Inherited from: \Zend_Oauth_Token::__set()

Parameters

Name	Type	Description
$key	string
$value	string

__sleep() : void

inherited

Limit serialisation stored data to the parameters

Inherited from: \Zend_Oauth_Token::__sleep()

__toString() : string

inherited

Convert Token to a string, specifically a raw encoded query string.

Inherited from: \Zend_Oauth_Token::__toString()

Aliases to self::toString()

Returns

Type	Description
string

__wakeup() : void

inherited

After serialisation, re-instantiate a HTTP utility class for use

Inherited from: \Zend_Oauth_Token::__wakeup()

_parseParameters(\Zend_Http_Response $response) : array

inherited

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()

Parameters

Name	Type	Description
$response	\Zend_Http_Response

Returns

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

Parameters

Name	Type	Description
$oauthOptions	array
$uri	null \| string
$config	null \| array \| \Zend_Config
$excludeCustomParamsFromHeader	bool

Returns

Type	Description
\Zend_Oauth_Client

getParam(string $key) : mixed

inherited

Get the value for a parameter (e.g.

Inherited from: \Zend_Oauth_Token::getParam()

token secret or other).

Parameters

Name	Type	Description
$key	string

Returns

Type	Description
mixed

getResponse() : \Zend_Http_Response

inherited

Return the HTTP response object used to initialise this instance.

Inherited from: \Zend_Oauth_Token::getResponse()

Returns

Type	Description
\Zend_Http_Response

getToken() : string

inherited

Gets the value for a Token.

Inherited from: \Zend_Oauth_Token::getToken()

Returns

Type	Description
string

getTokenSecret() : string

inherited

Retrieve this Token's secret which may be used when signing requests with this Token.

Inherited from: \Zend_Oauth_Token::getTokenSecret()

Returns

Type	Description
string

isValid() : bool

inherited

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()

Returns

Type	Description
bool

setParam(string $key, string $value) : \Zend_Oauth_Token

inherited

Sets the value for a parameter (e.g.

Inherited from: \Zend_Oauth_Token::setParam()

token secret or other) and run a simple filter to remove any trailing newlines.

Parameters

Name	Type	Description
$key	string
$value	string

Returns

Type	Description
\Zend_Oauth_Token

setParams(array $params) : \Zend_Oauth_Token

inherited

Sets the value for some parameters (e.g.

Inherited from: \Zend_Oauth_Token::setParams()

token secret or other) and run a simple filter to remove any trailing newlines.

Parameters

Name	Type	Description
$params	array

Returns

Type	Description
\Zend_Oauth_Token

setToken(string $token) : \Zend_Oauth_Token

inherited

Sets the value for a Token.

Inherited from: \Zend_Oauth_Token::setToken()

Parameters

Name	Type	Description
$token	string

Returns

Type	Description
\Zend_Oauth_Token

setTokenSecret(string $secret) : \Zend_Oauth_Token

inherited

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()

Parameters

Name	Type	Description
$secret	string

Returns

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

Parameters

Name	Type	Description
$url	string
$config	\Zend_Oauth_Config_ConfigInterface
$customParams	null \| array
$realm	null \| string

Returns

Type	Description
string

toQueryString(mixed $url, \Zend_Oauth_Config_ConfigInterface $config, null | array $params = null) : string

Cast to HTTP query string

Parameters

Name	Type	Description
$url	mixed
$config	\Zend_Oauth_Config_ConfigInterface
$params	null \| array

Returns

Type	Description
string

toString() : string

inherited

Convert Token to a string, specifically a raw encoded query string.

Inherited from: \Zend_Oauth_Token::toString()

Returns

Type	Description
string

Oauth/Token/Access.php

\Zend_Oauth_Token_Accessjump to top

Constants

Properties

Methods

\Zend_Oauth_Token_Access
jump to top