You are here

Home » API reference » Data Policy 8 » DataPolicyRevisionRevertTranslationForm.php

class DataPolicyRevisionRevertTranslationForm in Data Policy 8

Provides a form for reverting a revision for a single translation.

Hierarchy

Expanded class hierarchy of DataPolicyRevisionRevertTranslationForm

File

src/Form/DataPolicyRevisionRevertTranslationForm.php, line 18

Namespace

Drupal\data_policy\Form
View source 
class DataPolicyRevisionRevertTranslationForm extends DataPolicyRevisionRevertForm {

  /**
   * The language to be reverted.
   *
   * @var string
   */
  protected $langcode;

  /**
   * The language manager.
   *
   * @var \Drupal\Core\Language\LanguageManagerInterface
   */
  protected $languageManager;

  /**
   * Constructs a new DataPolicyRevisionRevertTranslationForm.
   *
   * @param \Drupal\Core\Entity\EntityStorageInterface $entity_storage
   *   The Data policy storage.
   * @param \Drupal\Core\Datetime\DateFormatterInterface $date_formatter
   *   The date formatter service.
   * @param \Drupal\Component\Datetime\TimeInterface $time
   *   The system time.
   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
   *   The language manager.
   */
  public function __construct(EntityStorageInterface $entity_storage, DateFormatterInterface $date_formatter, TimeInterface $time, LanguageManagerInterface $language_manager) {
    parent::__construct($entity_storage, $date_formatter, $time);
    $this->languageManager = $language_manager;
  }

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

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $data_policy_revision = NULL, $langcode = NULL) {
    $this->langcode = $langcode;
    $form = parent::buildForm($form, $form_state, $data_policy_revision);
    $form['revert_untranslated_fields'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Revert content shared among translations'),
      '#default_value' => FALSE,
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  protected function prepareRevertedRevision(DataPolicyInterface $revision, FormStateInterface $form_state) {
    $revert_untranslated_fields = $form_state
      ->getValue('revert_untranslated_fields');

    /** @var \Drupal\data_policy\Entity\DataPolicyInterface $default_revision */
    $latest_revision = $this->dataPolicyStorage
      ->load($revision
      ->id());
    $latest_revision_translation = $latest_revision
      ->getTranslation($this->langcode);
    $revision_translation = $revision
      ->getTranslation($this->langcode);
    foreach ($latest_revision_translation
      ->getFieldDefinitions() as $field_name => $definition) {
      if ($definition
        ->isTranslatable() || $revert_untranslated_fields) {
        $latest_revision_translation
          ->set($field_name, $revision_translation
          ->get($field_name)
          ->getValue());
      }
    }
    $latest_revision_translation
      ->setNewRevision();
    $latest_revision_translation
      ->isDefaultRevision(TRUE);
    $revision
      ->setRevisionCreationTime($this->time
      ->getRequestTime());
    return $latest_revision_translation;
  }

}

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
DataPolicyRevisionRevertForm::$dataPolicyStorage protected property The Data policy storage.
DataPolicyRevisionRevertForm::$dateFormatter protected property The date formatter service.
DataPolicyRevisionRevertForm::$revision protected property The Data policy revision.
DataPolicyRevisionRevertForm::$time protected property The time service.
DataPolicyRevisionRevertForm::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
DataPolicyRevisionRevertForm::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
DataPolicyRevisionRevertForm::getDescription public function Returns additional text to display as a description. Overrides ConfirmFormBase::getDescription
DataPolicyRevisionRevertForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
DataPolicyRevisionRevertTranslationForm::$langcode protected property The language to be reverted.
DataPolicyRevisionRevertTranslationForm::$languageManager protected property The language manager.
DataPolicyRevisionRevertTranslationForm::buildForm public function Form constructor. Overrides DataPolicyRevisionRevertForm::buildForm
DataPolicyRevisionRevertTranslationForm::create public static function Instantiates a new instance of this class. Overrides DataPolicyRevisionRevertForm::create
DataPolicyRevisionRevertTranslationForm::getFormId public function Returns a unique string identifying the form. Overrides DataPolicyRevisionRevertForm::getFormId
DataPolicyRevisionRevertTranslationForm::getQuestion public function Returns the question to ask the user. Overrides DataPolicyRevisionRevertForm::getQuestion
DataPolicyRevisionRevertTranslationForm::prepareRevertedRevision protected function Prepares a revision to be reverted. Overrides DataPolicyRevisionRevertForm::prepareRevertedRevision
DataPolicyRevisionRevertTranslationForm::__construct public function Constructs a new DataPolicyRevisionRevertTranslationForm. Overrides DataPolicyRevisionRevertForm::__construct
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.
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.