class CommentTypeDeleteForm in Drupal 9
Same name and namespace in other branches
- 8 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 ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
- class \Drupal\Core\Entity\EntityForm implements EntityFormInterface
- class \Drupal\Core\Entity\EntityConfirmFormBase implements ConfirmFormInterface
- class \Drupal\Core\Entity\EntityDeleteForm uses EntityDeleteFormTrait
- class \Drupal\comment\Form\CommentTypeDeleteForm
- class \Drupal\Core\Entity\EntityDeleteForm uses EntityDeleteFormTrait
- class \Drupal\Core\Entity\EntityConfirmFormBase implements ConfirmFormInterface
- class \Drupal\Core\Entity\EntityForm implements 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) {
$comment_count = $this->entityTypeManager
->getStorage('comment')
->getQuery()
->accessCheck(FALSE)
->condition('comment_type', $this->entity
->id())
->count()
->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 ($comment_count) {
$caption .= '<p>' . $this
->formatPlural($comment_count, '%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
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
CommentTypeDeleteForm:: |
protected | property | The comment manager service. | |
CommentTypeDeleteForm:: |
protected | property |
The entity being used by this form. Overrides EntityForm:: |
|
CommentTypeDeleteForm:: |
protected | property | A logger instance. | |
CommentTypeDeleteForm:: |
public | function |
Form constructor. Overrides EntityDeleteForm:: |
|
CommentTypeDeleteForm:: |
public static | function |
Instantiates a new instance of this class. Overrides FormBase:: |
|
CommentTypeDeleteForm:: |
public | function | Constructs a query factory object. | |
ConfigDependencyDeleteFormTrait:: |
protected | function | Adds form elements to list affected configuration entities. | |
ConfigDependencyDeleteFormTrait:: |
abstract protected | function | Translates a string to the current language or to a given language. | |
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
EntityConfirmFormBase:: |
protected | function |
Returns an array of supported actions for the current entity form. Overrides EntityForm:: |
1 |
EntityConfirmFormBase:: |
public | function | The delete() method is not used in EntityConfirmFormBase. This overrides the default implementation that redirects to the delete-form confirmation form. | |
EntityConfirmFormBase:: |
public | function |
Returns a string identifying the base form. Overrides EntityForm:: |
|
EntityConfirmFormBase:: |
public | function |
Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface:: |
|
EntityConfirmFormBase:: |
public | function |
Returns additional text to display as a description. Overrides ConfirmFormInterface:: |
11 |
EntityConfirmFormBase:: |
public | function |
Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface:: |
|
EntityConfirmFormBase:: |
public | function |
The save() method is not used in EntityConfirmFormBase. This overrides the
default implementation that saves the entity. Overrides EntityForm:: |
|
EntityDeleteForm:: |
protected | function | Gets the configuration manager. | |
EntityDeleteForm:: |
protected | function | Returns config names to delete for the deletion confirmation form. | 1 |
EntityDeleteFormTrait:: |
public | function | 3 | |
EntityDeleteFormTrait:: |
public | function | 1 | |
EntityDeleteFormTrait:: |
protected | function | Gets the message to display to the user after deleting the entity. | 3 |
EntityDeleteFormTrait:: |
abstract public | function | Gets the entity of this form. | |
EntityDeleteFormTrait:: |
public | function | 4 | |
EntityDeleteFormTrait:: |
protected | function | Returns the URL where the user should be redirected after deletion. | 5 |
EntityDeleteFormTrait:: |
protected | function | Logs a message about the deleted entity. | 2 |
EntityDeleteFormTrait:: |
abstract protected | function | Gets the logger for a specific channel. | |
EntityDeleteFormTrait:: |
public | function | 4 | |
EntityForm:: |
protected | property | The entity type manager. | 3 |
EntityForm:: |
protected | property | The module handler service. | |
EntityForm:: |
protected | property | The name of the current operation. | |
EntityForm:: |
protected | function | Returns the action form element for the current entity form. | |
EntityForm:: |
public | function | Form element #after_build callback: Updates the entity with submitted data. | |
EntityForm:: |
public | function |
Builds an updated entity object based upon the submitted form values. Overrides EntityFormInterface:: |
3 |
EntityForm:: |
protected | function | Copies top-level form values to entity properties. | 9 |
EntityForm:: |
public | function | Gets the actual form array to be built. | 36 |
EntityForm:: |
public | function |
Determines which entity will be used by this form from a RouteMatch object. Overrides EntityFormInterface:: |
3 |
EntityForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
12 |
EntityForm:: |
public | function |
Gets the operation identifying the form. Overrides EntityFormInterface:: |
|
EntityForm:: |
protected | function | Initialize the form state and the entity before the first form build. | 3 |
EntityForm:: |
protected | function | Prepares the entity object before the form is built first. | 3 |
EntityForm:: |
protected | function | Invokes the specified prepare hook variant. | |
EntityForm:: |
public | function | Process callback: assigns weights and hides extra fields. | |
EntityForm:: |
public | function |
Sets the form entity. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Sets the entity type manager for this form. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Sets the module handler for this form. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Sets the operation for this form. Overrides EntityFormInterface:: |
|
FormBase:: |
protected | property | The config factory. | 3 |
FormBase:: |
protected | property | The request stack. | 1 |
FormBase:: |
protected | property | The route match. | |
FormBase:: |
protected | function | Retrieves a configuration object. | |
FormBase:: |
protected | function | Gets the config factory for this form. | 3 |
FormBase:: |
private | function | Returns the service container. | |
FormBase:: |
protected | function | Gets the current user. | |
FormBase:: |
protected | function | Gets the request object. | |
FormBase:: |
protected | function | Gets the route match. | |
FormBase:: |
protected | function | Returns a redirect response object for the specified route. | |
FormBase:: |
public | function | Resets the configuration factory. | |
FormBase:: |
public | function | Sets the config factory for this form. | |
FormBase:: |
public | function | Sets the request stack object to use. | |
FormBase:: |
public | function |
Form validation handler. Overrides FormInterface:: |
72 |
LoggerChannelTrait:: |
protected | property | The logger channel factory service. | |
LoggerChannelTrait:: |
protected | function | Gets the logger for a specific channel. | |
LoggerChannelTrait:: |
public | function | Injects the logger channel factory. | |
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
MessengerTrait:: |
public | function | Sets the messenger. | |
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 4 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |