interface AcquiaPurgeStateItemInterface in Acquia Purge 7

Describes a single state item kept in state storage.

Hierarchy

• interface \AcquiaPurgeStateItemInterface

File

lib/state/AcquiaPurgeStateItemInterface.php, line 11

Contains AcquiaPurgeStateItemInterface.

interface AcquiaPurgeStateItemInterface {

  /**
   * Construct a state item object.
   *
   * @param AcquiaPurgeStateStorageInterface $storage
   *   The state storage in which the item has been stored.
   * @param int $key
   *   The key with which the object is stored in state storage.
   * @param mixed $value
   *   The value of the state item.
   */
  public function __construct(AcquiaPurgeStateStorageInterface $storage, $key, $value);

  /**
   * Get the item value.
   *
   * @return mixed
   *   The value of the item.
   */
  public function get();

  /**
   * Get the item key.
   *
   * @return string
   *   The key of the item.
   */
  public function getKey();

  /**
   * Store the state item in state item storage.
   *
   * @param mixed $value
   *   The new value.
   */
  public function set($value);

}

Members

Name	Modifiers	Type	Description	Overrides
AcquiaPurgeStateItemInterface::get	public	function	Get the item value.	1
AcquiaPurgeStateItemInterface::getKey	public	function	Get the item key.	1
AcquiaPurgeStateItemInterface::set	public	function	Store the state item in state item storage.	1
AcquiaPurgeStateItemInterface::__construct	public	function	Construct a state item object.	1