class RulesSettingsForm in Rules 8.3

Provides rules settings form.

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\rules\Form\RulesSettingsForm

Expanded class hierarchy of RulesSettingsForm

1 string reference to 'RulesSettingsForm'

rules.routing.yml in ./rules.routing.yml: rules.routing.yml

File

src/Form/RulesSettingsForm.php, line 13

Namespace

Drupal\rules\Form

View source

class RulesSettingsForm extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('rules.settings');
    $form['#tree'] = TRUE;
    $form['system_log'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('System logging'),
    ];
    $form['system_log']['log_level'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Evaluation errors log level'),
      '#options' => [
        LogLevel::WARNING => $this
          ->t('Log all warnings and errors'),
        LogLevel::ERROR => $this
          ->t('Log errors only'),
      ],
      '#default_value' => $config
        ->get('system_log.log_level'),
      '#description' => $this
        ->t('Evaluation errors are logged to the system database logger and all other registered loggers.'),
    ];
    $form['debug_log'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Debug logging'),
    ];
    $form['debug_log']['enabled'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable debug logging'),
      '#description' => $this
        ->t('Show debug information on screen (in the HTML response). Debug information is only shown when rules are evaluated, and is visible for users having the permission %permission.', [
        '%permission' => Link::createFromRoute('View Rules debug log', 'user.admin_permissions', [], [
          'fragment' => 'module-rules',
        ])
          ->toString(),
      ]),
      '#default_value' => $config
        ->get('debug_log.enabled'),
    ];
    $form['debug_log']['settings'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Settings'),
      '#states' => [
        // Hide the logging destination fields when the debug log is disabled.
        'invisible' => [
          'input[name="debug_log[enabled]"]' => [
            'checked' => FALSE,
          ],
        ],
      ],
    ];
    $form['debug_log']['settings']['system_debug'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Also log debug information to the system log'),
      '#description' => $this
        ->t('Write a copy of the debug information to the system database log. This will be visible for users having the permission %permission.', [
        '%permission' => Link::createFromRoute('View site reports', 'user.admin_permissions', [], [
          'fragment' => 'module-system',
        ])
          ->toString(),
      ]),
      '#default_value' => $config
        ->get('debug_log.system_debug'),
    ];
    $form['debug_log']['settings']['log_level'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Debug log level'),
      '#options' => [
        LogLevel::DEBUG => $this
          ->t('Log everything'),
        LogLevel::WARNING => $this
          ->t('Log warnings and errors only'),
        LogLevel::ERROR => $this
          ->t('Log errors only'),
      ],
      '#default_value' => $config
        ->get('debug_log.log_level'),
      '#description' => $this
        ->t('Level of debug log messages shown on screen'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->config('rules.settings')
      ->set('system_log.log_level', $form_state
      ->getValue([
      'system_log',
      'log_level',
    ]))
      ->set('debug_log.enabled', $form_state
      ->getValue([
      'debug_log',
      'enabled',
    ]))
      ->set('debug_log.system_debug', $form_state
      ->getValue([
      'debug_log',
      'settings',
      'system_debug',
    ]))
      ->set('debug_log.log_level', $form_state
      ->getValue([
      'debug_log',
      'settings',
      'log_level',
    ]))
      ->save();
    parent::submitForm($form, $form_state);
  }

}

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.
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.
RulesSettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
RulesSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
RulesSettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
RulesSettingsForm::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.

You are here

class RulesSettingsForm in Rules 8.3

Hierarchy

File

Namespace

Members

API Navigation