class CommentTypeDeleteForm
Same name in other branches
- 9 core/modules/comment/src/Form/CommentTypeDeleteForm.php \Drupal\comment\Form\CommentTypeDeleteForm
- 10 core/modules/comment/src/Form/CommentTypeDeleteForm.php \Drupal\comment\Form\CommentTypeDeleteForm
- 11.x core/modules/comment/src/Form/CommentTypeDeleteForm.php \Drupal\comment\Form\CommentTypeDeleteForm
Provides a confirmation form for deleting a comment type entity.
@internal
Hierarchy
- class \Drupal\Core\Form\FormBase implements \Drupal\Core\Form\FormInterface, \Drupal\Core\DependencyInjection\ContainerInjectionInterface uses \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Routing\LinkGeneratorTrait, \Drupal\Core\Logger\LoggerChannelTrait, \Drupal\Core\Messenger\MessengerTrait, \Drupal\Core\Routing\RedirectDestinationTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\Routing\UrlGeneratorTrait
- class \Drupal\Core\Entity\EntityForm extends \Drupal\Core\Form\FormBase implements \Drupal\Core\Entity\EntityFormInterface
- class \Drupal\Core\Entity\EntityConfirmFormBase extends \Drupal\Core\Entity\EntityForm implements \Drupal\Core\Form\ConfirmFormInterface
- class \Drupal\Core\Entity\EntityDeleteForm extends \Drupal\Core\Entity\EntityConfirmFormBase uses \Drupal\Core\Entity\EntityDeleteFormTrait
- class \Drupal\comment\Form\CommentTypeDeleteForm extends \Drupal\Core\Entity\EntityDeleteForm
- class \Drupal\Core\Entity\EntityDeleteForm extends \Drupal\Core\Entity\EntityConfirmFormBase uses \Drupal\Core\Entity\EntityDeleteFormTrait
- class \Drupal\Core\Entity\EntityConfirmFormBase extends \Drupal\Core\Entity\EntityForm implements \Drupal\Core\Form\ConfirmFormInterface
- class \Drupal\Core\Entity\EntityForm extends \Drupal\Core\Form\FormBase implements \Drupal\Core\Entity\EntityFormInterface
Expanded class hierarchy of CommentTypeDeleteForm
File
-
core/
modules/ comment/ src/ Form/ CommentTypeDeleteForm.php, line 17
Namespace
Drupal\comment\FormView source
class CommentTypeDeleteForm extends EntityDeleteForm {
/**
* The comment manager service.
*
* @var \Drupal\comment\CommentManagerInterface
*/
protected $commentManager;
/**
* A logger instance.
*
* @var \Psr\Log\LoggerInterface
*/
protected $logger;
/**
* The entity being used by this form.
*
* @var \Drupal\comment\CommentTypeInterface
*/
protected $entity;
/**
* Constructs a query factory object.
*
* @param \Drupal\comment\CommentManagerInterface $comment_manager
* The comment manager service.
* @param \Psr\Log\LoggerInterface $logger
* A logger instance.
*/
public function __construct(CommentManagerInterface $comment_manager, LoggerInterface $logger) {
$this->commentManager = $comment_manager;
$this->logger = $logger;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container->get('comment.manager'), $container->get('logger.factory')
->get('comment'));
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state) {
$comments = $this->entityTypeManager
->getStorage('comment')
->getQuery()
->condition('comment_type', $this->entity
->id())
->execute();
$entity_type = $this->entity
->getTargetEntityTypeId();
$caption = '';
foreach (array_keys($this->commentManager
->getFields($entity_type)) as $field_name) {
/** @var \Drupal\field\FieldStorageConfigInterface $field_storage */
if (($field_storage = FieldStorageConfig::loadByName($entity_type, $field_name)) && $field_storage->getSetting('comment_type') == $this->entity
->id() && !$field_storage->isDeleted()) {
$caption .= '<p>' . $this->t('%label is used by the %field field on your site. You can not remove this comment type until you have removed the field.', [
'%label' => $this->entity
->label(),
'%field' => $field_storage->label(),
]) . '</p>';
}
}
if (!empty($comments)) {
$caption .= '<p>' . $this->formatPlural(count($comments), '%label is used by 1 comment on your site. You can not remove this comment type until you have removed all of the %label comments.', '%label is used by @count comments on your site. You may not remove %label until you have removed all of the %label comments.', [
'%label' => $this->entity
->label(),
]) . '</p>';
}
if ($caption) {
$form['description'] = [
'#markup' => $caption,
];
return $form;
}
else {
return parent::buildForm($form, $form_state);
}
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|---|
CommentTypeDeleteForm::$commentManager | protected | property | The comment manager service. | |||
CommentTypeDeleteForm::$entity | protected | property | The entity being used by this form. | Overrides EntityForm::$entity | ||
CommentTypeDeleteForm::$logger | protected | property | A logger instance. | |||
CommentTypeDeleteForm::buildForm | public | function | Form constructor. | Overrides EntityDeleteForm::buildForm | ||
CommentTypeDeleteForm::create | public static | function | Instantiates a new instance of this class. | Overrides FormBase::create | ||
CommentTypeDeleteForm::__construct | public | function | Constructs a query factory object. | |||
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. | |||
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 | |||
EntityConfirmFormBase::actions | protected | function | Returns an array of supported actions for the current entity form. | Overrides EntityForm::actions | 1 | |
EntityConfirmFormBase::delete | public | function | The delete() method is not used in EntityConfirmFormBase. This overrides the default implementation that redirects to the delete-form confirmation form. |
|||
EntityConfirmFormBase::getBaseFormId | public | function | Returns a string identifying the base form. | Overrides EntityForm::getBaseFormId | ||
EntityConfirmFormBase::getCancelText | public | function | Returns a caption for the link which cancels the action. | Overrides ConfirmFormInterface::getCancelText | ||
EntityConfirmFormBase::getDescription | public | function | Returns additional text to display as a description. | Overrides ConfirmFormInterface::getDescription | 10 | |
EntityConfirmFormBase::getFormName | public | function | Returns the internal name used to refer to the confirmation item. | Overrides ConfirmFormInterface::getFormName | ||
EntityConfirmFormBase::save | public | function | The save() method is not used in EntityConfirmFormBase. This overrides the default implementation that saves the entity. |
Overrides EntityForm::save | ||
EntityDeleteForm::getConfigManager | protected | function | Gets the configuration manager. | |||
EntityDeleteForm::getConfigNamesToDelete | protected | function | Returns config names to delete for the deletion confirmation form. | 1 | ||
EntityDeleteFormTrait::getCancelUrl | public | function | 3 | |||
EntityDeleteFormTrait::getConfirmText | public | function | 1 | |||
EntityDeleteFormTrait::getDeletionMessage | protected | function | Gets the message to display to the user after deleting the entity. | 3 | ||
EntityDeleteFormTrait::getEntity | abstract public | function | Gets the entity of this form. | |||
EntityDeleteFormTrait::getQuestion | public | function | 4 | |||
EntityDeleteFormTrait::getRedirectUrl | protected | function | Returns the URL where the user should be redirected after deletion. | 5 | ||
EntityDeleteFormTrait::logDeletionMessage | protected | function | Logs a message about the deleted entity. | 2 | ||
EntityDeleteFormTrait::logger | abstract protected | function | Gets the logger for a specific channel. | |||
EntityDeleteFormTrait::submitForm | public | function | 4 | |||
EntityForm::$entityTypeManager | protected | property | The entity type manager. | 3 | ||
EntityForm::$moduleHandler | protected | property | The module handler service. | |||
EntityForm::$operation | protected | property | The name of the current operation. | |||
EntityForm::$privateEntityManager | private | property | The entity manager. | |||
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::buildEntity | public | function | Builds an updated entity object based upon the submitted form values. | Overrides EntityFormInterface::buildEntity | 3 | |
EntityForm::copyFormValuesToEntity | protected | function | Copies top-level form values to entity properties | 9 | ||
EntityForm::form | public | function | Gets the actual form array to be built. | 36 | ||
EntityForm::getEntityFromRouteMatch | public | function | Determines which entity will be used by this form from a RouteMatch object. | Overrides EntityFormInterface::getEntityFromRouteMatch | 3 | |
EntityForm::getFormId | public | function | Returns a unique string identifying the form. | Overrides FormInterface::getFormId | 12 | |
EntityForm::getOperation | public | function | Gets the operation identifying the form. | Overrides EntityFormInterface::getOperation | ||
EntityForm::init | protected | function | Initialize the form state and the entity before the first form build. | 3 | ||
EntityForm::prepareEntity | protected | function | Prepares the entity object before the form is built first. | 3 | ||
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 | Sets the form entity. | Overrides EntityFormInterface::setEntity | ||
EntityForm::setEntityManager | public | function | Sets the entity manager for this form. | Overrides EntityFormInterface::setEntityManager | ||
EntityForm::setEntityTypeManager | public | function | Sets the entity type manager for this form. | Overrides EntityFormInterface::setEntityTypeManager | ||
EntityForm::setModuleHandler | public | function | Sets the module handler for this form. | Overrides EntityFormInterface::setModuleHandler | ||
EntityForm::setOperation | public | function | Sets the operation for this form. | Overrides EntityFormInterface::setOperation | ||
EntityForm::__get | public | function | ||||
EntityForm::__set | public | function | ||||
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. | |||
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. | 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 | 73 | |
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. | 17 | ||
MessengerTrait::messenger | public | function | Gets the messenger. | 17 | ||
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. | |||
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 | ||
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. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.