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.

__construct(
null|\Zend_Http_Response $response
=
null, null|\Zend_Oauth_Http_Utility $utility
=
null
)
:
void
Constructor; basic setup for any Token subclass.
Name | Type | Description |
---|---|---|
$response | null|\Zend_Http_Response | |
$utility | null|\Zend_Oauth_Http_Utility |

__get(
$key
)
:
string
Generic accessor to enable access as public properties.
Name | Type | Description |
---|---|---|
$key |
Type | Description |
---|---|
string |

__set(
string $key, string $value
)
:
void
Generic mutator to enable access as public properties.
Name | Type | Description |
---|---|---|
$key | string | |
$value | string |

__toString(
)
:
string
Convert Token to a string, specifically a raw encoded query string.
Aliases to self::toString()
Type | Description |
---|---|
string |

_parseParameters(
\Zend_Http_Response $response
)
:
array
Parse a HTTP response body and collect returned parameters as raw url decoded key-value pairs in an associative array.

getParam(
string $key
)
:
mixed
Get the value for a parameter (e.g. token secret or other).
Name | Type | Description |
---|---|---|
$key | string |
Type | Description |
---|---|
mixed |

getResponse(
)
:
\Zend_Http_Response
Return the HTTP response object used to initialise this instance.
Type | Description |
---|---|
\Zend_Http_Response |

getTokenSecret(
)
:
string
Retrieve this Token's secret which may be used when signing requests with this Token.
Type | Description |
---|---|
string |

isValid(
)
:
bool
Attempts to validate the Token parsed from the HTTP response - really it's just very basic existence checks which are minimal.
Type | Description |
---|---|
bool |

setParam(
string $key, string $value
)
:
\Zend_Oauth_Token
Sets the value for a parameter (e.g. token secret or other) and run a simple filter to remove any trailing newlines.
Name | Type | Description |
---|---|---|
$key | string | |
$value | string |
Type | Description |
---|---|
\Zend_Oauth_Token |

setParams(
array $params
)
:
\Zend_Oauth_Token
Sets the value for some parameters (e.g. token secret or other) and run a simple filter to remove any trailing newlines.

setTokenSecret(
string $secret
)
:
\Zend_Oauth_Token
Sets the value for the this Token's secret which may be used when signing requests with this Token.