interface TxBufferInterface in Purge 8.3

Describes the transaction buffer.

\Drupal\purge\Plugin\Purge\Queue\QueueServiceInterface derivatives use the transaction buffer as instance registry for invalidation objects. References are kept to invalidations and the buffer allows setting properties and queue specific states. The held object references can be retrieved and deleted.

What the buffer allows the queue service to do is to reduce actual calls on the underlying queue backend and by doing so, being a lot more efficient.

Hierarchy

• interface \Drupal\purge\Plugin\Purge\Queue\TxBufferInterface extends \Drupal\purge\Plugin\Purge\Queue\Countable \Drupal\purge\Plugin\Purge\Queue\Iterator

1 file declares its use of TxBufferInterface

TxBufferTest.php in tests/src/Kernel/Queue/TxBufferTest.php

File

src/Plugin/Purge/Queue/TxBufferInterface.php, line 18

Namespace

Drupal\purge\Plugin\Purge\Queue

interface TxBufferInterface extends \Countable, \Iterator {

  /**
   * Freshly claimed objects.
   */
  const CLAIMED = 0;

  /**
   * Objects in the process of being added to the queue.
   */
  const ADDING = 1;

  /**
   * Objects that just got added to the queue.
   */
  const ADDED = 2;

  /**
   * Objects in the process of being released back to the queue.
   */
  const RELEASING = 3;

  /**
   * Objects that just got released back to the queue.
   */
  const RELEASED = 4;

  /**
   * Objects in the process of being deleted from the queue.
   */
  const DELETING = 5;

  /**
   * Delete the given invalidation object from the buffer.
   *
   * @param array|\Drupal\purge\Plugin\Purge\Invalidation\InvalidationInterface $invalidations
   *   Invalidation object or array with objects.
   */
  public function delete($invalidations);

  /**
   * Delete everything in the buffer.
   */
  public function deleteEverything();

  /**
   * Retrieve a buffered object by property=value combination.
   *
   * @param string $property
   *   The name of the property you want to look for.
   * @param mixed $value
   *   The (unique) value of the property that has to be stored in the buffer
   *   in order to return the object.
   *
   * @return \Drupal\purge\Plugin\Purge\Invalidation\InvalidationInterface|false
   *   The matched invalidation object or FALSE when there was no combination
   *   found of the property and value.
   */
  public function getByProperty($property, $value);

  /**
   * Only retrieve items from the buffer in a particular given state(s).
   *
   * @param int|array $states
   *   Individual state or array with one of the following states:
   *     - \Drupal\purge\Plugin\Purge\Queue\TxBufferInterface::CLAIMED
   *     - \Drupal\purge\Plugin\Purge\Queue\TxBufferInterface::ADDING
   *     - \Drupal\purge\Plugin\Purge\Queue\TxBufferInterface::ADDED
   *     - \Drupal\purge\Plugin\Purge\Queue\TxBufferInterface::RELEASING
   *     - \Drupal\purge\Plugin\Purge\Queue\TxBufferInterface::RELEASED
   *     - \Drupal\purge\Plugin\Purge\Queue\TxBufferInterface::DELETING.
   *
   * @return \Drupal\purge\Plugin\Purge\Invalidation\InvalidationInterface[]
   *   List of invalidation objects.
   */
  public function getFiltered($states);

  /**
   * Request the in-buffer set state for the given invalidation object.
   *
   * @param \Drupal\purge\Plugin\Purge\Invalidation\InvalidationInterface $invalidation
   *   Invalidation object.
   *
   * @return int|null
   *   The state of the given object or NULL when not found.
   *     - \Drupal\purge\Plugin\Purge\Queue\TxBufferInterface::CLAIMED
   *     - \Drupal\purge\Plugin\Purge\Queue\TxBufferInterface::ADDING
   *     - \Drupal\purge\Plugin\Purge\Queue\TxBufferInterface::ADDED
   *     - \Drupal\purge\Plugin\Purge\Queue\TxBufferInterface::RELEASING
   *     - \Drupal\purge\Plugin\Purge\Queue\TxBufferInterface::RELEASED
   *     - \Drupal\purge\Plugin\Purge\Queue\TxBufferInterface::DELETING
   */
  public function getState(InvalidationInterface $invalidation);

