You are here

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

class ReleaseNotes in Production check & Production monitor 8

Release notes check

Plugin annotation


@ProdCheck(
  id = "release_notes",
  title = @Translation("Release notes & help files"),
  category = "server",
)

Hierarchy

Expanded class hierarchy of ReleaseNotes

File

src/Plugin/ProdCheck/Server/ReleaseNotes.php, line 17

Namespace

Drupal\prod_check\Plugin\ProdCheck\Server
View source 
class ReleaseNotes extends ProdCheckBase {

  /**
   * Remaining files
   */
  public $remaining_files;

  /**
   * {@inheritdoc}
   */
  public function init() {
    $this->remaining_files = [];
    foreach ($this->configuration['files'] as $file) {
      if (file_exists(DRUPAL_ROOT . '/' . $file)) {
        array_push($this->remaining_files, $file);
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function state() {
    return empty($this->remaining_files);
  }

  /**
   * {@inheritdoc}
   */
  public function successMessages() {
    return [
      'value' => $this
        ->t('Release note & help files have been removed.'),
      'description' => $this
        ->t('Status is OK for production use.'),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function failMessages() {
    return [
      'value' => $this
        ->t('Release note & help files still present on your server!'),
      'description' => $this
        ->t('Leaving the "@files" files present on the webserver is a minor security risk. These files are useless on production anyway and they simply should not be there.', [
        '@files' => implode(', ', $this->remaining_files),
      ]),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    $configuration = parent::defaultConfiguration();
    $configuration['files'] = [
      'core/CHANGELOG.txt',
      'core/COPYRIGHT.txt',
      'core/INSTALL.mysql.txt',
      'core/INSTALL.pgsql.txt',
      'core/INSTALL.sqlite.txt',
      'core/INSTALL.txt',
      'core/LICENSE.txt',
      'core/MAINTAINERS.txt',
      'README.txt',
      'core/UPGRADE.txt',
      'themes/README.txt',
      'modules/README.txt',
    ];
    return $configuration;
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildConfigurationForm($form, $form_state);
    $form['files'] = [
      '#type' => 'textarea',
      '#title' => t('Files to check'),
      '#default_value' => implode("\n", $this->configuration['files']),
      '#rows' => 20,
      '#required' => TRUE,
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::submitConfigurationForm($form, $form_state);
    $files = $form_state
      ->getValue('files');
    $files = explode("\n", $files);

    // Ensure that all strings are trimmed, eg. don't have extra spaces,
    // \r chars etc.
    foreach ($files as $k => $v) {
      $files[$k] = trim($v);
    }
    $this->configuration['files'] = $files;
  }

}

Members

Namesort descending 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.
ProdCheckBase::$configFactory protected property The config factory
ProdCheckBase::$dateFormatter protected property The date formatter service
ProdCheckBase::$destination protected property The redirect destination service.
ProdCheckBase::$linkGenerator protected property The link generator service.
ProdCheckBase::$moduleHandler protected property The module handler service 1
ProdCheckBase::$processor protected property The prod check processor plugin manager.
ProdCheckBase::calculateDependencies public function
ProdCheckBase::category public function Returns the title of the check Overrides ProdCheckInterface::category
ProdCheckBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 1
ProdCheckBase::data public function Returns the extra data of the check. Overrides ProdCheckInterface::data 1
ProdCheckBase::generateDescription protected function Helper function to generate generic 'settings OK' description.
ProdCheckBase::generateLinkArray protected function Helper function to generate link array to pass to the t() function
ProdCheckBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ProdCheckBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ProdCheckBase::setProcessor public function Sets the processor
ProdCheckBase::severity public function Defines the severity of the check. Overrides ProdCheckInterface::severity 2
ProdCheckBase::title public function Returns the title of the plugin. Overrides ProdCheckInterface::title
ProdCheckBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
ProdCheckBase::__construct public function Constructs a Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct 1
ReleaseNotes::$remaining_files public property Remaining files
ReleaseNotes::buildConfigurationForm public function Form constructor. Overrides ProdCheckBase::buildConfigurationForm
ReleaseNotes::defaultConfiguration public function Gets default configuration for this plugin. Overrides ProdCheckBase::defaultConfiguration
ReleaseNotes::failMessages public function Returns the fail messages for the check Overrides ProdCheckInterface::failMessages
ReleaseNotes::init public function Initializes the check plugin. Overrides ProdCheckBase::init
ReleaseNotes::state public function Calculates the state for the check. Overrides ProdCheckInterface::state
ReleaseNotes::submitConfigurationForm public function Form submission handler. Overrides ProdCheckBase::submitConfigurationForm
ReleaseNotes::successMessages public function Returns the success messages for the check. Overrides ProdCheckInterface::successMessages
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.