class ConfigsList

Same name in other branches
  1. 4.x src/Form/ConfigsList.php \Drupal\devel\Form\ConfigsList

Form that displays all the config variables to edit them.

Hierarchy

Expanded class hierarchy of ConfigsList

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

File

src/Form/ConfigsList.php, line 14

Namespace

Drupal\devel\Form
View source
class ConfigsList extends FormBase {
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) : static {
        $instance = parent::create($container);
        $instance->configFactory = $container->get('config.factory');
        $instance->redirectDestination = $container->get('redirect.destination');
        $instance->stringTranslation = $container->get('string_translation');
        return $instance;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() : string {
        return 'devel_config_system_form';
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state, $filter = '') : array {
        $form['filter'] = [
            '#type' => 'details',
            '#title' => $this->t('Filter variables'),
            '#attributes' => [
                'class' => [
                    'container-inline',
                ],
            ],
            '#open' => isset($filter) && trim($filter) !== '',
        ];
        $form['filter']['name'] = [
            '#type' => 'textfield',
            '#title' => $this->t('Variable name'),
            '#title_display' => 'invisible',
            '#default_value' => $filter,
        ];
        $form['filter']['actions'] = [
            '#type' => 'actions',
        ];
        $form['filter']['actions']['show'] = [
            '#type' => 'submit',
            '#value' => $this->t('Filter'),
        ];
        $header = [
            'name' => [
                'data' => $this->t('Name'),
            ],
            'edit' => [
                'data' => $this->t('Operations'),
            ],
        ];
        $rows = [];
        $destination = $this->redirectDestination
            ->getAsArray();
        // List all the variables filtered if any filter was provided.
        $names = $this->configFactory
            ->listAll($filter);
        foreach ($names as $config_name) {
            $operations['edit'] = [
                'title' => $this->t('Edit'),
                'url' => Url::fromRoute('devel.config_edit', [
                    'config_name' => $config_name,
                ]),
                'query' => $destination,
            ];
            $rows[] = [
                'name' => $config_name,
                'operation' => [
                    'data' => [
                        '#type' => 'operations',
                        '#links' => $operations,
                    ],
                ],
            ];
        }
        $form['variables'] = [
            '#type' => 'table',
            '#header' => $header,
            '#rows' => $rows,
            '#empty' => $this->t('No variables found'),
        ];
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) : void {
        $filter = $form_state->getValue('name');
        $form_state->setRedirectUrl(Url::FromRoute('devel.configs_list', [
            'filter' => Html::escape($filter),
        ]));
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ConfigsList::buildForm public function Form constructor. Overrides FormInterface::buildForm
ConfigsList::create public static function Instantiates a new instance of this class. Overrides FormBase::create
ConfigsList::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
ConfigsList::submitForm public function Form submission handler. Overrides FormInterface::submitForm
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::config protected function Retrieves a configuration object.
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.
FormBase::validateForm public function Overrides FormInterface::validateForm 57
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.