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

Fix phpdoc comments for abstract class SimpleSAML_Store.

parent e135bb4f
No related branches found
No related tags found
No related merge requests found
<?php <?php
/** /**
* Base class for datastores. * Base class for data stores.
* *
* @package simpleSAMLphp * @package SimpleSAMLphp
*/ */
abstract class SimpleSAML_Store { abstract class SimpleSAML_Store {
/** /**
* Our singleton instance. * Our singleton instance.
* *
* This is FALSE if the datastore isn't enabled, and NULL * This is false if the data store isn't enabled, and null if we haven't attempted to initialize it.
* if we haven't attempted to initialize it.
* *
* @var SimpleSAML_Store|FALSE|NULL * @var SimpleSAML_Store|boolean|null
*/ */
private static $instance; private static $instance;
...@@ -21,7 +20,7 @@ abstract class SimpleSAML_Store { ...@@ -21,7 +20,7 @@ abstract class SimpleSAML_Store {
/** /**
* Retrieve our singleton instance. * Retrieve our singleton instance.
* *
* @return SimpleSAML_Store|FALSE The datastore, or FALSE if it isn't enabled. * @return SimpleSAML_Store|boolean The data store, or false if it isn't enabled.
*/ */
public static function getInstance() { public static function getInstance() {
...@@ -57,31 +56,31 @@ abstract class SimpleSAML_Store { ...@@ -57,31 +56,31 @@ abstract class SimpleSAML_Store {
/** /**
* Retrieve a value from the datastore. * Retrieve a value from the data store.
* *
* @param string $type The datatype. * @param string $type The data type.
* @param string $key The key. * @param string $key The key.
* @return mixed|NULL The value. * @return mixed|null The value.
*/ */
abstract public function get($type, $key); abstract public function get($type, $key);
/** /**
* Save a value to the datastore. * Save a value to the data store.
* *
* @param string $type The datatype. * @param string $type The data type.
* @param string $key The key. * @param string $key The key.
* @param mixed $value The value. * @param mixed $value The value.
* @param int|NULL $expire The expiration time (unix timestamp), or NULL if it never expires. * @param int|null $expire The expiration time (unix timestamp), or null if it never expires.
*/ */
abstract public function set($type, $key, $value, $expire = NULL); abstract public function set($type, $key, $value, $expire = NULL);
/** /**
* Delete a value from the datastore. * Delete a value from the data store.
* *
* @param string $type The datatype. * @param string $type The data type.
* @param string $key The key. * @param string $key The key.
*/ */
abstract public function delete($type, $key); abstract public function delete($type, $key);
......
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