class DevelopmentEnvironmentSettingsForm in Development Environment 8

DevelopmentEnvironmentConfigurationForm class.

Form definition for the Development Environment Configuration Form.

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\development_environment\Form\DevelopmentEnvironmentSettingsForm

File

src/Form/DevelopmentEnvironmentSettingsForm.php, line 16

Namespace

Drupal\development_environment\Form

class DevelopmentEnvironmentSettingsForm extends FormBase {

  /**
   * The state service.
   *
   * @var \Drupal\Core\State\StateInterface
   */
  protected $state;

  /**
   * Instance specific settings.
   *
   * @var \Drupal\Core\Site\Settings
   */
  protected $settings;

  /**
   * Constructs a DevelopmentEnvironmentSettingsForm object.
   *
   * @param \Drupal\Core\State\StateInterface $state
   *   The state service.
   * @param \Drupal\Core\Site\Settings $settings
   *   Instance specific settings.
   */
  public function __construct(StateInterface $state, Settings $settings) {
    $this->state = $state;
    $this->settings = $settings;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('state'), $container
      ->get('settings'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {

    // Retrieve a value from settings.php, if one has been set.
    $settings_value = $this->settings
      ->get('development_environment.log_emails');
    if (is_null($settings_value)) {
      $form['log_emails'] = [
        '#title' => $this
          ->t('Log Emails'),
        '#type' => 'checkbox',
        '#default_value' => $this->state
          ->get('development_environment.log_emails'),
        '#description' => $this
          ->t('If this box is checked, emails will not longer be sent from this system, and will instead be written to a log. Note that this setting is NOT configuration, and will not migrate between environments. This value needs to be set independently for each environment.'),
      ];
      $form['log_emails_gui_description'] = [
        '#prefix' => '<p>',
        '#suffix' => '</p>',
        '#markup' => $this
          ->t("To set this value and prevent it from being able to be managed through the admin UI, add a line containing <code>&#36;settings[\\'development_environment.log_emails\\'] = TRUE;</code> (or FALSE) to settings.php."),
      ];
    }
    else {
      $form['log_emails'] = [
        '#type' => 'value',
        '#value' => $settings_value,
      ];
      $form['log_emails_display'] = [
        '#prefix' => '<p>',
        '#suffix' => '</p>',
      ];
      if ($settings_value) {
        $form['log_emails_display']['#markup'] = $this
          ->t("Emails on the system are set to be logged in settings.php, and will NOT be sent from the system. To set emails to be sent rather than logged, edit settings.php, and set the value of <code>&#36;settings[\\'development_environment.log_emails\\']</code> to FALSE.");
      }
      else {
        $form['log_emails_display']['#markup'] = $this
          ->t("Emails on the system are NOT set to be logged in settings.php, and will be sent from the system. To set emails to be logged rather than sent, edit settings.php, and set the value of <code>&#36;settings[\\'development_environment.log_emails\\']</code> to TRUE.");
      }
      $form['log_emails_gui_description'] = [
        '#prefix' => '<p>',
        '#suffix' => '</p>',
        '#markup' => $this
          ->t("To manage this setting through the admin UI, remove the line containing <code>&#36;settings[\\'development_environment.log_emails\\']</code> from settings.php altogether."),
      ];
    }
    $form['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Submit'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this->state
      ->set('development_environment.log_emails', $form_state
      ->getValue('log_emails'));
    $this
      ->messenger()
      ->addStatus('The settings have been updated');
  }

}

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
DevelopmentEnvironmentSettingsForm::$settings	protected	property	Instance specific settings.
DevelopmentEnvironmentSettingsForm::$state	protected	property	The state service.
DevelopmentEnvironmentSettingsForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
DevelopmentEnvironmentSettingsForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
DevelopmentEnvironmentSettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
DevelopmentEnvironmentSettingsForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
DevelopmentEnvironmentSettingsForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
DevelopmentEnvironmentSettingsForm::__construct	public	function	Constructs a DevelopmentEnvironmentSettingsForm object.
FormBase::$configFactory	protected	property	The config factory.	1
FormBase::$requestStack	protected	property	The request stack.	1
FormBase::$routeMatch	protected	property	The route match.
FormBase::config	protected	function	Retrieves a configuration object.
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.
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.
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.