class HeartbeatRevisionRevertTranslationForm in Heartbeat 8

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

View source

class HeartbeatRevisionRevertTranslationForm extends HeartbeatRevisionRevertForm {

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

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

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

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

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

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

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

    /** @var \Drupal\heartbeat\Entity\HeartbeatInterface $default_revision */
    $latest_revision = $this->HeartbeatStorage
      ->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(REQUEST_TIME);
    return $latest_revision_translation;
  }

}

Members

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

You are here

class HeartbeatRevisionRevertTranslationForm in Heartbeat 8

Hierarchy

File

Namespace

Members

API Navigation