You are here

Home » API reference » Menu Manipulator 8 » MenuManipulatorSettingsForm.php

class MenuManipulatorSettingsForm in Menu Manipulator 8

Same name and namespace in other branches
  1. 8.2 src/Form/MenuManipulatorSettingsForm.php \Drupal\menu_manipulator\Form\MenuManipulatorSettingsForm
  2. 3.0.x src/Form/MenuManipulatorSettingsForm.php \Drupal\menu_manipulator\Form\MenuManipulatorSettingsForm
  3. 2.0.x src/Form/MenuManipulatorSettingsForm.php \Drupal\menu_manipulator\Form\MenuManipulatorSettingsForm

Configure custom settings for Menu Manipulators.

Hierarchy

Expanded class hierarchy of MenuManipulatorSettingsForm

1 string reference to 'MenuManipulatorSettingsForm'
menu_manipulator.routing.yml in ./menu_manipulator.routing.yml
menu_manipulator.routing.yml

File

src/Form/MenuManipulatorSettingsForm.php, line 16

Namespace

Drupal\menu_manipulator\Form
View source 
class MenuManipulatorSettingsForm extends ConfigFormBase {
  use StringTranslationTrait;

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

  /**
   * {@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\Config\Entity\ConfigEntityStorage $menu_storage
   *   The menu storage service.
   * @param \Drupal\language\ConfigurableLanguageManagerInterface $language_manager
   *   The language manager handler.
   */
  public function __construct(ConfigFactoryInterface $config_factory, ConfigEntityStorage $menu_storage, ConfigurableLanguageManagerInterface $language_manager) {
    parent::__construct($config_factory);
    $this->configFactory = $config_factory;
    $this->menus = $menu_storage
      ->loadMultiple();
    $this->languageManager = $language_manager;
  }

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

  /**
   * {@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->configFactory
      ->getEditable('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);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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.
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. 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.