PHP Class sspmod_discopower_PowerIdPDisco, simplesamlphp

This module extends the basic IdP disco handler, and add features like filtering and tabs.

Inheritance: extends SimpleSAML_XHTML_IdPDisco

Show file Open project: simplesamlphp/simplesamlphp Class Usage Examples

Public Methods

Method	Description
__construct ( array $metadataSets, string $instance )	Initializes this discovery service.
handleRequest ( )	Handles a request to this discovery service.
mcmp ( array $a, array $b ) : integer	Compare two entities.

Protected Methods

Method	Description
filterList ( array $list ) : array	Filter a list of entities according to any filters defined in the parent class, plus discopower configuration options regarding filtering.
getPreviousIdP ( ) : string \| null	Retrieve the previous IdP the user used.
idplistStructured ( array $list ) : array	Structure the list of IdPs in a hierarchy based upon the tags.
log ( string $message )	Log a message.
setPreviousIdP ( string $idp )	Save the current IdP choice to a cookie.

Private Methods

Method	Description
getCDC ( ) : array	Get the IdP entities saved in the common domain cookie.
processFilter ( array $filter, array $entry, boolean $default = true ) : boolean	Do the actual filtering according the rules defined.

Method Details

__construct() public method

The constructor does the parsing of the request. If this is an invalid request, it will throw an exception.

public __construct ( array $metadataSets, string $instance )
$metadataSets	array	Array with metadata sets we find remote entities in.
$instance	string	The name of this instance of the discovery service.

getPreviousIdP() protected method

This function overrides the corresponding function in the parent class, to add support for common domain cookie.

protected getPreviousIdP ( ) : string \| null
return	string \| null	The entity id of the previous IdP the user used, or null if this is the first time.

handleRequest() public method

The IdP disco parameters should be set before calling this function.

public handleRequest ( )

idplistStructured() protected method

Structure the list of IdPs in a hierarchy based upon the tags.

protected idplistStructured ( array $list ) : array
$list	array	A list of IdPs.
return	array	The list of IdPs structured accordingly.

log() protected method

This is an helper function for logging messages. It will prefix the messages with our discovery service type.

protected log ( string $message )
$message	string	The message which should be logged.

mcmp() public static method

This function is used to sort the entity list. It sorts based on english name, and will always put IdP's with names configured before those with only an entityID.

public static mcmp ( array $a, array $b ) : integer
$a	array	The metadata of the first entity.
$b	array	The metadata of the second entity.
return	integer	How $a compares to $b.

setPreviousIdP() protected method