Oauth/Token.php

Show:

inherited

Classes
- \Zend_Oauth_Token

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 license@zend.com so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Oauth
Version: $Id$

\Zend_Oauth_Token
jump to top

Package: Zend_Oauth

Children: \Zend_Oauth_Token_AuthorizedRequest; \Zend_Oauth_Token_Request; \Zend_Oauth_Token_Access
Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Constants

 
                TOKEN_PARAM_KEY
                = 'oauth_token'

 
                TOKEN_SECRET_PARAM_KEY
                = 'oauth_token_secret'

 
                TOKEN_PARAM_CALLBACK_CONFIRMED
                = 'oauth_callback_confirmed'

Properties

\Zend_Oauth_Http_Utility $_httpUtility = null

Default valuenullDetails

Type: \Zend_Oauth_Http_Utility

array $_params = array()

Token parameters

Default valuearray()Details

Type: array

\Zend_Http_Response $_response = null

OAuth response object

Default valuenullDetails

Type: \Zend_Http_Response

Methods

__construct(null | \Zend_Http_Response $response = null, null | \Zend_Oauth_Http_Utility $utility = null) : void

Constructor; basic setup for any Token subclass.

Parameters

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.

Parameters

Name	Type	Description
$key

Returns

Type	Description
string

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

Generic mutator to enable access as public properties.

Parameters

Name	Type	Description
$key	string
$value	string

__sleep() : void

Limit serialisation stored data to the parameters

__toString() : string

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

Aliases to self::toString()

Returns

Type	Description
string

__wakeup() : void

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

_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.

Parameters

Name	Type	Description
$response	\Zend_Http_Response

Returns

Type	Description
array

getParam(string $key) : mixed

Get the value for a parameter (e.g. token secret or other).

Parameters

Name	Type	Description
$key	string

Returns

Type	Description
mixed

getResponse() : \Zend_Http_Response

Return the HTTP response object used to initialise this instance.

Returns

Type	Description
\Zend_Http_Response

getToken() : string

Gets the value for a Token.

Returns

Type	Description
string

getTokenSecret() : string

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

Returns

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.

Returns

Type	Description
bool

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

Sets the value for a parameter (e.g. 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

Sets the value for some parameters (e.g. 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

Sets the value for a Token.

Parameters

Name	Type	Description
$token	string

Returns

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.

Parameters

Name	Type	Description
$secret	string

Returns

Type	Description
\Zend_Oauth_Token

toString() : string

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

Returns

Type	Description
string

Oauth/Token.php

\Zend_Oauth_Tokenjump to top

Constants

Properties

Methods

\Zend_Oauth_Token
jump to top