Oauth/Token/Request.php

Show: PublicProtectedPrivateinherited
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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Oauth  
Version
$Id: Request.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Oauth_Token_Request

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

>VConstant  TOKEN_PARAM_KEY = 'oauth_token'
inheritedInherited from: \Zend_Oauth_Token::TOKEN_PARAM_KEY
>VConstant  TOKEN_SECRET_PARAM_KEY = 'oauth_token_secret'
>VConstant  TOKEN_PARAM_CALLBACK_CONFIRMED = 'oauth_callback_confirmed'

Properties

>VPropertyprotected\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  
>VPropertyprotectedarray $_params = array()
inherited
Token parameters
Inherited from: \Zend_Oauth_Token::$$_params
Default valuearray()Details
Type
array
Inherited_from
\Zend_Oauth_Token::$$_params  
>VPropertyprotected\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

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

Constructor

Parameters
NameTypeDescription
$responsenull | \Zend_Http_Response
$utilitynull | \Zend_Oauth_Http_Utility
methodpublic__get( $key) : string
inherited

Generic accessor to enable access as public properties.

Inherited from: \Zend_Oauth_Token::__get()
Parameters
NameTypeDescription
$key
Returns
TypeDescription
string
methodpublic__set(string $key, string $value) : void
inherited

Generic mutator to enable access as public properties.

Inherited from: \Zend_Oauth_Token::__set()
Parameters
NameTypeDescription
$keystring
$valuestring
methodpublic__sleep() : void
inherited

Limit serialisation stored data to the parameters

Inherited from: \Zend_Oauth_Token::__sleep()
methodpublic__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
TypeDescription
string
methodpublic__wakeup() : void
inherited

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

Inherited from: \Zend_Oauth_Token::__wakeup()
methodprotected_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
NameTypeDescription
$response\Zend_Http_Response
Returns
TypeDescription
array
methodpublicgetParam(string $key) : mixed
inherited

Get the value for a parameter (e.g.

Inherited from: \Zend_Oauth_Token::getParam()

token secret or other).

Parameters
NameTypeDescription
$keystring
Returns
TypeDescription
mixed
methodpublicgetResponse() : \Zend_Http_Response
inherited

Return the HTTP response object used to initialise this instance.

Inherited from: \Zend_Oauth_Token::getResponse()
Returns
TypeDescription
\Zend_Http_Response
methodpublicgetToken() : string
inherited

Gets the value for a Token.

Inherited from: \Zend_Oauth_Token::getToken()
Returns
TypeDescription
string
methodpublicgetTokenSecret() : string
inherited

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

Inherited from: \Zend_Oauth_Token::getTokenSecret()
Returns
TypeDescription
string
methodpublicisValid() : 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
TypeDescription
bool
methodpublicsetParam(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
NameTypeDescription
$keystring
$valuestring
Returns
TypeDescription
\Zend_Oauth_Token
methodpublicsetParams(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
NameTypeDescription
$paramsarray
Returns
TypeDescription
\Zend_Oauth_Token
methodpublicsetToken(string $token) : \Zend_Oauth_Token
inherited

Sets the value for a Token.

Inherited from: \Zend_Oauth_Token::setToken()
Parameters
NameTypeDescription
$tokenstring
Returns
TypeDescription
\Zend_Oauth_Token
methodpublicsetTokenSecret(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
NameTypeDescription
$secretstring
Returns
TypeDescription
\Zend_Oauth_Token
methodpublictoString() : string
inherited

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

Inherited from: \Zend_Oauth_Token::toString()
Returns
TypeDescription
string
Documentation was generated by phpDocumentor 2.0.0a12.