Skip to content
Snippets Groups Projects
Commit adc7ddc5 authored by Jaime Perez Crespo's avatar Jaime Perez Crespo
Browse files

Fix phpdoc comments for SimpleSAML_Metadata_MetaDataStorageHandlerXML.

parent 96d55973
No related branches found
No related tags found
No related merge requests found
...@@ -11,6 +11,8 @@ class SimpleSAML_Metadata_MetaDataStorageHandlerXML extends SimpleSAML_Metadata_ ...@@ -11,6 +11,8 @@ class SimpleSAML_Metadata_MetaDataStorageHandlerXML extends SimpleSAML_Metadata_
/** /**
* This variable contains an associative array with the parsed metadata. * This variable contains an associative array with the parsed metadata.
*
* @var array
*/ */
private $metadata; private $metadata;
...@@ -22,7 +24,9 @@ class SimpleSAML_Metadata_MetaDataStorageHandlerXML extends SimpleSAML_Metadata_ ...@@ -22,7 +24,9 @@ class SimpleSAML_Metadata_MetaDataStorageHandlerXML extends SimpleSAML_Metadata_
* base directory. * base directory.
* - 'url': URL we should download the metadata from. This is only meant for testing. * - 'url': URL we should download the metadata from. This is only meant for testing.
* *
* @param $config The configuration for this instance of the XML metadata source. * @param array $config The configuration for this instance of the XML metadata source.
*
* @throws Exception If neither the 'file' or 'url' options are defined in the configuration.
*/ */
protected function __construct($config) { protected function __construct($config) {
...@@ -34,7 +38,7 @@ class SimpleSAML_Metadata_MetaDataStorageHandlerXML extends SimpleSAML_Metadata_ ...@@ -34,7 +38,7 @@ class SimpleSAML_Metadata_MetaDataStorageHandlerXML extends SimpleSAML_Metadata_
} elseif(array_key_exists('url', $config)) { } elseif(array_key_exists('url', $config)) {
$src = $config['url']; $src = $config['url'];
} else { } else {
throw new Exception('Missing either \'file\' or \'url\' in XML metadata source configuration.'); throw new Exception("Missing either 'file' or 'url' in XML metadata source configuration.");
} }
...@@ -88,8 +92,8 @@ class SimpleSAML_Metadata_MetaDataStorageHandlerXML extends SimpleSAML_Metadata_ ...@@ -88,8 +92,8 @@ class SimpleSAML_Metadata_MetaDataStorageHandlerXML extends SimpleSAML_Metadata_
* This function returns an associative array with metadata for all entities in the given set. The * This function returns an associative array with metadata for all entities in the given set. The
* key of the array is the entity id. * key of the array is the entity id.
* *
* @param $set The set we want to list metadata for. * @param string $set The set we want to list metadata for.
* @return An associative array with all entities in the given set. * @return array An associative array with all entities in the given set.
*/ */
public function getMetadataSet($set) { public function getMetadataSet($set) {
if(array_key_exists($set, $this->metadata)) { if(array_key_exists($set, $this->metadata)) {
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment