API Documentation

Zend/Oauth/Http/AccessToken.php

Show: inherited
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: AccessToken.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Oauth_Http_AccessToken

Package: Zend\Oauth

Parent(s)
\Zend_Oauth_Http
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotected\Zend_Http_Client  $_httpClient= 'null'

Singleton instance if required of the HTTP client

Default valuenullDetails
Type
\Zend_Http_Client

Methods

methodprotected_attemptRequest( array $params ) : \Zend_Http_Response

Attempt a request based on the current configured OAuth Request Scheme and return the resulting HTTP Response.

Parameters
Name Type Description
$params array
Returns
Type Description
\Zend_Http_Response
methodprotected_cleanParamsOfIllegalCustomParameters( array $params ) : array

Access Token requests specifically may not contain non-OAuth parameters.

So these should be striped out and excluded. Detection is easy since specified OAuth parameters start with "oauth_", Extension params start with "xouth_", and no other parameters should use these prefixes.

xouth params are not currently allowable.

Parameters
Name Type Description
$params array
Returns
Type Description
array
methodpublicassembleParams( ) : array

Assemble all parameters for an OAuth Access Token request.

Returns
Type Description
array
methodpublicexecute( ) : \Zend_Oauth_Token_Access

Initiate a HTTP request to retrieve an Access Token.

Returns
Type Description
\Zend_Oauth_Token_Access
methodpublicgetRequestSchemeHeaderClient( array $params ) : \Zend_Http_Client

Generate and return a HTTP Client configured for the Header Request Scheme specified by OAuth, for use in requesting an Access Token.

Parameters
Name Type Description
$params array
Returns
Type Description
\Zend_Http_Client
methodpublicgetRequestSchemePostBodyClient( array $params ) : \Zend_Http_Client

Generate and return a HTTP Client configured for the POST Body Request Scheme specified by OAuth, for use in requesting an Access Token.

Parameters
Name Type Description
$params array
Returns
Type Description
\Zend_Http_Client
methodpublicgetRequestSchemeQueryStringClient( array $params, string $url ) : \Zend_Http_Client

Generate and return a HTTP Client configured for the Query String Request Scheme specified by OAuth, for use in requesting an Access Token.

Parameters
Name Type Description
$params array
$url string
Returns
Type Description
\Zend_Http_Client
Documentation was generated by DocBlox 0.15.1.