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

Class: Auth_OpenID_AX_StoreResponse

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

Class Auth_OpenID_AX_StoreResponse

Class Overview

An indication that the store request was processed along with this OpenID transaction. Use make(), NOT the constructor, to create response objects.

Located in /zp-extensions/federated_logon/Auth/OpenID/AX.php [line 974]

Auth_OpenID_Extension
   |
   --Auth_OpenID_AX_Message
      |
      --Auth_OpenID_AX_StoreResponse

Properties

Methods

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From Auth_OpenID_AX_Message

Auth_OpenID_AX_Message::$mode
Auth_OpenID_AX_Message::$ns_alias
Auth_OpenID_AX_Message::$ns_uri

Inherited From Auth_OpenID_Extension

Auth_OpenID_Extension::getExtensionArgs()
Get the string arguments that should be added to an OpenID message for this extension.
Auth_OpenID_Extension::toMessage()
Add the arguments from this extension to the provided message.

[ Top ]
Property Summary
mixed   $FAILURE_MODE  
mixed   $SUCCESS_MODE  

[ Top ]
Method Summary
Auth_OpenID_AX_StoreResponse   Auth_OpenID_AX_StoreResponse()  
void   getExtensionArgs()  
void   make()   Returns Auth_OpenID_AX_Error on error or an Auth_OpenID_AX_StoreResponse object on success.
void   succeeded()   Was this response a success response?

[ Top ]
Properties
mixed   $FAILURE_MODE = 'store_response_failure' [line 976]

[ Top ]
mixed   $SUCCESS_MODE = 'store_response_success' [line 975]

[ Top ]
Methods
Constructor Auth_OpenID_AX_StoreResponse  [line 992]

  Auth_OpenID_AX_StoreResponse Auth_OpenID_AX_StoreResponse( [ $succeeded = true], [ $error_message = null]  )

Parameters:
   $succeeded: 
   $error_message: 


[ Top ]
getExtensionArgs  [line 1011]

  void getExtensionArgs( )



Redefinition of:
Auth_OpenID_Extension::getExtensionArgs()
Get the string arguments that should be added to an OpenID message for this extension.

[ Top ]
make  [line 982]

  void make( [ $succeeded = true], [ $error_message = null]  )

Returns Auth_OpenID_AX_Error on error or an Auth_OpenID_AX_StoreResponse object on success.

Parameters:
   $succeeded: 
   $error_message: 


[ Top ]
succeeded  [line 1006]

  void succeeded( )

Was this response a success response?



[ Top ]

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