You are here

Home » API reference » Menu Trail By Path 8 » MenuTrailByPathSettingsForm.php

class MenuTrailByPathSettingsForm in Menu Trail By Path 8

Configures menu trail by path settings for this site.

Hierarchy

Expanded class hierarchy of MenuTrailByPathSettingsForm

1 file declares its use of MenuTrailByPathSettingsForm
menu_trail_by_path.module in ./menu_trail_by_path.module
Expand menu items and set active-trail according to current path.
1 string reference to 'MenuTrailByPathSettingsForm'
menu_trail_by_path.routing.yml in ./menu_trail_by_path.routing.yml
menu_trail_by_path.routing.yml

File

src/Form/MenuTrailByPathSettingsForm.php, line 12

Namespace

Drupal\menu_trail_by_path\Form
View source 
class MenuTrailByPathSettingsForm extends ConfigFormBase {

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

  /**
   * Returns an array of trail source options.
   *
   * @return string[]
   *   An array of trail source options.
   */
  public static function getTrailSourceOptions() {
    return [
      MenuTrailByPathActiveTrail::MENU_TRAIL_PATH => t('By Path'),
      MenuTrailByPathActiveTrail::MENU_TRAIL_CORE => t('Drupal Core Behavior'),
      MenuTrailByPathActiveTrail::MENU_TRAIL_DISABLED => t('Disabled'),
    ];
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('menu_trail_by_path.settings');
    $form['max_path_parts'] = [
      '#type' => 'number',
      '#min' => 0,
      '#size' => 30,
      '#title' => $this
        ->t('Maximum path parts'),
      '#default_value' => $config
        ->get('max_path_parts'),
      '#description' => $this
        ->t('Configures how deep the module should go when resolving active trail links. Setting this value to zero will not limit the number of the path parts. It is recommended to configure the path parts and enabled menu to only those that require it, to avoid unnecessary performance overhead. The path setting only applies when using the by path option.'),
    ];
    $form['trail_source'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Trail Source'),
      '#description' => $this
        ->t('Configures the global behavior for the trail source. The trail source default can be overriden for each menu in the menu settings.'),
      '#options' => static::getTrailSourceOptions(),
      '#default_value' => $config
        ->get('trail_source'),
    ];
    $form['trail_source'][MenuTrailByPathActiveTrail::MENU_TRAIL_PATH]['#description'] = t('Attempt to find a matching parent menu link based on the path structure. Slower, especially with a large amount of paths parts to consider.');
    $form['trail_source'][MenuTrailByPathActiveTrail::MENU_TRAIL_CORE]['#description'] = t('Active trail only for pages that have a menu link pointing to them, same as when not using this module.');
    $form['trail_source'][MenuTrailByPathActiveTrail::MENU_TRAIL_DISABLED]['#description'] = t('No active trail at all. No performance overhead, useful for special/footer menus.');
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $config = $this
      ->config('menu_trail_by_path.settings');
    $config
      ->set('max_path_parts', (int) $form_state
      ->getValue('max_path_parts'));
    $config
      ->set('trail_source', $form_state
      ->getValue('trail_source'));
    $config
      ->save();
  }

}

Members

Namesort descending 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.
MenuTrailByPathSettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
MenuTrailByPathSettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
MenuTrailByPathSettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
MenuTrailByPathSettingsForm::getTrailSourceOptions public static function Returns an array of trail source options.
MenuTrailByPathSettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
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.