class MigrateUpgradeFormBase
Same name in other branches
- 8.9.x core/modules/migrate_drupal_ui/src/Form/MigrateUpgradeFormBase.php \Drupal\migrate_drupal_ui\Form\MigrateUpgradeFormBase
- 10 core/modules/migrate_drupal_ui/src/Form/MigrateUpgradeFormBase.php \Drupal\migrate_drupal_ui\Form\MigrateUpgradeFormBase
- 11.x core/modules/migrate_drupal_ui/src/Form/MigrateUpgradeFormBase.php \Drupal\migrate_drupal_ui\Form\MigrateUpgradeFormBase
Form base for the Migrate Upgrade UI.
Hierarchy
- class \Drupal\Core\Form\FormBase implements \Drupal\Core\Form\FormInterface, \Drupal\Core\DependencyInjection\ContainerInjectionInterface uses \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Logger\LoggerChannelTrait, \Drupal\Core\Messenger\MessengerTrait, \Drupal\Core\Routing\RedirectDestinationTrait, \Drupal\Core\StringTranslation\StringTranslationTrait
- class \Drupal\migrate_drupal_ui\Form\MigrateUpgradeFormBase extends \Drupal\Core\Form\FormBase uses \Drupal\migrate_drupal\MigrationConfigurationTrait
Expanded class hierarchy of MigrateUpgradeFormBase
File
-
core/
modules/ migrate_drupal_ui/ src/ Form/ MigrateUpgradeFormBase.php, line 17
Namespace
Drupal\migrate_drupal_ui\FormView source
abstract class MigrateUpgradeFormBase extends FormBase {
use MigrationConfigurationTrait;
/**
* Private temporary storage.
*
* @var \Drupal\Core\TempStore\PrivateTempStoreFactory
*/
protected $store;
/**
* The destination site major version.
*
* @var string
*/
protected $destinationSiteVersion;
/**
* Constructs the Migrate Upgrade Form Base.
*
* @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
* The config factory service.
* @param \Drupal\migrate\Plugin\MigrationPluginManagerInterface $migration_plugin_manager
* The migration plugin manager service.
* @param \Drupal\Core\State\StateInterface $state
* The state service.
* @param \Drupal\Core\TempStore\PrivateTempStoreFactory $tempstore_private
* The private tempstore factory service.
*/
public function __construct(ConfigFactoryInterface $config_factory, MigrationPluginManagerInterface $migration_plugin_manager, StateInterface $state, PrivateTempStoreFactory $tempstore_private) {
$this->configFactory = $config_factory;
$this->migrationPluginManager = $migration_plugin_manager;
$this->state = $state;
$this->store = $tempstore_private->get('migrate_drupal_ui');
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container->get('config.factory'), $container->get('plugin.manager.migration'), $container->get('state'), $container->get('tempstore.private'));
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state) {
// Get the current major version.
[
$this->destinationSiteVersion,
] = explode('.', \Drupal::VERSION, 2);
$form = [];
$form['actions']['#type'] = 'actions';
$form['actions']['submit'] = [
'#type' => 'submit',
'#value' => $this->getConfirmText(),
'#button_type' => 'primary',
'#weight' => 10,
];
return $form;
}
/**
* Helper to redirect to the Overview form.
*
* @return \Symfony\Component\HttpFoundation\RedirectResponse
* A redirect response object that may be returned by the controller.
*
* @throws \Drupal\Core\TempStore\TempStoreException
* Thrown when a lock for the backend storage could not be acquired.
*/
protected function restartUpgradeForm() {
$this->store
->set('step', 'overview');
return $this->redirect('migrate_drupal_ui.upgrade');
}
/**
* Returns a caption for the button that confirms the action.
*
* @return string
* The form confirmation text.
*/
protected abstract function getConfirmText();
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
DependencySerializationTrait::$_entityStorages | protected | property | |||
DependencySerializationTrait::$_serviceIds | protected | property | |||
DependencySerializationTrait::__sleep | public | function | 1 | ||
DependencySerializationTrait::__wakeup | public | function | 2 | ||
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. | 3 | |
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. | ||
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 | 73 |
FormInterface::getFormId | public | function | Returns a unique string identifying the form. | 270 | |
FormInterface::submitForm | public | function | Form submission handler. | 220 | |
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. | 17 | |
MessengerTrait::messenger | public | function | Gets the messenger. | 17 | |
MessengerTrait::setMessenger | public | function | Sets the messenger. | ||
MigrateUpgradeFormBase::$destinationSiteVersion | protected | property | The destination site major version. | ||
MigrateUpgradeFormBase::$store | protected | property | Private temporary storage. | ||
MigrateUpgradeFormBase::buildForm | public | function | Form constructor. | Overrides FormInterface::buildForm | 5 |
MigrateUpgradeFormBase::create | public static | function | Instantiates a new instance of this class. | Overrides FormBase::create | 3 |
MigrateUpgradeFormBase::getConfirmText | abstract protected | function | Returns a caption for the button that confirms the action. | 5 | |
MigrateUpgradeFormBase::restartUpgradeForm | protected | function | Helper to redirect to the Overview form. | ||
MigrateUpgradeFormBase::__construct | public | function | Constructs the Migrate Upgrade Form Base. | 3 | |
MigrationConfigurationTrait::$configFactory | protected | property | The config factory service. | ||
MigrationConfigurationTrait::$followUpMigrationTags | protected | property | The follow-up migration tags. | ||
MigrationConfigurationTrait::$migrationPluginManager | protected | property | The migration plugin manager service. | ||
MigrationConfigurationTrait::$state | protected | property | The state service. | ||
MigrationConfigurationTrait::createDatabaseStateSettings | protected | function | Creates the necessary state entries for SqlBase::getDatabase() to work. | ||
MigrationConfigurationTrait::getConfigFactory | protected | function | Gets the config factory service. | ||
MigrationConfigurationTrait::getConnection | protected | function | Gets the database connection for the source Drupal database. | ||
MigrationConfigurationTrait::getFollowUpMigrationTags | protected | function | Returns the follow-up migration tags. | ||
MigrationConfigurationTrait::getLegacyDrupalVersion | public static | function | Determines what version of Drupal the source database contains. | ||
MigrationConfigurationTrait::getMigrationPluginManager | protected | function | Gets the migration plugin manager service. | ||
MigrationConfigurationTrait::getMigrations | protected | function | Gets the migrations for import. | ||
MigrationConfigurationTrait::getState | protected | function | Gets the state service. | ||
MigrationConfigurationTrait::getSystemData | protected | function | Gets the system data from the system table of the source Drupal database. | ||
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. | 3 | |
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. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.