class DeleteForm

Same name and namespace in other branches
  1. 11.x core/modules/comment/src/Form/DeleteForm.php \Drupal\comment\Form\DeleteForm
  2. 10 core/modules/forum/src/Form/DeleteForm.php \Drupal\forum\Form\DeleteForm
  3. 10 core/modules/comment/src/Form/DeleteForm.php \Drupal\comment\Form\DeleteForm
  4. 9 core/modules/forum/src/Form/DeleteForm.php \Drupal\forum\Form\DeleteForm
  5. 9 core/modules/comment/src/Form/DeleteForm.php \Drupal\comment\Form\DeleteForm
  6. 8.9.x core/modules/forum/src/Form/DeleteForm.php \Drupal\forum\Form\DeleteForm
  7. 8.9.x core/modules/comment/src/Form/DeleteForm.php \Drupal\comment\Form\DeleteForm

Provides the comment delete confirmation form.

@internal

Hierarchy

Expanded class hierarchy of DeleteForm

1 file declares its use of DeleteForm
Comment.php in core/modules/comment/src/Entity/Comment.php

File

core/modules/comment/src/Form/DeleteForm.php, line 12

Namespace

Drupal\comment\Form
View source
class DeleteForm extends ContentEntityDeleteForm {
  
  /**
   * {@inheritdoc}
   */
  public function getCancelUrl() {
    // Point to the entity of which this comment is a reply.
    return $this->entity
      ->get('entity_id')->entity
      ->toUrl();
  }
  
  /**
   * {@inheritdoc}
   */
  protected function getRedirectUrl() {
    return $this->getCancelUrl();
  }
  
  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    return $this->t('Any replies to this comment will be lost. This action cannot be undone.');
  }
  
  /**
   * {@inheritdoc}
   */
  protected function getDeletionMessage() {
    return $this->t('The comment and all its replies have been deleted.');
  }
  
  /**
   * {@inheritdoc}
   */
  public function logDeletionMessage() {
    $this->logger('comment')
      ->info('Deleted comment @cid and its replies.', [
      '@cid' => $this->entity
        ->id(),
    ]);
  }

}

Members

