interface ProxyItemInterface in Purge 8.3

Describes a proxy item.

Queue proxy objects act as middle man between our high level invalidation objects and the lower level \Drupal\Core\Queue\QueueInterface API. As Purge queue plugins extend core's API, these are also unaware of invalidation objects and therefore proxy objects play a key translation role. A proxy has the properties 'data', 'item_id' and 'created', of which the data is stored in the given \Drupal\purge\Plugin\Purge\Queue\TxBufferInterface derivative.

Hierarchy

• interface \Drupal\purge\Plugin\Purge\Queue\ProxyItemInterface

1 file declares its use of ProxyItemInterface

InvalidationsService.php in src/Plugin/Purge/Invalidation/InvalidationsService.php

File

src/Plugin/Purge/Queue/ProxyItemInterface.php, line 17

Namespace

Drupal\purge\Plugin\Purge\Queue

interface ProxyItemInterface {

  /**
   * The array index in the data property where the invalidation type is stored.
   *
   * @var int
   */
  const DATA_INDEX_TYPE = 0;

  /**
   * The array index in the data property that holds the states.
   *
   * @var int
   */
  const DATA_INDEX_STATES = 1;

  /**
   * The array index in the data property that holds the expression.
   *
   * @var int
   */
  const DATA_INDEX_EXPRESSION = 2;

  /**
   * The array index in the data property that holds the purger properties.
   *
   * @var int
   */
  const DATA_INDEX_PROPERTIES = 3;

  /**
   * Construct a proxy item object.
   *
   * @param \Drupal\purge\Plugin\Purge\Invalidation\InvalidationInterface $invalidation
   *   Invalidation object being wrapped in a proxy.
   * @param \Drupal\purge\Plugin\Purge\Queue\TxBufferInterface $buffer
   *   The current transaction buffer used by the queue service.
   *
   * @see \Drupal\Core\Queue\QueueInterface::createItem
   * @see \Drupal\Core\Queue\QueueInterface::claimItem
   * @see \Drupal\Core\Queue\QueueInterface::deleteItem
   * @see \Drupal\Core\Queue\QueueInterface::releaseItem
   */
  public function __construct(InvalidationInterface $invalidation, TxBufferInterface $buffer);

  /**
   * Retrieve a property.
   *
   * @param string $name
   *   The name of the property, can be 'item_id', 'created' or 'data'.
   *
   * @throws \Drupal\purge\Plugin\Purge\Queue\Exception\InvalidPropertyException
   *   Thrown when the requested property isn't 'item_id', 'created' or 'data'.
   *
   * @see http://php.net/manual/en/language.oop5.overloading.php#object.get
   *
   * @return mixed
   *   The property value.
   */
  public function __get($name);

  /**
   * Set a writable property.
   *
   * @param string $name
   *   The name of the property, can be 'item_id' or 'created'.
   * @param mixed $value
   *   The value of the property you want to set.
   *
   * @throws \Drupal\purge\Plugin\Purge\Queue\Exception\InvalidPropertyException
   *   Thrown when the requested property isn't 'item_id' or 'created'.
   *
   * @see http://php.net/manual/en/language.oop5.overloading.php#object.set
   */
  public function __set($name, $value);

}

Members

Name	Modifiers	Type	Description	Overrides
ProxyItemInterface::DATA_INDEX_EXPRESSION		constant	The array index in the data property that holds the expression.
ProxyItemInterface::DATA_INDEX_PROPERTIES		constant	The array index in the data property that holds the purger properties.
ProxyItemInterface::DATA_INDEX_STATES		constant	The array index in the data property that holds the states.
ProxyItemInterface::DATA_INDEX_TYPE		constant	The array index in the data property where the invalidation type is stored.
ProxyItemInterface::__construct	public	function	Construct a proxy item object.	1
ProxyItemInterface::__get	public	function	Retrieve a property.	1
ProxyItemInterface::__set	public	function	Set a writable property.	1