Oauth/Http/Utility.php
inherited
Classes
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 24593 2012-01-05 20:35:02Z matthew $
\Zend_Oauth_Http_Utility
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Methods
assembleParams(string $url, \Zend_Oauth_Config_ConfigInterface $config, null | array $serviceProviderParams = null) : arrayAssemble all parameters for a generic OAuth request - i.e.
no special params other than the defaults expected for any OAuth query.
| Name | Type | Description |
|---|---|---|
| $url | string | |
| $config | \Zend_Oauth_Config_ConfigInterface | |
| $serviceProviderParams | null | array |
| Type | Description |
|---|---|
| array |
generateNonce() : stringGenerate nonce
| Type | Description |
|---|---|
| string |
generateTimestamp() : intGenerate timestamp
| Type | Description |
|---|---|
| int |
parseQueryString(mixed $query) : arrayParse query string
| Name | Type | Description |
|---|---|---|
| $query | mixed |
| Type | Description |
|---|---|
| array |
sign(array $params, string $signatureMethod, string $consumerSecret, null | string $tokenSecret = null, null | string $method = null, null | string $url = null) : stringSign request
| Name | Type | Description |
|---|---|---|
| $params | array | |
| $signatureMethod | string | |
| $consumerSecret | string | |
| $tokenSecret | null | string | |
| $method | null | string | |
| $url | null | string |
| Type | Description |
|---|---|
| string |
toAuthorizationHeader(array $params, null | string $realm = null, bool $excludeCustomParams = true) : voidCast to authorization header
| Name | Type | Description |
|---|---|---|
| $params | array | |
| $realm | null | string | |
| $excludeCustomParams | bool |
toEncodedQueryString(array $params, bool $customParamsOnly = false) : stringGiven both OAuth parameters and any custom parametere, generate an encoded query string.
This method expects parameters to have been assembled and signed beforehand.
| Name | Type | Description |
|---|---|---|
| $params | array | |
| $customParamsOnly | bool | Ignores OAuth params e.g. for requests using OAuth Header |
| Type | Description |
|---|---|
| string |
urlEncode(string $value) : stringurlencode a value
| Name | Type | Description |
|---|---|---|
| $value | string |
| Type | Description |
|---|---|
| string |