interface ExplainedCounterInterface in Purge 8.3

Describes a counter with the ability to return user-friendly explanations.

Hierarchy

• interface \Drupal\purge\Counter\CounterInterface
  • interface \Drupal\purge\Counter\ExplainedCounterInterface

5 files declare their use of ExplainedCounterInterface

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

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

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

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

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

File

src/Counter/ExplainedCounterInterface.php, line 8

Namespace

Drupal\purge\Counter

interface ExplainedCounterInterface extends CounterInterface {

  /**
   * Gets a short machine readable ID.
   *
   * @return string
   *   The machine readable ID.
   */
  public function getId();

  /**
   * Gets the title of the counter.
   *
   * @return \Drupal\Core\StringTranslation\TranslatableMarkup
   *   The translated title.
   */
  public function getTitle();

  /**
   * Gets the description of the counter.
   *
   * @return \Drupal\Core\StringTranslation\TranslatableMarkup
   *   The translated description.
   */
  public function getDescription();

}

Members

Name	Modifiers	Type	Description	Overrides
CounterInterface::decrement	public	function	Decrease the counter.	1
CounterInterface::disableDecrement	public	function	Disable the possibility to decrement the counter.	1
CounterInterface::disableIncrement	public	function	Disable the possibility to increment the counter.	1
CounterInterface::disableSet	public	function	Disable the possibility of setting counter.	1
CounterInterface::get	public	function	Get the current value.	1
CounterInterface::getInteger	public	function	Get the current value as integer.	1
CounterInterface::increment	public	function	Increase the counter.	1
CounterInterface::set	public	function	Overwrite the counter value.	1
CounterInterface::setWriteCallback	public	function	Set the callback that gets called when writes occur.	1
CounterInterface::__construct	public	function	Construct a counter object.	1
ExplainedCounterInterface::getDescription	public	function	Gets the description of the counter.	5
ExplainedCounterInterface::getId	public	function	Gets a short machine readable ID.	5
ExplainedCounterInterface::getTitle	public	function	Gets the title of the counter.	5