You are here

Home » API reference » Bibliography & Citation 8 » ReferenceRevisionDeleteForm.php

class ReferenceRevisionDeleteForm in Bibliography & Citation 8

Same name and namespace in other branches
  1. 2.0.x modules/bibcite_entity/src/Form/ReferenceRevisionDeleteForm.php \Drupal\bibcite_entity\Form\ReferenceRevisionDeleteForm

Provides a form for reverting a reference revision.

@internal

Hierarchy

Expanded class hierarchy of ReferenceRevisionDeleteForm

1 string reference to 'ReferenceRevisionDeleteForm'
bibcite_entity.routing.yml in modules/bibcite_entity/bibcite_entity.routing.yml
modules/bibcite_entity/bibcite_entity.routing.yml

File

modules/bibcite_entity/src/Form/ReferenceRevisionDeleteForm.php, line 19

Namespace

Drupal\bibcite_entity\Form
View source 
class ReferenceRevisionDeleteForm extends ConfirmFormBase {

  /**
   * The reference revision.
   *
   * @var \Drupal\bibcite_entity\entity\Reference
   */
  protected $revision;

  /**
   * The reference storage.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $referenceStorage;

  /**
   * The database connection.
   *
   * @var \Drupal\Core\Database\Connection
   */
  protected $connection;

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

  /**
   * Constructs a new ReferenceRevisionDeleteForm.
   *
   * @param \Drupal\Core\Entity\EntityStorageInterface $referenceStorage
   *   The reference storage.
   * @param \Drupal\Core\Database\Connection $connection
   *   The database connection.
   * @param \Drupal\Core\Datetime\DateFormatterInterface $date_formatter
   *   The date formatter service.
   */
  public function __construct(EntityStorageInterface $referenceStorage, Connection $connection, DateFormatterInterface $date_formatter) {
    $this->referenceStorage = $referenceStorage;
    $this->connection = $connection;
    $this->dateFormatter = $date_formatter;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {

    /** @var DateFormatterInterface $date_formatter */
    $date_formatter = $container
      ->get('date.formatter');

    /** @var \Drupal\Core\Database\Connection $connection */
    $connection = $container
      ->get('database');
    return new static($container
      ->get('entity_type.manager')
      ->getStorage('bibcite_reference'), $connection, $date_formatter);
  }

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

  /**
   * {@inheritdoc}
   */
  public function getQuestion() {
    return 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 new Url('entity.bibcite_reference.version_history', [
      'bibcite_reference' => $this->revision
        ->id(),
    ]);
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this->referenceStorage
      ->deleteRevision($this->revision
      ->getRevisionId());
    $this
      ->logger('bibcite')
      ->notice('@type: deleted %title revision %revision.', [
      '@type' => $this->revision
        ->bundle(),
      '%title' => $this->revision
        ->label(),
      '%revision' => $this->revision
        ->getRevisionId(),
    ]);
    $type = ReferenceType::load($this->revision
      ->bundle());
    $type_label = $type ? $type
      ->label() : $this->revision
      ->bundle();
    $this
      ->messenger()
      ->addStatus($this
      ->t('Revision from %revision-date of @type %title has been deleted.', [
      '%revision-date' => $this->dateFormatter
        ->format($this->revision
        ->getRevisionCreationTime()),
      '@type' => $type_label,
      '%title' => $this->revision
        ->label(),
    ]));
    $form_state
      ->setRedirect('entity.bibcite_reference.canonical', [
      'bibcite_reference' => $this->revision
        ->id(),
    ]);
    $query = $this->connection
      ->select('bibcite_reference_revision', 'br');
    $query
      ->addExpression('COUNT(DISTINCT(revision_id))');
    $query
      ->condition('id', $this->revision
      ->id());
    $count = $query
      ->execute()
      ->fetchField();
    if ($count > 1) {
      $form_state
        ->setRedirect('entity.bibcite_reference.version_history', [
        'bibcite_reference' => $this->revision
          ->id(),
      ]);
    }
  }

}

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
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.
ReferenceRevisionDeleteForm::$connection protected property The database connection.
ReferenceRevisionDeleteForm::$dateFormatter protected property The date formatter service.
ReferenceRevisionDeleteForm::$referenceStorage protected property The reference storage.
ReferenceRevisionDeleteForm::$revision protected property The reference revision.
ReferenceRevisionDeleteForm::buildForm public function Form constructor. Overrides ConfirmFormBase::buildForm
ReferenceRevisionDeleteForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
ReferenceRevisionDeleteForm::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
ReferenceRevisionDeleteForm::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
ReferenceRevisionDeleteForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
ReferenceRevisionDeleteForm::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
ReferenceRevisionDeleteForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
ReferenceRevisionDeleteForm::__construct public function Constructs a new ReferenceRevisionDeleteForm.
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.