Title Sort descending Modifiers Object type Summary Member alias Overriden Title
ConfigDependencyDeleteFormTrait::addDependencyListsToForm protected function Adds form elements to list affected configuration entities.
ConfigDependencyDeleteFormTrait::t abstract protected function Translates a string to the current language or to a given language.
ContentEntityConfirmFormBase::actions protected function
ContentEntityConfirmFormBase::delete public function The delete() method is not used in ContentEntityConfirmFormBase. This
overrides the default implementation that redirects to the delete-form
confirmation form.
ContentEntityConfirmFormBase::form public function
ContentEntityConfirmFormBase::getBaseFormId public function
ContentEntityConfirmFormBase::getCancelText public function
ContentEntityConfirmFormBase::getFormName public function
ContentEntityConfirmFormBase::save public function The save() method is not used in ContentEntityConfirmFormBase. This
overrides the default implementation that saves the entity.
ContentEntityConfirmFormBase::validateForm public function
ContentEntityDeleteForm::buildForm public function
ContentEntityDeleteForm::getQuestion public function
ContentEntityDeleteForm::submitForm public function
ContentEntityForm::$entity protected property The entity being used by this form.
ContentEntityForm::$entityRepository protected property The entity repository service.
ContentEntityForm::$entityTypeBundleInfo protected property The entity type bundle info service.
ContentEntityForm::$time protected property The time service.
ContentEntityForm::addRevisionableFormFields protected function Add revision form fields if the entity enabled the UI.
ContentEntityForm::buildEntity public function
ContentEntityForm::copyFormValuesToEntity protected function
ContentEntityForm::create public static function
ContentEntityForm::flagViolations protected function Flags violations for the current form.
ContentEntityForm::getBundleEntity protected function Returns the bundle entity of the entity, or NULL if there is none.
ContentEntityForm::getEditedFieldNames protected function Gets the names of all fields edited in the form.
ContentEntityForm::getFormDisplay public function
ContentEntityForm::getFormLangcode public function
ContentEntityForm::getNewRevisionDefault protected function Should new revisions created on default.
ContentEntityForm::init protected function Initializes the form state and the entity before the first form build.
ContentEntityForm::initFormLangcodes protected function Initializes form language code values.
ContentEntityForm::isDefaultFormLangcode public function
ContentEntityForm::prepareEntity protected function
ContentEntityForm::setFormDisplay public function
ContentEntityForm::showRevisionUi protected function Checks whether the revision form fields should be added to the form.
ContentEntityForm::updateChangedTime public function Updates the changed time of the entity.
ContentEntityForm::updateFormLangcode public function Updates the form language to reflect any change to the entity language.
ContentEntityForm::__construct public function Constructs a ContentEntityForm object.
DeleteForm::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ContentEntityDeleteForm::getCancelUrl
DeleteForm::getDeletionMessage protected function Overrides ContentEntityDeleteForm::getDeletionMessage
DeleteForm::getDescription public function Returns additional text to display as a description. Overrides ContentEntityConfirmFormBase::getDescription
DeleteForm::getRedirectUrl protected function Returns the URL where the user should be redirected after deletion. Overrides EntityDeleteFormTrait::getRedirectUrl
DeleteForm::logDeletionMessage public function Overrides ContentEntityDeleteForm::logDeletionMessage
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
DependencySerializationTrait::__wakeup public function
EntityDeleteFormTrait::getCancelUrl public function Aliased as: traitGetCancelUrl
EntityDeleteFormTrait::getConfirmText public function
EntityDeleteFormTrait::getDeletionMessage protected function Gets the message to display to the user after deleting the entity. Aliased as: traitGetDeletionMessage
EntityDeleteFormTrait::getEntity abstract public function Gets the entity of this form.
EntityDeleteFormTrait::getQuestion public function Aliased as: traitGetQuestion
EntityDeleteFormTrait::logDeletionMessage protected function Logs a message about the deleted entity. Aliased as: traitLogDeletionMessage
EntityDeleteFormTrait::logger abstract protected function Gets the logger for a specific channel.
EntityForm::$entityTypeManager protected property The entity type manager.
EntityForm::$moduleHandler protected property The module handler service.
EntityForm::$operation protected property The name of the current operation.
EntityForm::actionsElement protected function Returns the action form element for the current entity form.
EntityForm::afterBuild public function Form element #after_build callback: Updates the entity with submitted data.
EntityForm::getCallableFromDefinition protected function Gets a callable from a string or array definition if possible.
EntityForm::getEntityFromRouteMatch public function
EntityForm::getFormId public function
EntityForm::getOperation public function
EntityForm::prepareInvokeAll protected function Invokes the specified prepare hook variant.
EntityForm::processForm public function Process callback: assigns weights and hides extra fields.
EntityForm::setEntity public function
EntityForm::setEntityTypeManager public function
EntityForm::setModuleHandler public function
EntityForm::setOperation public function
FormBase::$configFactory protected property The config factory.
FormBase::$requestStack protected property The request stack.
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.
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::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.
HtmxRequestInfoTrait::getHtmxCurrentUrl protected function Retrieves the URL of the requesting page from an HTMX request header.
HtmxRequestInfoTrait::getHtmxPrompt protected function Retrieves the prompt from an HTMX request header.
HtmxRequestInfoTrait::getHtmxTarget protected function Retrieves the target identifier from an HTMX request header.
HtmxRequestInfoTrait::getHtmxTrigger protected function Retrieves the trigger identifier from an HTMX request header.
HtmxRequestInfoTrait::getHtmxTriggerName protected function Retrieves the trigger name from an HTMX request header.
HtmxRequestInfoTrait::isHtmxBoosted protected function Determines if the request is boosted by HTMX.
HtmxRequestInfoTrait::isHtmxHistoryRestoration protected function Determines if if the request is for history restoration.
HtmxRequestInfoTrait::isHtmxRequest protected function Determines if the request is sent by HTMX.
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.
MessengerTrait::messenger public function Gets the messenger.
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service.
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.
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.

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