abstract class ProdCheckProcessorBase in Production check & Production monitor 8

Base class for all the prod check processor plugins.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\prod_check\Plugin\ProdCheckProcessor\ProdCheckProcessorBase implements ContainerFactoryPluginInterface, ProdCheckProcessorInterface

File

src/Plugin/ProdCheckProcessor/ProdCheckProcessorBase.php, line 17

Namespace

Drupal\prod_check\Plugin\ProdCheckProcessor

abstract class ProdCheckProcessorBase extends PluginBase implements ContainerFactoryPluginInterface, ProdCheckProcessorInterface {

  /**
   * The prod check plugin manager.
   *
   * @var \Drupal\prod_check\Plugin\ProdCheckPluginManager;
   */
  protected $checkManager;

  /**
   * The prod check category plugin manager.
   *
   * @var \Drupal\prod_check\Plugin\ProdCheckCategoryPluginManager;
   */
  protected $categoryManager;

  /**
   * Constructs a Drupal\Component\Plugin\PluginBase 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, ProdCheckPluginManager $manager, ProdCheckCategoryPluginManager $category_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->checkManager = $manager;
    $this->categoryManager = $category_manager;
  }

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

  /**
   * {@inheritdoc}
   */
  public function process(ProdCheckInterface $plugin) {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function info() {
    return ProdCheck::REQUIREMENT_INFO;
  }

  /**
   * {@inheritdoc}
   */
  public function ok() {
    return ProdCheck::REQUIREMENT_OK;
  }

  /**
   * {@inheritdoc}
   */
  public function warning() {
    return ProdCheck::REQUIREMENT_WARNING;
  }

  /**
   * {@inheritdoc}
   */
  public function error() {
    return ProdCheck::REQUIREMENT_ERROR;
  }

}

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
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.
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
ProdCheckProcessorBase::__construct	public	function	Constructs a Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct	1
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.