ILIAS  release_5-0 Revision 5.0.0-1144-gc4397b1f87
Auth_OpenID_AX_StoreResponse Class Reference
+ Inheritance diagram for Auth_OpenID_AX_StoreResponse:
+ Collaboration diagram for Auth_OpenID_AX_StoreResponse:

Public Member Functions

 make ($succeeded=true, $error_message=null)
 Returns Auth_OpenID_AX_Error on error or an Auth_OpenID_AX_StoreResponse object on success. More...
 
 Auth_OpenID_AX_StoreResponse ($succeeded=true, $error_message=null)
 
 succeeded ()
 Was this response a success response? More...
 
 getExtensionArgs ()
 
- Public Member Functions inherited from Auth_OpenID_AX_Message
 _checkMode ($ax_args)
 Return Auth_OpenID_AX_Error if the mode in the attribute exchange arguments does not match what is expected for this class; true otherwise. More...
 
 _newArgs ()
 Return a set of attribute exchange arguments containing the basic information that must be in every attribute exchange message. More...
 
- Public Member Functions inherited from Auth_OpenID_Extension
 getExtensionArgs ()
 Get the string arguments that should be added to an OpenID message for this extension. More...
 
 toMessage ($message)
 Add the arguments from this extension to the provided message. More...
 

Data Fields

 $SUCCESS_MODE = 'store_response_success'
 
 $FAILURE_MODE = 'store_response_failure'
 
- Data Fields inherited from Auth_OpenID_AX_Message
 $ns_alias = 'ax'
 ns_alias: The preferred namespace alias for attribute exchange messages More...
 
 $mode = null
 mode: The type of this attribute exchange message. More...
 
 $ns_uri = Auth_OpenID_AX_NS_URI
 
- Data Fields inherited from Auth_OpenID_Extension
 $ns_uri = null
 ns_uri: The namespace to which to add the arguments for this extension More...
 
 $ns_alias = null
 

Detailed Description

Definition at line 974 of file AX.php.

Member Function Documentation

◆ Auth_OpenID_AX_StoreResponse()

Auth_OpenID_AX_StoreResponse::Auth_OpenID_AX_StoreResponse (   $succeeded = true,
  $error_message = null 
)

Definition at line 992 of file AX.php.

994  {
995  if ($succeeded) {
996  $this->mode = $this->SUCCESS_MODE;
997  } else {
998  $this->mode = $this->FAILURE_MODE;
999  }
1000 
1001  $this->error_message = $error_message;

◆ getExtensionArgs()

Auth_OpenID_AX_StoreResponse::getExtensionArgs ( )

Definition at line 1011 of file AX.php.

1013  {
1014  $ax_args = $this->_newArgs();
1015  if ((!$this->succeeded()) && $this->error_message) {
1016  $ax_args['error'] = $this->error_message;
1017  }
1018 
1019  return $ax_args;
_newArgs()
Return a set of attribute exchange arguments containing the basic information that must be in every a...
Definition: AX.php:125
succeeded()
Was this response a success response?
Definition: AX.php:1006

◆ make()

Auth_OpenID_AX_StoreResponse::make (   $succeeded = true,
  $error_message = null 
)

Returns Auth_OpenID_AX_Error on error or an Auth_OpenID_AX_StoreResponse object on success.

Definition at line 982 of file AX.php.

984  {
985  if (($succeeded) && ($error_message !== null)) {
986  return new Auth_OpenID_AX_Error('An error message may only be '.
987  'included in a failing fetch response');
988  }
989 
990  return new Auth_OpenID_AX_StoreResponse($succeeded, $error_message);
Auth_OpenID_AX_StoreResponse($succeeded=true, $error_message=null)
Definition: AX.php:992

◆ succeeded()

Auth_OpenID_AX_StoreResponse::succeeded ( )

Was this response a success response?

Definition at line 1006 of file AX.php.

1008  {
1009  return $this->mode == $this->SUCCESS_MODE;

Field Documentation

◆ $FAILURE_MODE

Auth_OpenID_AX_StoreResponse::$FAILURE_MODE = 'store_response_failure'

Definition at line 976 of file AX.php.

◆ $SUCCESS_MODE

Auth_OpenID_AX_StoreResponse::$SUCCESS_MODE = 'store_response_success'

Definition at line 975 of file AX.php.


The documentation for this class was generated from the following file: