Code Coverage |
||||||||||
Classes and Traits |
Functions and Methods |
Lines |
||||||||
| Total | |
0.00% |
0 / 1 |
|
0.00% |
0 / 7 |
CRAP | |
0.00% |
0 / 40 |
| EntityDeleteFormTrait | |
0.00% |
0 / 1 |
|
22.22% |
2 / 9 |
132 | |
0.00% |
0 / 40 |
| getEntity | |
100.00% |
1 / 1 |
1 | |
100.00% |
0 / 0 |
|||
| logger | |
100.00% |
1 / 1 |
1 | |
100.00% |
0 / 0 |
|||
| getQuestion | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 5 |
|||
| getConfirmText | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 2 |
|||
| getDeletionMessage | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 6 |
|||
| getCancelUrl | |
0.00% |
0 / 1 |
6 | |
0.00% |
0 / 8 |
|||
| getRedirectUrl | |
0.00% |
0 / 1 |
6 | |
0.00% |
0 / 8 |
|||
| logDeletionMessage | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 6 |
|||
| submitForm | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 5 |
|||
| <?php | |
| /** | |
| * @file | |
| * Contains \Drupal\Core\Entity\EntityDeleteFormTrait. | |
| */ | |
| namespace Drupal\Core\Entity; | |
| use Drupal\Core\Config\Entity\ConfigDependencyDeleteFormTrait; | |
| use Drupal\Core\Form\FormStateInterface; | |
| use Drupal\Core\Url; | |
| /** | |
| * Provides a trait for an entity deletion form. | |
| * | |
| * This trait relies on the StringTranslationTrait and the logger method added | |
| * by FormBase. | |
| * | |
| * @ingroup entity_api | |
| */ | |
| trait EntityDeleteFormTrait { | |
| use ConfigDependencyDeleteFormTrait; | |
| /** | |
| * Gets the entity of this form. | |
| * | |
| * Provided by \Drupal\Core\Entity\EntityForm. | |
| * | |
| * @return \Drupal\Core\Entity\EntityInterface | |
| * The entity. | |
| */ | |
| abstract public function getEntity(); | |
| /** | |
| * Gets the logger for a specific channel. | |
| * | |
| * Provided by \Drupal\Core\Form\FormBase. | |
| * | |
| * @param string $channel | |
| * The name of the channel. | |
| * | |
| * @return \Psr\Log\LoggerInterface | |
| * The logger for this channel. | |
| */ | |
| abstract protected function logger($channel); | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public function getQuestion() { | |
| return $this->t('Are you sure you want to delete the @entity-type %label?', array( | |
| '@entity-type' => $this->getEntity()->getEntityType()->getLowercaseLabel(), | |
| '%label' => $this->getEntity()->label(), | |
| )); | |
| } | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public function getConfirmText() { | |
| return $this->t('Delete'); | |
| } | |
| /** | |
| * Gets the message to display to the user after deleting the entity. | |
| * | |
| * @return string | |
| * The translated string of the deletion message. | |
| */ | |
| protected function getDeletionMessage() { | |
| $entity = $this->getEntity(); | |
| return $this->t('The @entity-type %label has been deleted.', array( | |
| '@entity-type' => $entity->getEntityType()->getLowercaseLabel(), | |
| '%label' => $entity->label(), | |
| )); | |
| } | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public function getCancelUrl() { | |
| $entity = $this->getEntity(); | |
| if ($entity->hasLinkTemplate('collection')) { | |
| // If available, return the collection URL. | |
| return $entity->urlInfo('collection'); | |
| } | |
| else { | |
| // Otherwise fall back to the default link template. | |
| return $entity->urlInfo(); | |
| } | |
| } | |
| /** | |
| * Returns the URL where the user should be redirected after deletion. | |
| * | |
| * @return \Drupal\Core\Url | |
| * The redirect URL. | |
| */ | |
| protected function getRedirectUrl() { | |
| $entity = $this->getEntity(); | |
| if ($entity->hasLinkTemplate('collection')) { | |
| // If available, return the collection URL. | |
| return $entity->urlInfo('collection'); | |
| } | |
| else { | |
| // Otherwise fall back to the front page. | |
| return Url::fromRoute('<front>'); | |
| } | |
| } | |
| /** | |
| * Logs a message about the deleted entity. | |
| */ | |
| protected function logDeletionMessage() { | |
| $entity = $this->getEntity(); | |
| $this->logger($entity->getEntityType()->getProvider())->notice('The @entity-type %label has been deleted.', array( | |
| '@entity-type' => $entity->getEntityType()->getLowercaseLabel(), | |
| '%label' => $entity->label(), | |
| )); | |
| } | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public function submitForm(array &$form, FormStateInterface $form_state) { | |
| $this->getEntity()->delete(); | |
| drupal_set_message($this->getDeletionMessage()); | |
| $form_state->setRedirectUrl($this->getCancelUrl()); | |
| $this->logDeletionMessage(); | |
| } | |
| } |