class ConfigDeleteForm in Config Delete 8

Provides a form for deleting a single configuration file.

@internal

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\config\Form\ConfigSingleExportForm uses DeprecatedServicePropertyTrait
    • class \Drupal\config_delete\Form\ConfigDeleteForm

1 string reference to 'ConfigDeleteForm'

config_delete.routing.yml in ./config_delete.routing.yml

config_delete.routing.yml

File

src/Form/ConfigDeleteForm.php, line 13

Namespace

Drupal\config_delete\Form

class ConfigDeleteForm extends ConfigSingleExportForm {

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

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $config_name = $form_state
      ->getValue('config_name');
    if (empty($config_name)) {
      $form_state
        ->setErrorByName('config_name', $this
        ->t('Please select a valid configuration name.'));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config_type = $form_state
      ->getValue('config_type');
    $config_name = $form_state
      ->getValue('config_name');
    if ($form_state
      ->getValue('config_type') !== 'system.simple') {
      $definition = $this->entityTypeManager
        ->getDefinition($config_type);
      $name = $definition
        ->getConfigPrefix() . '.' . $config_name;
    }
    else {
      $name = $config_name;
    }
    $message = $this
      ->t('Configuration "@config_name" successfully deleted.', [
      '@config_name' => $name,
    ]);
    if ($form_state
      ->getValue('delete_dependencies')) {
      $dependencies = \Drupal::configFactory()
        ->get($name)
        ->get('dependencies');
      if (isset($dependencies['config'])) {
        foreach ($dependencies['config'] as $config_name) {
          $this
            ->deleteConfig($config_name);
        }
        $message = $this
          ->t('Configuration "@config_name" and all its dependencies successfully deleted.', [
          '@config_name' => $name,
        ]);
      }
    }
    $this
      ->deleteConfig($name);
    \Drupal::messenger()
      ->addStatus($message);
  }

  /**
   * Deletes the configuration object.
   *
   * @param string $name
   *   The configuration name.
   */
  protected function deleteConfig($name) {
    \Drupal::configFactory()
      ->getEditable($name)
      ->delete();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigDeleteForm::deleteConfig	protected	function	Deletes the configuration object.
ConfigDeleteForm::getFormId	public	function	Returns a unique string identifying the form. Overrides ConfigSingleExportForm::getFormId
ConfigDeleteForm::submitForm	public	function	Form submission handler. Overrides ConfigSingleExportForm::submitForm
ConfigDeleteForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
ConfigSingleExportForm::$configStorage	protected	property	The config storage.
ConfigSingleExportForm::$definitions	protected	property	Tracks the valid config entity type definitions.
ConfigSingleExportForm::$deprecatedProperties	protected	property
ConfigSingleExportForm::$entityTypeManager	protected	property	The entity type manager.
ConfigSingleExportForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
ConfigSingleExportForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
ConfigSingleExportForm::findConfiguration	protected	function	Handles switching the configuration type selector.
ConfigSingleExportForm::updateConfigurationType	public	function	Handles switching the configuration type selector.
ConfigSingleExportForm::updateExport	public	function	Handles switching the export textarea.
ConfigSingleExportForm::__construct	public	function	Constructs a new ConfigSingleImportForm.
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
DeprecatedServicePropertyTrait::__get	public	function	Allows to access deprecated/removed properties.
FormBase::$configFactory	protected	property	The config factory.	1
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.	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.
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.
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.