You are here

Home » API reference » Menu Breadcrumb 8 » SettingsForm.php

class SettingsForm in Menu Breadcrumb 8

Same name and namespace in other branches
  1. 2.0.x src/Form/SettingsForm.php \Drupal\menu_breadcrumb\Form\SettingsForm

Hierarchy

Expanded class hierarchy of SettingsForm

1 string reference to 'SettingsForm'
menu_breadcrumb.routing.yml in ./menu_breadcrumb.routing.yml
menu_breadcrumb.routing.yml

File

src/Form/SettingsForm.php, line 15

Namespace

Drupal\menu_breadcrumb\Form
View source 
class SettingsForm extends ConfigFormBase {

  /**
   * Services used by the form generator.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * SettingsForm constructor.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   Used to obtain configuration information.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $moduleHandler
   *   Used to determined whether the Menu UI module is installed.
   */
  public function __construct(ConfigFactoryInterface $config_factory, ModuleHandlerInterface $moduleHandler) {
    parent::__construct($config_factory);
    $this->moduleHandler = $moduleHandler;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('menu_breadcrumb.settings');
    $form['determine_menu'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable the Menu Breadcrumb module'),
      '#description' => $this
        ->t('Use menu the page belongs to, or the page for the taxonomy of which it is a member, for the breadcrumb. If unset, no breadcrumbs are generated or cached by this module and all settings below are ignored.'),
      '#default_value' => $config
        ->get('determine_menu'),
    ];
    $form['disable_admin_page'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Disable for admin pages'),
      '#description' => $this
        ->t('Do not build menu-based breadcrumbs for admin pages.'),
      '#default_value' => $config
        ->get('disable_admin_page'),
    ];
    $form['append_current_page'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Append current page to breadcrumb'),
      '#description' => $this
        ->t('If current page is on a menu, include it in the breadcrumb trail.'),
      '#default_value' => $config
        ->get('append_current_page'),
    ];
    $form['current_page_as_link'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Show current page as link'),
      '#description' => $this
        ->t('Set TRUE if the current page in the breadcrumb trail should be a link (otherwise it will be plain text).'),
      '#default_value' => $config
        ->get('current_page_as_link'),
      '#states' => [
        'visible' => [
          ':input[name="append_current_page"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['stop_on_first_match'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Stop on the first matching'),
      '#description' => $this
        ->t('End the breadcrumb trail when the first matching found in the menu.'),
      '#default_value' => $config
        ->get('stop_on_first_match'),
    ];
    $form['append_member_page'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Attach taxonomy member page to breadcrumb'),
      '#description' => $this
        ->t('This option affects breadcrumb display when the current page is a member of a taxonomy whose term is on a menu with "Taxonomy Attachment" selected, when it "attaches" to the menu-based breadcrumbs of that taxonomy term. In this case that term\'s menu title will show as a link regardless of the "current page" options above. Set this option TRUE to also show the current ("attached") <i>page</i> title as the final breadcrumb.'),
      '#default_value' => $config
        ->get('append_member_page'),
    ];
    $form['member_page_as_link'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Show attached current page as link'),
      '#description' => $this
        ->t('Set TRUE to show the attached final breadcrumb as a link (otherwise it will be plain text).'),
      '#default_value' => $config
        ->get('member_page_as_link'),
      '#states' => [
        'visible' => [
          ':input[name="append_member_page"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['remove_home'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Remove "Home" link'),
      '#default_value' => $config
        ->get('remove_home'),
      '#description' => $this
        ->t('Regardless of option settings, this module always checks if the first breadcrumb is also the &lt;front&gt; page. Without this option set, it will always replace the link for that node- or view- based path of the &lt;front&gt; page (e.g., /node/1 or /node) with a link to the site home. Set this option TRUE to <i>delete</i> the &lt;front&gt; breadcrumb rather than replacing it.'),
    ];
    $form['add_home'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Add "Home" link'),
      '#default_value' => $config
        ->get('add_home'),
      '#description' => $this
        ->t('If TRUE will add a link to the &lt;front&gt; page if it doesn\'t already begin the breadcrumb trail: ensuring that the first breadcrumb of every page is the site home. If both "add" and "remove" are set, when displaying the &lt;front&gt; page and its menu children the "remove" option will take precedence.'),
    ];
    $form['front_title'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Home title'),
      '#default_value' => $config
        ->get('front_title'),
      '#options' => [
        0 => $this
          ->t('Use "Home" as title'),
        1 => $this
          ->t('Uses the site name from the configuration settings: if this option is not set, a translated value for "Home" will be used.'),
        2 => $this
          ->t('Use title menu parent'),
      ],
    ];
    $form['exclude_empty_url'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Exclude menu items with empty URLs'),
      '#description' => $this
        ->t('If TRUE, menu items whose Link fields resolves to an empty string (like in the case "&lt;none&gt;" was used) will not be included in the breadcrumb trail.'),
      '#default_value' => $config
        ->get('exclude_empty_url'),
    ];
    $form['exclude_disabled_menu_items'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Exclude disabled menu items'),
      '#description' => $this
        ->t('If TRUE, menu items that are disabled will not be included in the breadcrumb trail.'),
      '#default_value' => $config
        ->get('exclude_disabled_menu_items'),
    ];
    $form['derived_active_trail'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Derive MenuActiveTrail from RouteMatch'),
      '#description' => $this
        ->t('If FALSE, the injected @menu.active_trail service will be used. If you have a multilingual site with unusually large menus, see <a target="_blank" href="https://www.drupal.org/project/menu_breadcrumb/issues/3083028">issue 3083028</a>.'),
      '#default_value' => $config
        ->get('derived_active_trail'),
    ];
    $form['include_exclude'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Enable / Disable Menus'),
      '#description' => $this
        ->t('<b>Order of operation:</b> The breadcrumb will be generated from the first match it finds: "Enabled" to look for the current item on the menu, then "Taxonomy Attachment" to look for its taxonomy term. Re-order the list to change the priority of each menu.<br><b>Language Handling:</b> If set, skip this menu when the defined menu language does not match the current content language: recommended setting when you use a separate menu per language. This has no effect on taxonomy attachment.'),
    ];
    $form['include_exclude']['note_about_navigation'] = [
      '#markup' => '<p class="description">' . $this
        ->t("Note: If none of the selected menus contain an item for a given page, Drupal will look in the 'Navigation' menu by default, even if it is 'disabled' here.") . '</p>',
    ];

    // Orderable list of menu selections.
    $form['include_exclude']['menu_breadcrumb_menus'] = [
      '#type' => 'table',
      '#header' => [
        $this
          ->t('Menu'),
        $this
          ->t('Enabled'),
        $this
          ->t('Taxonomy Attachment'),
        $this
          ->t('Language Handling'),
        $this
          ->t('Weight'),
      ],
      '#empty' => $this
        ->t('There are no menus yet.'),
      '#tabledrag' => [
        [
          'action' => 'order',
          'relationship' => 'sibling',
          'group' => 'menus-order-weight',
        ],
      ],
    ];
    foreach ($this
      ->getSortedMenus() as $menu_name => $menu_config) {
      $form['include_exclude']['menu_breadcrumb_menus'][$menu_name] = [
        '#attributes' => [
          'class' => [
            'draggable',
          ],
        ],
        '#weight' => $menu_config['weight'],
        'title' => [
          '#plain_text' => $menu_config['label'],
        ],
        'enabled' => [
          '#type' => 'checkbox',
          '#default_value' => $menu_config['enabled'],
        ],
        'taxattach' => [
          '#type' => 'checkbox',
          '#default_value' => $menu_config['taxattach'],
        ],
        'langhandle' => [
          '#type' => 'checkbox',
          '#default_value' => $menu_config['langhandle'],
        ],
        'weight' => [
          '#type' => 'weight',
          '#default_value' => $menu_config['weight'],
          '#attributes' => [
            'class' => [
              'menus-order-weight',
            ],
          ],
        ],
      ];
    }
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->config('menu_breadcrumb.settings')
      ->set('determine_menu', (bool) $form_state
      ->getValue('determine_menu'))
      ->set('disable_admin_page', (bool) $form_state
      ->getValue('disable_admin_page'))
      ->set('append_current_page', (bool) $form_state
      ->getValue('append_current_page'))
      ->set('current_page_as_link', (bool) $form_state
      ->getValue('current_page_as_link'))
      ->set('stop_on_first_match', (bool) $form_state
      ->getValue('stop_on_first_match'))
      ->set('append_member_page', (bool) $form_state
      ->getValue('append_member_page'))
      ->set('member_page_as_link', (bool) $form_state
      ->getValue('member_page_as_link'))
      ->set('front_title', $form_state
      ->getValue('front_title'))
      ->set('remove_home', (bool) $form_state
      ->getValue('remove_home'))
      ->set('add_home', (bool) $form_state
      ->getValue('add_home'))
      ->set('menu_breadcrumb_menus', $form_state
      ->getValue('menu_breadcrumb_menus'))
      ->set('exclude_empty_url', $form_state
      ->getValue('exclude_empty_url'))
      ->set('exclude_disabled_menu_items', $form_state
      ->getValue('exclude_disabled_menu_items'))
      ->set('derived_active_trail', $form_state
      ->getValue('derived_active_trail'))
      ->save();
    parent::submitForm($form, $form_state);
  }

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

  /**
   * Get Sorted Menus.
   *
   * Returns array of menus with properties (enabled, taxattach, langhandle,
   * weight, label) sorted by weight, initializing those properties if needed.
   */
  protected function getSortedMenus() {
    $menu_enabled = $this->moduleHandler
      ->moduleExists('menu_ui');
    $menus = $menu_enabled ? menu_ui_get_menus() : menu_list_system_menus();
    $menu_breadcrumb_menus = $this
      ->config('menu_breadcrumb.settings')
      ->get('menu_breadcrumb_menus');
    foreach ($menus as $menu_name => &$menu) {
      if (!empty($menu_breadcrumb_menus[$menu_name])) {
        $menu = $menu_breadcrumb_menus[$menu_name] + [
          'label' => $menu,
        ];

        // Earlier versions of the module might not have these array keys set.
        // TODO Maybe set these for existing menu definitions in upgrade script?
        if (!isset($menu['taxattach'])) {
          $menu['taxattach'] = 0;
        }
        if (!isset($menu['langhandle'])) {
          $menu['langhandle'] = 0;
        }
      }
      else {
        $menu = [
          'weight' => 0,
          'enabled' => 0,
          'taxattach' => 0,
          'langhandle' => 0,
          'label' => $menu,
        ];
      }
    }
    uasort($menus, function ($a, $b) {
      return SortArray::sortByWeightElement($a, $b);
    });
    return $menus;
  }

}

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.
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.
SettingsForm::$moduleHandler protected property Services used by the form generator.
SettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
SettingsForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
SettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
SettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
SettingsForm::getSortedMenus protected function Get Sorted Menus.
SettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
SettingsForm::__construct public function SettingsForm constructor. Overrides ConfigFormBase::__construct
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.