You are here

Home » API reference » Automatic Updates 8 » SettingsForm.php

class SettingsForm in Automatic Updates 8

Settings form for automatic updates.

Hierarchy

Expanded class hierarchy of SettingsForm

1 string reference to 'SettingsForm'
automatic_updates.routing.yml in ./automatic_updates.routing.yml
automatic_updates.routing.yml

File

src/Form/SettingsForm.php, line 14

Namespace

Drupal\automatic_updates\Form
View source 
class SettingsForm extends ConfigFormBase {

  /**
   * The readiness checker.
   *
   * @var \Drupal\automatic_updates\ReadinessChecker\ReadinessCheckerManagerInterface
   */
  protected $checker;

  /**
   * The data formatter.
   *
   * @var \Drupal\Core\Datetime\DateFormatterInterface
   */
  protected $dateFormatter;

  /**
   * Drupal root path.
   *
   * @var string
   */
  protected $drupalRoot;

  /**
   * The update manager service.
   *
   * @var \Drupal\update\UpdateManagerInterface
   */
  protected $updateManager;

  /**
   * The update processor.
   *
   * @var \Drupal\update\UpdateProcessorInterface
   */
  protected $updateProcessor;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    $instance = parent::create($container);
    $instance->checker = $container
      ->get('automatic_updates.readiness_checker');
    $instance->dateFormatter = $container
      ->get('date.formatter');
    $instance->drupalRoot = (string) $container
      ->get('app.root');
    $instance->updateManager = $container
      ->get('update.manager');
    $instance->updateProcessor = $container
      ->get('update.processor');
    return $instance;
  }

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'automatic_updates.settings',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'automatic_updates_settings_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('automatic_updates.settings');
    $form['psa'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Public service announcements'),
      '#open' => TRUE,
    ];
    $form['psa']['description'] = [
      '#markup' => '<p>' . $this
        ->t('Public service announcements are compared against the entire code for the site, not just installed extensions.') . '</p>',
    ];
    $form['psa']['enable_psa'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Show Public service announcements on administrative pages.'),
      '#default_value' => $config
        ->get('enable_psa'),
    ];
    $form['psa']['notify'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Send email notifications for Public service announcements.'),
      '#default_value' => $config
        ->get('notify'),
      '#description' => $this
        ->t('The email addresses listed in <a href="@update_manager">update manager settings</a> will be notified.', [
        '@update_manager' => Url::fromRoute('update.settings')
          ->toString(),
      ]),
    ];
    $form['readiness'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Readiness checks'),
      '#open' => TRUE,
    ];
    $last_check_timestamp = $this->checker
      ->timestamp();
    $form['readiness']['enable_readiness_checks'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Check the readiness of automatically updating the site.'),
      '#default_value' => $config
        ->get('enable_readiness_checks'),
    ];
    if ($this->checker
      ->isEnabled()) {
      $form['readiness']['enable_readiness_checks']['#description'] = $this
        ->t('Readiness checks were last run @time ago. Manually <a href="@link">run the readiness checks</a>.', [
        '@time' => $this->dateFormatter
          ->formatTimeDiffSince($last_check_timestamp),
        '@link' => Url::fromRoute('automatic_updates.update_readiness')
          ->toString(),
      ]);
    }
    $form['readiness']['ignored_paths'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Paths to ignore for readiness checks'),
      '#description' => $this
        ->t('Paths relative to %drupal_root. One path per line. Automatic Updates is intentionally limited to Drupal core. It is recommended to ignore paths to contrib extensions.', [
        '%drupal_root' => $this->drupalRoot,
      ]),
      '#default_value' => $config
        ->get('ignored_paths'),
      '#states' => [
        'visible' => [
          ':input[name="enable_readiness_checks"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $this->updateManager
      ->refreshUpdateData();
    $this->updateProcessor
      ->fetchData();
    $available = update_get_available(TRUE);
    $projects = update_calculate_project_data($available);
    $not_recommended_version = $projects['drupal']['status'] !== UpdateManagerInterface::CURRENT;
    $not_dev_core = strpos(\Drupal::VERSION, '-dev') === FALSE;
    $security_update = in_array($projects['drupal']['status'], [
      UpdateManagerInterface::NOT_SECURE,
      UpdateManagerInterface::REVOKED,
    ], TRUE);
    $recommended_release = $projects['drupal']['releases'][$projects['drupal']['recommended']];
    $form['experimental'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Experimental'),
      '#states' => [
        'visible' => [
          ':input[name="enable_readiness_checks"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    if ($not_recommended_version && $not_dev_core) {
      $existing_major_version = explode('.', \Drupal::VERSION, -2);
      $recommended_major_version = explode('.', $recommended_release['version'], -2);
      $major_upgrade = $existing_major_version !== $recommended_major_version;
      if ($security_update) {
        $form['experimental']['security'] = [
          '#type' => 'html_tag',
          '#tag' => 'p',
          '#value' => $this
            ->t('A security update is available for your version of Drupal.'),
        ];
      }
      if ($major_upgrade) {
        $form['experimental']['major_version'] = [
          '#type' => 'html_tag',
          '#tag' => 'p',
          '#value' => $this
            ->t('This update is a major version update which means that it may not be backwards compatible with your currently running version. It is recommended that you read the release notes and proceed at your own risk.'),
        ];
      }
    }
    $update_text = $this
      ->t('Your site is running %version of Drupal core. No recommended update is available at this time.</i>', [
      '%version' => \Drupal::VERSION,
    ]);
    if ($not_recommended_version && $not_dev_core) {
      $update_text = $this
        ->t('A newer version of Drupal is available and you may <a href="@link">manually update now</a>.', [
        '@link' => Url::fromRoute('automatic_updates.inplace-update', [
          'project' => 'drupal',
          'type' => 'core',
          'from' => \Drupal::VERSION,
          'to' => $recommended_release['version'],
        ])
          ->toString(),
      ]);
    }
    $form['experimental']['update'] = [
      '#type' => 'html_tag',
      '#tag' => 'p',
      '#value' => $update_text,
    ];
    $form['experimental']['enable_cron_updates'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable automatic updates of Drupal core via cron.'),
      '#default_value' => $config
        ->get('enable_cron_updates'),
      '#description' => $this
        ->t('When a recommended update for Drupal core is available, a manual method to update is available. As an alternative to the full control of manually executing an update, enable automated updates via cron.'),
    ];
    $form['experimental']['enable_cron_security_updates'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable security only updates'),
      '#default_value' => $config
        ->get('enable_cron_security_updates'),
      '#description' => $this
        ->t('Enable automated updates via cron for security-only releases of Drupal core.'),
      '#states' => [
        'visible' => [
          ':input[name="enable_cron_updates"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $form_state
      ->cleanValues();
    $config = $this
      ->config('automatic_updates.settings');
    foreach ($form_state
      ->getValues() as $key => $value) {
      $config
        ->set($key, $value);

      // Disable cron automatic updates if readiness checks are disabled.
      if (in_array($key, [
        'enable_cron_updates',
        'enable_cron_security_updates',
      ], TRUE) && !$form_state
        ->getValue('enable_readiness_checks')) {
        $config
          ->set($key, FALSE);
      }
    }
    $config
      ->save();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigFormBase::__construct public function Constructs a \Drupal\system\ConfigFormBase object. 11
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
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
FormBase::$configFactory protected property The config factory. 1
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::configFactory protected function Gets the config factory for this form. 1
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 62
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
SettingsForm::$checker protected property The readiness checker.
SettingsForm::$dateFormatter protected property The data formatter.
SettingsForm::$drupalRoot protected property Drupal root path.
SettingsForm::$updateManager protected property The update manager service.
SettingsForm::$updateProcessor protected property The update processor.
SettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
SettingsForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
SettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
SettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
SettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
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.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.