class MenuManipulatorSettingsForm in Menu Manipulator 3.0.x

Configure custom settings for Menu Manipulators.

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
  • class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
    • class \Drupal\menu_manipulator\Form\MenuManipulatorSettingsForm uses StringTranslationTrait

1 string reference to 'MenuManipulatorSettingsForm'

menu_manipulator.routing.yml in ./menu_manipulator.routing.yml

menu_manipulator.routing.yml

File

src/Form/MenuManipulatorSettingsForm.php, line 19

Namespace

Drupal\menu_manipulator\Form

class MenuManipulatorSettingsForm extends ConfigFormBase {
  use StringTranslationTrait;

  /**
   * The list of existing Menus (config entities).
   *
   * @var array
   */
  protected $menus;

  /**
   * The language manager.
   *
   * @var \Drupal\Core\Language\LanguageManagerInterface
   */
  protected $languageManager;

  /**
   * Cache backend instance for the extracted tree data.
   *
   * @var \Drupal\Core\Cache\CacheBackendInterface
   */
  protected $menuCacheBackend;

  /**
   * Block manager service.
   *
   * @var \Drupal\Core\Block\BlockManagerInterface|null
   */
  protected $blockManager;

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

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

  /**
   * Constructs a MenuManipulatorSettingsForm object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\Core\Entity\EntityStorageInterface $menu_storage
   *   The menu storage service.
   * @param \Drupal\language\ConfigurableLanguageManagerInterface $language_manager
   *   The language manager handler.
   * @param \Drupal\Core\Cache\CacheBackendInterface $cache
   *   The cache backend.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler
   */
  public function __construct(ConfigFactoryInterface $config_factory, ConfigurableLanguageManagerInterface $language_manager, CacheBackendInterface $cache_menu, ModuleHandlerInterface $module_handler, EntityStorageInterface $menu_storage) {
    parent::__construct($config_factory);
    $this->languageManager = $language_manager;
    $this->menuCacheBackend = $cache_menu;
    $this->menus = $menu_storage
      ->loadMultiple();
    if ($module_handler
      ->moduleExists('block')) {
      $this->blockManager = \Drupal::service('plugin.manager.block');
    }
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('language_manager'), $container
      ->get('cache.menu'), $container
      ->get('module_handler'), $container
      ->get('entity_type.manager')
      ->getStorage('menu'));
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('menu_manipulator.settings');
    $menus_options = [];
    foreach ($this->menus as $menu) {
      $menus_options[$menu
        ->id()] = $menu
        ->label();
    }

    // Quick intro.
    $form['intro'] = [
      '#type' => 'markup',
      '#markup' => '<p>' . $this
        ->t('Configure custom Menu Manipulator settings here.') . '</p>',
      '#weight' => 0,
    ];

    // Global settings.
    $form['global'] = [
      '#type' => 'details',
      '#open' => TRUE,
      '#title' => $this
        ->t('Global'),
      '#weight' => 0,
    ];
    $form['global']['preprocess_menus_title'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t("Add menus' title in Twig"),
      '#description' => $this
        ->t('You can then use {{ menu_title }} in your menu.html.twig files.'),
      '#default_value' => $config
        ->get('preprocess_menus_title'),
      '#weight' => 0,
    ];

    // Language settings.
    $form['language'] = [
      '#type' => 'details',
      '#open' => TRUE,
      '#title' => $this
        ->t('Language'),
      '#weight' => 1,
    ];
    $form['language']['preprocess_menus_language'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t("Automatically filter menus by current's user language"),
      '#default_value' => $config
        ->get('preprocess_menus_language'),
      '#weight' => 1,
    ];
    $form['language']['preprocess_menus_language_list'] = [
      '#type' => 'checkboxes',
      '#options' => $menus_options,
      '#title' => $this
        ->t("Select menus to be filtered by language"),
      '#description' => $this
        ->t("If none selected, all menus will be filtered by language."),
      '#default_value' => !empty($config
        ->get('preprocess_menus_language_list')) ? $config
        ->get('preprocess_menus_language_list') : [],
      '#states' => [
        'visible' => [
          ':input[name="preprocess_menus_language"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
      '#weight' => 1,
    ];

    // Custom icons.
    $form['theming'] = [
      '#type' => 'details',
      '#open' => TRUE,
      '#title' => $this
        ->t('Theming'),
      '#weight' => 1,
    ];
    $form['theming']['preprocess_menus_icon'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t("Process menu items to display icons"),
      '#default_value' => $config
        ->get('preprocess_menus_icon'),
      '#weight' => 1,
    ];
    $form['theming']['preprocess_menus_icon_list'] = [
      '#type' => 'checkboxes',
      '#options' => $menus_options,
      '#title' => $this
        ->t("Select menus with icons"),
      '#default_value' => !empty($config
        ->get('preprocess_menus_icon_list')) ? $config
        ->get('preprocess_menus_icon_list') : [],
      '#states' => [
        'visible' => [
          ':input[name="preprocess_menus_icon"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
      '#weight' => 1,
      '#description' => $this
        ->t("If none selected, all menus will be processed to expose icon in Twig."),
    ];
    $form['theming']['menu_link_icon_list'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t("List of available icons"),
      '#default_value' => !empty($config
        ->get('menu_link_icon_list')) ? $config
        ->get('menu_link_icon_list') : '',
      '#states' => [
        'visible' => [
          ':input[name="preprocess_menus_icon"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
      '#weight' => 1,
      '#description' => $this
        ->t("One value per line (e.g `facebook|Facebook`)."),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('menu_manipulator.settings');
    $exclude = [
      'submit',
      'form_build_id',
      'form_token',
      'form_id',
      'op',
    ];
    foreach ($form_state
      ->getValues() as $key => $data) {
      if (!in_array($key, $exclude)) {
        $config
          ->set($key, $data);
      }
    }
    $config
      ->save();
    parent::submitForm($form, $form_state);

    // Invalidate the menu cache.
    $this->menuCacheBackend
      ->invalidateAll();

    // Invalidate the block cache to update menu-based derivatives.
    if ($this->blockManager instanceof BlockManagerInterface) {
      $this->blockManager
        ->clearCachedDefinitions();
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigFormBaseTrait::config	protected	function	Retrieves a configuration object.
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
FormBase::$configFactory	protected	property	The config factory.	3
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.	3
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.
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	72
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.
MenuManipulatorSettingsForm::$blockManager	protected	property	Block manager service.
MenuManipulatorSettingsForm::$languageManager	protected	property	The language manager.
MenuManipulatorSettingsForm::$menuCacheBackend	protected	property	Cache backend instance for the extracted tree data.
MenuManipulatorSettingsForm::$menus	protected	property	The list of existing Menus (config entities).
MenuManipulatorSettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
MenuManipulatorSettingsForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
MenuManipulatorSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
MenuManipulatorSettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
MenuManipulatorSettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
MenuManipulatorSettingsForm::__construct	public	function	Constructs a MenuManipulatorSettingsForm object. Overrides ConfigFormBase::__construct
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
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.	4
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.