You are here

Home » API reference » Group 8 » GroupRevisionDeleteForm.php

class GroupRevisionDeleteForm in Group 8

Same name and namespace in other branches
  1. 2.0.x src/Entity/Form/GroupRevisionDeleteForm.php \Drupal\group\Entity\Form\GroupRevisionDeleteForm

Provides a form for deleting a group revision.

Hierarchy

Expanded class hierarchy of GroupRevisionDeleteForm

1 string reference to 'GroupRevisionDeleteForm'
group.routing.yml in ./group.routing.yml
group.routing.yml

File

src/Entity/Form/GroupRevisionDeleteForm.php, line 15

Namespace

Drupal\group\Entity\Form
View source 
class GroupRevisionDeleteForm extends ConfirmFormBase {

  /**
   * The group revision.
   *
   * @var \Drupal\group\Entity\GroupInterface
   */
  protected $revision;

  /**
   * The group storage.
   *
   * @var \Drupal\Core\Entity\ContentEntityStorageInterface
   */
  protected $groupStorage;

  /**
   * The date formatter service.
   *
   * @var \Drupal\Core\Datetime\DateFormatterInterface
   */
  protected $dateFormatter;

  /**
   * Constructs a new GroupRevisionDeleteForm.
   *
   * @param \Drupal\Core\Entity\ContentEntityStorageInterface
   *   The group storage.
   * @param \Drupal\Core\Datetime\DateFormatterInterface $date_formatter
   *   The date formatter service.
   */
  public function __construct(ContentEntityStorageInterface $group_storage, DateFormatterInterface $date_formatter) {
    $this->groupStorage = $group_storage;
    $this->dateFormatter = $date_formatter;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    $entity_manager = $container
      ->get('entity_type.manager');
    return new static($entity_manager
      ->getStorage('group'), $container
      ->get('date.formatter'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function getQuestion() {
    return $this
      ->t('Are you sure you want to delete the revision from %revision-date?', [
      '%revision-date' => $this->dateFormatter
        ->format($this->revision
        ->getRevisionCreationTime()),
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function getCancelUrl() {
    return $this->revision
      ->toUrl('version-history');
  }

  /**
   * {@inheritdoc}
   */
  public function getConfirmText() {
    return $this
      ->t('Delete');
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $group_revision = NULL) {
    $this->revision = $group_revision;
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this->groupStorage
      ->deleteRevision($this->revision
      ->getRevisionId());
    $group_type = $this->revision
      ->getGroupType();
    $this
      ->logger('content')
      ->notice('@type: deleted %title revision %revision.', [
      '@type' => $group_type
        ->label(),
      '%title' => $this->revision
        ->label(),
      '%revision' => $this->revision
        ->getRevisionId(),
    ]);
    $this
      ->messenger()
      ->addStatus($this
      ->t('Revision from %revision-date of @type %title has been deleted.', [
      '%revision-date' => $this->dateFormatter
        ->format($this->revision
        ->getRevisionCreationTime()),
      '@type' => $group_type,
      '%title' => $this->revision
        ->label(),
    ]));
    $redirect_route = 'entity.group.canonical';
    if ($this
      ->countRevisions($this->revision) > 1) {
      $redirect_route = 'entity.group.version_history';
    }
    $form_state
      ->setRedirect($redirect_route, [
      'group' => $this->revision
        ->id(),
    ]);
  }

  /**
   * Counts the number of revisions.
   *
   * @param \Drupal\group\Entity\GroupInterface $group
   *   The group.
   *
   * @return int
   *   The number of revisions.
   */
  protected function countRevisions(GroupInterface $group) {
    return $this->groupStorage
      ->getQuery()
      ->allRevisions()
      ->condition('id', $group
      ->id())
      ->count()
      ->execute();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfirmFormBase::getCancelText public function Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface::getCancelText 1
ConfirmFormBase::getDescription public function Returns additional text to display as a description. Overrides ConfirmFormInterface::getDescription 11
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
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::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
GroupRevisionDeleteForm::$dateFormatter protected property The date formatter service.
GroupRevisionDeleteForm::$groupStorage protected property The group storage.
GroupRevisionDeleteForm::$revision protected property The group revision.
GroupRevisionDeleteForm::buildForm public function Form constructor. Overrides ConfirmFormBase::buildForm
GroupRevisionDeleteForm::countRevisions protected function Counts the number of revisions.
GroupRevisionDeleteForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
GroupRevisionDeleteForm::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
GroupRevisionDeleteForm::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
GroupRevisionDeleteForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
GroupRevisionDeleteForm::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
GroupRevisionDeleteForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
GroupRevisionDeleteForm::__construct public function Constructs a new GroupRevisionDeleteForm.
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.