You are here

class ToolbarSettingsForm in Devel 8.3

Same name and namespace in other branches
  1. 8 src/Form/ToolbarSettingsForm.php \Drupal\devel\Form\ToolbarSettingsForm
  2. 8.2 src/Form/ToolbarSettingsForm.php \Drupal\devel\Form\ToolbarSettingsForm
  3. 4.x src/Form/ToolbarSettingsForm.php \Drupal\devel\Form\ToolbarSettingsForm

Configures devel toolbar settings.

Hierarchy

Expanded class hierarchy of ToolbarSettingsForm

1 string reference to 'ToolbarSettingsForm'
devel.routing.yml in ./devel.routing.yml
devel.routing.yml

File

src/Form/ToolbarSettingsForm.php, line 15

Namespace

Drupal\devel\Form
View source
class ToolbarSettingsForm extends ConfigFormBase {

  /**
   * The menu link tree service.
   *
   * @var \Drupal\Core\Menu\MenuLinkTree
   */
  protected $menuLinkTree;

  /**
   * ToolbarSettingsForm constructor.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory.
   * @param \Drupal\Core\Menu\MenuLinkTreeInterface $menu_link_tree
   *   The menu link tree service.
   */
  public function __construct(ConfigFactoryInterface $config_factory, MenuLinkTreeInterface $menu_link_tree) {
    parent::__construct($config_factory);
    $this->menuLinkTree = $menu_link_tree;
  }

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

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('devel.toolbar.settings');
    $form['toolbar_items'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Menu items always visible'),
      '#options' => $this
        ->getLinkLabels(),
      '#default_value' => $config
        ->get('toolbar_items') ?: [],
      '#required' => TRUE,
      '#description' => $this
        ->t('Select the menu items always visible in devel toolbar tray. All the items not selected in this list will be visible only when the toolbar orientation is vertical.'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $values = $form_state
      ->getValues();
    $toolbar_items = array_keys(array_filter($values['toolbar_items']));
    $this
      ->config('devel.toolbar.settings')
      ->set('toolbar_items', $toolbar_items)
      ->save();
    parent::submitForm($form, $form_state);
  }

  /**
   * Provides an array of available menu items.
   *
   * @return array
   *   Associative array of devel menu item labels keyed by plugin ID.
   */
  protected function getLinkLabels() {
    $options = [];
    $parameters = new MenuTreeParameters();
    $parameters
      ->onlyEnabledLinks()
      ->setTopLevelOnly();
    $tree = $this->menuLinkTree
      ->load('devel', $parameters);
    foreach ($tree as $element) {
      $link = $element->link;
      $options[$link
        ->getPluginId()] = $link
        ->getTitle();
    }
    asort($options);
    return $options;
  }

}

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.
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.
ToolbarSettingsForm::$menuLinkTree protected property The menu link tree service.
ToolbarSettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
ToolbarSettingsForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
ToolbarSettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
ToolbarSettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
ToolbarSettingsForm::getLinkLabels protected function Provides an array of available menu items.
ToolbarSettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
ToolbarSettingsForm::__construct public function ToolbarSettingsForm constructor. Overrides ConfigFormBase::__construct
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.