Oauth/Http/Utility.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Oauth
version: $Id: Utility.php 21233 2010-02-28 13:48:58Z padraic $
Classes: Zend_Oauth_Http_Utility

Description

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.

Zend_Oauth_Http_Utility
jump to top

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Oauth
Methods: assembleParams; toEncodedQueryString; toAuthorizationHeader; sign; parseQueryString; generateNonce; generateTimestamp; urlEncode

Description

Methods

assembleParams
jump to class

assembleParams(
          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.

Arguments

$url: string
$config: Zend_Oauth_Config_ConfigInterface
$serviceProviderParams: nullarray

Output

array

Details

visibility: public
final: false
static: false

generateNonce
jump to class

generateNonce(
          
          )
        
        :
        string

Generate nonce

Output

string

Details

visibility: public
final: false
static: false

generateTimestamp
jump to class

generateTimestamp(
          
          )
        
        :
        int

Generate timestamp

Output

int

Details

visibility: public
final: false
static: false

parseQueryString
jump to class

parseQueryString(
          mixed $query
          )
        
        :
        array

Parse query string

Arguments

$query: mixed

Output

array

Details

visibility: public
final: false
static: false

sign
jump to class

sign(
          array $params, string $signatureMethod, string $consumerSecret, null|string $tokenSecret
              =
              null, null|string $method
              =
              null, null|string $url
              =
              null
          )
        
        :
        string

Sign request

Arguments

$params: array
$signatureMethod: string
$consumerSecret: string
$tokenSecret: nullstring
$method: nullstring
$url: nullstring

Output

string

Details

visibility: public
final: false
static: false

toAuthorizationHeader
jump to class

toAuthorizationHeader(
          array $params, null|string $realm
              =
              null, bool $excludeCustomParams
              =
              true
          )
        
        :
        void

Cast to authorization header

Arguments

$params: array
$realm: nullstring
$excludeCustomParams: bool

Details

visibility: public
final: false
static: false

toEncodedQueryString
jump to class

toEncodedQueryString(
          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.

Arguments

$params: array
$customParamsOnly: bool
Ignores OAuth params e.g. for requests using OAuth Header

Output

string

Details

visibility: public
final: false
static: false

urlEncode
jump to class

urlEncode(
          string $value
          )
        
        :
        string

urlencode a value

Arguments

$value: string

Output

string

Details

visibility: public
final: false
static: true

API Documentation

Oauth/Http/Utility.php

Description

Zend_Oauth_Http_Utilityjump to top

Description

Methods

assembleParamsjump to class

Arguments

Output

Details

generateNoncejump to class

Output

Details

generateTimestampjump to class

Output

Details

parseQueryStringjump to class

Arguments

Output

Details

signjump to class

Arguments

Output

Details

toAuthorizationHeaderjump to class

Arguments

Details

toEncodedQueryStringjump to class

Arguments

Output

Details

urlEncodejump to class

Arguments

Output

Details

Zend_Oauth_Http_Utility
jump to top

assembleParams
jump to class

generateNonce
jump to class

generateTimestamp
jump to class

parseQueryString
jump to class

sign
jump to class

toAuthorizationHeader
jump to class

toEncodedQueryString
jump to class

urlEncode
jump to class