class LogStdoutConfigForm in log_stdout 8

Provides a settings form for stdout logging.

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
    • class \Drupal\log_stdout\Form\LogStdoutConfigForm

1 string reference to 'LogStdoutConfigForm'

log_stdout.routing.yml in ./log_stdout.routing.yml

log_stdout.routing.yml

File

src/Form/LogStdoutConfigForm.php, line 11

Namespace

Drupal\log_stdout\Form

class LogStdoutConfigForm extends ConfigFormBase {

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

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

    // Form constructor.
    $form = parent::buildForm($form, $form_state);

    // Default settings.
    $config = $this
      ->config('log_stdout.settings');
    $form['use_stderr'] = [
      '#title' => $this
        ->t('Write warning and error messages to stderr'),
      '#type' => 'radios',
      '#default_value' => $config
        ->get('use_stderr'),
      '#options' => [
        '0' => $this
          ->t('No'),
        '1' => $this
          ->t('Yes'),
      ],
    ];
    $form['format'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Log format'),
      '#default_value' => $config
        ->get('format'),
      '#description' => $this
        ->t("Specify the format of the log entry. Available variables are: <dl>\n        <dt><code>@base_url</code></dt><dd>Base URL of the site.</dd>\n        <dt><code>@timestamp</code></dt><dd>Unix timestamp of the log entry.</dd>\n        <dt><code>@type</code></dt><dd>The category to which this message belongs.</dd>\n        <dt><code>@ip</code></dt><dd>IP address of the user triggering the message.</dd>\n        <dt><code>@request_uri</code></dt><dd>The requested URI.</dd>\n        <dt><code>@referer</code></dt><dd>HTTP Referer if available.</dd>\n        <dt><code>@severity</code></dt><dd>The severity level of the event; ranges from 0 (Emergency) to 7 (Debug).</dd>\n        <dt><code>@uid</code></dt><dd>User ID.</dd>\n        <dt><code>@link</code></dt><dd>A link to associate with the message.</dd>\n        <dt><code>@message</code></dt><dd>The message to store in the log.</dd></dl>"),
    ];
    return $form;
  }

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

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('log_stdout.settings');
    $config
      ->set('format', $form_state
      ->getValue('format'));
    $config
      ->set('use_stderr', $form_state
      ->getValue('use_stderr'));
    $config
      ->save();
    return parent::submitForm($form, $form_state);
  }

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

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigFormBase::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create	13
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.
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.
LogStdoutConfigForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
LogStdoutConfigForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
LogStdoutConfigForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
LogStdoutConfigForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
LogStdoutConfigForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
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.