API Documentation

Zend/Oauth/Http/Utility.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: Utility.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Oauth_Http_Utility

Package: Zend\Oauth

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

Methods

methodpublicassembleParams( string $url, \Zend_Oauth_Config_ConfigInterface $config, null|array $serviceProviderParams = null ) : array

Assemble all parameters for a generic OAuth request - i.e. no special params other than the defaults expected for any OAuth query.

Parameters
Name Type Description
$url string
$config \Zend_Oauth_Config_ConfigInterface
$serviceProviderParams null|array
Returns
Type Description
array
methodpublicgenerateNonce( ) : string

Generate nonce

Returns
Type Description
string
methodpublicgenerateTimestamp( ) : int

Generate timestamp

Returns
Type Description
int
methodpublicparseQueryString( mixed $query ) : array

Parse query string

Parameters
Name Type Description
$query mixed
Returns
Type Description
array
methodpublicsign( array $params, string $signatureMethod, string $consumerSecret, null|string $tokenSecret = null, null|string $method = null, null|string $url = null ) : string

Sign request

Parameters
Name Type Description
$params array
$signatureMethod string
$consumerSecret string
$tokenSecret null|string
$method null|string
$url null|string
Returns
Type Description
string
methodpublictoAuthorizationHeader( array $params, null|string $realm = null, bool $excludeCustomParams = true ) : void

Cast to authorization header

Parameters
Name Type Description
$params array
$realm null|string
$excludeCustomParams bool
methodpublictoEncodedQueryString( array $params, bool $customParamsOnly = false ) : string

Given both OAuth parameters and any custom parametere, generate an encoded query string. This method expects parameters to have been assembled and signed beforehand.

Parameters
Name Type Description
$params array
$customParamsOnly bool

Ignores OAuth params e.g. for requests using OAuth Header

Returns
Type Description
string
methodpublicurlEncode( string $value ) : string
static

urlencode a value

Parameters
Name Type Description
$value string
Returns
Type Description
string
Documentation was generated by DocBlox 0.15.1.