interface AuthcacheP13nKeyValueStoreInterface in Authenticated User Page Caching (Authcache) 7.2

Interface for key-value store implementations.

Hierarchy

• interface \AuthcacheP13nKeyValueStoreInterface

File

modules/authcache_p13n/includes/AuthcacheP13nKeyValueStoreInterface.inc, line 10

Defines an interface for key-value stores.

interface AuthcacheP13nKeyValueStoreInterface {

  /**
   * Set a value in the collection with the given key.
   *
   * @param string $key
   *   A key.
   */
  public function set($key, $value);

  /**
   * Return an associative array of entries for the given keys.
   *
   * @param array $keys
   *   A list of strings.
   */
  public function get($keys = NULL);

  /**
   * Return the value from the collection for the given key.
   *
   * @param string $key
   *   A key.
   */
  public function getOne($key);

  /**
   * Return a list of existing keys.
   *
   * @param array|NULL $keys
   *   A list of keys which should be checked.
   */
  public function getKeys($keys = NULL);

  /**
   * Remove entries with the given key. If keys is omitted, delete all entries.
   *
   * @param array $keys
   *   A list of strings.
   */
  public function delete($keys = NULL);

}

Members

Name	Modifiers	Type	Description	Overrides
AuthcacheP13nKeyValueStoreInterface::delete	public	function	Remove entries with the given key. If keys is omitted, delete all entries.	1
AuthcacheP13nKeyValueStoreInterface::get	public	function	Return an associative array of entries for the given keys.	1
AuthcacheP13nKeyValueStoreInterface::getKeys	public	function	Return a list of existing keys.	1
AuthcacheP13nKeyValueStoreInterface::getOne	public	function	Return the value from the collection for the given key.	1
AuthcacheP13nKeyValueStoreInterface::set	public	function	Set a value in the collection with the given key.	1