You are here

Home » API reference » Production check & Production monitor 8 » ConfigurableProdCheckProcessorBase.php

abstract class ConfigurableProdCheckProcessorBase in Production check & Production monitor 8

Provides a base implementation for a configurable Production check processor plugin.

Hierarchy

Expanded class hierarchy of ConfigurableProdCheckProcessorBase

1 file declares its use of ConfigurableProdCheckProcessorBase
XmlRpc.php in modules/prod_check_xmlrpc/src/Plugin/ProdCheckProcessor/XmlRpc.php

File

src/Plugin/ProdCheckProcessor/ConfigurableProdCheckProcessorBase.php, line 14

Namespace

Drupal\prod_check\Plugin\ProdCheckProcessor
View source 
abstract class ConfigurableProdCheckProcessorBase extends ProdCheckProcessorBase implements ConfigurableInterface, PluginFormInterface {

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, ProdCheckPluginManager $manager, ProdCheckCategoryPluginManager $category_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $manager, $category_manager);
    $this->configuration += $this
      ->defaultConfiguration();
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function getConfiguration() {
    return $this->configuration;
  }

  /**
   * {@inheritdoc}
   */
  public function setConfiguration(array $configuration) {
    $this->configuration = $configuration;
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    return [];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigurableProdCheckProcessorBase::calculateDependencies public function
ConfigurableProdCheckProcessorBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration 1
ConfigurableProdCheckProcessorBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ConfigurableProdCheckProcessorBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ConfigurableProdCheckProcessorBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
ConfigurableProdCheckProcessorBase::__construct public function Constructs a Drupal\Component\Plugin\PluginBase object. Overrides ProdCheckProcessorBase::__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
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.
PluginFormInterface::buildConfigurationForm public function Form constructor. 36
PluginFormInterface::submitConfigurationForm public function Form submission handler. 32
ProdCheckProcessorBase::$categoryManager protected property The prod check category plugin manager.
ProdCheckProcessorBase::$checkManager protected property The prod check plugin manager.
ProdCheckProcessorBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ProdCheckProcessorBase::error public function Returns the error key Overrides ProdCheckProcessorInterface::error
ProdCheckProcessorBase::info public function Returns the info key Overrides ProdCheckProcessorInterface::info
ProdCheckProcessorBase::ok public function Returns the ok key Overrides ProdCheckProcessorInterface::ok
ProdCheckProcessorBase::process public function Processes a single prod check plugin Overrides ProdCheckProcessorInterface::process 2
ProdCheckProcessorBase::warning public function Returns the warning key Overrides ProdCheckProcessorInterface::warning
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.