class FileManagementDeleteFileConfirmForm in File Management 8

Defines a confirmation form for deleting mymodule data.

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\Core\Form\ConfirmFormBase implements ConfirmFormInterface
    • class \Drupal\file_management\Form\FileManagementDeleteFileConfirmForm

File

src/Form/FileManagementDeleteFileConfirmForm.php, line 12

Namespace

Drupal\file_management\Form

class FileManagementDeleteFileConfirmForm extends ConfirmFormBase {

  /**
   * The file to be deleted.
   *
   * @var \Drupal\file\FileInterface
   */
  protected $file;

  /**
   * The ID of the item to delete.
   *
   * @var String
   */
  protected $id;

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

  /**
   * {@inheritdoc}
   */
  public function getQuestion() {
    return t('Do you want to delete the file "%label" ?', [
      '%label' => $this->file
        ->label(),
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function getCancelUrl() {
    $route_overview = 'file_management_view.overview';
    $route_provider = \Drupal::service('router.route_provider');
    if (count($route_provider
      ->getRoutesByNames([
      $route_overview,
    ])) === 1) {
      return new Url($route_overview);
    }

    // Fallback to the standard files view if File Management View was not used.
    return Url::fromRoute('view.files.page_1');
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    return t('This could break some pages and media entities if they use this file.');
  }

  /**
   * {@inheritdoc}
   */
  public function getConfirmText() {
    return t('Yes.');
  }

  /**
   * {@inheritdoc}
   */
  public function getCancelText() {
    return t('No, go back.');
  }

  /**
   * {@inheritdoc}
   *
   * @param \Drupal\file\FileInterface $file
   *   (optional) The file to be deleted.
   */
  public function buildForm(array $form, FormStateInterface $form_state, $file = NULL) {
    $this->file = $file;
    $this->id = $file
      ->id();
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    if (file_exists($this->file
      ->getFileUri())) {
      $this->file
        ->delete();
      \Drupal::messenger()
        ->addMessage(t('File "%label" has been deleted.', [
        '%label' => $this->file
          ->label(),
      ]), 'status');
    }
    else {
      \Drupal::messenger()
        ->addMessage(t('File "%label" could not be deleted.', [
        '%label' => $this->file
          ->label(),
      ]), 'error');
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfirmFormBase::getFormName	public	function	Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface::getFormName
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
FileManagementDeleteFileConfirmForm::$file	protected	property	The file to be deleted.
FileManagementDeleteFileConfirmForm::$id	protected	property	The ID of the item to delete.
FileManagementDeleteFileConfirmForm::buildForm	public	function	Overrides ConfirmFormBase::buildForm
FileManagementDeleteFileConfirmForm::getCancelText	public	function	Returns a caption for the link which cancels the action. Overrides ConfirmFormBase::getCancelText
FileManagementDeleteFileConfirmForm::getCancelUrl	public	function	Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
FileManagementDeleteFileConfirmForm::getConfirmText	public	function	Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
FileManagementDeleteFileConfirmForm::getDescription	public	function	Returns additional text to display as a description. Overrides ConfirmFormBase::getDescription
FileManagementDeleteFileConfirmForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
FileManagementDeleteFileConfirmForm::getQuestion	public	function	Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
FileManagementDeleteFileConfirmForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
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::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create	87
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.
FormBase::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm	62
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.