API Documentation

Oauth/Token/Access.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Oauth  
version
$Id: Access.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Oauth_Token_Access

Extends from
\Zend_Oauth_Token
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Oauth  

Methods

methodpublic__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()
Parameters
Name Type Description
$response null|\Zend_Http_Response
$utility null|\Zend_Oauth_Http_Utility
methodpublic__get(  $key ) : string

Generic accessor to enable access as public properties.

Inherited from: \Zend_Oauth_Token::__get()
Parameters
Name Type Description
$key
Returns
Type Description
string
methodpublic__set( string $key, string $value ) : void

Generic mutator to enable access as public properties.

Inherited from: \Zend_Oauth_Token::__set()
Parameters
Name Type Description
$key string
$value string
methodpublic__sleep( ) : void

Limit serialisation stored data to the parameters

Inherited from: \Zend_Oauth_Token::__sleep()
methodpublic__toString( ) : string

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
methodpublic__wakeup( ) : void

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

Inherited from: \Zend_Oauth_Token::__wakeup()
methodprotected_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()
Parameters
Name Type Description
$response \Zend_Http_Response
Returns
Type Description
array
methodpublicgetHttpClient( 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
methodpublicgetParam( string $key ) : mixed

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

Inherited from: \Zend_Oauth_Token::getParam()
Parameters
Name Type Description
$key string
Returns
Type Description
mixed
methodpublicgetResponse( ) : \Zend_Http_Response

Return the HTTP response object used to initialise this instance.

Inherited from: \Zend_Oauth_Token::getResponse()
Returns
Type Description
\Zend_Http_Response
methodpublicgetToken( ) : string

Gets the value for a Token.

Inherited from: \Zend_Oauth_Token::getToken()
Returns
Type Description
string
methodpublicgetTokenSecret( ) : string

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
methodpublicisValid( ) : 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()
Returns
Type Description
bool
methodpublicsetParam( 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.

Inherited from: \Zend_Oauth_Token::setParam()
Parameters
Name Type Description
$key string
$value string
Returns
Type Description
\Zend_Oauth_Token
methodpublicsetParams( 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.

Inherited from: \Zend_Oauth_Token::setParams()
Parameters
Name Type Description
$params array
Returns
Type Description
\Zend_Oauth_Token
methodpublicsetToken( string $token ) : \Zend_Oauth_Token

Sets the value for a Token.

Inherited from: \Zend_Oauth_Token::setToken()
Parameters
Name Type Description
$token string
Returns
Type Description
\Zend_Oauth_Token
methodpublicsetTokenSecret( 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()
Parameters
Name Type Description
$secret string
Returns
Type Description
\Zend_Oauth_Token
methodpublictoHeader( 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
methodpublictoQueryString( 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
methodpublictoString( ) : string

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

Inherited from: \Zend_Oauth_Token::toString()
Returns
Type Description
string
Documentation was generated by DocBlox 0.13.3.