Drush

No description

Return the current Drush version.

n.b. Called before the DI container is initialized. Do not log, etc. here.

Convert internal Composer dev version to ".x"

No description

No description

Sets a new global container.

Unsets the global container.

Returns the currently active global container.

Returns TRUE if the container has been initialized, FALSE otherwise.

Get the current Symfony Console Application.

Return the Robo runner.

Retrieves a service from the container.

Use this method if the desired service is not one of those with a dedicated accessor method below. If it is listed below, those methods are preferred as they can return useful type hints.

Indicates if a service is defined in the container.

Return command factory

Return the Drush logger object.

Return the configuration object

No description

No description

Return the input object

Return the output object

Run a Drush command on a site alias (or @self).

Tip: Use injected processManager() instead of this method. See below.

A class should use ProcessManagerAwareInterface / ProcessManagerAwareTrait in order to have the Process Manager injected by Drush's DI container. For example:

    use Consolidation\SiteProcess\ProcessManagerAwareTrait;
    use Consolidation\SiteProcess\ProcessManagerAwareInterface;

    abstract class DrushCommands implements ProcessManagerAwareInterface ...
    {
        use ProcessManagerAwareTrait;
    }

Since DrushCommands already uses ProcessManagerAwareTrait, all Drush commands may use the process manager to call other Drush commands. Other classes will need to ensure that the process manager is injected as shown above.

Note, however, that an alias record is required to use the drush method. The alias manager will provide an alias record, but the alias manager is not injected by default into Drush commands. In order to use it, it is necessary to use SiteAliasManagerAwareTrait:

    use Consolidation\SiteAlias\SiteAliasManagerAwareInterface;
    use Consolidation\SiteAlias\SiteAliasManagerAwareTrait;

    class SiteInstallCommands extends DrushCommands implements SiteAliasManagerAwareInterface
    {
        use SiteAliasManagerAwareTrait;

        public function install(array $profile, ...)
        {
            $selfRecord = $this->siteAliasManager()->getSelf();
            $args = ['system.site', ...];
            $options = ['yes' => true];
            $process = $this->processManager()->drush($selfRecord, 'config-set', $args, $options);
            $process->mustRun();
        }
    }

Objects that are fetched from the DI container, or any Drush command will automatically be given a reference to the alias manager if SiteAliasManagerAwareTrait is used. Other objects will need to be manually provided with a reference to the alias manager once it is created (call $obj->setAliasManager($aliasManager);).

Clients that are using Drush::drush(), and need a reference to the alias manager may use Drush::aliasManager().

Run a bash fragment on a site alias.

Use \Drush\Drush::drush() instead of this method when calling Drush.

Tip: Commands can consider using $this->processManager() instead of this method.

Run a bash fragment locally.

The timeout parameter on this method doesn't work. It exists for compatibility with parent. Call this method to get a Process and then call setters as needed.

Tip: Consider using injected process manager instead of this method.

Create a Process instance from a commandline string.

Tip: Consider using injected process manager instead of this method.

Return 'true' if we are in simulated mode

Return 'true' if we are in affirmative mode

Return 'true' if we are in negative mode

Return 'true' if we are in verbose mode

Return 'true' if we are in debug mode

Return the Bootstrap Manager.

Return the Bootstrap object.

No description