[ class tree: OpenID ] [ index: OpenID ] [ all elements ]

Class: Auth_OpenID_ServerError

Source Location: /zp-extensions/federated_logon/Auth/OpenID/Server.php

Class Auth_OpenID_ServerError

Class Overview

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.

Located in /zp-extensions/federated_logon/Auth/OpenID/Server.php [line 147]



		
		
		
		

Methods

[ Top ]
Descendants
Child Class Description
Auth_OpenID_NoReturnToError Error returned by the server code when a return_to is absent from a request.
Auth_OpenID_MalformedReturnURL An error indicating that the return_to URL is malformed.
Auth_OpenID_MalformedTrustRoot This error is returned when the trust_root value is malformed.
Auth_OpenID_UntrustedReturnURL An error that indicates that the given return_to is not under the given trust_root.

[ Top ]
Method Summary
void   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.
void   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.
void   getReturnTo()  
void   hasReturnTo()   Returns the return_to URL for the request which caused this error.
void   toFormMarkup()  
void   toHTML()  
void   toMessage()  
void   toString()   Returns this error message.
void   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.

[ Top ]
Methods
encodeToKVForm  [line 201]

  void 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.



[ Top ]
encodeToURL  [line 185]

  void 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.



[ Top ]
getReturnTo  [line 160]

  void getReturnTo( )



[ Top ]
hasReturnTo  [line 175]

  void hasReturnTo( )

Returns the return_to URL for the request which caused this error.



[ Top ]
toFormMarkup  [line 208]

  void toFormMarkup( [ $form_tag_attrs = null]  )

Parameters:
   $form_tag_attrs: 


[ Top ]
toHTML  [line 214]

  void toHTML( [ $form_tag_attrs = null]  )

Parameters:
   $form_tag_attrs: 


[ Top ]
toMessage  [line 220]

  void toMessage( )



[ Top ]
toString  [line 278]

  void toString( )

Returns this error message.



Redefined in descendants as:

[ Top ]
whichEncoding  [line 246]

  void 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.



[ Top ]

Documentation generated on Tue, 20 Dec 2011 16:08:06 +0100 by phpDocumentor 1.4.3