ILIAS  release_4-4 Revision
All Data Structures Namespaces Files Functions Variables Modules Pages
Auth_OpenID_ConsumerResponse Class Reference
+ Inheritance diagram for Auth_OpenID_ConsumerResponse:
+ Collaboration diagram for Auth_OpenID_ConsumerResponse:

Public Member Functions

 setEndpoint ($endpoint)
 
 getDisplayIdentifier ()
 Return the display identifier for this response. More...
 

Data Fields

 $status = null
 

Detailed Description

Definition at line 1970 of file Consumer.php.

Member Function Documentation

◆ getDisplayIdentifier()

Auth_OpenID_ConsumerResponse::getDisplayIdentifier ( )

Return the display identifier for this response.

The display identifier is related to the Claimed Identifier, but the two are not always identical. The display identifier is something the user should recognize as what they entered, whereas the response's claimed identifier (in the identity_url attribute) may have extra information for better persistence.

URLs will be stripped of their fragments for display. XRIs will display the human-readable identifier (i-name) instead of the persistent identifier (i-number).

Use the display identifier in your user interface. Use identity_url for querying your database or authorization server.

Definition at line 2000 of file Consumer.php.

2001  {
2002  if ($this->endpoint !== null) {
2003  return $this->endpoint->getDisplayIdentifier();
2004  }
2005  return null;
2006  }

◆ setEndpoint()

Auth_OpenID_ConsumerResponse::setEndpoint (   $endpoint)

Definition at line 1973 of file Consumer.php.

1974  {
1975  $this->endpoint = $endpoint;
1976  if ($endpoint === null) {
1977  $this->identity_url = null;
1978  } else {
1979  $this->identity_url = $endpoint->claimed_id;
1980  }
1981  }

Field Documentation

◆ $status

Auth_OpenID_ConsumerResponse::$status = null

Definition at line 1971 of file Consumer.php.


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