Auth_OpenID_ServerError Class Reference
Detailed Description
An error class which gets instantiated and returned whenever an OpenID protocol error occurs. Be prepared to use this in place of an ordinary server response.Definition at line 147 of file Server.php.
Public Member Functions | |
| Auth_OpenID_ServerError ($message=null, $text=null, $reference=null, $contact=null) | |
| getReturnTo () | |
| hasReturnTo () | |
| encodeToURL () | |
| encodeToKVForm () | |
| toFormMarkup ($form_tag_attrs=null) | |
| toHTML ($form_tag_attrs=null) | |
| toMessage () | |
| whichEncoding () | |
| toString () | |
Member Function Documentation
| Auth_OpenID_ServerError.Auth_OpenID_ServerError | ( | $ | message = null, |
|
| $ | text = null, |
|||
| $ | reference = null, |
|||
| $ | contact = null | |||
| ) |
private
Definition at line 151 of file Server.php.
| Auth_OpenID_ServerError.getReturnTo | ( | ) |
Definition at line 160 of file Server.php.
| Auth_OpenID_ServerError.hasReturnTo | ( | ) |
Returns the return_to URL for the request which caused this error.
Definition at line 175 of file Server.php.
| Auth_OpenID_ServerError.encodeToURL | ( | ) |
Encodes this error's response as a URL suitable for redirection. If the response has no return_to, another Auth_OpenID_ServerError is returned.
Definition at line 185 of file Server.php.
| Auth_OpenID_ServerError.encodeToKVForm | ( | ) |
Encodes the response to key-value form. This is a machine-readable format used to respond to messages which came directly from the consumer and not through the user-agent. See the OpenID specification.
Definition at line 201 of file Server.php.
| Auth_OpenID_ServerError.toFormMarkup | ( | $ | form_tag_attrs = null |
) |
Definition at line 208 of file Server.php.
| Auth_OpenID_ServerError.toHTML | ( | $ | form_tag_attrs = null |
) |
Definition at line 214 of file Server.php.
| Auth_OpenID_ServerError.toMessage | ( | ) |
Definition at line 220 of file Server.php.
| Auth_OpenID_ServerError.whichEncoding | ( | ) |
Returns one of Auth_OpenID_ENCODE_URL, Auth_OpenID_ENCODE_KVFORM, or null, depending on the type of encoding expected for this error's payload.
Definition at line 246 of file Server.php.
| Auth_OpenID_ServerError.toString | ( | ) |
Returns this error message.
Reimplemented in Auth_OpenID_NoReturnToError, Auth_OpenID_MalformedTrustRoot, and Auth_OpenID_UntrustedReturnURL.
Definition at line 278 of file Server.php.
The documentation for this class was generated from the following file:
- core/openid/Auth/OpenID/Server.php
