class ModuleFilterSettingsForm in Module Filter 8

Same name and namespace in other branches

8.3 src/Form/ModuleFilterSettingsForm.php \Drupal\module_filter\Form\ModuleFilterSettingsForm

Settings form for module filter.

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\module_filter\Form\ModuleFilterSettingsForm

Expanded class hierarchy of ModuleFilterSettingsForm

1 string reference to 'ModuleFilterSettingsForm'

module_filter.routing.yml in ./module_filter.routing.yml: module_filter.routing.yml

File

src/Form/ModuleFilterSettingsForm.php, line 16: Contains \Drupal\module_filter\Form\ModuleFilterSettingsForm.

Namespace

Drupal\module_filter\Form

View source

class ModuleFilterSettingsForm extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildForm($form, $form_state);
    $config = $this
      ->config('module_filter.settings');
    $form['module_filter_set_focus'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Set focus to filter field on page load'),
      '#description' => $this
        ->t('Currently has no effect when using Overlay module.'),
      '#default_value' => $config
        ->get('module_filter_set_focus'),
    );
    $form['module_filter_tabs'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enhance the modules page with tabs'),
      '#description' => $this
        ->t('Alternate tabbed theme that restructures packages into tabs.'),
      '#default_value' => $config
        ->get('module_filter_tabs'),
    );
    $form['tabs'] = array(
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Tabs'),
      '#description' => $this
        ->t('Settings used with the tabs view of the modules page.'),
      '#open' => TRUE,
      '#collapsible' => TRUE,
      '#collapsed' => FALSE,
    );
    $form['tabs']['module_filter_count_enabled'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Number of enabled modules'),
      '#description' => $this
        ->t('Display the number of enabled modules in the active tab along with the total number of modules.'),
      '#default_value' => $config
        ->get('module_filter_count_enabled'),
    );
    $form['tabs']['module_filter_visual_aid'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Visual aids'),
      '#description' => $this
        ->t('When enabling/disabling modules, the module name will display in the tab summary.<br />When filtering, a count of results for each tab will be presented.'),
      '#default_value' => $config
        ->get('module_filter_visual_aid'),
    );
    $form['tabs']['module_filter_hide_empty_tabs'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Hide tabs with no results'),
      '#description' => $this
        ->t('When a filter returns no results for a tab, the tab is hidden. This is dependent on visual aids being enabled.'),
      '#default_value' => $config
        ->get('module_filter_hide_empty_tabs'),
    );
    $form['tabs']['module_filter_dynamic_save_position'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Dynamically position Save button'),
      '#description' => $this
        ->t("For sites with lots of tabs, enable to help keep the 'Save configuration' button more accessible."),
      '#default_value' => $config
        ->get('module_filter_dynamic_save_position'),
    );
    $form['tabs']['module_filter_use_url_fragment'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Use URL fragment'),
      '#description' => $this
        ->t('Use URL fragment when navigating between tabs. This lets you use the browsers back/forward buttons to navigate through the tabs you selected.') . '<br />' . t('When the Overlay module is enabled this functionality will not be used since overlay relies on the URL fragment.'),
      '#default_value' => $config
        ->get('module_filter_use_url_fragment'),
    );
    $form['tabs']['module_filter_use_switch'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Use switch instead of checkbox'),
      '#description' => $this
        ->t('This is purely cosmetic (at least for now). Displays a ON/OFF switch rather than a checkbox to enable/disable modules.<br /><strong>Modules will not actually be enabled/disabled until the form is saved.</strong>'),
      '#default_value' => $config
        ->get('module_filter_use_switch'),
    );
    $form['tabs']['module_filter_track_recent_modules'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Track recently enabled/disabled modules'),
      '#description' => $this
        ->t('Adds a "Recent" tab that displays modules that have been enabled or disabled with the last week.'),
      '#default_value' => $config
        ->get('module_filter_track_recent_modules'),
    );
    $form['tabs']['module_filter_remember_active_tab'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Remember active tab.'),
      '#description' => $this
        ->t('When enabled, the active tab will be remembered.'),
      '#default_value' => $config
        ->get('module_filter_remember_active_tab'),
    );
    $form['update'] = array(
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Update status'),
      '#collapsible' => TRUE,
      '#collapsed' => \Drupal::moduleHandler()
        ->moduleExists('update') ? FALSE : TRUE,
    );
    $form['update']['module_filter_remember_update_state'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Remember the last selected filter.'),
      '#description' => $this
        ->t('When enabled, the last state (All, Update available, Security update, Unknown) will be remembered.'),
      '#default_value' => $config
        ->get('module_filter_remember_update_state'),
    );
    if (\Drupal::moduleHandler()
      ->moduleExists('page_actions')) {
      $form['tabs']['module_filter_dynamic_save_position']['#description'] .= '<br />' . $this
        ->t('The module %name is enabled and thus this setting will have no affect.', array(
        '%name' => $this
          ->t('Page actions'),
      ));
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->config('module_filter.settings')
      ->set('module_filter_set_focus', $form_state
      ->getValue('module_filter_set_focus'))
      ->set('module_filter_tabs', $form_state
      ->getValue('module_filter_tabs'))
      ->set('module_filter_count_enabled', $form_state
      ->getValue('module_filter_count_enabled'))
      ->set('module_filter_visual_aid', $form_state
      ->getValue('module_filter_visual_aid'))
      ->set('module_filter_hide_empty_tabs', $form_state
      ->getValue('module_filter_hide_empty_tabs'))
      ->set('module_filter_dynamic_save_position', $form_state
      ->getValue('module_filter_dynamic_save_position'))
      ->set('module_filter_use_url_fragment', $form_state
      ->getValue('module_filter_use_url_fragment'))
      ->set('module_filter_use_switch', $form_state
      ->getValue('module_filter_use_switch'))
      ->set('module_filter_track_recent_modules', $form_state
      ->getValue('module_filter_track_recent_modules'))
      ->set('module_filter_remember_active_tab', $form_state
      ->getValue('module_filter_remember_active_tab'))
      ->set('module_filter_remember_update_state', $form_state
      ->getValue('module_filter_remember_update_state'))
      ->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.
ModuleFilterSettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
ModuleFilterSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
ModuleFilterSettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
ModuleFilterSettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
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.

You are here

class ModuleFilterSettingsForm in Module Filter 8

Hierarchy

File

Namespace

Members

API Navigation