PHP Class sspmod_saml_IdP_SQLNameID, simplesamlphp

Datei anzeigen Open project: simplesamlphp/simplesamlphp Class Usage Examples

Public Methods

Method	Description
add ( string $idpEntityId, string $spEntityId, string $user, string $value )	Add a NameID into the database.
delete ( string $idpEntityId, string $spEntityId, string $user )	Delete a NameID from the database.
get ( string $idpEntityId, string $spEntityId, string $user ) : string \| null	Retrieve a NameID into from database.
getIdentities ( string $idpEntityId, string $spEntityId ) : array	Retrieve all federated identities for an IdP-SP pair.

Private Methods

Method	Description
createTable ( SimpleSAML_Store_SQL $store )	Create NameID table in SQL, if it is missing.
getStore ( ) : SimpleSAML_Store_SQL	Retrieve the SQL datastore.

Method Details

add() public static method

Add a NameID into the database.

public static add ( string $idpEntityId, string $spEntityId, string $user, string $value )
$idpEntityId	string	The IdP entityID.
$spEntityId	string	The SP entityID.
$user	string	The user's unique identificator (e.g. username).
$value	string	The NameID value.

delete() public static method

Delete a NameID from the database.

public static delete ( string $idpEntityId, string $spEntityId, string $user )
$idpEntityId	string	The IdP entityID.
$spEntityId	string	The SP entityID.
$user	string	The user's unique identificator (e.g. username).

get() public static method

Retrieve a NameID into from database.

public static get ( string $idpEntityId, string $spEntityId, string $user ) : string \| null
$idpEntityId	string	The IdP entityID.
$spEntityId	string	The SP entityID.
$user	string	The user's unique identificator (e.g. username).
return	string \| null	$value The NameID value, or NULL of no NameID value was found.

getIdentities() public static method

Retrieve all federated identities for an IdP-SP pair.

public static getIdentities ( string $idpEntityId, string $spEntityId ) : array
$idpEntityId	string	The IdP entityID.
$spEntityId	string	The SP entityID.
return	array	Array of userid => NameID.