interface InvStatesInterface in Purge 8.3

Describes the states invalidations can be in during their lifetime.

Hierarchy

• interface \Drupal\purge\Plugin\Purge\Invalidation\InvStatesInterface

3 files declare their use of InvStatesInterface

InvalidateCommand.php in modules/purge_drush/src/Commands/InvalidateCommand.php

PurgeBlockForm.php in modules/purge_ui/src/Form/PurgeBlockForm.php

StatsTracker.php in src/Plugin/Purge/Queue/StatsTracker.php

File

src/Plugin/Purge/Invalidation/InvStatesInterface.php, line 8

Namespace

Drupal\purge\Plugin\Purge\Invalidation

interface InvStatesInterface {

  /**
   * Invalidation is new and no processing has been attempted on it yet.
   *
   * @var int
   */
  const FRESH = 0;

  /**
   * The invalidation is processing.
   *
   * Invalidation is actively processing remotely and hasn't yet reached
   * its final state. The invalidation flows back to the queue so that the
   * purger conducting the multi-step invalidation, can put it to FAILED or
   * SUCCEEDED at the next round of queue processing. There is no limit of how
   * many times the same object can be put into this state, but when this is
   * happening for too many times, this can lead to queue congestion.
   *
   * @var int
   */
  const PROCESSING = 1;

  /**
   * The invalidation succeeded.
   *
   * @var int
   */
  const SUCCEEDED = 2;

  /**
   * The invalidation failed and will be offered again later.
   *
   * @var int
   */
  const FAILED = 3;

  /**
   * The type of invalidation isn't supported and will be offered again later.
   *
   * @var int
   */
  const NOT_SUPPORTED = 4;

}

Members

Name	Modifiers	Type	Description	Overrides
InvStatesInterface::FAILED		constant	The invalidation failed and will be offered again later.
InvStatesInterface::FRESH		constant	Invalidation is new and no processing has been attempted on it yet.
InvStatesInterface::NOT_SUPPORTED		constant	The type of invalidation isn't supported and will be offered again later.
InvStatesInterface::PROCESSING		constant	The invalidation is processing.
InvStatesInterface::SUCCEEDED		constant	The invalidation succeeded.