class ConsentAgreementRevisionRevertForm in General Data Protection Regulation 3.0.x
Same name and namespace in other branches
- 8.2 modules/gdpr_consent/src/Form/ConsentAgreementRevisionRevertForm.php \Drupal\gdpr_consent\Form\ConsentAgreementRevisionRevertForm
- 8 modules/gdpr_consent/src/Form/ConsentAgreementRevisionRevertForm.php \Drupal\gdpr_consent\Form\ConsentAgreementRevisionRevertForm
Provides a form for reverting a Consent Agreement revision.
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfirmFormBase implements ConfirmFormInterface
- class \Drupal\gdpr_consent\Form\ConsentAgreementRevisionRevertForm
- class \Drupal\Core\Form\ConfirmFormBase implements ConfirmFormInterface
Expanded class hierarchy of ConsentAgreementRevisionRevertForm
1 file declares its use of ConsentAgreementRevisionRevertForm
- ConsentAgreementHtmlRouteProvider.php in modules/
gdpr_consent/ src/ ConsentAgreementHtmlRouteProvider.php
File
- modules/
gdpr_consent/ src/ Form/ ConsentAgreementRevisionRevertForm.php, line 18
Namespace
Drupal\gdpr_consent\FormView source
class ConsentAgreementRevisionRevertForm extends ConfirmFormBase {
/**
* The Consent Agreement revision.
*
* @var \Drupal\gdpr_consent\Entity\ConsentAgreementInterface
*/
protected $revision;
/**
* The Consent Agreement storage.
*
* @var \Drupal\Core\Entity\EntityStorageInterface
*/
protected $consentAgreementStorage;
/**
* The date formatter service.
*
* @var \Drupal\Core\Datetime\DateFormatterInterface
*/
protected $dateFormatter;
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container
->get('entity_type.manager')
->getStorage('gdpr_consent_agreement'), $container
->get('date.formatter'));
}
/**
* Constructs a new ConsentAgreementRevisionRevertForm.
*
* @param \Drupal\Core\Entity\EntityStorageInterface $entityStorage
* The Consent Agreement storage.
* @param \Drupal\Core\Datetime\DateFormatterInterface $dateFormatter
* The date formatter service.
*/
public function __construct(EntityStorageInterface $entityStorage, DateFormatterInterface $dateFormatter) {
$this->consentAgreementStorage = $entityStorage;
$this->dateFormatter = $dateFormatter;
}
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'gdpr_consent_agreement_revision_revert_confirm';
}
/**
* {@inheritdoc}
*/
public function getQuestion() {
return $this
->t('Are you sure you want to revert to the revision from %revision-date?', [
'%revision-date' => $this->dateFormatter
->format($this->revision
->getRevisionCreationTime()),
]);
}
/**
* {@inheritdoc}
*/
public function getCancelUrl() {
return new Url('entity.gdpr_consent_agreement.version_history', [
'gdpr_consent_agreement' => $this->revision
->id(),
]);
}
/**
* {@inheritdoc}
*/
public function getConfirmText() {
return $this
->t('Revert');
}
/**
* {@inheritdoc}
*/
public function getDescription() {
return '';
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state, $gdpr_consent_agreement_revision = NULL) {
$this->revision = $this->consentAgreementStorage
->loadRevision($gdpr_consent_agreement_revision);
$form = parent::buildForm($form, $form_state);
return $form;
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
// The revision timestamp will be updated when the revision is saved. Keep
// the original one for the confirmation message.
$originalRevisionTimestamp = $this->revision
->getRevisionCreationTime();
$this->revision = $this
->prepareRevertedRevision($this->revision, $form_state);
$this->revision->revision_log = $this
->t('Copy of the revision from %date.', [
'%date' => $this->dateFormatter
->format($originalRevisionTimestamp),
]);
$this->revision
->save();
$this
->logger('content')
->notice('Consent Agreement: reverted %title revision %revision.', [
'%title' => $this->revision
->label(),
'%revision' => $this->revision
->getRevisionId(),
]);
\Drupal::messenger()
->addMessage($this
->t('Consent Agreement %title has been reverted to the revision from %revision-date.', [
'%title' => $this->revision
->label(),
'%revision-date' => $this->dateFormatter
->format($originalRevisionTimestamp),
]));
$form_state
->setRedirect('entity.gdpr_consent_agreement.version_history', [
'gdpr_consent_agreement' => $this->revision
->id(),
]);
}
/**
* Prepares a revision to be reverted.
*
* @param \Drupal\gdpr_consent\Entity\ConsentAgreementInterface $revision
* The revision to be reverted.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The current state of the form.
*
* @return \Drupal\gdpr_consent\Entity\ConsentAgreementInterface
* The prepared revision ready to be stored.
*/
protected function prepareRevertedRevision(ConsentAgreementInterface $revision, FormStateInterface $form_state) {
$revision
->setNewRevision();
$revision
->isDefaultRevision(TRUE);
$revision
->setRevisionCreationTime(\Drupal::time()
->getRequestTime());
return $revision;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ConfirmFormBase:: |
public | function |
Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface:: |
2 |
ConfirmFormBase:: |
public | function |
Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface:: |
|
ConsentAgreementRevisionRevertForm:: |
protected | property | The Consent Agreement storage. | |
ConsentAgreementRevisionRevertForm:: |
protected | property | The date formatter service. | |
ConsentAgreementRevisionRevertForm:: |
protected | property | The Consent Agreement revision. | |
ConsentAgreementRevisionRevertForm:: |
public | function |
Form constructor. Overrides ConfirmFormBase:: |
|
ConsentAgreementRevisionRevertForm:: |
public static | function |
Instantiates a new instance of this class. Overrides FormBase:: |
|
ConsentAgreementRevisionRevertForm:: |
public | function |
Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface:: |
|
ConsentAgreementRevisionRevertForm:: |
public | function |
Returns a caption for the button that confirms the action. Overrides ConfirmFormBase:: |
|
ConsentAgreementRevisionRevertForm:: |
public | function |
Returns additional text to display as a description. Overrides ConfirmFormBase:: |
|
ConsentAgreementRevisionRevertForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
|
ConsentAgreementRevisionRevertForm:: |
public | function |
Returns the question to ask the user. Overrides ConfirmFormInterface:: |
|
ConsentAgreementRevisionRevertForm:: |
protected | function | Prepares a revision to be reverted. | |
ConsentAgreementRevisionRevertForm:: |
public | function |
Form submission handler. Overrides FormInterface:: |
|
ConsentAgreementRevisionRevertForm:: |
public | function | Constructs a new ConsentAgreementRevisionRevertForm. | |
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
FormBase:: |
protected | property | The config factory. | 3 |
FormBase:: |
protected | property | The request stack. | 1 |
FormBase:: |
protected | property | The route match. | |
FormBase:: |
protected | function | Retrieves a configuration object. | |
FormBase:: |
protected | function | Gets the config factory for this form. | 3 |
FormBase:: |
private | function | Returns the service container. | |
FormBase:: |
protected | function | Gets the current user. | |
FormBase:: |
protected | function | Gets the request object. | |
FormBase:: |
protected | function | Gets the route match. | |
FormBase:: |
protected | function | Gets the logger for a specific channel. | |
FormBase:: |
protected | function | Returns a redirect response object for the specified route. | |
FormBase:: |
public | function | Resets the configuration factory. | |
FormBase:: |
public | function | Sets the config factory for this form. | |
FormBase:: |
public | function | Sets the request stack object to use. | |
FormBase:: |
public | function |
Form validation handler. Overrides FormInterface:: |
72 |
LoggerChannelTrait:: |
protected | property | The logger channel factory service. | |
LoggerChannelTrait:: |
protected | function | Gets the logger for a specific channel. | |
LoggerChannelTrait:: |
public | function | Injects the logger channel factory. | |
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
MessengerTrait:: |
public | function | Sets the messenger. | |
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 4 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |