Auth_OpenID_ServerError
in package
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.
Table of Contents
- $contact : null|string
- $message : Auth_OpenID_Message|null
- $reference : null|string
- $text : null|string
- __construct() : mixed
- Auth_OpenID_ServerError constructor.
- encodeToKVForm() : mixed
- 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.
- encodeToURL() : mixed
- Encodes this error's response as a URL suitable for redirection. If the response has no return_to, another Auth_OpenID_ServerError is returned.
- getReturnTo() : mixed
- hasReturnTo() : mixed
- Returns the return_to URL for the request which caused this error.
- toFormMarkup() : mixed
- toHTML() : mixed
- toMessage() : mixed
- toString() : mixed
- Returns this error message.
- whichEncoding() : mixed
- 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.
Properties
$contact
private
null|string
$contact
$message
private
Auth_OpenID_Message|null
$message
= \null
$reference
private
null|string
$reference
$text
private
null|string
$text
Methods
__construct()
Auth_OpenID_ServerError constructor.
public
__construct([Auth_OpenID_Message $message = null ][, string $text = null ][, string $reference = null ][, string $contact = null ]) : mixed
Parameters
- $message : Auth_OpenID_Message = null
- $text : string = null
- $reference : string = null
- $contact : string = null
Return values
mixed —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.
public
encodeToKVForm() : mixed
Return values
mixed —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.
public
encodeToURL() : mixed
Return values
mixed —getReturnTo()
public
getReturnTo() : mixed
Return values
mixed —hasReturnTo()
Returns the return_to URL for the request which caused this error.
public
hasReturnTo() : mixed
Return values
mixed —toFormMarkup()
public
toFormMarkup([mixed $form_tag_attrs = null ]) : mixed
Parameters
- $form_tag_attrs : mixed = null
Return values
mixed —toHTML()
public
toHTML([mixed $form_tag_attrs = null ]) : mixed
Parameters
- $form_tag_attrs : mixed = null
Return values
mixed —toMessage()
public
toMessage() : mixed
Return values
mixed —toString()
Returns this error message.
public
toString() : mixed
Return values
mixed —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.
public
whichEncoding() : mixed