class AccordionMenusConfigForm in Accordion Menus 8.4

Configure accordion menus settings.

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\accordion_menus\Form\AccordionMenusConfigForm

1 string reference to 'AccordionMenusConfigForm'

accordion_menus.routing.yml in ./accordion_menus.routing.yml

accordion_menus.routing.yml

File

src/Form/AccordionMenusConfigForm.php, line 11

Namespace

Drupal\accordion_menus\Form

class AccordionMenusConfigForm extends ConfigFormBase {

  /**
   * Config settings.
   */
  const SETTINGS = 'accordion_menus.settings';

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

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      static::SETTINGS,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config(static::SETTINGS);

    // Get list of menus.
    $menus = menu_ui_get_menus();
    $form['accordion_menus'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Accordion Menus'),
      '#options' => $menus,
      '#description' => $this
        ->t('Select menu to make them accordion menu.'),
      '#default_value' => !empty($config
        ->get('accordion_menus')) ? $config
        ->get('accordion_menus') : [],
    ];
    $form['accordion_advanced'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Advanced settings'),
      '#open' => FALSE,
    ];
    $form['accordion_advanced']['accordion_menus_no_submenus'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Accordion without sub menu item'),
      '#options' => $menus,
      '#description' => $this
        ->t('Menus which have no sub menu item, will show also in accordion menu.'),
      '#default_value' => !empty($config
        ->get('accordion_menus_no_submenus')) ? $config
        ->get('accordion_menus_no_submenus') : [],
    ];
    $form['accordion_advanced']['accordion_menus_default_closed'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Accordion menu closed by default'),
      '#options' => $menus,
      '#description' => $this
        ->t('Allow all trees closed at beginning.'),
      '#default_value' => !empty($config
        ->get('accordion_menus_default_closed')) ? $config
        ->get('accordion_menus_default_closed') : [],
    ];
    $form['accordion_advanced']['default_tab'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Default tab'),
      '#description' => $this
        ->t('Consider all first level menu item and value will start from 0. Example for first menu item, it will be 0, for second it will be 1 and so on.'),
      '#open' => TRUE,
    ];
    foreach ($menus as $menu_name => $menu) {
      $form['accordion_advanced']['default_tab']['accordion_menus_active_tab_' . $menu_name] = [
        '#type' => 'textfield',
        '#title' => $this
          ->t($menu . ': Active menu tab'),
        '#attributes' => [
          'type' => 'number',
        ],
        '#maxlength' => 3,
        '#default_value' => !empty($config
          ->get('accordion_menus_active_tab_' . $menu_name)) ? $config
          ->get('accordion_menus_active_tab_' . $menu_name) : 0,
      ];
    }
    return parent::buildForm($form, $form_state);
  }

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

    // Retrieve the configuration and Set the submitted configuration setting.
    $output = $this->configFactory
      ->getEditable(static::SETTINGS)
      ->set('accordion_menus', $form_state
      ->getValue('accordion_menus'))
      ->set('accordion_menus_no_submenus', $form_state
      ->getValue('accordion_menus_no_submenus'))
      ->set('accordion_menus_default_closed', $form_state
      ->getValue('accordion_menus_default_closed'));
    $menus = menu_ui_get_menus();
    $active = [];
    foreach ($menus as $menu_name => $menu) {
      $output
        ->set('accordion_menus_active_tab_' . $menu_name, $form_state
        ->getValue('accordion_menus_active_tab_' . $menu_name));
      $active[$menu_name] = $form_state
        ->getValue('accordion_menus_active_tab_' . $menu_name);
    }
    $output
      ->set('accordion_menus_active_tab', $active);
    $output
      ->save();
    parent::submitForm($form, $form_state);

    // Clear cache is needed to effect this value on block derivetive plugin
    // system. See @src/Plugin/Derivative/AccordionMenusBlock.
    drupal_flush_all_caches();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AccordionMenusConfigForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
AccordionMenusConfigForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
AccordionMenusConfigForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
AccordionMenusConfigForm::SETTINGS		constant	Config settings.
AccordionMenusConfigForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
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.
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.