class AcquiaPurgeProcessorRuntime in Acquia Purge 7

Processes the queue at the end of EVERY request.

Hierarchy

• class \AcquiaPurgeProcessorBase implements AcquiaPurgeProcessorInterface
  • class \AcquiaPurgeProcessorRuntime implements AcquiaPurgeProcessorInterface

File

lib/processor/AcquiaPurgeProcessorRuntime.php, line 11

Contains AcquiaPurgeProcessorRuntime.

class AcquiaPurgeProcessorRuntime extends AcquiaPurgeProcessorBase implements AcquiaPurgeProcessorInterface {

  /**
   * Path to the script client.
   *
   * @var string
   */
  protected $processingOccurred = FALSE;

  /**
   * {@inheritdoc}
   */
  public static function isEnabled() {
    return (bool) _acquia_purge_variable('acquia_purge_lateruntime');
  }

  /**
   * {@inheritdoc}
   */
  public function __construct($service) {
    parent::__construct($service);
    drupal_register_shutdown_function(array(
      $this,
      'onShutdown',
    ));
  }

  /**
   * {@inheritdoc}
   */
  public function getSubscribedEvents() {
    return array(
      'onExit',
    );
  }

  /**
   * Attempt to process a chunk from the queue.
   *
   * When processing already occurred earlier during this request, it can occur
   * that this call will not process anything anymore. AcquiaPurgeCapacity keeps
   * the number of claimable items per request and can reach 0 when other
   * processors already called ::process() before.
   *
   * @param bool $log
   *   (optional) Whether diagnostic failure should be logged or not.
   */
  protected function processQueueChunk($log = TRUE) {
    if (!$this->processingOccurred) {
      parent::processQueueChunk($log);
      $this->processingOccurred = TRUE;
    }
  }

  /**
   * Implements event onExit.
   *
   * @see acquia_purge_exit()
   */
  public function onExit() {
    $this
      ->processQueueChunk();
  }

  /**
   * Custom shutdown function from which we check if work needs to be done.
   *
   * @see acquia_purge_exit()
   */
  public function onShutdown() {
    $this
      ->processQueueChunk();
  }

  /**
   * Destruct a AcquiaPurgeProcessorRuntime instance.
   */
  public function __destruct() {
    $this
      ->processQueueChunk();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AcquiaPurgeProcessorBase::$service	protected	property	The Acquia Purge service object.
AcquiaPurgeProcessorRuntime::$processingOccurred	protected	property	Path to the script client.
AcquiaPurgeProcessorRuntime::getSubscribedEvents	public	function	Subscribe to the events this processor requires. Overrides AcquiaPurgeProcessorInterface::getSubscribedEvents
AcquiaPurgeProcessorRuntime::isEnabled	public static	function	Determine if the processor is enabled or not. Overrides AcquiaPurgeProcessorInterface::isEnabled
AcquiaPurgeProcessorRuntime::onExit	public	function	Implements event onExit.
AcquiaPurgeProcessorRuntime::onShutdown	public	function	Custom shutdown function from which we check if work needs to be done.
AcquiaPurgeProcessorRuntime::processQueueChunk	protected	function	Attempt to process a chunk from the queue. Overrides AcquiaPurgeProcessorBase::processQueueChunk
AcquiaPurgeProcessorRuntime::__construct	public	function	Construct a new AcquiaPurgeProcessorBase instance. Overrides AcquiaPurgeProcessorBase::__construct
AcquiaPurgeProcessorRuntime::__destruct	public	function	Destruct a AcquiaPurgeProcessorRuntime instance.