class FileQueue in Purge 8.3

A \Drupal\purge\Plugin\Purge\Queue\QueueInterface compliant file-based queue.

Plugin annotation


@PurgeQueue(
  id = "file",
  label = @Translation("File"),
  description = @Translation("A file-based queue for fast I/O systems."),
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\purge\Plugin\Purge\Queue\QueueBase implements QueueInterface uses QueueBasePageTrait
    class \Drupal\purge\Plugin\Purge\Queue\MemoryQueue implements QueueInterface
    class \Drupal\purge\Plugin\Purge\Queue\FileQueue implements DestructableInterface, QueueInterface

Expanded class hierarchy of FileQueue

File

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

Namespace

Drupal\purge\Plugin\Purge\Queue

View source

class FileQueue extends MemoryQueue implements QueueInterface, DestructableInterface {

  /**
   * The file under public:// to which the queue buffer gets written to.
   *
   * @var string
   */
  protected $file = 'purge-file.queue';

  /**
   * The separator string to split columns with.
   */
  const SEPARATOR = '|';

  /**
   * Construct a FileQueue object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->file = DRUPAL_ROOT . '/' . PublicStream::basePath() . '/' . $this->file;
    $this
      ->bufferInitialize();
  }

  /**
   * {@inheritdoc}
   */
  private function bufferInitialize() {
    if (!$this->bufferInitialized) {
      $this->bufferInitialized = TRUE;
      $this->buffer = [];

      // Open and parse the queue file, if it wasn't there during initialization
      // it will automatically get written at some point.
      if (file_exists($this->file)) {
        foreach (file($this->file) as $line) {
          $line = explode(self::SEPARATOR, str_replace("\n", '', $line));
          $item_id = (int) array_shift($line);
          $line[self::EXPIRE] = (int) $line[self::EXPIRE];
          $line[self::CREATED] = (int) $line[self::CREATED];
          $this->buffer[$item_id] = $line;
        }
      }
    }
  }

  /**
   * Commit the buffer to disk.
   */
  public function bufferCommit() {
    $ob = '';
    if (!file_exists($path = dirname($this->file))) {
      if (!mkdir($path, 0777, TRUE)) {
        throw new \Exception("Failed recursive mkdir() to create missing '{$path}'!");
      }
      if (!file_exists($path)) {
        throw new \Exception("Path '{$path}' still does not exist after trying mkdir()!");
      }
    }
    if (!($fh = fopen($this->file, 'w'))) {
      throw new \Exception('Unable to open file resource to ' . $this->file);
    }
    foreach ($this->buffer as $item_id => $line) {
      $ob .= $item_id . self::SEPARATOR . $line[self::DATA] . self::SEPARATOR . $line[self::EXPIRE] . self::SEPARATOR . $line[self::CREATED] . "\n";
    }
    fwrite($fh, $ob);
    fclose($fh);
  }

  /**
   * {@inheritdoc}
   */
  public function deleteQueue() {
    if (file_exists($this->file)) {
      unlink($this->file);
    }
    parent::deleteQueue();
  }

  /**
   * {@inheritdoc}
   *
   * @see \Drupal\purge\Plugin\Purge\Queue\QueueService::reload()
   */
  public function destruct() {
    if ($this->bufferInitialized) {
      $this
        ->bufferCommit();
    }
  }

  /**
   * Trigger a disk commit when the object is destructed.
   */
  public function __destruct() {
    if ($this->bufferInitialized) {
      $this
        ->bufferCommit();
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
FileQueue::$file	protected	property	The file under public:// to which the queue buffer gets written to.
FileQueue::bufferCommit	public	function	Commit the buffer to disk.
FileQueue::bufferInitialize	private	function	Initialize the buffer. Overrides MemoryQueue::bufferInitialize
FileQueue::deleteQueue	public	function	Deletes a queue and every item in the queue. Overrides MemoryQueue::deleteQueue
FileQueue::destruct	public	function	Overrides DestructableInterface::destruct
FileQueue::SEPARATOR		constant	The separator string to split columns with.
FileQueue::__construct	public	function	Construct a FileQueue object. Overrides PluginBase::__construct
FileQueue::__destruct	public	function	Trigger a disk commit when the object is destructed.
MemoryQueue::$buffer	protected	property	The internal buffer where all data is copied in.
MemoryQueue::$bufferInitialized	protected	property	Whether the buffer has been initialized or not.
MemoryQueue::claimItem	public	function	Claims an item in the queue for processing. Overrides QueueInterface::claimItem
MemoryQueue::claimItemMultiple	public	function	Claims multiple items from the queue for processing. Overrides QueueBase::claimItemMultiple
MemoryQueue::CREATED		constant
MemoryQueue::createItem	public	function	Adds a queue item and store it directly to the queue. Overrides QueueInterface::createItem
MemoryQueue::createItemMultiple	public	function	Add multiple items to the queue and store them efficiently. Overrides QueueBase::createItemMultiple
MemoryQueue::createQueue	public	function	Creates a queue. Overrides QueueInterface::createQueue
MemoryQueue::DATA		constant	Define constants for the array indiced in our buffer.
MemoryQueue::deleteItem	public	function	Deletes a finished item from the queue. Overrides QueueInterface::deleteItem
MemoryQueue::deleteItemMultiple	public	function	Delete multiple items from the queue at once. Overrides QueueBase::deleteItemMultiple
MemoryQueue::EXPIRE		constant
MemoryQueue::numberOfItems	public	function	Retrieves the number of items in the queue. Overrides QueueInterface::numberOfItems
MemoryQueue::releaseItem	public	function	Releases an item that the worker could not process. Overrides QueueInterface::releaseItem
MemoryQueue::releaseItemMultiple	public	function	Release multiple items that the worker could not process. Overrides QueueBase::releaseItemMultiple
MemoryQueue::selectPage	public	function	Select a page of queue data with a limited number of items. Overrides QueueInterface::selectPage
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
QueueBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
QueueBasePageTrait::$selectPageLimit	protected	property	The configured limit of items on selected data pages.
QueueBasePageTrait::selectPageLimit	public	function
QueueBasePageTrait::selectPageMax	public	function
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.

You are here

class FileQueue in Purge 8.3

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation