class ConfigDeleteForm

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

Edit config variable form.

Hierarchy

Expanded class hierarchy of ConfigDeleteForm

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

File

src/Form/ConfigDeleteForm.php, line 16

Namespace

Drupal\devel\Form
View source
class ConfigDeleteForm extends FormBase implements ConfirmFormInterface {
    
    /**
     * Logger service.
     */
    protected LoggerInterface $logger;
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) : static {
        $instance = parent::create($container);
        $instance->messenger = $container->get('messenger');
        $instance->logger = $container->get('logger.channel.devel');
        $instance->configFactory = $container->get('config.factory');
        $instance->requestStack = $container->get('request_stack');
        $instance->stringTranslation = $container->get('string_translation');
        return $instance;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() : string {
        return 'devel_config_system_delete_form';
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state, $config_name = '') : array {
        $config = $this->configFactory
            ->get($config_name);
        if ($config->isNew()) {
            $this->messenger
                ->addError($this->t('Config @name does not exist in the system.', [
                '@name' => $config_name,
            ]));
            return $form;
        }
        $form['#title'] = $this->getQuestion();
        $form['#attributes']['class'][] = 'confirmation';
        $form['description'] = [
            '#markup' => $this->getDescription(),
        ];
        $form[$this->getFormName()] = [
            '#type' => 'hidden',
            '#value' => 1,
        ];
        // By default, render the form using theme_confirm_form().
        if (!isset($form['#theme'])) {
            $form['#theme'] = 'confirm_form';
        }
        $form['name'] = [
            '#type' => 'value',
            '#value' => $config_name,
        ];
        $form['actions'] = [
            '#type' => 'actions',
        ];
        $form['actions']['submit'] = [
            '#type' => 'submit',
            '#value' => $this->getConfirmText(),
            '#submit' => [
                function (array &$form, FormStateInterface $form_state) : void {
                    $this->submitForm($form, $form_state);
                },
            ],
        ];
        $form['actions']['cancel'] = ConfirmFormHelper::buildCancelLink($this, $this->requestStack
            ->getCurrentRequest());
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) : void {
        $config_name = $form_state->getValue('name');
        try {
            $this->configFactory
                ->getEditable($config_name)
                ->delete();
            $this->messenger
                ->addStatus($this->t('Configuration variable %variable was successfully deleted.', [
                '%variable' => $config_name,
            ]));
            $this->logger
                ->info('Configuration variable %variable was successfully deleted.', [
                '%variable' => $config_name,
            ]);
            $form_state->setRedirectUrl($this->getCancelUrl());
        } catch (\Exception $e) {
            $this->messenger
                ->addError($e->getMessage());
            $this->logger
                ->error('Error deleting configuration variable %variable : %error.', [
                '%variable' => $config_name,
                '%error' => $e->getMessage(),
            ]);
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCancelUrl() {
        return Url::fromRoute('devel.configs_list');
    }
    
    /**
     * {@inheritdoc}
     */
    public function getQuestion() {
        return $this->t('Are you sure you want to delete this configuration?');
    }
    
    /**
     * {@inheritdoc}
     */
    public function getDescription() {
        return $this->t('This action cannot be undone.');
    }
    
    /**
     * {@inheritdoc}
     */
    public function getConfirmText() {
        return $this->t('Confirm');
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCancelText() {
        return $this->t('Cancel');
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFormName() : string {
        return 'confirm';
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ConfigDeleteForm::$logger protected property Logger service.
ConfigDeleteForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
ConfigDeleteForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
ConfigDeleteForm::getCancelText public function Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface::getCancelText
ConfigDeleteForm::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
ConfigDeleteForm::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormInterface::getConfirmText
ConfigDeleteForm::getDescription public function Returns additional text to display as a description. Overrides ConfirmFormInterface::getDescription
ConfigDeleteForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
ConfigDeleteForm::getFormName public function Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface::getFormName
ConfigDeleteForm::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
ConfigDeleteForm::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 Form validation handler. 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.