  /**
   * Retrieve a stored property for the given invalidation object.
   *
   * @param \Drupal\purge\Plugin\Purge\Invalidation\InvalidationInterface $invalidation
   *   Invalidation object.
   * @param string $property
   *   The string key of the stored property you want to receive.
   * @param mixed $default
   *   The return value for when the property is not found.
   *
   * @return mixed|null
   *   The stored property value or the value of the $default argument.
   */
  public function getProperty(InvalidationInterface $invalidation, $property, $default = NULL);

  /**
   * Check if the given object is already in buffer our not.
   *
   * @param \Drupal\purge\Plugin\Purge\Invalidation\InvalidationInterface $invalidation
   *   Invalidation object.
   *
   * @return bool
   *   Whether the object is already in the buffer.
   */
  public function has(InvalidationInterface $invalidation);

  /**
   * Set the given state on one or multiple invalidation objects.
   *
   * @param array|\Drupal\purge\Plugin\Purge\Invalidation\InvalidationInterface $invalidations
   *   Invalidation object or array with objects.
   * @param int $state
   *   One of the following states:
   *     - \Drupal\purge\Plugin\Purge\Queue\TxBufferInterface::CLAIMED
   *     - \Drupal\purge\Plugin\Purge\Queue\TxBufferInterface::ADDING
   *     - \Drupal\purge\Plugin\Purge\Queue\TxBufferInterface::ADDED
   *     - \Drupal\purge\Plugin\Purge\Queue\TxBufferInterface::RELEASING
   *     - \Drupal\purge\Plugin\Purge\Queue\TxBufferInterface::RELEASED
   *     - \Drupal\purge\Plugin\Purge\Queue\TxBufferInterface::DELETING.
   *
   * @throws \Drupal\purge\Plugin\Purge\Purger\Exception\BadBehaviorException
   *   Thrown when $invalidations contains other data than derivatives of
   *   \Drupal\purge\Plugin\Purge\Invalidation\InvalidationInterface.
   */
  public function set($invalidations, $state);

  /**
   * Store a named property for the given invalidation object.
   *
   * @param \Drupal\purge\Plugin\Purge\Invalidation\InvalidationInterface $invalidation
   *   Invalidation object.
   * @param string $property
   *   The string key of the property you want to store.
   * @param mixed $value
   *   The value of the property you want to set.
   */
  public function setProperty(InvalidationInterface $invalidation, $property, $value);

}

Members

Name	Modifiers	Type	Description	Overrides
TxBufferInterface::ADDED		constant	Objects that just got added to the queue.
TxBufferInterface::ADDING		constant	Objects in the process of being added to the queue.
TxBufferInterface::CLAIMED		constant	Freshly claimed objects.
TxBufferInterface::delete	public	function	Delete the given invalidation object from the buffer.	1
TxBufferInterface::deleteEverything	public	function	Delete everything in the buffer.	1
TxBufferInterface::DELETING		constant	Objects in the process of being deleted from the queue.
TxBufferInterface::getByProperty	public	function	Retrieve a buffered object by property=value combination.	1
TxBufferInterface::getFiltered	public	function	Only retrieve items from the buffer in a particular given state(s).	1
TxBufferInterface::getProperty	public	function	Retrieve a stored property for the given invalidation object.	1
TxBufferInterface::getState	public	function	Request the in-buffer set state for the given invalidation object.	1
TxBufferInterface::has	public	function	Check if the given object is already in buffer our not.	1
TxBufferInterface::RELEASED		constant	Objects that just got released back to the queue.
TxBufferInterface::RELEASING		constant	Objects in the process of being released back to the queue.
TxBufferInterface::set	public	function	Set the given state on one or multiple invalidation objects.	1
TxBufferInterface::setProperty	public	function	Store a named property for the given invalidation object.	1