sspmod_consent_Store Class Reference

Inheritance diagram for sspmod_consent_Store:

Collaboration diagram for sspmod_consent_Store:

Public Member Functions
	hasConsent ($userId, $destinationId, $attributeSet)
	Check for consent. More...
	saveConsent ($userId, $destinationId, $attributeSet)
	Save consent. More...
	deleteConsent ($userId, $destinationId)
	Delete consent. More...
	deleteAllConsents ($userId)
	Delete all consents. More...
	getStatistics ()
	Get statistics for all consent given in the consent store. More...
	getConsents ($userId)
	Retrieve consents. More...

Static Public Member Functions
static	parseStoreConfig ($config)
	Parse consent storage configuration. More...

Protected Member Functions
	__construct (&$config)
	Constructor for the base class. More...

Detailed Description

Definition at line 9 of file Store.php.

Constructor & Destructor Documentation

__construct()

sspmod_consent_Store::__construct ( &  $config )

protected

Constructor for the base class.

This constructor should always be called first in any class which implements this class.

Parameters

array

&$config

The configuration for this storage handler.

Definition at line 18 of file Store.php.

References deleteConsent(), hasConsent(), and saveConsent().

    {
        assert('is_array($config)');
    }

Here is the call graph for this function:

Member Function Documentation

deleteAllConsents()

sspmod_consent_Store::deleteAllConsents

(

$userId

)

Delete all consents.

Called when a user revokes all consents

Parameters

string

$userId

The hash identifying the user at an IdP.

Returns

mixed Should be the number of consent removed

Exceptions

Exception

Definition at line 79 of file Store.php.

    {
        throw new Exception('Not implemented: deleteAllConsents()');
    }

deleteConsent()

sspmod_consent_Store::deleteConsent (   $userId,   $destinationId  )

abstract

Delete consent.

Called when a user revokes consent for a given destination.

Parameters

string	$userId	The hash identifying the user at an IdP.
string	$destinationId	A string which identifyes the destination.

Returns

mixed Should be the number of consent deleted.

Referenced by __construct().

Here is the caller graph for this function:

getConsents()

sspmod_consent_Store::getConsents (   $userId )

abstract

Retrieve consents.

This function should return a list of consents the user has saved.

Parameters

string

$userId

The hash identifying the user at an IdP.

Returns

array Array of all destination ids the user has given consent for.

Referenced by getStatistics().

Here is the caller graph for this function:

getStatistics()

sspmod_consent_Store::getStatistics

(

)

Get statistics for all consent given in the consent store.

Returns

mixed Statistics from the consent store

Exceptions

Exception

Definition at line 92 of file Store.php.

References getConsents().

    {
        throw new Exception('Not implemented: getStatistics()');
    }

Here is the call graph for this function:

hasConsent()

sspmod_consent_Store::hasConsent (   $userId,   $destinationId,   $attributeSet  )

abstract

Check for consent.

This function checks whether a given user has authorized the release of the attributes identified by $attributeSet from $source to $destination.

Parameters

string	$userId	The hash identifying the user at an IdP.
string	$destinationId	A string which identifyes the destination.
string	$attributeSet	A hash which identifies the attributes.

Returns

bool True if the user has given consent earlier, false if not (or on error).

Referenced by __construct().

Here is the caller graph for this function:

parseStoreConfig()

static sspmod_consent_Store::parseStoreConfig (   $config )

static

Parse consent storage configuration.

This function parses the configuration for a consent storage method. An exception will be thrown if configuration parsing fails.

Parameters

mixed

$config

The configuration.

Returns

sspmod_consent_Store An object which implements the sspmod_consent_Store class.

Exceptions

Exception

if the configuration is invalid.

Definition at line 122 of file Store.php.

References $config, array, and SimpleSAML\Module\resolveClass().

Referenced by sspmod_consent_Auth_Process_Consent\__construct().

    {
        if (is_string($config)) {
            $config = array($config);
        }

        if (!is_array($config)) {
            throw new Exception('Invalid configuration for consent store option: '.var_export($config, true));
        }

        if (!array_key_exists(0, $config)) {
            throw new Exception('Consent store without name given.');
        }

        $className = SimpleSAML\Module::resolveClass(
            $config[0],
            'Consent_Store',
            'sspmod_consent_Store'
        );

        unset($config[0]);
        return new $className($config);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveConsent()

sspmod_consent_Store::saveConsent (   $userId,   $destinationId,   $attributeSet  )

abstract

Save consent.

Called when the user asks for the consent to be saved. If consent information for the given user and destination already exists, it should be overwritten.

Parameters

string	$userId	The hash identifying the user at an IdP.
string	$destinationId	A string which identifyes the destination.
string	$attributeSet	A hash which identifies the attributes.

Returns

bool True if consent is succesfully saved otherwise false.

Referenced by __construct().

Here is the caller graph for this function:

---

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

• libs/composer/vendor/simplesamlphp/simplesamlphp/modules/consent/lib/Store.php