You are here

class UpdateSettingsForm in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 core/modules/update/src/UpdateSettingsForm.php \Drupal\update\UpdateSettingsForm

Configure update settings for this site.

Hierarchy

Expanded class hierarchy of UpdateSettingsForm

1 string reference to 'UpdateSettingsForm'
update.routing.yml in core/modules/update/update.routing.yml
core/modules/update/update.routing.yml

File

core/modules/update/src/UpdateSettingsForm.php, line 19
Contains \Drupal\update\UpdateSettingsForm.

Namespace

Drupal\update
View source
class UpdateSettingsForm extends ConfigFormBase implements ContainerInjectionInterface {

  /**
   * The email validator.
   *
   * @var \Egulias\EmailValidator\EmailValidator
   */
  protected $emailValidator;

  /**
   * Constructs a new UpdateSettingsForm.
   *
   * @param \Egulias\EmailValidator\EmailValidator $email_validator
   *   The email validator.
   */
  public function __construct(EmailValidator $email_validator) {
    $this->emailValidator = $email_validator;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('email.validator'));
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('update.settings');
    $form['update_check_frequency'] = array(
      '#type' => 'radios',
      '#title' => t('Check for updates'),
      '#default_value' => $config
        ->get('check.interval_days'),
      '#options' => array(
        '1' => t('Daily'),
        '7' => t('Weekly'),
      ),
      '#description' => t('Select how frequently you want to automatically check for new releases of your currently installed modules and themes.'),
    );
    $form['update_check_disabled'] = array(
      '#type' => 'checkbox',
      '#title' => t('Check for updates of uninstalled modules and themes'),
      '#default_value' => $config
        ->get('check.disabled_extensions'),
    );
    $notification_emails = $config
      ->get('notification.emails');
    $form['update_notify_emails'] = array(
      '#type' => 'textarea',
      '#title' => t('Email addresses to notify when updates are available'),
      '#rows' => 4,
      '#default_value' => implode("\n", $notification_emails),
      '#description' => t('Whenever your site checks for available updates and finds new releases, it can notify a list of users via email. Put each address on a separate line. If blank, no emails will be sent.'),
    );
    $form['update_notification_threshold'] = array(
      '#type' => 'radios',
      '#title' => t('Email notification threshold'),
      '#default_value' => $config
        ->get('notification.threshold'),
      '#options' => array(
        'all' => t('All newer versions'),
        'security' => t('Only security updates'),
      ),
      '#description' => t('You can choose to send email only if a security update is available, or to be notified about all newer versions. If there are updates available of Drupal core or any of your installed modules and themes, your site will always print a message on the <a href=":status_report">status report</a> page, and will also display an error message on administration pages if there is a security update.', array(
        ':status_report' => $this
          ->url('system.status'),
      )),
    );
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $form_state
      ->set('notify_emails', []);
    if (!$form_state
      ->isValueEmpty('update_notify_emails')) {
      $valid = array();
      $invalid = array();
      foreach (explode("\n", trim($form_state
        ->getValue('update_notify_emails'))) as $email) {
        $email = trim($email);
        if (!empty($email)) {
          if ($this->emailValidator
            ->isValid($email)) {
            $valid[] = $email;
          }
          else {
            $invalid[] = $email;
          }
        }
      }
      if (empty($invalid)) {
        $form_state
          ->set('notify_emails', $valid);
      }
      elseif (count($invalid) == 1) {
        $form_state
          ->setErrorByName('update_notify_emails', $this
          ->t('%email is not a valid email address.', array(
          '%email' => reset($invalid),
        )));
      }
      else {
        $form_state
          ->setErrorByName('update_notify_emails', $this
          ->t('%emails are not valid email addresses.', array(
          '%emails' => implode(', ', $invalid),
        )));
      }
    }
    parent::validateForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('update.settings');

    // See if the update_check_disabled setting is being changed, and if so,
    // invalidate all update status data.
    if ($form_state
      ->getValue('update_check_disabled') != $config
      ->get('check.disabled_extensions')) {
      update_storage_clear();
    }
    $config
      ->set('check.disabled_extensions', $form_state
      ->getValue('update_check_disabled'))
      ->set('check.interval_days', $form_state
      ->getValue('update_check_frequency'))
      ->set('notification.emails', $form_state
      ->get('notify_emails'))
      ->set('notification.threshold', $form_state
      ->getValue('update_notification_threshold'))
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
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. 3
FormBase::$loggerFactory protected property The logger factory.
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. 3
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::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.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator protected function Returns the link generator.
LinkGeneratorTrait::l protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator public function Sets the link generator service.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service.
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.
StringTranslationTrait::$stringTranslation protected property The string translation service.
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.
UpdateSettingsForm::$emailValidator protected property The email validator.
UpdateSettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
UpdateSettingsForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
UpdateSettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
UpdateSettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
UpdateSettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
UpdateSettingsForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
UpdateSettingsForm::__construct public function Constructs a new UpdateSettingsForm. Overrides ConfigFormBase::__construct
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator protected function Returns the URL generator service.
UrlGeneratorTrait::redirect protected function Returns a redirect response object for the specified route.
UrlGeneratorTrait::setUrlGenerator public function Sets the URL generator service.
UrlGeneratorTrait::url protected function Generates a URL or path for a specific route based on the given parameters.