Oauth/Token.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: Token.php 20232 2010-01-12 17:56:33Z matthew $
Classes: Zend_Oauth_Token

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_Token
jump to top

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
Constants: TOKEN_PARAM_KEY; TOKEN_SECRET_PARAM_KEY; TOKEN_PARAM_CALLBACK_CONFIRMED
Properties: $_params; $_response; $_httpUtility
Methods: __construct; isValid; getResponse; setTokenSecret; getTokenSecret; setParam; setParams; getParam; setToken; getToken; __get; __set; toString; __toString; _parseParameters; __sleep; __wakeup

Description

Constants

TOKEN_PARAM_KEY
jump to class

 TOKEN_PARAM_KEY = 'oauth_token'

Details

value: oauth_token

TOKEN_SECRET_PARAM_KEY
jump to class

 TOKEN_SECRET_PARAM_KEY = 'oauth_token_secret'

Details

value: oauth_token_secret

TOKEN_PARAM_CALLBACK_CONFIRMED
jump to class

 TOKEN_PARAM_CALLBACK_CONFIRMED = 'oauth_callback_confirmed'

Details

value: oauth_callback_confirmed

Properties

$_httpUtility
jump to class

Zend_Oauth_Http_Utility $_httpUtility = 'null'

Details

$_httpUtility: Zend_Oauth_Http_Utility
visibility: protected
default: null
final: false
static: false

$_params
jump to class

array $_params = 'array'

Token parameters

Details

$_params: array
visibility: protected
default: array
final: false
static: false

$_response
jump to class

Zend_Http_Response $_response = 'null'

OAuth response object

Details

$_response: Zend_Http_Response
visibility: protected
default: null
final: false
static: false

Methods

__construct
jump to class

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

Constructor; basic setup for any Token subclass.

Arguments

$response: nullZend_Http_Response
$utility: nullZend_Oauth_Http_Utility

Details

visibility: public
final: false
static: false

__get
jump to class

__get(
           $key
          )
        
        :
        string

Generic accessor to enable access as public properties.

Arguments

$key

Output

string

Details

visibility: public
final: false
static: false

__set
jump to class

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

Generic mutator to enable access as public properties.

Arguments

$key: string
$value: string

Details

visibility: public
final: false
static: false

__sleep
jump to class

Limit serialisation stored data to the parameters

Details

visibility: public
final: false
static: false

__toString
jump to class

__toString(
          
          )
        
        :
        string

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

Aliases to self::toString()

Output

string

Details

visibility: public
final: false
static: false

__wakeup
jump to class

__wakeup(
          
          )
        
        :

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

Details

visibility: public
final: false
static: false

_parseParameters
jump to class

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

Arguments

$response: Zend_Http_Response

Output

array

Details

visibility: protected
final: false
static: false

getParam
jump to class

getParam(
          string $key
          )
        
        :
        mixed

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

Arguments

$key: string

Output

mixed

Details

visibility: public
final: false
static: false

getResponse
jump to class

getResponse(
          
          )
        
        :
        Zend_Http_Response

Return the HTTP response object used to initialise this instance.

Output

Zend_Http_Response

Details

visibility: public
final: false
static: false

getToken
jump to class

getToken(
          
          )
        
        :
        string

Gets the value for a Token.

Output

string

Details

visibility: public
final: false
static: false

getTokenSecret
jump to class

getTokenSecret(
          
          )
        
        :
        string

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

Output

string

Details

visibility: public
final: false
static: false

isValid
jump to class

isValid(
          
          )
        
        :
        bool

Attempts to validate the Token parsed from the HTTP response - really it's just very basic existence checks which are minimal.

Output

bool

Details

visibility: public
final: false
static: false

setParam
jump to class

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.

Arguments

$key: string
$value: string

Output

Zend_Oauth_Token

Details

visibility: public
final: false
static: false

setParams
jump to class

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.

Arguments

$params: array

Output

Zend_Oauth_Token

Details

visibility: public
final: false
static: false

setToken
jump to class

setToken(
          string $token
          )
        
        :
        Zend_Oauth_Token

Sets the value for a Token.

Arguments

$token: string

Output

Zend_Oauth_Token

Details

visibility: public
final: false
static: false

setTokenSecret
jump to class

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.

Arguments

$secret: string

Output

Zend_Oauth_Token

Details

visibility: public
final: false
static: false

toString
jump to class

toString(
          
          )
        
        :
        string

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

Output

string

Details

visibility: public
final: false
static: false

API Documentation

Oauth/Token.php

Description

Zend_Oauth_Tokenjump to top

Description

Constants

TOKEN_PARAM_KEYjump to class

Details

TOKEN_SECRET_PARAM_KEYjump to class

Details

TOKEN_PARAM_CALLBACK_CONFIRMEDjump to class

Details

Properties

$_httpUtilityjump to class

Details

$_paramsjump to class

Details

$_responsejump to class

Details

Methods

__constructjump to class

Arguments

Details

__getjump to class

Arguments

Output

Details

__setjump to class

Arguments

Details

__sleepjump to class

Details

__toStringjump to class

Output

Details

__wakeupjump to class

Details

_parseParametersjump to class

Arguments

Output

Details

getParamjump to class

Arguments

Output

Details

getResponsejump to class

Output

Details

getTokenjump to class

Output

Details

getTokenSecretjump to class

Output

Details

isValidjump to class

Output

Details

setParamjump to class

Arguments

Output

Details

setParamsjump to class

Arguments

Output

Details

setTokenjump to class

Arguments

Output

Details

setTokenSecretjump to class

Arguments

Output

Details

toStringjump to class

Output

Details

Zend_Oauth_Token
jump to top

TOKEN_PARAM_KEY
jump to class

TOKEN_SECRET_PARAM_KEY
jump to class

TOKEN_PARAM_CALLBACK_CONFIRMED
jump to class

$_httpUtility
jump to class

$_params
jump to class

$_response
jump to class

__construct
jump to class

__get
jump to class

__set
jump to class

__sleep
jump to class

__toString
jump to class

__wakeup
jump to class

_parseParameters
jump to class

getParam
jump to class

getResponse
jump to class

getToken
jump to class

getTokenSecret
jump to class

isValid
jump to class

setParam
jump to class

setParams
jump to class

setToken
jump to class

setTokenSecret
jump to class

toString
jump to class