class Internal in Production check & Production monitor 8

Internal processor that handles processing of all checks.

Plugin annotation

@ProdCheckProcessor(
  id = "internal",
  title = @Translation("Internal prod check processor"),
)

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
      • class \Drupal\prod_check\Plugin\ProdCheckProcessor\Internal

1 file declares its use of Internal

Rest.php in modules/prod_check_rest/src/Plugin/ProdCheckProcessor/Rest.php

1 string reference to 'Internal'

prod_check.prod_check_processor.internal.yml in config/install/prod_check.prod_check_processor.internal.yml

config/install/prod_check.prod_check_processor.internal.yml

File

src/Plugin/ProdCheckProcessor/Internal.php, line 15

Namespace

Drupal\prod_check\Plugin\ProdCheckProcessor

class Internal extends ProdCheckProcessorBase {

  /**
   * Fetches all the requirements for the prod check status report page.
   *
   * @return array
   *   An array of requirements keyed by plugin id.
   */
  public function requirements() {
    $definitions = $this->checkManager
      ->getDefinitions();
    $requirements = [];
    foreach ($definitions as $plugin_id => $definition) {
      $plugin = $this->checkManager
        ->createInstance($plugin_id, $definition);
      $requirement = $this
        ->process($plugin);
      if (!empty($requirement)) {
        $requirements[$plugin_id] = $requirement;
      }
    }
    return $requirements;
  }

  /**
   * Processes a single prod check plugin
   *
   * @param \Drupal\prod_check\Plugin\ProdCheckInterface $plugin
   * @return array
   *   An array containing the check result. Contains the status, severity,
   *   title and success or failure messages depending on the result.
   *
   */
  public function process(ProdCheckInterface $plugin) {
    if (!$plugin) {
      return [];
    }
    $plugin
      ->setProcessor($this);
    $status = $plugin
      ->state();
    $requirement = [
      'status' => $status,
      'severity' => $status ? $this
        ->ok() : $plugin
        ->severity(),
      'title' => $plugin
        ->title(),
      'category' => $plugin
        ->category(),
    ];
    if ($status) {
      $requirement += $plugin
        ->successMessages();
    }
    else {
      $requirement += $plugin
        ->failMessages();
    }
    return $requirement;
  }

}

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
Internal::process	public	function	Processes a single prod check plugin Overrides ProdCheckProcessorBase::process	1
Internal::requirements	public	function	Fetches all the requirements for the prod check status report page.
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::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.