class ConfigTranslationDeleteForm

Same name in other branches
  1. 9 core/modules/config_translation/src/Form/ConfigTranslationDeleteForm.php \Drupal\config_translation\Form\ConfigTranslationDeleteForm
  2. 8.9.x core/modules/config_translation/src/Form/ConfigTranslationDeleteForm.php \Drupal\config_translation\Form\ConfigTranslationDeleteForm
  3. 10 core/modules/config_translation/src/Form/ConfigTranslationDeleteForm.php \Drupal\config_translation\Form\ConfigTranslationDeleteForm

Builds a form to delete configuration translation.

@internal

Hierarchy

Expanded class hierarchy of ConfigTranslationDeleteForm

File

core/modules/config_translation/src/Form/ConfigTranslationDeleteForm.php, line 21

Namespace

Drupal\config_translation\Form
View source
class ConfigTranslationDeleteForm extends ConfirmFormBase {
    
    /**
     * The language manager.
     *
     * @var \Drupal\language\ConfigurableLanguageManagerInterface
     */
    protected $languageManager;
    
    /**
     * The configuration mapper manager.
     *
     * @var \Drupal\config_translation\ConfigMapperManagerInterface
     */
    protected $configMapperManager;
    
    /**
     * The module handler.
     *
     * @var \Drupal\Core\Extension\ModuleHandlerInterface
     */
    protected $moduleHandler;
    
    /**
     * The configuration translation to be deleted.
     *
     * @var \Drupal\config_translation\ConfigMapperInterface
     */
    protected $mapper;
    
    /**
     * The language of configuration translation.
     *
     * @var \Drupal\Core\Language\LanguageInterface
     */
    protected $language;
    
    /**
     * Constructs a ConfigTranslationDeleteForm.
     *
     * @param \Drupal\language\ConfigurableLanguageManagerInterface $language_manager
     *   The language override configuration storage.
     * @param \Drupal\config_translation\ConfigMapperManagerInterface $config_mapper_manager
     *   The configuration mapper manager.
     * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
     *   The module handler.
     */
    public function __construct(ConfigurableLanguageManagerInterface $language_manager, ConfigMapperManagerInterface $config_mapper_manager, ModuleHandlerInterface $module_handler) {
        $this->languageManager = $language_manager;
        $this->configMapperManager = $config_mapper_manager;
        $this->moduleHandler = $module_handler;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('language_manager'), $container->get('plugin.manager.config_translation.mapper'), $container->get('module_handler'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function getQuestion() {
        return $this->t('Are you sure you want to delete the @language translation of %label?', [
            '%label' => $this->mapper
                ->getTitle(),
            '@language' => $this->language
                ->getName(),
        ]);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getConfirmText() {
        return $this->t('Delete');
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCancelUrl() {
        return new Url($this->mapper
            ->getOverviewRouteName(), $this->mapper
            ->getOverviewRouteParameters());
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'config_translation_delete_form';
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state, ?RouteMatchInterface $route_match = NULL, $plugin_id = NULL, $langcode = NULL) {
        
        /** @var \Drupal\config_translation\ConfigMapperInterface $mapper */
        $mapper = $this->configMapperManager
            ->createInstance($plugin_id);
        $mapper->populateFromRouteMatch($route_match);
        $language = $this->languageManager
            ->getLanguage($langcode);
        if (!$language) {
            throw new NotFoundHttpException();
        }
        $this->mapper = $mapper;
        $this->language = $language;
        return parent::buildForm($form, $form_state);
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        foreach ($this->mapper
            ->getConfigNames() as $name) {
            $this->languageManager
                ->getLanguageConfigOverride($this->language
                ->getId(), $name)
                ->delete();
        }
        // Flush all persistent caches.
        $this->moduleHandler
            ->invokeAll('cache_flush');
        foreach (Cache::getBins() as $cache_backend) {
            $cache_backend->deleteAll();
        }
        $this->messenger()
            ->addStatus($this->t('@language translation of %label was deleted', [
            '%label' => $this->mapper
                ->getTitle(),
            '@language' => $this->language
                ->getName(),
        ]));
        $form_state->setRedirectUrl($this->getCancelUrl());
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ConfigTranslationDeleteForm::$configMapperManager protected property The configuration mapper manager.
ConfigTranslationDeleteForm::$language protected property The language of configuration translation.
ConfigTranslationDeleteForm::$languageManager protected property The language manager.
ConfigTranslationDeleteForm::$mapper protected property The configuration translation to be deleted.
ConfigTranslationDeleteForm::$moduleHandler protected property The module handler.
ConfigTranslationDeleteForm::buildForm public function Form constructor. Overrides ConfirmFormBase::buildForm
ConfigTranslationDeleteForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
ConfigTranslationDeleteForm::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
ConfigTranslationDeleteForm::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
ConfigTranslationDeleteForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
ConfigTranslationDeleteForm::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
ConfigTranslationDeleteForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
ConfigTranslationDeleteForm::__construct public function Constructs a ConfigTranslationDeleteForm.
ConfirmFormBase::getCancelText public function Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface::getCancelText 2
ConfirmFormBase::getDescription public function Returns additional text to display as a description. Overrides ConfirmFormInterface::getDescription 17
ConfirmFormBase::getFormName public function Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface::getFormName
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. 2
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. 2
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.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.