class ConfigurationCheck in Varnish purger 8

Verifies that only fully configured Varnish purgers load.

Plugin annotation

@PurgeDiagnosticCheck(
  id = "varnishconfiguration",
  title = @Translation("Varnish"),
  description = @Translation("Verifies that only fully configured Varnish purgers load."),
  dependent_queue_plugins = {},
  dependent_purger_plugins = {"varnish"}
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\purge\Plugin\Purge\DiagnosticCheck\DiagnosticCheckBase implements DiagnosticCheckInterface
      • class \Drupal\varnish_purger\Plugin\Purge\DiagnosticCheck\ConfigurationCheck implements DiagnosticCheckInterface

File

src/Plugin/Purge/DiagnosticCheck/ConfigurationCheck.php, line 22

Namespace

Drupal\varnish_purger\Plugin\Purge\DiagnosticCheck

class ConfigurationCheck extends DiagnosticCheckBase implements DiagnosticCheckInterface {

  /**
   * @var \Drupal\purge\Plugin\Purge\Purger\PurgersServiceInterface
   */
  protected $purgePurgers;

  /**
   * Constructs a \Drupal\purge\Plugin\Purge\DiagnosticCheck\PurgerAvailableCheck 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.
   * @param \Drupal\purge\Plugin\Purge\Purger\PurgersServiceInterface $purge_purgers
   *   The purge executive service, which wipes content from external caches.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, PurgersServiceInterface $purge_purgers) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->purgePurgers = $purge_purgers;
  }

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

  /**
   * {@inheritdoc}
   */
  public function run() {

    // Load configuration objects for all enabled HTTP purgers.
    $plugins = [];
    foreach ($this->purgePurgers
      ->getPluginsEnabled() as $id => $plugin_id) {
      if (in_array($plugin_id, [
        'varnish',
        'varnishbundled',
      ])) {
        $plugins[$id] = VarnishPurgerSettings::load($id);
      }
    }

    // Perform checks against configuration.
    $labels = $this->purgePurgers
      ->getLabels();
    foreach ($plugins as $id => $settings) {
      $t = [
        '@purger' => $labels[$id],
      ];
      foreach ([
        'name',
        'hostname',
        'port',
        'request_method',
        'scheme',
      ] as $f) {
        if (empty($settings->{$f})) {
          $this->recommendation = $this
            ->t("@purger not configured.", $t);
          return SELF::SEVERITY_ERROR;
        }
      }
      if ($settings->scheme === 'https' && $settings->port != 443) {
        $this->recommendation = $this
          ->t("@purger uses https:// but its port is not 443!", $t);
        return SELF::SEVERITY_WARNING;
      }
      if ($settings->scheme === 'http' && $settings->port == 443) {
        $this->recommendation = $this
          ->t("@purger uses http:// but its port is 443!", $t);
        return SELF::SEVERITY_WARNING;
      }
    }
    $this->recommendation = $this
      ->t("All purgers configured.");
    return SELF::SEVERITY_OK;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurationCheck::$purgePurgers	protected	property
ConfigurationCheck::create	public static	function	Creates an instance of the plugin. Overrides DiagnosticCheckBase::create
ConfigurationCheck::run	public	function	Perform the check and determine the severity level. Overrides DiagnosticCheckInterface::run
ConfigurationCheck::__construct	public	function	Constructs a \Drupal\purge\Plugin\Purge\DiagnosticCheck\PurgerAvailableCheck object. Overrides PluginBase::__construct
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
DiagnosticCheckBase::$description	private	property	The description of the check as described in the plugin's metadata.
DiagnosticCheckBase::$recommendation	protected	property	A recommendation matching the severity level, may contain NULL.
DiagnosticCheckBase::$severity	private	property	The severity of the outcome of this check.
DiagnosticCheckBase::$title	private	property	The title of the check as described in the plugin's metadata.
DiagnosticCheckBase::$value	protected	property	Optional check outcome / value (e.g. version numbers), may contain NULL.
DiagnosticCheckBase::getDescription	public	function	Gets the description of the check. Overrides DiagnosticCheckInterface::getDescription
DiagnosticCheckBase::getRecommendation	public	function	Get a recommendation matching the severity level, may return NULL. Overrides DiagnosticCheckInterface::getRecommendation
DiagnosticCheckBase::getRequirementsArray	public	function	Generates a individual Drupal-like requirements array. Overrides DiagnosticCheckInterface::getRequirementsArray
DiagnosticCheckBase::getRequirementsSeverity	public	function	Get the severity level, expressed as a status_report severity. Overrides DiagnosticCheckInterface::getRequirementsSeverity
DiagnosticCheckBase::getSeverity	public	function	Get the severity level. Overrides DiagnosticCheckInterface::getSeverity
DiagnosticCheckBase::getSeverityString	public	function	Get the severity level as unprefixed string. Overrides DiagnosticCheckInterface::getSeverityString
DiagnosticCheckBase::getTitle	public	function	Gets the title of the check. Overrides DiagnosticCheckInterface::getTitle
DiagnosticCheckBase::getValue	public	function	Get an optional value for the check output, may return NULL. Overrides DiagnosticCheckInterface::getValue
DiagnosticCheckBase::runCheck	protected	function	Late runtime helper to assure that ::run() got called (and only once).
DiagnosticCheckInterface::SEVERITY_ERROR		constant	BLOCKING severity -- Error condition; purge.purgers service cannot operate.
DiagnosticCheckInterface::SEVERITY_INFO		constant	Non-blocking severity -- Informational message only.
DiagnosticCheckInterface::SEVERITY_OK		constant	Non-blocking severity -- check successfully passed.
DiagnosticCheckInterface::SEVERITY_WARNING		constant	Non-blocking severity -- Warning condition; proceed but flag warning.
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.
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.