final class MigrationConfirmationForm in Lightning Workflow 8.2
Same name and namespace in other branches
- 8.3 modules/lightning_scheduler/src/Form/MigrationConfirmationForm.php \Drupal\lightning_scheduler\Form\MigrationConfirmationForm
Provides a UI for migrating or purging scheduled transition data.
This class is final for the same reason that the Migrator service is: the migration is not an API and should not be extended or re-used.
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfirmFormBase implements ConfirmFormInterface
- class \Drupal\lightning_scheduler\Form\MigrationConfirmationForm
- class \Drupal\Core\Form\ConfirmFormBase implements ConfirmFormInterface
Expanded class hierarchy of MigrationConfirmationForm
1 string reference to 'MigrationConfirmationForm'
- lightning_scheduler.routing.yml in modules/
lightning_scheduler/ lightning_scheduler.routing.yml - modules/lightning_scheduler/lightning_scheduler.routing.yml
File
- modules/
lightning_scheduler/ src/ Form/ MigrationConfirmationForm.php, line 19
Namespace
Drupal\lightning_scheduler\FormView source
final class MigrationConfirmationForm extends ConfirmFormBase {
/**
* The migrator service.
*
* @var \Drupal\lightning_scheduler\Migrator
*/
protected $migrator;
/**
* MigrationConfirmationForm constructor.
*
* @param \Drupal\lightning_scheduler\Migrator $migrator
* The migrator service.
* @param \Drupal\Core\Messenger\MessengerInterface $messenger
* (optional) The messenger service.
*/
public function __construct(Migrator $migrator, MessengerInterface $messenger = NULL) {
$this->migrator = $migrator;
if ($messenger) {
$this
->setMessenger($messenger);
}
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container
->get('lightning_scheduler.migrator'), $container
->get('messenger'));
}
/**
* Performs access check.
*
* @return AccessResult
* Allowed if the current user is droot (Drupal root).
*/
public function access() {
$uid = (int) $this
->currentUser()
->id();
// This migration is serious business, so only droot can do it.
return AccessResult::allowedIf($uid === 1);
}
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'lightning_scheduler_migration_confirm_form';
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state) {
$entity_types = $this->migrator
->getEntityTypesToMigrate();
if (empty($entity_types)) {
$this
->messenger()
->addStatus($this
->t('Hey, nice! All migrations are completed.'));
return $form;
}
$form = parent::buildForm($form, $form_state);
$form['purge'] = [
'#type' => 'details',
'#collapsible' => TRUE,
'#title' => $this
->t('Purge without migrating'),
'#description' => $this
->t('Purging will allow you to discard existing scheduled transitions for a particular entity type without running the migration. This is useful if you don\'t have any scheduled transitions that you want to migrate. <strong>This will permanently delete scheduled transitions and cannot be undone.</strong>'),
'#tree' => TRUE,
'entity_type_id' => [
'#type' => 'select',
'#title' => $this
->t('Entity type to purge'),
'#options' => $this->migrator
->entityTypeOptions($entity_types),
],
'actions' => [
'#type' => 'actions',
'purge' => [
'#type' => 'submit',
'#value' => $this
->t('Purge'),
'#submit' => [
'::purge',
],
],
],
];
return $form;
}
/**
* {@inheritdoc}
*/
public function getQuestion() {
return $this
->t('Are you sure you want to migrate all scheduled transitions?');
}
/**
* {@inheritdoc}
*/
public function getDescription() {
$entity_types = $this->migrator
->getEntityTypesToMigrate();
return $this->migrator
->generatePreMigrationMessage($entity_types);
}
/**
* {@inheritdoc}
*/
public function getConfirmText() {
return $this
->t('Continue');
}
/**
* {@inheritdoc}
*/
public function getCancelUrl() {
return Url::fromRoute('<front>');
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
$operations = [];
$callback = [
static::class,
'migrate',
];
foreach (array_keys($this->migrator
->getEntityTypesToMigrate()) as $entity_type_id) {
foreach ($this->migrator
->query($entity_type_id)
->execute() as $item) {
$arguments = [
$entity_type_id,
$item,
];
array_push($operations, [
$callback,
$arguments,
]);
}
array_push($operations, [
[
static::class,
'complete',
],
[
$entity_type_id,
],
]);
}
batch_set([
'operations' => $operations,
]);
}
/**
* Batch API callback to migrate a single entity.
*/
public static function migrate($entity_type_id, \stdClass $item) {
\Drupal::service('lightning_scheduler.migrator')
->migrate($entity_type_id, $item);
}
/**
* Batch API callback to mark an entity type's migration as completed.
*/
public static function complete($entity_type_id) {
\Drupal::service('lightning_scheduler.migrator')
->completeMigration($entity_type_id);
}
/**
* Submit function to handle purging 1.x base field data.
*
* @param array $form
* The complete form.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The current form state.
*/
public function purge(array &$form, FormStateInterface $form_state) {
$entity_type_id = $form_state
->getValue([
'purge',
'entity_type_id',
]);
$this->migrator
->purge($entity_type_id, 'scheduled_publication');
$this->migrator
->purge($entity_type_id, 'scheduled_moderation_state');
$this->migrator
->completeMigration($entity_type_id);
$message = $this
->t('Purged scheduled transitions for @entity_type.', [
'@entity_type' => $form['purge']['entity_type_id']['#options'][$entity_type_id],
]);
$this
->messenger()
->addStatus($message);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ConfirmFormBase:: |
public | function |
Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface:: |
1 |
ConfirmFormBase:: |
public | function |
Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface:: |
|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
FormBase:: |
protected | property | The config factory. | 1 |
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. | 1 |
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. Overrides UrlGeneratorTrait:: |
|
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:: |
62 |
LinkGeneratorTrait:: |
protected | property | The link generator. | 1 |
LinkGeneratorTrait:: |
protected | function | Returns the link generator. | |
LinkGeneratorTrait:: |
protected | function | Renders a link to a route given a route name and its parameters. | |
LinkGeneratorTrait:: |
public | function | Sets the link generator service. | |
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. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
MigrationConfirmationForm:: |
protected | property | The migrator service. | |
MigrationConfirmationForm:: |
public | function | Performs access check. | |
MigrationConfirmationForm:: |
public | function |
Form constructor. Overrides ConfirmFormBase:: |
|
MigrationConfirmationForm:: |
public static | function | Batch API callback to mark an entity type's migration as completed. | |
MigrationConfirmationForm:: |
public static | function |
Instantiates a new instance of this class. Overrides FormBase:: |
|
MigrationConfirmationForm:: |
public | function |
Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface:: |
|
MigrationConfirmationForm:: |
public | function |
Returns a caption for the button that confirms the action. Overrides ConfirmFormBase:: |
|
MigrationConfirmationForm:: |
public | function |
Returns additional text to display as a description. Overrides ConfirmFormBase:: |
|
MigrationConfirmationForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
|
MigrationConfirmationForm:: |
public | function |
Returns the question to ask the user. Overrides ConfirmFormInterface:: |
|
MigrationConfirmationForm:: |
public static | function | Batch API callback to migrate a single entity. | |
MigrationConfirmationForm:: |
public | function | Submit function to handle purging 1.x base field data. | |
MigrationConfirmationForm:: |
public | function |
Form submission handler. Overrides FormInterface:: |
|
MigrationConfirmationForm:: |
public | function | MigrationConfirmationForm constructor. | |
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. | 1 |
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. | |
UrlGeneratorTrait:: |
protected | property | The url generator. | |
UrlGeneratorTrait:: |
protected | function | Returns the URL generator service. | |
UrlGeneratorTrait:: |
public | function | Sets the URL generator service. | |
UrlGeneratorTrait:: |
protected | function | Generates a URL or path for a specific route based on the given parameters. |