class ToolbarSettingsForm

Same name in other branches
  1. 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 14

Namespace

Drupal\devel\Form
View source
class ToolbarSettingsForm extends ConfigFormBase {
    
    /**
     * The menu link tree service.
     */
    protected MenuLinkTreeInterface $menuLinkTree;
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) : static {
        $instance = parent::create($container);
        $instance->menuLinkTree = $container->get('menu.link_tree');
        $instance->stringTranslation = $container->get('string_translation');
        return $instance;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() : string {
        return 'devel_toolbar_settings_form';
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getEditableConfigNames() : array {
        return [
            'devel.toolbar.settings',
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state) {
        $config = $this->configFactory
            ->getEditable('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) : void {
        $values = $form_state->getValues();
        $toolbar_items = array_keys(array_filter($values['toolbar_items']));
        $this->configFactory
            ->getEditable('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() : array {
        $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

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ConfigFormBase::CONFIG_KEY_TO_FORM_ELEMENT_MAP protected constant The $form_state key which stores a map of config keys to form elements.
ConfigFormBase::copyFormValuesToConfig private static function Copies form values to Config keys.
ConfigFormBase::doStoreConfigMap protected function Helper method for #after_build callback ::storeConfigKeyToFormElementMap().
ConfigFormBase::formatMultipleViolationsMessage protected function Formats multiple violation messages associated with a single form element. 1
ConfigFormBase::loadDefaultValuesFromConfig public function Process callback to recursively load default values from #config_target.
ConfigFormBase::storeConfigKeyToFormElementMap public function #after_build callback which stores a map of element names to config keys.
ConfigFormBase::typedConfigManager protected function Returns the typed config manager service.
ConfigFormBase::validateForm public function Form validation handler. Overrides FormBase::validateForm 13
ConfigFormBase::__construct public function Constructs a \Drupal\system\ConfigFormBase object. 17
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
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. 2
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.
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. 16
MessengerTrait::messenger public function Gets the messenger. 16
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 2
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. 3
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