You are here

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

class XmlRpc in Production check & Production monitor 8

XML-RPC processor

Plugin annotation


@ProdCheckProcessor(
  id = "xmlrpc",
  title = @Translation("XML-RPC processor"),
)

Hierarchy

Expanded class hierarchy of XmlRpc

File

modules/prod_check_xmlrpc/src/Plugin/ProdCheckProcessor/XmlRpc.php, line 17

Namespace

Drupal\prod_check_xmlrpc\Plugin\ProdCheckProcessor
View source 
class XmlRpc extends ConfigurableProdCheckProcessorBase {

  /**
   * Fetches all plugins in a format prod monitor can deal with.
   */
  public function listPlugins() {
    $categories = $this->categoryManager
      ->getDefinitions();
    $checks = $this->checkManager
      ->getDefinitions();
    $plugins = [];
    foreach ($checks as $plugin_id => $check) {
      if (isset($categories[$check['category']])) {
        $plugins[(string) $check['category']]['functions'][$plugin_id] = (string) $check['title'];
      }
    }
    return $plugins;
  }

  /**
   * Helper function to check for correct API key.
   */
  function verifyKey($ping_key) {
    $connect_key = $this->configuration['key'];
    $result = FALSE;
    if ($connect_key && $ping_key == $connect_key) {
      $result = TRUE;
    }
    return $result;
  }

  /**
   * {@inheritdoc}
   */
  public function process(ProdCheckInterface $plugin) {
    if (!$plugin) {
      return [];
    }
    $plugin
      ->setProcessor($this);
    $status = $plugin
      ->state();
    $requirement = [
      'status' => $status,
      'severity' => $status ? $this
        ->ok() : $plugin
        ->severity(),
      'title' => (string) $plugin
        ->title(),
      'category' => $plugin
        ->category(),
      'data' => $plugin
        ->data(),
    ];
    if ($status) {
      $message = $plugin
        ->successMessages();
      $requirement['value'] = (string) render($message['value']);
      $requirement['description'] = (string) render($message['description']);
    }
    else {
      $message = $plugin
        ->failMessages();
      $requirement['value'] = (string) render($message['value']);
      $requirement['description'] = (string) render($message['description']);
    }
    return $requirement;
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'key' => '',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form['key'] = [
      '#type' => 'textfield',
      '#title' => t('API key'),
      '#default_value' => $this->configuration['key'],
      '#required' => TRUE,
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    $this->configuration['key'] = $form_state
      ->getValue('key');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigurableProdCheckProcessorBase::calculateDependencies public function
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.
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
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.
XmlRpc::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm
XmlRpc::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableProdCheckProcessorBase::defaultConfiguration
XmlRpc::listPlugins public function Fetches all plugins in a format prod monitor can deal with.
XmlRpc::process public function Processes a single prod check plugin Overrides ProdCheckProcessorBase::process
XmlRpc::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
XmlRpc::verifyKey function Helper function to check for correct API key.