PHP Class SimpleSAML_Metadata_MetaDataStorageHandlerSerialize, simplesamlphp

Inheritance: extends SimpleSAML_Metadata_MetaDataStorageSource
Show file Open project: simplesamlphp/simplesamlphp Class Usage Examples

Public Methods

Method Description
__construct ( array $config ) Constructor for this metadata handler.
deleteMetadata ( string $entityId, string $set ) Delete a metadata entry.
getMetaData ( string $entityId, string $set ) : array Retrieve a metadata entry.
getMetadataSet ( string $set ) : array Retrieve a list of all available metadata for a given set.
getMetadataSets ( ) : array Retrieve a list of all available metadata sets.
saveMetadata ( string $entityId, string $set, array $metadata ) : boolean Save a metadata entry.

Private Methods

Method Description
getMetadataPath ( string $entityId, string $set ) : string Helper function for retrieving the path of a metadata file.

Method Details

__construct() public method

Parses configuration.
public __construct ( array $config )
$config array The configuration for this metadata handler.

deleteMetadata() public method

Delete a metadata entry.
public deleteMetadata ( string $entityId, string $set )
$entityId string The entityId of the metadata entry.
$set string The metadata set this metadata entry belongs to.

getMetaData() public method

Retrieve a metadata entry.
public getMetaData ( string $entityId, string $set ) : array
$entityId string The entityId we are looking up.
$set string The set we are looking for metadata in.
return array An associative array with metadata for the given entity, or NULL if we are unable to locate the entity.

getMetadataSet() public method

Retrieve a list of all available metadata for a given set.
public getMetadataSet ( string $set ) : array
$set string The set we are looking for metadata in.
return array An associative array with all the metadata for the given set.

getMetadataSets() public method

Retrieve a list of all available metadata sets.
public getMetadataSets ( ) : array
return array An array with the available sets.

saveMetadata() public method

Save a metadata entry.
public saveMetadata ( string $entityId, string $set, array $metadata ) : boolean
$entityId string The entityId of the metadata entry.
$set string The metadata set this metadata entry belongs to.
$metadata array The metadata.
return boolean True if successfully saved, false otherwise.