MigrateRunnerCommands
final class MigrateRunnerCommands extends DrushCommands (View source)
Traits
A copy of \Drupal\Core\DependencyInjection\AutowireTrait with first params' type hint changed.
Constants
| REQ |
|
| OPT |
|
| EXIT_SUCCESS |
|
| EXIT_FAILURE |
|
| EXIT_FAILURE_WITH_CLARITY |
|
Properties
| protected | $uri | from ExecTrait | |
| protected ConfigInterface | $config | from ConfigAwareTrait | |
| protected InputInterface | $input | from InputAwareTrait | |
| protected OutputInterface | $output | from OutputAwareTrait | |
| protected | $io | from IO | |
| protected | $obj | from IO | |
| protected CommandData|null | $commandData | from DrushCommands | |
| protected MigrationPluginManagerInterface|null | $migrationPluginManager | ||
| protected KeyValueStoreInterface | $keyValue |
Methods
Starts a background browser/tab for the current site or a specified URL.
Any class that uses ConfigAwareTrait SHOULD override this method , and define a prefix for its configuration items. This is usually done in a base class. When used, this method should return a string that ends with a "."; see BaseTask::configPrefix().
No description
No description
No description
Prompt the user until the given validation callback passes.
Persist commandData for use in primary command callback. Used by 'topic' commands.
Print the contents of a file. The path comes from the @topic annotation.
This method overrides the trait in order to provide a more specific return type.
Instantiates a new instance of the implementing class using autowiring.
Provide a migration plugin manager.
List all migrations with current status.
Returns the migration source rows count.
Returns the number of items that needs update.
Returns the number of unprocessed items.
Returns the number of imported items.
Returns the last imported date/time if any.
Pads an incomplete table row with empty cells.
Perform one or more migration processes.
Executes a single migration.
Rollback one or more migrations.
Stop an active migration operation.
Reset an active migration's status to idle.
View any messages associated with a migration.
List the fields available for mapping in a source.
Retrieves a list of active migrations.
Returns the migrate message logger.
Get the source ID keys.
Details
bool
startBrowser(string|null $uri = null, int $sleep = 0, int|null $port = null, string|bool $browser = false)
Starts a background browser/tab for the current site or a specified URL.
Uses a non-blocking Process call, so Drush execution will continue.
static bool
programExists($program)
No description
static string
getEditor(string|null $editor = null)
No description
$this
setConfig(ConfigInterface $config)
Set the config management object.
ConfigInterface
getConfig()
Get the config management object.
static protected string
configPrefix()
Any class that uses ConfigAwareTrait SHOULD override this method , and define a prefix for its configuration items. This is usually done in a base class. When used, this method should return a string that ends with a "."; see BaseTask::configPrefix().
static protected
configClassIdentifier($classname)
No description
static protected
configPostfix()
No description
static
configure(string $key, mixed $value, ConfigInterface|null $config = null)
No description
protected mixed|null
getConfigValue(string $key, mixed|null $default = null)
No description
$this
setInput(InputInterface $input)
No description
protected InputInterface
input()
No description
protected InputInterface
getInput()
deprecated
deprecated
Backwards compatibility.
$this
setOutput(OutputInterface $output)
No description
protected OutputInterface
output()
No description
protected OutputInterface
stderr()
No description
protected OutputInterface
getOutput()
deprecated
deprecated
Backwards compatibility
in
IO at line 24
currentState()
No description
__construct(DateFormatterInterface $dateFormatter, KeyValueFactoryInterface $keyValueFactory)
No description
in
IO at line 40
restore()
No description
protected void
configurePrompts(InputInterface $input)
Configure the prompt fallbacks.
protected mixed
promptUntilValid(Closure $prompt, bool|string $required, Closure|null $validate)
Prompt the user until the given validation callback passes.
protected void
restorePrompts()
Restore the prompts output.
protected bool
runningUnitTests()
No description
protected DrushStyle
io()
Override Robo's IO function with our custom style.
DrushLoggerManager|null
logger()
Returns a logger object.
protected void
printFile(string $file)
Print the contents of a file.
preHook(CommandData $commandData)
Persist commandData for use in primary command callback. Used by 'topic' commands.
initHook($input, AnnotationData $annotationData)
Configure Laravel prompts package.
protected
printFileTopic(CommandData $commandData)
Print the contents of a file. The path comes from the @topic annotation.
protected HandlerStack
getStack()
Get a Guzzle handler stack that uses the Drush logger.
ProcessManager
processManager()
This method overrides the trait in order to provide a more specific return type.
static AutowireTrait
create(ContainerInterface $container)
Instantiates a new instance of the implementing class using autowiring.
setMigrationPluginManager(MigrationPluginManagerInterface $migrationPluginManager)
Provide a migration plugin manager.
RowsOfFields
status(string|null $migrationIds = null, array $options = ['tag' => self::REQ, 'format' => 'table'])
List all migrations with current status.
protected int|null
getMigrationSourceRowsCount(MigrationInterface $migration)
Returns the migration source rows count.
protected int
getMigrationNeedingUpdateCount(MigrationInterface $migration)
Returns the number of items that needs update.
protected int|null
getMigrationUnprocessedCount(MigrationInterface $migration)
Returns the number of unprocessed items.
protected int|null
getMigrationImportedCount(MigrationInterface $migration)
Returns the number of imported items.
protected string
getMigrationLastImportedTime(MigrationInterface $migration)
Returns the last imported date/time if any.
protected array
padTableRow(array $row, array $fields)
Pads an incomplete table row with empty cells.
void
import(string|null $migrationIds = null, array $options = ['all' => false, 'tag' => self::REQ, 'limit' => self::REQ, 'feedback' => self::REQ, 'idlist' => self::REQ, 'update' => false, 'force' => false, 'execute-dependencies' => false, 'timestamp' => false, 'total' => false, 'progress' => true, 'delete' => false])
Perform one or more migration processes.
protected void
executeMigration(MigrationInterface $migration, string $migrationId, array $userData)
Executes a single migration.
If the --execute-dependencies option was given, the migration's dependencies will also be executed first.
void
rollback(string|null $migrationIds = null, array $options = ['all' => false, 'tag' => self::REQ, 'feedback' => self::REQ, 'idlist' => self::REQ, 'progress' => true])
Rollback one or more migrations.
void
stop(string $migrationId)
Stop an active migration operation.
void
resetStatus(string $migrationId)
Reset an active migration's status to idle.
RowsOfFields
messages(string $migrationId, array $options = ['idlist' => self::REQ, 'format' => 'table'])
View any messages associated with a migration.
protected array
preprocessMessageRow(StdClass $row, array $sourceIdKeys)
Preprocesses migrate message rows.
Given an item inside the list generated by MigrateIdMapInterface::getMessages(), prepare it for display.
RowsOfFields
fieldsSource(string $migrationId, $options = ['format' => 'table'])
List the fields available for mapping in a source.
protected array
getMigrationList(string|null $migrationIds, string|null $tags)
Retrieves a list of active migrations.
protected MigrateMessageInterface
getMigrateMessage()
Returns the migrate message logger.
protected array
getSourceIdKeys(MigrateIdMapInterface $idMap)
Get the source ID keys.
CommandError|null
validateMigrationId(CommandData $commandData)
Validates a migration ID is valid.
If the argument to be validated is not named migrationId, pass the argument name as the value of the annotation.