Oauth/Http/UserAuthorization.php

Show:

inherited

Classes
- \Zend_Oauth_Http_UserAuthorization

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: UserAuthorization.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Oauth_Http_UserAuthorization
jump to top

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

string $_consumer = null

inherited

Reference to the Zend_Oauth_Consumer instance in use.

Inherited from: \Zend_Oauth_Http::$$_consumer

Default valuenullDetails

Type: string
Inherited_from: \Zend_Oauth_Http::$$_consumer

\Zend_Oauth_Http_Utility $_httpUtility = null

inherited

Instance of the general Zend_Oauth_Http_Utility class.

Inherited from: \Zend_Oauth_Http::$$_httpUtility

Default valuenullDetails

Type: \Zend_Oauth_Http_Utility
Inherited_from: \Zend_Oauth_Http::$$_httpUtility

array $_parameters = array()

inherited

Array of all custom service parameters to be sent in the HTTP request in addition to the usual OAuth parameters.

Inherited from: \Zend_Oauth_Http::$$_parameters

Default valuearray()Details

Type: array
Inherited_from: \Zend_Oauth_Http::$$_parameters

string $_preferredRequestMethod = \Zend_Oauth::POST

inherited

Request Method for the HTTP Request.

Inherited from: \Zend_Oauth_Http::$$_preferredRequestMethod

Default value\Zend_Oauth::POSTDetails

Type: string
Inherited_from: \Zend_Oauth_Http::$$_preferredRequestMethod

string $_preferredRequestScheme = null

inherited

OAuth specifies three request methods, this holds the current preferred one which by default uses the Authorization Header approach for passing OAuth parameters, and a POST body for non-OAuth custom parameters.

Inherited from: \Zend_Oauth_Http::$$_preferredRequestScheme

Default valuenullDetails

Type: string
Inherited_from: \Zend_Oauth_Http::$$_preferredRequestScheme

Methods

__construct(\Zend_Oauth_Consumer $consumer, null | array $parameters = null, null | \Zend_Oauth_Http_Utility $utility = null) : void

inherited

Constructor

Inherited from: \Zend_Oauth_Http::__construct()

Parameters

Name	Type	Description
$consumer	\Zend_Oauth_Consumer
$parameters	null \| array
$utility	null \| \Zend_Oauth_Http_Utility

_assessRequestAttempt(\Zend_Http_Response $response = null) : void

inherited

Manages the switch from OAuth request scheme to another lower preference scheme during a request cycle.

Inherited from: \Zend_Oauth_Http::_assessRequestAttempt()

Parameters

Name	Type	Description
$response	\Zend_Http_Response

Throws

Exception	Description
\Zend_Oauth_Exception	if unable to retrieve valid token response

_toAuthorizationHeader(array $params, string $realm = null) : string

inherited

Generates a valid OAuth Authorization header based on the provided parameters and realm.

Inherited from: \Zend_Oauth_Http::_toAuthorizationHeader()

Parameters

Name	Type	Description
$params	array
$realm	string

Returns

Type	Description
string

assembleParams() : array

Assemble all parameters for inclusion in a redirect URL.

Returns

Type	Description
array

getConsumer() : \Zend_Oauth_Consumer

inherited

Return the Consumer instance in use.

Inherited from: \Zend_Oauth_Http::getConsumer()

Returns

Type	Description
\Zend_Oauth_Consumer

getMethod() : string

inherited

Preferred HTTP request method accessor.

Inherited from: \Zend_Oauth_Http::getMethod()

Returns

Type	Description
string

getParameters() : array

inherited

Accessor for an array of custom parameters.

Inherited from: \Zend_Oauth_Http::getParameters()

Returns

Type	Description
array

getRequestSchemeQueryStringClient(array $params, string $url) : \Zend_Http_Client

inherited

Return an instance of Zend_Http_Client configured to use the Query String scheme for an OAuth driven HTTP request.

Inherited from: \Zend_Oauth_Http::getRequestSchemeQueryStringClient()

Parameters

Name	Type	Description
$params	array
$url	string

Returns

Type	Description
\Zend_Http_Client

getUrl() : string

Generate a redirect URL from the allowable parameters and configured values.

Returns

Type	Description
string

setMethod(string $method) : \Zend_Oauth_Http

inherited

Set a preferred HTTP request method.

Inherited from: \Zend_Oauth_Http::setMethod()

Parameters

Name	Type	Description
$method	string

Returns

Type	Description
\Zend_Oauth_Http

setParameters(array $customServiceParameters) : \Zend_Oauth_Http

inherited

Mutator to set an array of custom parameters for the HTTP request.

Inherited from: \Zend_Oauth_Http::setParameters()

Parameters

Name	Type	Description
$customServiceParameters	array

Returns

Type	Description
\Zend_Oauth_Http

startRequestCycle(array $params) : \Zend_Http_Response

inherited

Commence a request cycle where the current HTTP method and OAuth request scheme set an upper preferred HTTP request style and where failures generate a new HTTP request style further down the OAuth preference list for OAuth Request Schemes.

Inherited from: \Zend_Oauth_Http::startRequestCycle()

On success, return the Request object that results for processing.

Parameters

Name	Type	Description
$params	array

Returns

Type	Description
\Zend_Http_Response

Throws

Exception	Description
\Zend_Oauth_Exception	on HTTP request errors

Oauth/Http/UserAuthorization.php

\Zend_Oauth_Http_UserAuthorizationjump to top

Properties

Methods

\Zend_Oauth_Http_UserAuthorization
jump to top