QueuersAvailableDiagnosticCheck.php in Purge 8.3

Namespace

Drupal\purge\Plugin\Purge\DiagnosticCheck

File

src/Plugin/Purge/DiagnosticCheck/QueuersAvailableDiagnosticCheck.php

<?php

namespace Drupal\purge\Plugin\Purge\DiagnosticCheck;

use Drupal\purge\Plugin\Purge\Queuer\QueuersServiceInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Queuers.
 *
 * @PurgeDiagnosticCheck(
 *   id = "queuersavailable",
 *   title = @Translation("Queuers"),
 *   description = @Translation("Checks if there is a queuer that propagates the queue."),
 *   dependent_queue_plugins = {},
 *   dependent_purger_plugins = {}
 * )
 */
class QueuersAvailableDiagnosticCheck extends DiagnosticCheckBase implements DiagnosticCheckInterface {

  /**
   * The 'purge.queuers' service.
   *
   * @var \Drupal\purge\Plugin\Purge\Queuer\QueuersServiceInterface
   */
  protected $purgeQueuers;

  /**
   * Construct a QueuersAvailableDiagnosticCheck object.
   *
   * @param \Drupal\purge\Plugin\Purge\Queuer\QueuersServiceInterface $purge_queuers
   *   The purge queuers service.
   * @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 final function __construct(QueuersServiceInterface $purge_queuers, array $configuration, $plugin_id, $plugin_definition) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->purgeQueuers = $purge_queuers;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($container
      ->get('purge.queuers'), $configuration, $plugin_id, $plugin_definition);
  }

  /**
   * {@inheritdoc}
   */
  public function run() {
    if (count($this->purgeQueuers) === 0) {
      $this->value = '';
      $this->recommendation = $this
        ->t("You have no queuers populating the queue!");
      return self::SEVERITY_WARNING;
    }
    elseif (count($this->purgeQueuers) === 1) {
      $plugin_id = current($this->purgeQueuers
        ->getPluginsEnabled());
      $queuer = $this->purgeQueuers
        ->get($plugin_id);
      $this->value = $queuer
        ->getLabel();
      $this->recommendation = $queuer
        ->getDescription();
      return self::SEVERITY_OK;
    }
    else {
      $this->value = [];
      foreach ($this->purgeQueuers as $queuer) {
        $this->value[] = $queuer
          ->getLabel();
      }
      $this->value = implode(', ', $this->value);
      $this->recommendation = $this
        ->t("You have multiple queuers populating the queue.");
      return self::SEVERITY_OK;
    }
  }

}

Classes

Name	Description
QueuersAvailableDiagnosticCheck	Queuers.