You are here

Home » API reference » Support Ticketing System 8 » SupportTicketRevisionRevertForm.php

class SupportTicketRevisionRevertForm in Support Ticketing System 8

Provides a form for reverting a support ticket revision.

Hierarchy

Expanded class hierarchy of SupportTicketRevisionRevertForm

1 string reference to 'SupportTicketRevisionRevertForm'
support_ticket.routing.yml in modules/support_ticket/support_ticket.routing.yml
modules/support_ticket/support_ticket.routing.yml

File

modules/support_ticket/src/Form/SupportTicketRevisionRevertForm.php, line 20
Contains \Drupal\support_ticket\Form\SupportTicketRevisionRevertForm.

Namespace

Drupal\support_ticket\Form
View source 
class SupportTicketRevisionRevertForm extends ConfirmFormBase {

  /**
   * The support ticket revision.
   *
   * @var \Drupal\support_ticket\SupportTicketInterface
   */
  protected $revision;

  /**
   * The support ticket storage.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $supportTicketStorage;

  /**
   * Constructs a new SupportTicketRevisionRevertForm.
   *
   * @param \Drupal\Core\Entity\EntityStorageInterface $support_ticket_storage
   *   The support_ticket storage.
   */
  public function __construct(EntityStorageInterface $support_ticket_storage) {
    $this->supportTicketStorage = $support_ticket_storage;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('entity.manager')
      ->getStorage('support_ticket'));
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function getCancelUrl() {
    return new Url('entity.support_ticket.version_history', array(
      'support_ticket' => $this->revision
        ->id(),
    ));
  }

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

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

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

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $revision = $this
      ->prepareRevertedRevision($this->revision);

    // The revision timestamp will be updated when the revision is saved. Keep the
    // original one for the confirmation message.
    $original_revision_timestamp = $revision
      ->getRevisionCreationTime();
    $revision->revision_log = t('Copy of the revision from %date.', array(
      '%date' => format_date($original_revision_timestamp),
    ));
    $revision
      ->save();
    $this
      ->logger('content')
      ->notice('@type: reverted %title revision %revision.', array(
      '@type' => $this->revision
        ->bundle(),
      '%title' => $this->revision
        ->label(),
      '%revision' => $this->revision
        ->getRevisionId(),
    ));
    drupal_set_message(t('@type %title has been reverted to the revision from %revision-date.', array(
      '@type' => support_ticket_get_type_label($this->revision),
      '%title' => $this->revision
        ->label(),
      '%revision-date' => format_date($original_revision_timestamp),
    )));
    $form_state
      ->setRedirect('entity.support_ticket.version_history', array(
      'support_ticket' => $this->revision
        ->id(),
    ));
  }

  /**
   * Prepares a revision to be reverted.
   *
   * @param \Drupal\support_ticket\SupportTicketInterface $revision
   *   The revision to be reverted.
   *
   * @return \Drupal\support_ticket\SupportTicketInterface
   *   The prepared revision ready to be stored.
   */
  protected function prepareRevertedRevision(SupportTicketInterface $revision) {

    /** @var \Drupal\support_ticket\SupportTicketInterface $default_revision */
    $default_revision = $this->supportTicketStorage
      ->load($revision
      ->id());

    // If the entity is translated, make sure only translations affected by the
    // specified revision are reverted.
    $languages = $default_revision
      ->getTranslationLanguages();
    if (count($languages) > 1) {
      foreach ($languages as $langcode => $language) {
        if ($revision
          ->hasTranslation($langcode) && !$revision
          ->getTranslation($langcode)
          ->isRevisionTranslationAffected()) {
          $revision_translation = $revision
            ->getTranslation($langcode);
          $default_translation = $default_revision
            ->getTranslation($langcode);
          foreach ($default_revision
            ->getFieldDefinitions() as $field_name => $definition) {
            if ($definition
              ->isTranslatable()) {
              $revision_translation
                ->set($field_name, $default_translation
                ->get($field_name)
                ->getValue());
            }
          }
        }
      }
    }
    $revision
      ->setNewRevision();
    $revision
      ->isDefaultRevision(TRUE);
    return $revision;
  }

}

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::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.
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.
SupportTicketRevisionRevertForm::$revision protected property The support ticket revision.
SupportTicketRevisionRevertForm::$supportTicketStorage protected property The support ticket storage.
SupportTicketRevisionRevertForm::buildForm public function Form constructor. Overrides ConfirmFormBase::buildForm
SupportTicketRevisionRevertForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
SupportTicketRevisionRevertForm::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
SupportTicketRevisionRevertForm::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
SupportTicketRevisionRevertForm::getDescription public function Returns additional text to display as a description. Overrides ConfirmFormBase::getDescription
SupportTicketRevisionRevertForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
SupportTicketRevisionRevertForm::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
SupportTicketRevisionRevertForm::prepareRevertedRevision protected function Prepares a revision to be reverted.
SupportTicketRevisionRevertForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
SupportTicketRevisionRevertForm::__construct public function Constructs a new SupportTicketRevisionRevertForm.
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.