• A
• B
• C
• D
• E
• F
• G
• H
• I
• J
• K
• L
• M
• N
• O
• P
• Q
• R
• S
• T
• U
• V
• W
• X
• Y
• Z

A

Application — Class in namespace Drush

Our application object

$ Application#aliasManager — Property in class Application

Application::aliasManager() — Method in class Application

Argument — Class in namespace Drush\Attributes

BootstrapManager::add() — Method in class BootstrapManager

Add a bootstrap object to the list of candidates.

DrupalBoot8::addDrupalModuleDrushCommands() — Method in class DrupalBoot8

Kernels::availableKernels() — Method in class Kernels

Returns the available kernels.

DrushCommandInfoAlterer::alterCommandInfo() — Method in class DrushCommandInfoAlterer

ServiceCommandlist::addCommandReference() — Method in class ServiceCommandlist

AutowireTrait — Class in namespace Drush\Commands

A copy of \Drupal\Core\DependencyInjection\AutowireTrait with first params' type hint changed.

ExampleCommands::alterFormatters() — Method in class ExampleCommands

Demonstrate an alter hook with an option.

LegacyCommands::archiveRestore() — Method in class LegacyCommands

archive:restore has been removed. A replacement may be available from your web host.

ArchiveDumpCommands — Class in namespace Drush\Commands\core

LanguageCommands::add() — Method in class LanguageCommands

LinkHooks::askLinkType() — Method in class LinkHooks

LinkHooks::askAllowLinkText() — Method in class LinkHooks

MkCommands::appendPostAmble() — Method in class MkCommands

MkCommands::appendAliases() — Method in class MkCommands

MkCommands::appendTopics() — Method in class MkCommands

MkCommands::appendOptions() — Method in class MkCommands

MkCommands::appendOptionsGlobal() — Method in class MkCommands

MkCommands::appendArguments() — Method in class MkCommands

MkCommands::appendUsages() — Method in class MkCommands

MkCommands::appendPreamble() — Method in class MkCommands

MkCommands::argToArray() — Method in class MkCommands

Build an array since that's what HelpCLIFormatter expects.

StatusCommands::adjustStatusOptions() — Method in class StatusCommands

UserCommands::addRole() — Method in class UserCommands

Add a role to the specified user accounts.

ViewsCommands::analyze() — Method in class ViewsCommands

Get a list of all Views and analyze warnings.

EntityTypeBundleAskTrait::askEntityType() — Method in class EntityTypeBundleAskTrait

EntityTypeBundleAskTrait::askBundle() — Method in class EntityTypeBundleAskTrait

FieldBaseOverrideCreateCommands::askFieldName() — Method in class FieldBaseOverrideCreateCommands

FieldBaseOverrideCreateCommands::askFieldLabel() — Method in class FieldBaseOverrideCreateCommands

FieldBaseOverrideCreateCommands::askFieldDescription() — Method in class FieldBaseOverrideCreateCommands

FieldBaseOverrideCreateCommands::askRequired() — Method in class FieldBaseOverrideCreateCommands

FieldCreateCommands::askExistingFieldName() — Method in class FieldCreateCommands

FieldCreateCommands::askFieldName() — Method in class FieldCreateCommands

FieldCreateCommands::askFieldLabel() — Method in class FieldCreateCommands

FieldCreateCommands::askFieldDescription() — Method in class FieldCreateCommands

FieldCreateCommands::askFieldType() — Method in class FieldCreateCommands

FieldCreateCommands::askFieldWidget() — Method in class FieldCreateCommands

FieldCreateCommands::askRequired() — Method in class FieldCreateCommands

FieldCreateCommands::askTranslatable() — Method in class FieldCreateCommands

FieldCreateCommands::askCardinality() — Method in class FieldCreateCommands

FieldDeleteCommands::askExisting() — Method in class FieldDeleteCommands

FieldDeleteCommands::askBundle() — Method in class FieldDeleteCommands

FieldEntityReferenceHooks::askReferencedEntityType() — Method in class FieldEntityReferenceHooks

FieldEntityReferenceHooks::askReferencedBundles() — Method in class FieldEntityReferenceHooks

FieldTextHooks::askAllowedFormats() — Method in class FieldTextHooks

Ask for the allowed formats. Only used in case the command is run interactively.

ApplicationFactory — Class in namespace Drush\Commands\generate

ApplicationFactory::alterGenerators() — Method in class ApplicationFactory

Implements hook GeneratorInfoAlter.

PmCommands::addInstallDependencies() — Method in class PmCommands

PmCommands::addUninstallDependencies() — Method in class PmCommands

SanitizeCommentsCommands::applies() — Method in class SanitizeCommentsCommands

ConfigLocator::addToSources() — Method in class ConfigLocator

Accumulate the sources provided by the configuration loader.

ConfigLocator::addEnvironment() — Method in class ConfigLocator

Exports all of the information stored in the environment, and adds it to the configuration. The Environment object itself is only available during preflight; the information exported here may be obtained by commands et. al. as needed.

ConfigLocator::addPreflightConfigFiles() — Method in class ConfigLocator

Add config paths defined in preflight configuration.

ConfigLocator::addAliasConfig() — Method in class ConfigLocator

Take any configuration from the active alias record, and add it to our configuration.

ConfigLocator::addUserConfig() — Method in class ConfigLocator

Given the path provided via --config and the user's home directory, add all of the user configuration paths.

ConfigLocator::addDrushConfig() — Method in class ConfigLocator

Add the Drush project directory as a configuration search location.

ConfigLocator::addSitewideConfig() — Method in class ConfigLocator

Add any configuration files found around the Drupal root of the selected site.

ConfigLocator::addConfigPaths() — Method in class ConfigLocator

Add any configuration file found at any of the provided paths. Both the provided location, and the directory config inside each provided location is searched for a drush.yml file.

ConfigLocator::addConfigFiles() — Method in class ConfigLocator

Adds $configFiles to the list of config files.

ConfigLocator::addSiteSpecificConfig() — Method in class ConfigLocator

Attempt to load site specific configuration.

Environment::applyEnvironment() — Method in class Environment

Alter our default locations based on the value of environment variables.

DrupalKernelTrait::addServiceModifier() — Method in class DrupalKernelTrait

Add a service modifier to the container builder.

$ MigrateExecutable#allSourceIdValues — Property in class MigrateExecutable

List of all source IDs that are found in source during this migration.

MigrateIdMapFilter::accept() — Method in class MigrateIdMapFilter

{@inheritdoc}

Drush::aliasManager() — Method in class Drush

Drush::affirmative() — Method in class Drush

Return 'true' if we are in affirmative mode

ArgsPreprocessor — Class in namespace Drush\Preflight

Preprocess commandline arguments.

ArgsRemapper — Class in namespace Drush\Preflight

Map commandline arguments from one value to another during preflight.

$ Preflight#aliasManager — Property in class Preflight

Preflight::aliasManager() — Method in class Preflight

$ PreflightArgs#args — Property in class PreflightArgs

PreflightArgs::adjustHelpOption() — Method in class PreflightArgs

If the user enters '--help' or '-h', thrown that option away and add a 'help' command to the beginning of the argument list.

PreflightArgs::applyToConfig() — Method in class PreflightArgs

PreflightArgs::args() — Method in class PreflightArgs

PreflightArgs::applicationPath() — Method in class PreflightArgs

PreflightArgs::addArg() — Method in class PreflightArgs

PreflightArgs::alias() — Method in class PreflightArgs

PreflightArgs::addConfigPath() — Method in class PreflightArgs

Add another location where drush.yml files may be found

PreflightArgs::aliasPaths() — Method in class PreflightArgs

Get the alias paths where drush site.site.yml files may be found

PreflightArgs::addAliasPath() — Method in class PreflightArgs

Set one more path where aliases may be found.

PreflightArgs::addCommandPath() — Method in class PreflightArgs

Add one more path where commandfiles might be found.

PreflightArgsInterface::applyToConfig() — Method in class PreflightArgsInterface

Copy any applicable arguments into the provided configuration object, as appropriate.

PreflightArgsInterface::args() — Method in class PreflightArgsInterface

Return all of the args from the inputs that were NOT processed by the ArgsPreprocessor (anything not listed in optionsWithValues).

PreflightArgsInterface::applicationPath() — Method in class PreflightArgsInterface

Return the path to this application's executable ($argv[0]).

PreflightArgsInterface::addArg() — Method in class PreflightArgsInterface

Add one argument to the end of the list returned by the args() method.

PreflightArgsInterface::alias() — Method in class PreflightArgsInterface

Return any '@alias' that may have appeared before the argument holding the command name.

DependencyInjection::addDrushServices() — Method in class DependencyInjection

DependencyInjection::alterServicesForDrush() — Method in class DependencyInjection

LegacyServiceFinder::addModuleDrushServiceProvider() — Method in class LegacyServiceFinder

Determine whether or not the Drush services.yml file is applicable for this version of Drush.

LegacyServiceFinder::addDrushServiceProvider() — Method in class LegacyServiceFinder

Add a services.yml file if it exists.

LegacyServiceInstantiator::allServicesHaveClassElement() — Method in class LegacyServiceInstantiator

Check all elements for required "class" elements.

LegacyServiceInstantiator::atLeastOneValue() — Method in class LegacyServiceInstantiator

Helper function to determine whether or not any of the arguments resolved. set methods with non-required DI container references are not called at all if the optional references are not in the container.

RedispatchHook::alterArgsForRedispatch() — Method in class RedispatchHook

Remove anything that is not necessary for the remote side.

SqlBase::addPipeFail() — Method in class SqlBase

Handle 'pipefail' option for the specified command.

SqlBase::alwaysQuery() — Method in class SqlBase

Execute a SQL query. Always execute regardless of simulate mode.

SqlBase::alwaysQueryCommand() — Method in class SqlBase

Start building the command to run a query.

CliTestTrait::assertOutputEquals() — Method in class CliTestTrait

Checks that the output matches the expected output.

CliTestTrait::assertErrorOutputEquals() — Method in class CliTestTrait

Checks that the error output matches the expected output.

B

$ Application#bootstrapManager — Property in class Application

Application::bootstrapManager() — Method in class Application

Application::bootstrapAndFind() — Method in class Application

Look up a command. Bootstrap further if necessary.

Bootstrap — Class in namespace Drush\Attributes

BackendPathEvaluator — Class in namespace Drush\Backend

BaseBoot — Class in namespace Drush\Boot

BaseBoot::bootstrapPhaseMap() — Method in class BaseBoot

Return an array mapping from bootstrap phase shorthand strings (e.g. "full") to the corresponding bootstrap phase index constant (e.g. DRUSH_BOOTSTRAP_DRUPAL_FULL).

BaseBoot::bootstrapDrush() — Method in class BaseBoot

Boot — Class in namespace Drush\Boot

Defines the interface for a Boot classes. Any CMS that wishes to work with Drush should extend BaseBoot. If the CMS has a Drupal-Compatibility layer, then it should extend DrupalBoot.

Boot::bootstrapPhases() — Method in class Boot

Returns an array that determines what bootstrap phases are necessary to bootstrap this CMS. This array should map from a numeric phase to the name of a method (string) in the Boot class that handles the bootstrap phase.

Boot::bootstrapPhaseMap() — Method in class Boot

Return an array mapping from bootstrap phase shorthand strings (e.g. "full") to the corresponding bootstrap phase index constant (e.g. DRUSH_BOOTSTRAP_DRUPAL_FULL).

BootstrapHook — Class in namespace Drush\Boot

The BootstrapHook is installed as an init hook that runs before all commands. If there is a @bootstrap annotation/attribute, then we will bootstrap Drupal to the requested phase.

$ BootstrapHook#bootstrapManager — Property in class BootstrapHook

BootstrapManager — Class in namespace Drush\Boot

$ BootstrapManager#bootstrapCandidates — Property in class BootstrapManager

$ BootstrapManager#bootstrap — Property in class BootstrapManager

BootstrapManager::bootstrap() — Method in class BootstrapManager

Crete the bootstrap object if necessary, then return it.

BootstrapManager::bootstrapObjectForRoot() — Method in class BootstrapManager

Look up the best bootstrap class for the given location from the set of available candidates.

BootstrapManager::bootstrapPhases() — Method in class BootstrapManager

Returns an array that determines what bootstrap phases are necessary to bootstrap the CMS.

BootstrapManager::bootstrapValidate() — Method in class BootstrapManager

Validate whether a bootstrap phase can be reached.

BootstrapManager::bootstrapToPhase() — Method in class BootstrapManager

Bootstrap to the specified phase.

BootstrapManager::bootstrapToPhaseIndex() — Method in class BootstrapManager

Bootstrap to the specified phase.

BootstrapManager::bootstrapMax() — Method in class BootstrapManager

Bootstrap to the highest level possible, without triggering any errors.

DrupalBoot::bootstrapPhases() — Method in class DrupalBoot

Bootstrap phases used with Drupal:

DrupalBoot::bootstrapPhaseMap() — Method in class DrupalBoot

Return an array mapping from bootstrap phase shorthand strings (e.g. "full") to the corresponding bootstrap phase index constant (e.g. DRUSH_BOOTSTRAP_DRUPAL_FULL).

DrupalBoot::bootstrapDrupalRootValidate() — Method in class DrupalBoot

Validate the DRUSH_BOOTSTRAP_DRUPAL_ROOT phase.

DrupalBoot::bootstrapDrupalRoot() — Method in class DrupalBoot

Bootstrap Drush with a valid Drupal Directory.

DrupalBoot::bootstrapDrupalCore() — Method in class DrupalBoot

DrupalBoot::bootstrapDrupalSiteValidate() — Method in class DrupalBoot

VALIDATE the DRUSH_BOOTSTRAP_DRUPAL_SITE phase.

DrupalBoot::bootstrapDrupalConfiguration() — Method in class DrupalBoot

Initialize and load the Drupal configuration files.

DrupalBoot::bootstrapDrupalDatabaseValidate() — Method in class DrupalBoot

Validate the DRUSH_BOOTSTRAP_DRUPAL_DATABASE phase

DrupalBoot::bootstrapDrupalDatabase() — Method in class DrupalBoot

Bootstrap the Drupal database.

DrupalBoot::bootstrapDrupalFull() — Method in class DrupalBoot

Attempt to load the full Drupal system.

DrupalBoot8::bootstrapDrupalSiteValidate() — Method in class DrupalBoot8

VALIDATE the DRUSH_BOOTSTRAP_DRUPAL_SITE phase.

DrupalBoot8::bootstrapDoDrupalSite() — Method in class DrupalBoot8

Called by bootstrapDrupalSite to do the main work of the Drush drupal site bootstrap.

DrupalBoot8::bootstrapDrupalConfigurationValidate() — Method in class DrupalBoot8

DrupalBoot8::bootstrapDrupalDatabaseValidate() — Method in class DrupalBoot8

Validate the DRUSH_BOOTSTRAP_DRUPAL_DATABASE phase

DrupalBoot8::bootstrapDrupalDatabase() — Method in class DrupalBoot8

Bootstrap the Drupal database.

DrupalBoot8::bootstrapDrupalConfiguration() — Method in class DrupalBoot8

Initialize and load the Drupal configuration files.

DrupalBoot8::bootstrapDrupalFull() — Method in class DrupalBoot8

Attempt to load the full Drupal system.

DrupalBoot8::bootstrapDrupalSite() — Method in class DrupalBoot8

Initialize a site on the Drupal root.

EmptyBoot::bootstrapPhases() — Method in class EmptyBoot

Returns an array that determines what bootstrap phases are necessary to bootstrap this CMS. This array should map from a numeric phase to the name of a method (string) in the Boot class that handles the bootstrap phase.

EmptyBoot::bootstrapInitPhases() — Method in class EmptyBoot

BatchCommands — Class in namespace Drush\Commands\core

BrowseCommands — Class in namespace Drush\Commands\core

BrowseCommands::browse() — Method in class BrowseCommands

Display a link to a given path or open link in a browser.

DocsCommands::bisect() — Method in class DocsCommands

Drush docs for Git Bisect.

DocsCommands::bootstrap() — Method in class DocsCommands

Bootstrap explanation: how Drush starts up and prepares the Drupal environment.

EditCommands::bashFiles() — Method in class EditCommands

UserCommands::block() — Method in class UserCommands

Block the specified user(s).

FieldBaseOverrideCreateCommands::baseOverrideCreateField() — Method in class FieldBaseOverrideCreateCommands

Create a new base field override

ListCommands::buildDom() — Method in class ListCommands

Drush::bootstrapManager() — Method in class Drush

Return the Bootstrap Manager.

Drush::bootstrap() — Method in class Drush

Return the Bootstrap object.

PreflightSiteLocator::buildSelf() — Method in class PreflightSiteLocator

Generate @self from the provided root and URI.

DrushCommand::buildHelpFromCommand() — Method in class DrushCommand

Build a command help from the Drush configuration array.

$ ServiceManager#bootstrapCommandClasses — Property in class ServiceManager

ServiceManager::bootstrapCommandClasses() — Method in class ServiceManager

Return cached of deferred commandhander objects.

ServiceManager::bootStrapAttributeValue() — Method in class ServiceManager

Does the provided class have a Bootstrap Attribute, indicating early loading.

BootstrapCompilerPass — Class in namespace Drush\Symfony

CliTestTrait::buildProcessMessage() — Method in class CliTestTrait

Borrowed from \Symfony\Component\Process\Exception\ProcessTimedOutException

C

Application::configureGlobalOptions() — Method in class Application

Add global options to the Application and their default values to Config.

Application::checkObsolete() — Method in class Application

If a command is annotated @obsolete, then we will throw an exception immediately; the command will not run, and no hooks will be called.

Application::configureIO() — Method in class Application

Application::configureAndRegisterCommands() — Method in class Application

Configure the application object and register all of the commandfiles available in the search paths provided via Preflight

Command — Class in namespace Drush\Attributes

Complete — Class in namespace Drush\Attributes

BaseBoot::commandDefaults() — Method in class BaseBoot

DrupalBoot::confPath() — Method in class DrupalBoot

DrupalBoot8::confPath() — Method in class DrupalBoot8

Beware, this function populates Database::Connection info.

$ ServiceCommandlist#commandList — Property in class ServiceCommandlist

AutowireTrait::create() — Method in class AutowireTrait

Instantiates a new instance of the implementing class using autowiring.

ConfiguresPrompts — Class in namespace Drush\Commands

ConfiguresPrompts::configurePrompts() — Method in class ConfiguresPrompts

Configure the prompt fallbacks.

$ DrushCommands#commandData — Property in class DrushCommands

ConfigCommands — Class in namespace Drush\Commands\config

ConfigCommands::configChangesTable() — Method in class ConfigCommands

Build a table of config changes.

ConfigCommands::configComplete() — Method in class ConfigCommands

ConfigCommands::copyConfig() — Method in class ConfigCommands

Copies configuration objects from source storage to target storage.

ConfigExportCommands — Class in namespace Drush\Commands\config

$ ConfigExportCommands#configStorageSync — Property in class ConfigExportCommands

$ ConfigExportCommands#configStorageExport — Property in class ConfigExportCommands

ConfigExportCommands::create() — Method in class ConfigExportCommands

ConfigImportCommands — Class in namespace Drush\Commands\config

$ ConfigImportCommands#configStorageSync — Property in class ConfigImportCommands

ConfigImportCommands::create() — Method in class ConfigImportCommands

ConfigPullCommands — Class in namespace Drush\Commands\config

CacheCommands — Class in namespace Drush\Commands\core

CacheCommands::clear() — Method in class CacheCommands

Clear a specific cache, or all Drupal caches.

CacheCommands::clearDrush() — Method in class CacheCommands

Clear caches internal to Drush core.

CacheCommands::clearBins() — Method in class CacheCommands

Clear one or more cache bins.

CacheCommands::clearThemeRegistry() — Method in class CacheCommands

CacheCommands::clearRouter() — Method in class CacheCommands

CacheCommands::clearCssJs() — Method in class CacheCommands

CacheCommands::clearContainer() — Method in class CacheCommands

CacheCommands::clearRender() — Method in class CacheCommands

Clears the render cache entries.

CacheCommands::clearPlugin() — Method in class CacheCommands

CacheRebuildCommands — Class in namespace Drush\Commands\core

CliCommands — Class in namespace Drush\Commands\core

CliCommands::cli() — Method in class CliCommands

Open an interactive shell on a Drupal site.

CoreCommands — Class in namespace Drush\Commands\core

DeployCommands::cacheRebuild() — Method in class DeployCommands

DocsCommands::config() — Method in class DocsCommands

Drush configuration.

DocsCommands::configExport() — Method in class DocsCommands

Drupal config export instructions, including customizing config by environment.

DocsCommands::cron() — Method in class DocsCommands

Crontab instructions for running your Drupal cron tasks via drush cron.

DocsCommands::commands() — Method in class DocsCommands

Instructions on creating your own Drush commands.

DrupalCommands::cron() — Method in class DrupalCommands

Run all cron hooks in all active modules for specified site.

EditCommands::create() — Method in class EditCommands

Not using Autowire in order to implicitly test backward compat.

EditCommands::complete() — Method in class EditCommands

EntityCreateCommands::createEntity() — Method in class EntityCreateCommands

Create a content entity after prompting for field values.

LocaleCommands::check() — Method in class LocaleCommands

Checks for available translation updates.

LocaleCommands::clearStatus() — Method in class LocaleCommands

Clears the translation status.

MkCommands::createAnnotatedCommands() — Method in class MkCommands

Convert generators into Annotated commands (for Help).

MkCommands::cliTextToMarkdown() — Method in class MkCommands

Convert text like foo to foo.

RoleCommands::createRole() — Method in class RoleCommands

Create a new role.

StatusCommands::createEarly() — Method in class StatusCommands

Not using Autowire in order to implicitly test backward compat.

UpdateDBCommands::cacheRebuild() — Method in class UpdateDBCommands

Clears caches and rebuilds the container.

UserCommands::createUser() — Method in class UserCommands

Create a user account.

UserCommands::createValidate() — Method in class UserCommands

Assure that provided username is available.

UserCommands::cancel() — Method in class UserCommands

Block or delete user account(s) with the specified name(s).

ViewsCommands::cacheClear() — Method in class ViewsCommands

Adds a cache clear option for views.

FieldBaseInfoCommands::complete() — Method in class FieldBaseInfoCommands

FieldBaseOverrideCreateCommands::complete() — Method in class FieldBaseOverrideCreateCommands

FieldBaseOverrideCreateCommands::createBaseFieldOverride() — Method in class FieldBaseOverrideCreateCommands

$ FieldCreateCommands#contentTranslationManager — Property in class FieldCreateCommands

FieldCreateCommands::create() — Method in class FieldCreateCommands

FieldCreateCommands::complete() — Method in class FieldCreateCommands

FieldCreateCommands::createField() — Method in class FieldCreateCommands

FieldCreateCommands::createFieldStorage() — Method in class FieldCreateCommands

FieldCreateCommands::createFieldDisplay() — Method in class FieldCreateCommands

FieldDefinitionCommands::complete() — Method in class FieldDefinitionCommands

FieldDeleteCommands::complete() — Method in class FieldDeleteCommands

FieldInfoCommands::complete() — Method in class FieldInfoCommands

ApplicationFactory::create() — Method in class ApplicationFactory

Creates Drush generate application.

GenerateCommands::create() — Method in class GenerateCommands

HelpCLIFormatter::cleanOptions() — Method in class HelpCLIFormatter

ListCommands::categorize() — Method in class ListCommands

SqlCommands::conf() — Method in class SqlCommands

SqlCommands::connect() — Method in class SqlCommands

A string for connecting to the DB.

SqlCommands::createDb() — Method in class SqlCommands

Create a database.

SqlCommands::cli() — Method in class SqlCommands

Open a SQL command-line interface using Drupal's credentials.

ConfigAwareTrait — Class in namespace Drush\Config

ConfigLocator — Class in namespace Drush\Config

Locate Drush configuration files and load them into the configuration instance.

$ ConfigLocator#config — Property in class ConfigLocator

$ ConfigLocator#composerRoot — Property in class ConfigLocator

$ ConfigLocator#configFilePaths — Property in class ConfigLocator

$ ConfigLocator#configFileVariant — Property in class ConfigLocator

ConfigLocator::collectSources() — Method in class ConfigLocator

Keep track of the source that every config item originally came from.

ConfigLocator::configFilePaths() — Method in class ConfigLocator

Return a list of all configuration files that were loaded.

ConfigLocator::config() — Method in class ConfigLocator

Return the configuration object. Create it and load it with all identified configuration if necessary.

DrushConfig::cwd() — Method in class DrushConfig

DrushConfig::configPaths() — Method in class DrushConfig

Return the list of paths to active Drush configuration files.

$ Environment#configFileVariant — Property in class Environment

Environment::cwd() — Method in class Environment

The original working directory

Environment::calculateColumns() — Method in class Environment

Get terminal width.

$ MigrateExecutable#counter — Property in class MigrateExecutable

Count of number of items processed so far in this migration.

Drush::commandFactory() — Method in class Drush

Return command factory

Drush::config() — Method in class Drush

Return the configuration object

CommandFailedException — Class in namespace Drush\Exceptions

Throw an exception indicating that the command was unable to continue.

EntityToArraySimplifier::canSimplify() — Method in class EntityToArraySimplifier

ArgsPreprocessor::checkMatchingOption() — Method in class ArgsPreprocessor

Check to see if the provided option matches the entry from the option table.

ArgsRemapper::checkRemap() — Method in class ArgsRemapper

Check to see if the provided single arg needs to be remapped. If it does, then the remapping is performed.

$ Preflight#configLocator — Property in class Preflight

Preflight::createInput() — Method in class Preflight

Preflight::config() — Method in class Preflight

$ PreflightArgs#commandName — Property in class PreflightArgs

PreflightArgs::commandName() — Method in class PreflightArgs

PreflightArgs::configPaths() — Method in class PreflightArgs

Get the config path where drush.yml files may be found

PreflightArgs::commandPaths() — Method in class PreflightArgs

Get the path where Drush commandfiles e.g. FooCommands.php may be found.

PreflightArgs::coverageFile() — Method in class PreflightArgs

Get the path to the coverage file.

PreflightArgs::createInput() — Method in class PreflightArgs

Create a Symfony Input object.

PreflightArgsInterface::commandName() — Method in class PreflightArgsInterface

Return the command name from the runtime args. Note that the command name also exists inside the runtime args, because the runtime args maintain the order of the options relative to the command name (save for those options removed by preflight args).

PreflightVerify::confirmPhpVersion() — Method in class PreflightVerify

Fail fast if the php version does not meet the minimum requirements.

PreflightVerify::confirmUsingCLI() — Method in class PreflightVerify

Fail if not being run from the command line.

PreflightVerify::checkPhpIni() — Method in class PreflightVerify

Evaluate the environment before command bootstrapping begins. If the php environment is too restrictive, then notify the user that a setting change is needed and abort.

Caster — Class in namespace Drush\Psysh

Caster class for VarDumper casters for the shell.

Caster::castContentEntity() — Method in class Caster

Casts \Drupal\Core\Entity\ContentEntityInterface classes.

Caster::castFieldItemList() — Method in class Caster

Casts \Drupal\Core\Field\FieldItemListInterface classes.

Caster::castFieldItem() — Method in class Caster

Casts \Drupal\Core\Field\FieldItemInterface classes.

Caster::castConfigEntity() — Method in class Caster

Casts \Drupal\Core\Config\Entity\ConfigEntityInterface classes.

Caster::castConfig() — Method in class Caster

Casts \Drupal\Core\Config\ConfigBase classes.

Caster::castContainer() — Method in class Caster

Casts \Drupal\Component\DependencyInjection\Container classes.

Caster::castMarkup() — Method in class Caster

Casts \Drupal\Component\Render\MarkupInterface classes.

DrushCommand::configure() — Method in class DrushCommand

{@inheritdoc}

$ DrushHelpCommand#command — Property in class DrushHelpCommand

The currently set subcommand.

DrushHelpCommand::configure() — Method in class DrushHelpCommand

{@inheritdoc}

LegacyServiceInstantiator::create() — Method in class LegacyServiceInstantiator

Create one named service.

LegacyServiceInstantiator::call() — Method in class LegacyServiceInstantiator

Call a method of an object with the provided arguments.

ProcessManager::configureProcess() — Method in class ProcessManager

configureProcess sets up a process object so that it is ready to use.

SqlBase::create() — Method in class SqlBase

Get a driver specific instance of this class.

SqlBase::command() — Method in class SqlBase

The unix command used to connect to the database.

SqlBase::connect() — Method in class SqlBase

A string for connecting to a database.

SqlBase::createdbSql() — Method in class SqlBase

Build a SQL string for dropping and creating a database.

SqlBase::createdb() — Method in class SqlBase

Create a new database.

SqlBase::creds() — Method in class SqlBase

Build a string containing connection credentials.

SqlMysql::command() — Method in class SqlMysql

The unix command used to connect to the database.

SqlMysql::creds() — Method in class SqlMysql

Build a string containing connection credentials.

SqlMysql::createdbSql() — Method in class SqlMysql

Build a SQL string for dropping and creating a database.

SqlPgsql::command() — Method in class SqlPgsql

The unix command used to connect to the database.

SqlPgsql::creds() — Method in class SqlPgsql

Build a string containing connection credentials.

SqlPgsql::createdb() — Method in class SqlPgsql

Create a new database.

SqlPgsql::createdbSql() — Method in class SqlPgsql

Build a SQL string for dropping and creating a database.

SqlSqlite::command() — Method in class SqlSqlite

The unix command used to connect to the database.

SqlSqlite::creds() — Method in class SqlSqlite

Build a string containing connection credentials.

SqlSqlite::createdbSql() — Method in class SqlSqlite

Build a SQL string for dropping and creating a database.

SqlSqlite::createdb() — Method in class SqlSqlite

Create a new database.

CliTestTrait — Class in namespace Drush\TestTraits

CliTestTrait provides an execute() method that is useful for launching executable programs in functional tests.

DrushTestTrait::convertKeyValueToFlag() — Method in class DrushTestTrait

Given an option key / value pair, convert to a "--key=value" string.

FsUtils::cleanup() — Method in class FsUtils

Delete all of the files registered for deletion.

StringUtils::csvToArray() — Method in class StringUtils

Convert a csv string, or an array of items which may contain csv strings, into an array of items.

D

DefaultFields — Class in namespace Drush\Attributes

DefaultTableFields — Class in namespace Drush\Attributes

$ BootstrapManager#drupalFinder — Property in class BootstrapManager

BootstrapManager::drupalFinder() — Method in class BootstrapManager

BootstrapManager::doBootstrap() — Method in class BootstrapManager

Bootstrap Drush to the desired phase.

DrupalBoot — Class in namespace Drush\Boot

DrupalBoot8 — Class in namespace Drush\Boot

$ DrupalBoot8#drupalLoggerAdapter — Property in class DrupalBoot8

DrupalBootLevels — Class in namespace Drush\Boot

A value class with bootstrap levels.

DrushCommandInfoAlterer — Class in namespace Drush\Command

DrushCommands — Class in namespace Drush\Commands

ConfigCommands::delete() — Method in class ConfigCommands

Delete a configuration key, or a whole object(s).

ConfigExportCommands::doExport() — Method in class ConfigExportCommands

ConfigExportCommands::doAddCommit() — Method in class ConfigExportCommands

ConfigImportCommands::doImport() — Method in class ConfigImportCommands

ArchiveDumpCommands::dump() — Method in class ArchiveDumpCommands

Backup your code, files, and database into a single file.

CliCommands::docs() — Method in class CliCommands

Drush's PHP Shell.

DeployCommands — Class in namespace Drush\Commands\core

DeployCommands::deploy() — Method in class DeployCommands

Run several commands after performing a code deployment.

DeployHookCommands — Class in namespace Drush\Commands\core

DocsCommands — Class in namespace Drush\Commands\core

Topic commands.

DocsCommands::deploy() — Method in class DocsCommands

Deploy command for Drupal.

DrupalCommands — Class in namespace Drush\Commands\core

DrupalDirectoryCommands — Class in namespace Drush\Commands\core

DrupalDirectoryCommands::drupalDirectory() — Method in class DrupalDirectoryCommands

Return the filesystem path for modules/themes and other key folders.

DrupliconCommands — Class in namespace Drush\Commands\core

DrupliconCommands::druplicon() — Method in class DrupliconCommands

Print druplicon as post-command output.

EntityCommands::delete() — Method in class EntityCommands

Delete content entities.

EntityCommands::doDelete() — Method in class EntityCommands

Actual delete method.

EntityCommands::doSave() — Method in class EntityCommands

Actual save method.

ImageCommands::derive() — Method in class ImageCommands

Create an image derivative.

MkCommands::docs() — Method in class MkCommands

Build a Markdown document for each available Drush command/generator.

QueueCommands::delete() — Method in class QueueCommands

Delete all items in a specific queue.

RoleCommands::delete() — Method in class RoleCommands

Delete a role.

SiteInstallCommands::determineProfile() — Method in class SiteInstallCommands

StateCommands::delete() — Method in class StateCommands

Delete a state entry.

ViewsCommands::dev() — Method in class ViewsCommands

Set several Views settings to more developer-oriented values.

ViewsCommands::disable() — Method in class ViewsCommands

Disable the specified views.

WatchdogCommands::delete() — Method in class WatchdogCommands

Delete watchdog log records.

FieldDeleteCommands::delete() — Method in class FieldDeleteCommands

Delete a field

FieldDeleteCommands::deleteFieldConfig() — Method in class FieldDeleteCommands

ApplicationFactory::discover() — Method in class ApplicationFactory

DrushAliasFile — Class in namespace Drush\Commands\generate\Generators\Drush

DrushCommandFile — Class in namespace Drush\Commands\generate\Generators\Drush

DrushGeneratorFile — Class in namespace Drush\Commands\generate\Generators\Drush

DrushHelpDocument — Class in namespace Drush\Commands\help

SqlCommands::drop() — Method in class SqlCommands

Drop all tables in a given database.

SqlCommands::dump() — Method in class SqlCommands

Exports the Drupal DB as SQL using mysqldump or equivalent.

SqlSyncCommands::databaseName() — Method in class SqlSyncCommands

SqlSyncCommands::dump() — Method in class SqlSyncCommands

Perform sql-dump on source unless told otherwise. Returns the path to the dump file.

DrushConfig — Class in namespace Drush\Config

Accessors for common Drush config keys.

DrushConfig::drushScript() — Method in class DrushConfig

Return the path to this Drush

$ Environment#drushBasePath — Property in class Environment

$ Environment#docPrefix — Property in class Environment

Environment::drushBasePath() — Method in class Environment

The base directory of the Drush application itself (where composer.json et.al. are found)

Environment::docsPath() — Method in class Environment

Return the directory where Drush's documentation is stored. Usually this is within the Drush application, but some Drush RPM distributions & c. for Linux platforms slice-and-dice the contents and put the docs elsewhere.

DrushDrupalFinder — Class in namespace Drush\DrupalFinder

A replacement for DrupalFinder. We may go back to that once it uses InstalledVersions from Composer.

DrupalKernel — Class in namespace Drush\Drupal

Overridden version of DrupalKernel adapted to the needs of Drush.

DrupalKernelTrait — Class in namespace Drush\Drupal

Common functionality for overridden kernels.

DrupalKernelTrait::discoverServiceProviders() — Method in class DrupalKernelTrait

{@inheritdoc}

DrupalUtil — Class in namespace Drush\Drupal

DrupalUtil::drushRender() — Method in class DrupalUtil

Output a Drupal render array, object or string as plain text.

DrushLoggerServiceProvider — Class in namespace Drush\Drupal

$ MigrateExecutable#deleteCounter — Property in class MigrateExecutable

Counter of map deletions.

$ MigrateExecutable#deleteMissingSourceRows — Property in class MigrateExecutable

Whether to delete rows missing from source after an import.

$ MigrateIdMapFilter#destinationIdList — Property in class MigrateIdMapFilter

List of specific destination IDs to filter on.

MigrateMessage::display() — Method in class MigrateMessage

Outputs a message from the migration.

$ MigrateMissingSourceRowsEvent#destinationIds — Property in class MigrateMissingSourceRowsEvent

Values representing the destination IDs.

Drush — Class in namespace Drush

Static Service Container wrapper.

Drush::drush() — Method in class Drush

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

Drush::debug() — Method in class Drush

Return 'true' if we are in debug mode

DrushFormatterManager — Class in namespace Drush\Formatters

Our own output formatter

DrushLog — Class in namespace Drush\Log

Redirects Drupal logging messages to Drush log.

DrushLoggerManager — Class in namespace Drush\Log

$ Preflight#drupalFinder — Property in class Preflight

Preflight::drupalFinder() — Method in class Preflight

$ PreflightLog#debug — Property in class PreflightLog

PreflightSiteLocator::determineSelf() — Method in class PreflightSiteLocator

Either look up the specified alias name / site spec, or, if those are invalid, then generate one from the provided root and URI.

DrushCommand — Class in namespace Drush\Psysh

DrushCommand is a PsySH proxy command which accepts a Drush command config array and tries to build an appropriate PsySH command for it.

DrushHelpCommand — Class in namespace Drush\Psysh

Help command.

DependencyInjection — Class in namespace Drush\Runtime

Prepare our Dependency Injection Container

DependencyInjection::desiredHandlers() — Method in class DependencyInjection

$ LegacyServiceFinder#drushServiceYamls — Property in class LegacyServiceFinder

LegacyServiceFinder::discoverDrushServiceProviders() — Method in class LegacyServiceFinder

Search for drush.service.yml files in discoverable locations.

Runtime::doRun() — Method in class Runtime

Start up Drush

ServiceManager::discover() — Method in class ServiceManager

Discover all of the different kinds of command handler objects in the places where Drush can find them. Called during preflight; some command classes are returned right away, and others are saved to be handled later during Drupal bootstrap.

ServiceManager::discoverCommandsFromConfiguration() — Method in class ServiceManager

Discover commands explicitly declared in configuration.

ServiceManager::discoverCommands() — Method in class ServiceManager

Discovers command classes from a provided search path.

ServiceManager::discoverPsr4Commands() — Method in class ServiceManager

Discover PSR-4 autoloaded classes that implement Annotated Command library command handlers.

ServiceManager::discoverPsr4Generators() — Method in class ServiceManager

Discover PSR-4 autoloaded classes that implement DCG generators.

ServiceManager::discoverModuleCommands() — Method in class ServiceManager

Discover module commands. This is the preferred way to find module commands in Drush 12+.

ServiceManager::discoverModuleCommandInfoAlterers() — Method in class ServiceManager

Discover command info alterers in modules.

ServiceManager::discoverModuleGenerators() — Method in class ServiceManager

Return generators that ship in modules.

$ ProcessManager#drupalFinder — Property in class ProcessManager

ProcessManager::drush() — Method in class ProcessManager

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

ProcessManager::drushSiteProcess() — Method in class ProcessManager

drushSiteProcess should be avoided in favor of the drush method above.

ProcessManager::drushScript() — Method in class ProcessManager

Determine the path to Drush to use

SqlBase::dump() — Method in class SqlBase

SqlBase::dumpCmd() — Method in class SqlBase

SqlBase::dumpFile() — Method in class SqlBase

SqlBase::drop() — Method in class SqlBase

Drop specified database.

SqlBase::dropOrCreate() — Method in class SqlBase

Drop all tables (if DB exists) or CREATE target database.

SqlBase::dbExists() — Method in class SqlBase

SqlBase::dbSpecFromDbUrl() — Method in class SqlBase

Convert from an old-style database URL to an array of database settings.

SqlMariaDB::dumpProgram() — Method in class SqlMariaDB

SqlMysql::dumpProgram() — Method in class SqlMysql

SqlMysql::dbExists() — Method in class SqlMysql

SqlMysql::dumpCmd() — Method in class SqlMysql

SqlPgsql::drop() — Method in class SqlPgsql

Drop specified database.

SqlPgsql::dbExists() — Method in class SqlPgsql

SqlPgsql::dumpCmd() — Method in class SqlPgsql

SqlSqlite::dbExists() — Method in class SqlSqlite

SqlSqlite::drop() — Method in class SqlSqlite

Drop specified database.

SqlSqlite::dumpCmd() — Method in class SqlSqlite

DrushStyleInjector — Class in namespace Drush\Symfony

DrushTestTrait — Class in namespace Drush\TestTraits

DrushTestTrait provides a drush() method that may be used to write functional tests for Drush extensions.

DrushTestTrait::drush() — Method in class DrushTestTrait

Invoke drush in via execute().

DrushTestTrait::drushMajorVersion() — Method in class DrushTestTrait

Return the major version of Drush

E

BackendPathEvaluator::evaluate() — Method in class BackendPathEvaluator

Evaluate will check to see if the provided host path contains a path alias. If it does, the alias will be resolved, and the result of the resolution will be injected into the HostPath, replacing the alias.

EmptyBoot — Class in namespace Drush\Boot

This is a do-nothing 'Boot' class that is used when there is no site at --root, or when no root is specified.

RemoteCommandProxy::execute() — Method in class RemoteCommandProxy

ExampleCommands — Class in namespace Drush\Commands

ExampleCommands::exampleTable() — Method in class ExampleCommands

Demonstrate output formatters. Default format is 'table'.

ConfigCommands::edit() — Method in class ConfigCommands

Open a config file in a text editor. Edits are imported after closing editor.

ConfigExportCommands::export() — Method in class ConfigExportCommands

Export Drupal configuration to a directory.

DocsCommands::exampleCommand() — Method in class DocsCommands

Example Drush command file.

EditCommands — Class in namespace Drush\Commands\core

EditCommands::edit() — Method in class EditCommands

Edit drush.yml, site alias, and Drupal settings.php files.

EntityCommands — Class in namespace Drush\Commands\core

EntityCreateCommands — Class in namespace Drush\Commands\core

LocaleCommands::export() — Method in class LocaleCommands

Exports to a gettext translation file.

LocaleCommands::exportValidate() — Method in class LocaleCommands

Assure that required options are set.

MigrateRunnerCommands::executeMigration() — Method in class MigrateRunnerCommands

Executes a single migration.

PhpCommands::evaluate() — Method in class PhpCommands

Evaluate arbitrary php code after bootstrapping Drupal (if available).

ViewsCommands::execute() — Method in class ViewsCommands

Execute a view and show a count of the results, or the rendered HTML.

ViewsCommands::enable() — Method in class ViewsCommands

Enable the specified views.

EntityTypeBundleAskTrait — Class in namespace Drush\Commands\field

$ EntityTypeBundleAskTrait#entityTypeBundleInfo — Property in class EntityTypeBundleAskTrait

$ EntityTypeBundleAskTrait#entityTypeManager — Property in class EntityTypeBundleAskTrait

EntityTypeBundleValidationTrait — Class in namespace Drush\Commands\field

$ EntityTypeBundleValidationTrait#entityTypeManager — Property in class EntityTypeBundleValidationTrait

FieldCreateCommands::ensureOption() — Method in class FieldCreateCommands

PmCommands::extensionStatus() — Method in class PmCommands

Calculate an extension status based on current status and schema version.

ConfigLocator::expandCandidates() — Method in class ConfigLocator

Double the candidates, adding '$prefix' before each existing one.

Environment — Class in namespace Drush\Config

Store information about the environment

$ Environment#etcPrefix — Property in class Environment

Environment::exportConfigData() — Method in class Environment

Convert the environment object into an exported configuration array.

ExtensionDiscovery — Class in namespace Drush\Drupal

$ MigrateExecutable#exposeProgressBar — Property in class MigrateExecutable

If the execution exposes a progress bar.

ExecTrait — Class in namespace Drush\Exec

EntityToArraySimplifier — Class in namespace Drush\Formatters

Simplify a EntityInterface to an array.

$ Preflight#environment — Property in class Preflight

Preflight::environment() — Method in class Preflight

DrushCommand::execute() — Method in class DrushCommand

{@inheritdoc}

DrushHelpCommand::execute() — Method in class DrushHelpCommand

{@inheritdoc}

ErrorHandler — Class in namespace Drush\Runtime

Log PHP errors to the Drush log. This is in effect until Drupal's error handler takes over.

ErrorHandler::errorHandler() — Method in class ErrorHandler

RedispatchHook::exitEarly() — Method in class RedispatchHook

Abort the current execution without causing distress to our shutdown handler.

Runtime::exitCode() — Method in class Runtime

Get the exit code for current request.

SqlTableSelectionTrait::expandAndFilterTables() — Method in class SqlTableSelectionTrait

Given the table names in the input array that may contain wildcards (*), expand the table names so that the array returned only contains table names that exist in the database.

SqlTableSelectionTrait::expandWildcardTables() — Method in class SqlTableSelectionTrait

Expand wildcard tables.

CliTestTrait::execute() — Method in class CliTestTrait

Actually runs the command.

CliTestTrait::escapeshellarg() — Method in class CliTestTrait

F

Application::find() — Method in class Application

FieldLabels — Class in namespace Drush\Attributes

FilterDefaultField — Class in namespace Drush\Attributes

Format — Class in namespace Drush\Attributes

BaseBoot::findUri() — Method in class BaseBoot

Select the best URI for the provided cwd. Only called if the user did not explicitly specify a URI.

Boot::findUri() — Method in class Boot

Select the best URI for the provided cwd. Only called if the user did not explicitly specify a URI.

DrupalBoot::findUri() — Method in class DrupalBoot

Select the best URI for the provided cwd. Only called if the user did not explicitly specify a URI.

EditCommands::findBashrc() — Method in class EditCommands

Determine which .bashrc file is best to use on this platform.

ImageCommands::flush() — Method in class ImageCommands

Flush all derived images for a given style.

MigrateRunnerCommands::fieldsSource() — Method in class MigrateRunnerCommands

List the fields available for mapping in a source.

StateCommands::format() — Method in class StateCommands

WatchdogCommands::formatResult() — Method in class WatchdogCommands

Format a watchdog database row.

FieldBaseInfoCommands — Class in namespace Drush\Commands\field

FieldBaseOverrideCreateCommands — Class in namespace Drush\Commands\field

FieldCreateCommands — Class in namespace Drush\Commands\field

FieldCreateCommands::fieldCreate() — Method in class FieldCreateCommands

Create a new field

FieldCreateCommands::fieldExists() — Method in class FieldCreateCommands

FieldCreateCommands::fieldStorageExists() — Method in class FieldCreateCommands

FieldDefinitionCommands — Class in namespace Drush\Commands\field

FieldDefinitionCommands::formatters() — Method in class FieldDefinitionCommands

FieldDefinitionRowsOfFieldsTrait — Class in namespace Drush\Commands\field

FieldDeleteCommands — Class in namespace Drush\Commands\field

FieldEntityReferenceHooks — Class in namespace Drush\Commands\field

FieldInfoCommands — Class in namespace Drush\Commands\field

FieldTextHooks — Class in namespace Drush\Commands\field

ApplicationFactory::filterClassExists() — Method in class ApplicationFactory

Check each class for existence.

HelpCLIFormatter::formatOptionKeys() — Method in class HelpCLIFormatter

HelpCLIFormatter::formatOptionDescription() — Method in class HelpCLIFormatter

HelpCLIFormatter::formatArgumentName() — Method in class HelpCLIFormatter

ConfigLocator::findConfigFiles() — Method in class ConfigLocator

Given an array of paths, separates files and directories.

Environment::findDocsPath() — Method in class Environment

Locate the Drush documentation. This is recalculated whenever the share prefix is changed.

Environment::findFromCandidates() — Method in class Environment

Check a list of directories and return the first one that exists.

$ MigrateExecutable#feedback — Property in class MigrateExecutable

Frequency (in items) at which progress messages should be emitted.

Logger::formatSize() — Method in class Logger

ArgsPreprocessor::findMethodForOptionWithValues() — Method in class ArgsPreprocessor

Check to see if '$opt' is one of the options that we record that takes a value.

PreflightSiteLocator::findSite() — Method in class PreflightSiteLocator

During bootstrap, finds the currently selected site from the parameters provided on the commandline.

LegacyServiceFinder::findModuleDrushServiceProvider() — Method in class LegacyServiceFinder

LegacyServiceFinder::findDefaultServicesFile() — Method in class LegacyServiceFinder

LegacyServiceFinder::findModuleDrushServiceProviderFromComposer() — Method in class LegacyServiceFinder

In composer.json, the Drush version constraints will appear in the 'extra' section like so:

LegacyServiceFinder::findAppropriateServicesFile() — Method in class LegacyServiceFinder

SqlTableSelectionTrait::filterTables() — Method in class SqlTableSelectionTrait

Filters tables.

FsUtils — Class in namespace Drush\Utils

G

Application::getUri() — Method in class Application

Return the framework uri selected by the user.

ValidateQueueName::getQueues() — Method in class ValidateQueueName

BaseBoot::getUri() — Method in class BaseBoot

BaseBoot::getPhase() — Method in class BaseBoot

BaseBoot::getVersion() — Method in class BaseBoot

Given a site root directory, determine the exact version of the software.

Boot::getVersion() — Method in class Boot

Given a site root directory, determine the exact version of the software.

BootstrapManager::getPhase() — Method in class BootstrapManager

BootstrapManager::getRoot() — Method in class BootstrapManager

Return the framework root selected by the user.

BootstrapManager::getComposerRoot() — Method in class BootstrapManager

Return the composer root for the selected Drupal site.

BootstrapManager::getUri() — Method in class BootstrapManager

Return the framework uri selected by the user.

DrupalBoot::getVersion() — Method in class DrupalBoot

Given a site root directory, determine the exact version of the software.

DrupalBoot8::getRequest() — Method in class DrupalBoot8

DrupalBoot8::getKernel() — Method in class DrupalBoot8

DrupalBoot8::getVersion() — Method in class DrupalBoot8

Given a site root directory, determine the exact version of the software.

DrupalBootLevels::getPhaseName() — Method in class DrupalBootLevels

Kernels::getKernelFactory() — Method in class Kernels

Returns the factory method that can be used to retrieve the given kernel.

GlobalOptionsEventListener — Class in namespace Drush\Command

GlobalOptionsEventListener::getSubscribedEvents() — Method in class GlobalOptionsEventListener

ServiceCommandlist::getCommandList() — Method in class ServiceCommandlist

DrushCommands::getStack() — Method in class DrushCommands

Get a Guzzle handler stack that uses the Drush logger.

ConfigCommands::getConfigFactory() — Method in class ConfigCommands

ConfigCommands::getConfigStorageExport() — Method in class ConfigCommands

ConfigCommands::getImportTransformer() — Method in class ConfigCommands

ConfigCommands::get() — Method in class ConfigCommands

Display a config value, or a whole configuration object.

ConfigCommands::getDirectory() — Method in class ConfigCommands

Determine which configuration directory to use and return directory path.

ConfigCommands::getChanges() — Method in class ConfigCommands

Returns the difference in configuration between active storage and target storage.

ConfigCommands::getStorage() — Method in class ConfigCommands

Get storage corresponding to a configuration directory.

ConfigCommands::getDiff() — Method in class ConfigCommands

Get diff between two config sets.

ConfigExportCommands::getConfigManager() — Method in class ConfigExportCommands

ConfigExportCommands::getConfigStorageExport() — Method in class ConfigExportCommands

ConfigExportCommands::getConfigStorage() — Method in class ConfigExportCommands

ConfigExportCommands::getConfigStorageSync() — Method in class ConfigExportCommands

ConfigImportCommands::getConfigManager() — Method in class ConfigImportCommands

ConfigImportCommands::getConfigStorage() — Method in class ConfigImportCommands

ConfigImportCommands::getConfigStorageSync() — Method in class ConfigImportCommands

ConfigImportCommands::getConfigCache() — Method in class ConfigImportCommands

ConfigImportCommands::getModuleHandler() — Method in class ConfigImportCommands

ConfigImportCommands::getEventDispatcher() — Method in class ConfigImportCommands

ConfigImportCommands::getLock() — Method in class ConfigImportCommands

ConfigImportCommands::getConfigTyped() — Method in class ConfigImportCommands

ConfigImportCommands::getModuleInstaller() — Method in class ConfigImportCommands

ConfigImportCommands::getThemeHandler() — Method in class ConfigImportCommands

ConfigImportCommands::getStringTranslation() — Method in class ConfigImportCommands

ConfigImportCommands::getImportTransformer() — Method in class ConfigImportCommands

ConfigImportCommands::getModuleExtensionList() — Method in class ConfigImportCommands

CacheCommands::get() — Method in class CacheCommands

Fetch a cached object and display it.

CacheCommands::getTypes() — Method in class CacheCommands

Types of caches available for clearing. Contrib commands can hook in their own.

CliCommands::getDrushCommands() — Method in class CliCommands

Returns a filtered list of Drush commands used for CLI commands.

CliCommands::getCasters() — Method in class CliCommands

Returns a mapped array of casters for use in the shell.

CliCommands::getPhpKeywords() — Method in class CliCommands

Returns a list of PHP keywords.

CoreCommands::globalOptions() — Method in class CoreCommands

All global options.

DeployHookCommands::getRegistry() — Method in class DeployHookCommands

Get the deploy hook update registry.

DocsCommands::generators() — Method in class DocsCommands

Instructions on creating your own Drush Generators.

DrupalCommands::getCron() — Method in class DrupalCommands

DrupalCommands::getModuleHandler() — Method in class DrupalCommands

DrupalCommands::getRouteProvider() — Method in class DrupalCommands

DrupalDirectoryCommands::getPath() — Method in class DrupalDirectoryCommands

Given a target (e.g.

EntityCommands::getQuery() — Method in class EntityCommands

JsonapiCommands::get() — Method in class JsonapiCommands

Execute a JSONAPI request.

LanguageCommands::getLanguageManager() — Method in class LanguageCommands

LanguageCommands::getModuleHandler() — Method in class LanguageCommands

LocaleCommands::getLanguageManager() — Method in class LocaleCommands

LocaleCommands::getConfigFactory() — Method in class LocaleCommands

LocaleCommands::getState() — Method in class LocaleCommands

MaintCommands::getState() — Method in class MaintCommands

MaintCommands::get() — Method in class MaintCommands

Get maintenance mode. Returns 1 if enabled, 0 if not.

MigrateRunnerCommands::getMigrationSourceRowsCount() — Method in class MigrateRunnerCommands

Returns the migration source rows count.

MigrateRunnerCommands::getMigrationNeedingUpdateCount() — Method in class MigrateRunnerCommands

Returns the number of items that needs update.

MigrateRunnerCommands::getMigrationUnprocessedCount() — Method in class MigrateRunnerCommands

Returns the number of unprocessed items.

MigrateRunnerCommands::getMigrationImportedCount() — Method in class MigrateRunnerCommands

Returns the number of imported items.

MigrateRunnerCommands::getMigrationLastImportedTime() — Method in class MigrateRunnerCommands

Returns the last imported date/time if any.

MigrateRunnerCommands::getMigrationList() — Method in class MigrateRunnerCommands

Retrieves a list of active migrations.

MigrateRunnerCommands::getMigrateMessage() — Method in class MigrateRunnerCommands

Returns the migrate message logger.

MigrateRunnerCommands::getSourceIdKeys() — Method in class MigrateRunnerCommands

Get the source ID keys.

MkCommands::getRedirectMap() — Method in class MkCommands

MkCommands::getFilename() — Method in class MkCommands

Get a filename from a command.

QueueCommands::getWorkerManager() — Method in class QueueCommands

QueueCommands::getQueueService() — Method in class QueueCommands

QueueCommands::getQueues() — Method in class QueueCommands

QueueCommands::getQueue() — Method in class QueueCommands

SiteInstallCommands::getSitesSubdirFromUri() — Method in class SiteInstallCommands

Determine an appropriate site subdir name to use for the provided uri.

StateCommands::getState() — Method in class StateCommands

StateCommands::get() — Method in class StateCommands

Display a state value.

StatusCommands::getPropertyList() — Method in class StatusCommands

TopicCommands::getAllTopics() — Method in class TopicCommands

Retrieve all defined topics

TwigCommands::getTwig() — Method in class TwigCommands

TwigCommands::getModuleHandler() — Method in class TwigCommands

UpdateDBCommands::getUpdateList() — Method in class UpdateDBCommands

UpdateDBCommands::getUpdatedbStatus() — Method in class UpdateDBCommands

Returns information about available module updates.

UserCommands::getAccounts() — Method in class UserCommands

Get accounts from name variables or uid & mail options.

ViewsCommands::getConfigFactory() — Method in class ViewsCommands

ViewsCommands::getModuleHandler() — Method in class ViewsCommands

ViewsCommands::getEntityTypeManager() — Method in class ViewsCommands

ViewsCommands::getRenderer() — Method in class ViewsCommands

EntityTypeBundleAskTrait::getFieldableEntityTypes() — Method in class EntityTypeBundleAskTrait

FieldBaseOverrideCreateCommands::getBaseFieldDefinition() — Method in class FieldBaseOverrideCreateCommands

FieldCreateCommands::getEntityDisplay() — Method in class FieldCreateCommands

FieldCreateCommands::generateFieldName() — Method in class FieldCreateCommands

FieldCreateCommands::getExistingFieldStorageOptions() — Method in class FieldCreateCommands

FieldDefinitionRowsOfFieldsTrait::getRowsOfFieldsByFieldDefinitions() — Method in class FieldDefinitionRowsOfFieldsTrait

FieldDeleteCommands::getFieldConfigs() — Method in class FieldDeleteCommands

Returns all field configs for the given entity type and bundle.

FieldEntityReferenceHooks::getTargetType() — Method in class FieldEntityReferenceHooks

FieldEntityReferenceHooks::getTargetBundles() — Method in class FieldEntityReferenceHooks

GenerateCommands — Class in namespace Drush\Commands\generate

GenerateCommands::generate() — Method in class GenerateCommands

Generate boilerplate code for modules/plugins/services etc.

GenerateCommands::generatorNameComplete() — Method in class GenerateCommands

Generates completion for generator names.

DrushAliasFile::generate() — Method in class DrushAliasFile

{@inheritdoc}

DrushCommandFile::generate() — Method in class DrushCommandFile

{@inheritdoc}

DrushGeneratorFile::generate() — Method in class DrushGeneratorFile

DrushHelpDocument::generateBaseHelpDom() — Method in class DrushHelpDocument

ListCommands::getTerminalWidth() — Method in class ListCommands

PmCommands::getConfigFactory() — Method in class PmCommands

PmCommands::getModuleInstaller() — Method in class PmCommands

PmCommands::getModuleHandler() — Method in class PmCommands

PmCommands::getThemeHandler() — Method in class PmCommands

PmCommands::getExtensionListModule() — Method in class PmCommands

ThemeCommands::getThemeInstaller() — Method in class ThemeCommands

SanitizeUserFieldsCommands::getDatabase() — Method in class SanitizeUserFieldsCommands

SanitizeUserFieldsCommands::getEntityFieldManager() — Method in class SanitizeUserFieldsCommands

ConfigAwareTrait::getConfig() — Method in class ConfigAwareTrait

Replaces same method in ConfigAwareTrait in order to provide a DrushConfig as return type. Helps with IDE completion.

ConfigLocator::getSiteAliasPaths() — Method in class ConfigLocator

Get the site aliases according to preflight arguments and environment.

ConfigLocator::getCommandFilePaths() — Method in class ConfigLocator

Get the commandfile paths according to preflight arguments.

ConfigLocator::getBuiltinCommandFilePaths() — Method in class ConfigLocator

Return all of the built-in commandfile locations

ConfigLocator::getIncludedCommandFilePaths() — Method in class ConfigLocator

Return all of the commandfile locations specified via an 'include' option.

ConfigLocator::getSiteCommandFilePaths() — Method in class ConfigLocator

Return all of the commandfile paths in any '$root/drush' or 'dirname($root)/drush' directory that contains a composer.json file or a 'Commands' or 'src/Commands' directory.

Environment::getUsername() — Method in class Environment

Return the name of the user running drush.

Environment::getTmp() — Method in class Environment

Environment::getSiteSetAliasName() — Method in class Environment

Get the site:set alias from the current site:set file path.

Environment::getConfigFileVariant() — Method in class Environment

Get the config file variant -- defined to be the Drush major version number. This is for loading drush.yml and drush10.yml, etc.

Environment::getSiteSetAliasFilePath() — Method in class Environment

Returns the filename for the file that stores the DRUPAL_SITE variable.

DrushDrupalFinder::getDrupalRoot() — Method in class DrushDrupalFinder

Get the Drupal root.

DrushDrupalFinder::getComposerRoot() — Method in class DrushDrupalFinder

Get the Composer root.

DrushDrupalFinder::getVendorDir() — Method in class DrushDrupalFinder

Get the vendor path.

DrupalKernelTrait::getContainerBuilder() — Method in class DrupalKernelTrait

MigrateExecutable::getIdMap() — Method in class MigrateExecutable

{@inheritdoc}

MigrateExecutable::getCreatedCount() — Method in class MigrateExecutable

Returns the number of items created.

MigrateExecutable::getUpdatedCount() — Method in class MigrateExecutable

Returns the number of items updated.

MigrateExecutable::getIgnoredCount() — Method in class MigrateExecutable

Returns the number of items ignored.

MigrateExecutable::getFailedCount() — Method in class MigrateExecutable

Returns the number of items that failed.

MigrateExecutable::getProcessedCount() — Method in class MigrateExecutable

Returns the total number of items processed.

MigrateExecutable::getRollbackCount() — Method in class MigrateExecutable

Returns the number of items rolled back.

MigrateMissingSourceRowsEvent::getMigration() — Method in class MigrateMissingSourceRowsEvent

Gets the migration plugin instance.

MigrateMissingSourceRowsEvent::getDestinationIds() — Method in class MigrateMissingSourceRowsEvent

Gets the destination ID values.

MigratePrepareRowEvent::getRow() — Method in class MigratePrepareRowEvent

Gets the row object.

MigratePrepareRowEvent::getSource() — Method in class MigratePrepareRowEvent

Gets the source plugin.

MigratePrepareRowEvent::getMigration() — Method in class MigratePrepareRowEvent

Gets the migration plugin.

Drush::getTimeout() — Method in class Drush

Drush::getVersion() — Method in class Drush

Return the current Drush version.

Drush::getMajorVersion() — Method in class Drush

Drush::getMinorVersion() — Method in class Drush

Drush::getContainer() — Method in class Drush

Returns the currently active global container.

Drush::getApplication() — Method in class Drush

Get the current Symfony Console Application.

ExecTrait::getEditor() — Method in class ExecTrait

Preflight::getCommandFilePaths() — Method in class Preflight

PreflightArgs::getOptionNameList() — Method in class PreflightArgs

Search through the provided argv list, and return just the option name of any item that is an option.

PreflightLog::getDebug() — Method in class PreflightLog

Caster::getShortClass() — Method in class Caster

DrushCommand::getNamespace() — Method in class DrushCommand

Get the namespace of this command.

Shell::getCommand() — Method in class Shell

Get a command (if one exists) for the current input string.

Shell::getCommandFromInput() — Method in class Shell

Get the command from the current input, takes aliases into account.

LegacyServiceFinder::getDrushServiceFiles() — Method in class LegacyServiceFinder

Get all service files that this class can discover.

LegacyServiceFinder::getModuleFileNames() — Method in class LegacyServiceFinder

Find Drupal modules

ProcessManager::getDrupalFinder() — Method in class ProcessManager

SqlBase::getEnv() — Method in class SqlBase

Get environment variables to pass to Process.

SqlBase::getProcess() — Method in class SqlBase

Get the last used Process.

SqlBase::getInstance() — Method in class SqlBase

SqlBase::getDbSpec() — Method in class SqlBase

SqlBase::getOptions() — Method in class SqlBase

SqlBase::getOption() — Method in class SqlBase

SqlMysql::getVersion() — Method in class SqlMysql

The server version.

SqlPgsql::getEnv() — Method in class SqlPgsql

Get environment variables to pass to Process.

SqlPgsql::getPasswordFile() — Method in class SqlPgsql

SqlTableSelectionTrait::getExpandedTableSelection() — Method in class SqlTableSelectionTrait

Given a list of all tables, expand the convert the wildcards in the option-provided lists into a list of actual table names.

SqlTableSelectionTrait::getTableSelection() — Method in class SqlTableSelectionTrait

Construct an array that places table names in appropriate buckets based on whether the table is to be skipped, included for structure only, or have structure and data dumped.

SqlTableSelectionTrait::getRawTableList() — Method in class SqlTableSelectionTrait

Consult the specified options and return the list of tables specified.

DrushStyleInjector::get() — Method in class DrushStyleInjector

CliTestTrait::getOutputRaw() — Method in class CliTestTrait

Accessor for the last output, non-trimmed.

CliTestTrait::getErrorOutputRaw() — Method in class CliTestTrait

Accessor for the last stderr output, non-trimmed.

DrushTestTrait::getPathToDrush() — Method in class DrushTestTrait

OutputUtilsTrait::getOutputRaw() — Method in class OutputUtilsTrait

Accessor for the last output, non-trimmed.

OutputUtilsTrait::getErrorOutputRaw() — Method in class OutputUtilsTrait

Accessor for the last stderr output, non-trimmed.

OutputUtilsTrait::getSimplifiedOutput() — Method in class OutputUtilsTrait

Get command output and simplify things like full paths and extra whitespace.

OutputUtilsTrait::getSimplifiedErrorOutput() — Method in class OutputUtilsTrait

Returns a simplified version of the error output to facilitate testing.

OutputUtilsTrait::getOutput() — Method in class OutputUtilsTrait

Accessor for the last output, trimmed.

OutputUtilsTrait::getErrorOutput() — Method in class OutputUtilsTrait

Accessor for the last stderr output, trimmed.

OutputUtilsTrait::getOutputAsList() — Method in class OutputUtilsTrait

Accessor for the last output, rtrimmed and split on newlines.

OutputUtilsTrait::getErrorOutputAsList() — Method in class OutputUtilsTrait

Accessor for the last stderr output, rtrimmed and split on newlines.

OutputUtilsTrait::getOutputFromJSON() — Method in class OutputUtilsTrait

Accessor for the last output, decoded from json.

FsUtils::getBackupDir() — Method in class FsUtils

Decide where our backup directory should go

FsUtils::getBackupDirParent() — Method in class FsUtils

Get the base dir where our backup directories will be stored. Also stores CLI history file.

FsUtils::getMimeContentType() — Method in class FsUtils

Determines the MIME content type of the specified file.

StringUtils::generatePassword() — Method in class StringUtils

Generate a random alphanumeric password. Copied from user.module.

H

Bootstrap::handle() — Method in class Bootstrap

Format::handle() — Method in class Format

HandleRemoteCommands — Class in namespace Drush\Attributes

Help — Class in namespace Drush\Attributes

Hook — Class in namespace Drush\Attributes

HookSelector — Class in namespace Drush\Attributes

InteractConfigName::handle() — Method in class InteractConfigName

Kernel::handle() — Method in class Kernel

NoArgumentsBase::handle() — Method in class NoArgumentsBase

Obsolete::handle() — Method in class Obsolete

OptionsetGetEditor::handle() — Method in class OptionsetGetEditor

OptionsetProcBuild::handle() — Method in class OptionsetProcBuild

OptionsetSql::handle() — Method in class OptionsetSql

OptionsetSsh::handle() — Method in class OptionsetSsh

OptionsetTableSelection::handle() — Method in class OptionsetTableSelection

ValidatorBase::handle() — Method in class ValidatorBase

Version::handle() — Method in class Version

BaseBoot::hasRegisteredSymfonyCommand() — Method in class BaseBoot

BootstrapManager::hasBootstrap() — Method in class BootstrapManager

hasBootstrap determines whether the manager has a bootstrap object yet.

BootstrapManager::hasBootstrapped() — Method in class BootstrapManager

Determine whether a given bootstrap phase has been completed.

ConfigCommands::hasImportTransformer() — Method in class ConfigCommands

ConfigImportCommands::hasImportTransformer() — Method in class ConfigImportCommands

CliCommands::historyPath() — Method in class CliCommands

Returns the file path for the CLI history.

DocsCommands::hooks() — Method in class DocsCommands

Drush hooks.

LinkHooks::hookOption() — Method in class LinkHooks

LinkHooks::hookSetOptions() — Method in class LinkHooks

LinkHooks::hookFieldConfig() — Method in class LinkHooks

SiteInstallCommands::hasConfigFiles() — Method in class SiteInstallCommands

Check to see if there are any .yml files in the provided config directory.

FieldCreateCommands::hasContentTranslation() — Method in class FieldCreateCommands

FieldEntityReferenceHooks::hookFieldStorage() — Method in class FieldEntityReferenceHooks

FieldEntityReferenceHooks::hookFieldConfig() — Method in class FieldEntityReferenceHooks

FieldTextHooks::hookOption() — Method in class FieldTextHooks

FieldTextHooks::hookValidate() — Method in class FieldTextHooks

FieldTextHooks::hookSetOptions() — Method in class FieldTextHooks

FieldTextHooks::hookFieldConfig() — Method in class FieldTextHooks

FieldTextHooks::hasAllowedFormats() — Method in class FieldTextHooks

HelpCLIFormatter — Class in namespace Drush\Commands\help

Format an array into CLI help string.

HelpCommands — Class in namespace Drush\Commands\help

HelpCommands::help() — Method in class HelpCommands

Display usage details for a command.

ListCommands::helpList() — Method in class ListCommands

List available commands.

DrushConfig::home() — Method in class DrushConfig

$ Environment#homeDir — Property in class Environment

Environment::homeDir() — Method in class Environment

User's home directory

MigrateExecutable::handleMissingSourceRows() — Method in class MigrateExecutable

Handles missing source rows after import.

Drush::hasContainer() — Method in class Drush

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

Drush::hasService() — Method in class Drush

Indicates if a service is defined in the container.

$ PreflightArgs#homeDir — Property in class PreflightArgs

PreflightArgs::homeDir() — Method in class PreflightArgs

PreflightArgs::hasAlias() — Method in class PreflightArgs

PreflightArgs::hasUri() — Method in class PreflightArgs

PreflightArgsInterface::hasAlias() — Method in class PreflightArgsInterface

Returns 'true' if an '@alias' was set.

Caster::handleReferences() — Method in class Caster

Shell::hasCommand() — Method in class Shell

Check whether a command is set for the current input string.

$ DependencyInjection#handlers — Property in class DependencyInjection

HandlerInterface — Class in namespace Drush\Runtime

HandlerInterface represents a PHP system handler (e.g. the error reporting handler, the shutdown handler) that may be globally installed.

ServiceManager::hasStaticCreateFactory() — Method in class ServiceManager

Check to see if the provided class has a static create method.

ServiceManager::hasStaticMethod() — Method in class ServiceManager

Check to see if the provided class has the specified static method.

ServiceManager::hasStaticCreateEarlyFactory() — Method in class ServiceManager

Check to see if the provided class has a static createEarly method.

HostPath — Class in namespace Drush\SiteAlias

A host path is a path on some machine. The machine may be specified by a label, and the label may be an @alias or a site specification.

I

InteractConfigName — Class in namespace Drush\Attributes

BootstrapHook::initialize() — Method in class BootstrapHook

BootstrapManager::injectBootstrap() — Method in class BootstrapManager

For use in testing

DrushCommands::io() — Method in class DrushCommands

Override Robo's IO function with our custom style.

DrushCommands::initHook() — Method in class DrushCommands

Persist commandData for use in primary command callback. Used by 'topic' commands.

ConfigCommands::interactConfigName() — Method in class ConfigCommands

$ ConfigImportCommands#importStorageTransformer — Property in class ConfigImportCommands

ConfigImportCommands::import() — Method in class ConfigImportCommands

Import config from the config directory.

CacheCommands::interact() — Method in class CacheCommands

ImageCommands — Class in namespace Drush\Commands\core

ImageCommands::interactFlush() — Method in class ImageCommands

LanguageCommands::info() — Method in class LanguageCommands

Print the currently available languages.

LinkHooks::isInstalled() — Method in class LinkHooks

LocaleCommands::importAll() — Method in class LocaleCommands

Imports multiple translation files from the defined directory.

LocaleCommands::import() — Method in class LocaleCommands

Imports to a gettext translation file.

MigrateRunnerCommands::import() — Method in class MigrateRunnerCommands

Perform one or more migration processes.

NotifyCommands::isAllowed() — Method in class NotifyCommands

Identify if the given Drush request should trigger a notification.

RsyncCommands::injectAliasPathParameterOptions() — Method in class RsyncCommands

SiteInstallCommands::install() — Method in class SiteInstallCommands

Install Drupal along with modules/themes/configuration/profile.

TopicCommands::interact() — Method in class TopicCommands

UserCommands::information() — Method in class UserCommands

Print information about the specified user(s).

UserCommands::infoArray() — Method in class UserCommands

A flatter and simpler array presentation of a Drupal $user object.

WatchdogCommands::interactList() — Method in class WatchdogCommands

$ EntityTypeBundleAskTrait#input — Property in class EntityTypeBundleAskTrait

FieldBaseInfoCommands::info() — Method in class FieldBaseInfoCommands

List all base fields of an entity type

FieldInfoCommands::info() — Method in class FieldInfoCommands

List all configurable fields of an entity bundle

HelpCLIFormatter::isGlobalOption() — Method in class HelpCLIFormatter

PmCommands::install() — Method in class PmCommands

Enable one or more modules.

ThemeCommands::install() — Method in class ThemeCommands

Install one or more themes.

SqlSyncCommands::import() — Method in class SqlSyncCommands

Import file into target.

SanitizeUserTableCommands::isEnabled() — Method in class SanitizeUserTableCommands

Test an option value to see if it is disabled.

$ ConfigLocator#isLocal — Property in class ConfigLocator

ConfigLocator::identifyCandidates() — Method in class ConfigLocator

Given a list of paths, and candidates that might exist at each path, return all of the candidates that can be found. Candidates may be either directories or files.

ConfigLocator::identifyCandidatesAtPath() — Method in class ConfigLocator

Search for all matching candidate locations at a single path.

DrushConfig::isWindows() — Method in class DrushConfig

Environment::isWindows() — Method in class Environment

Determine whether current OS is a Windows variant.

DrupalKernelTrait::initializeContainer() — Method in class DrupalKernelTrait

Initializes the service container.

InstallerKernel — Class in namespace Drush\Drupal

Overridden version of InstallerKernel adapted to the needs of Drush.

$ MigrateExecutable#idlist — Property in class MigrateExecutable

List of specific source IDs to import.

$ MigrateExecutable#idMap — Property in class MigrateExecutable

Static cached ID map.

MigrateExecutable::importFeedbackMessage() — Method in class MigrateExecutable

Emits information on the import progress.

MigrateExecutable::initProgressBar() — Method in class MigrateExecutable

Initializes the command progress bar if possible.

Drush::input() — Method in class Drush

Return the input object

ArgsPreprocessor::isAliasOrSiteSpec() — Method in class ArgsPreprocessor

Determine whether the provided argument is an alias or a site specification.

LegacyPreflight::includeCode() — Method in class LegacyPreflight

Include old code. It is an aspirational goal to remove or refactor all of this into more modular, class-based code.

Preflight::init() — Method in class Preflight

Perform preliminary initialization. This mostly involves setting up legacy systems.

PreflightArgs::isLocal() — Method in class PreflightArgs

Determine whether Drush is in "local" mode

PreflightArgs::isSimulated() — Method in class PreflightArgs

Determine whether Drush is in "simulated" mode.

PreflightArgs::isStrict() — Method in class PreflightArgs

Determine whether Drush is in "strict" mode or not.

PreflightVerify::invalidIniValue() — Method in class PreflightVerify

Determine whether an ini value is valid based on the criteria.

DependencyInjection::initContainer() — Method in class DependencyInjection

Set up our dependency injection container.

DependencyInjection::installHandlers() — Method in class DependencyInjection

Make sure we are notified on exit, and when bad things happen.

DependencyInjection::injectApplicationServices() — Method in class DependencyInjection

ErrorHandler::installHandler() — Method in class ErrorHandler

HandlerInterface::installHandler() — Method in class HandlerInterface

$ LegacyServiceInstantiator#instantiatedDrushServices — Property in class LegacyServiceInstantiator

LegacyServiceInstantiator::isValidServiceData() — Method in class LegacyServiceInstantiator

Validate service data before using it.

LegacyServiceInstantiator::instantiateServices() — Method in class LegacyServiceInstantiator

Given a drush.services.yml file (parsed into an array), instantiate all of the services referenced therein.

LegacyServiceInstantiator::instantiateObject() — Method in class LegacyServiceInstantiator

Instantiate an object with the given arguments.

LegacyServiceInstantiator::isRequired() — Method in class LegacyServiceInstantiator

Check to see if the provided argument begins with a ?; those that do not are required.

RedispatchHook::initialize() — Method in class RedispatchHook

Check to see if it is necessary to redispatch to a remote site.

ServiceManager::instantiateYamlCliCommands() — Method in class ServiceManager

Instantiate commands from Grasmash\YamlCli that we want to expose as Drush commands.

ServiceManager::instantiateServices() — Method in class ServiceManager

Instantiate objects given a list of classes. For each class, if it has a static create factory, use that to instantiate it, passing both the Drupal and Drush DI containers. If there is no static factory, then instantiate it via 'new $class'

ServiceManager::inflect() — Method in class ServiceManager

Inject any dependencies needed via the "*AwareInterface" pattern

ShutdownHandler::installHandler() — Method in class ShutdownHandler

InternalYamlDataFileLoader — Class in namespace Drush\SiteAlias\Util

$ CliTestTrait#idleTimeout — Property in class CliTestTrait

Idle timeouts for commands.

CliTestTrait::isWindows() — Method in class CliTestTrait

FsUtils::isUsableDirectory() — Method in class FsUtils

Determine if the specified location is writable, or if a writable directory could be created at that path.

FsUtils::isTarball() — Method in class FsUtils

Check whether a file is a supported tarball.

StringUtils::interpolate() — Method in class StringUtils

Replace placeholders in a string.

J

JsonapiCommands — Class in namespace Drush\Commands\core

K

Kernel — Class in namespace Drush\Attributes

$ DrupalBoot8#kernel — Property in class DrupalBoot8

Kernels — Class in namespace Drush\Boot

Defines the available kernels that can be bootstrapped.

$ MigrateRunnerCommands#keyValue — Property in class MigrateRunnerCommands

L

BackendPathEvaluator::lookup() — Method in class BackendPathEvaluator

Lookup will use the provided alias record to look up and return the value of a path alias.

BaseBoot::lookUpPhaseIndex() — Method in class BaseBoot

Convert from a phase shorthand or constant to a phase index.

Boot::lookUpPhaseIndex() — Method in class Boot

Convert from a phase shorthand or constant to a phase index.

BootstrapManager::logger() — Method in class BootstrapManager

Allow those with a reference to the BootstrapManager to use its logger

DrushCommands::logger() — Method in class DrushCommands

Returns a logger object.

LegacyCommands — Class in namespace Drush\Commands

EditCommands::load() — Method in class EditCommands

EntityCommands::loadSave() — Method in class EntityCommands

Load and save entities.

LanguageCommands — Class in namespace Drush\Commands\core

LinkHooks — Class in namespace Drush\Commands\core

LocaleCommands — Class in namespace Drush\Commands\core

LoginCommands — Class in namespace Drush\Commands\core

LoginCommands::login() — Method in class LoginCommands

Display a one time login link for user ID 1, or another user.

MessengerCommands::log() — Method in class MessengerCommands

FieldBaseOverrideCreateCommands::logResult() — Method in class FieldBaseOverrideCreateCommands

FieldCreateCommands::logResult() — Method in class FieldCreateCommands

ApplicationFactory::logger() — Method in class ApplicationFactory

ListCommands — Class in namespace Drush\Commands\help

$ Environment#loader — Property in class Environment

Environment::loader() — Method in class Environment

The class loader returned when the autoload.php file is included.

YamlConfigLoader::load() — Method in class YamlConfigLoader

$ MigrateExecutable#limit — Property in class MigrateExecutable

Maximum number of items to process in this migration.

$ MigrateExecutable#listeners — Property in class MigrateExecutable

List of event listeners we have registered.

Drush::logger() — Method in class Drush

Return the Drush logger object.

DrushLog::log() — Method in class DrushLog

{@inheritdoc}

Logger — Class in namespace Drush\Log

Contains \Drush\Log\Logger.

Logger::log() — Method in class Logger

LegacyPreflight — Class in namespace Drush\Preflight

Prepare to bootstrap Drupal

$ Preflight#logger — Property in class Preflight

Preflight::logger() — Method in class Preflight

Preflight::loadSymfonyCompatabilityAutoloader() — Method in class Preflight

PreflightLog::log() — Method in class PreflightLog

PreflightVerify::loadedPhpIniMessage() — Method in class PreflightVerify

Returns a localizable message about php.ini that varies depending on whether the php_ini_loaded_file() is available or not.

LegacyServiceFinder — Class in namespace Drush\Runtime

Find drush.services.yml files.

LegacyServiceInstantiator — Class in namespace Drush\Runtime

Use the Symfony Dependency Injection Container to instantiate services.

LegacyServiceInstantiator::loadServiceFiles() — Method in class LegacyServiceInstantiator

Instantiate all of the objects declared by drush.services.yml files, and store them internally in this class for later retreival by type.

ServiceManager::loadCommandClasses() — Method in class ServiceManager

Ensure that any discovered class that is not part of the autoloader is, in fact, included.

InternalYamlDataFileLoader::load() — Method in class InternalYamlDataFileLoader

SqlBase::logQueryInDebugMode() — Method in class SqlBase

Show the query in debug mode and simulate mode

SqlBase::listTables() — Method in class SqlBase

Extract the name of all existing tables in the given database.

SqlBase::listTablesQuoted() — Method in class SqlBase

Extract the name of all existing tables in the given database.

SqlMysql::listTables() — Method in class SqlMysql

Extract the name of all existing tables in the given database.

SqlMysql::listTablesQuoted() — Method in class SqlMysql

Extract the name of all existing tables in the given database.

SqlPgsql::listTables() — Method in class SqlPgsql

Extract the name of all existing tables in the given database.

SqlSqlite::listTables() — Method in class SqlSqlite

Extract the name of all existing tables in the given database.

M

BootstrapManager::maxPhaseLimit() — Method in class BootstrapManager

CliCommands::makeEntitiesAvailableWithShortClassNames() — Method in class CliCommands

DocsCommands::migrate() — Method in class DocsCommands

Defining and running migrations.

MaintCommands — Class in namespace Drush\Commands\core

MessengerCommands — Class in namespace Drush\Commands\core

MigrateRunnerCommands — Class in namespace Drush\Commands\core

$ MigrateRunnerCommands#migrationPluginManager — Property in class MigrateRunnerCommands

MigrateRunnerCommands::messages() — Method in class MigrateRunnerCommands

View any messages associated with a migration.

MkCommands — Class in namespace Drush\Commands\core

WatchdogCommands::messageTypes() — Method in class WatchdogCommands

Helper function to obtain the message types based on drupal version.

SanitizeCommentsCommands::messages() — Method in class SanitizeCommentsCommands

Use #[CLI\Hook(type: HookManager::ON_EVENT, target: SanitizeCommands::CONFIRMS)]

SanitizePluginInterface::messages() — Method in class SanitizePluginInterface

Use #[CLI\Hook(type: HookManager::ON_EVENT, target: SanitizeCommands::CONFIRMS)]

SanitizeSessionsCommands::messages() — Method in class SanitizeSessionsCommands

Use #[CLI\Hook(type: HookManager::ON_EVENT, target: SanitizeCommands::CONFIRMS)]

SanitizeUserFieldsCommands::messages() — Method in class SanitizeUserFieldsCommands

Use #[CLI\Hook(type: HookManager::ON_EVENT, target: SanitizeCommands::CONFIRMS)]

SanitizeUserTableCommands::messages() — Method in class SanitizeUserTableCommands

Use #[CLI\Hook(type: HookManager::ON_EVENT, target: SanitizeCommands::CONFIRMS)]

MigrateEvents — Class in namespace Drush\Drupal\Migrate

Defines the row preparation event for the migration system.

MigrateExecutable — Class in namespace Drush\Drupal\Migrate

MigrateIdMapFilter — Class in namespace Drush\Drupal\Migrate

Filters the ID map by a source and/or a destination ID list.

MigrateMessage — Class in namespace Drush\Drupal\Migrate

Print message in drush from migrate message.

MigrateMissingSourceRowsEvent — Class in namespace Drush\Drupal\Migrate

Missing source rows event.

$ MigrateMissingSourceRowsEvent#migration — Property in class MigrateMissingSourceRowsEvent

The migration plugin instance.

MigratePrepareRowEvent — Class in namespace Drush\Drupal\Migrate

Wraps a prepare-row event for event listeners.

$ MigratePrepareRowEvent#migration — Property in class MigratePrepareRowEvent

Migration plugin.

MigrateUtils — Class in namespace Drush\Drupal\Migrate

Utility methods.

$ Drush#majorVersion — Property in class Drush

$ Drush#minorVersion — Property in class Drush

ArgsRemapper::matches() — Method in class ArgsRemapper

Check to see if the provided single arg matches the candidate.

PreflightArgs::mergeConfigPaths() — Method in class PreflightArgs

Add multiple additional locations where drush.yml files may be found.

PreflightArgs::mergeCommandPaths() — Method in class PreflightArgs

Add multiple paths where commandfiles might be found.

SqlMysql::make() — Method in class SqlMysql

A factory method which creates a mysql or mariadb instance as needed.

N

NoArgumentsBase — Class in namespace Drush\Attributes

NotifyCommands — Class in namespace Drush\Commands\core

Drush::negative() — Method in class Drush

Return 'true' if we are in negative mode

ArgsPreprocessor::nextCouldBeValue() — Method in class ArgsPreprocessor

nextCouldBeValue determines whether there is a next argument that exists and does not begin with a -.

O

Obsolete — Class in namespace Drush\Attributes

Mark commands as obsolete. These commands are omitted from help list and when user tries to run one, the command's description is shown. Example usage at https://github.com/drush-ops/drush/blob/13.x/src/Commands/LegacyCommands.php

Option — Class in namespace Drush\Attributes

OptionsetGetEditor — Class in namespace Drush\Attributes

OptionsetProcBuild — Class in namespace Drush\Attributes

OptionsetSql — Class in namespace Drush\Attributes

OptionsetSsh — Class in namespace Drush\Attributes

OptionsetTableSelection — Class in namespace Drush\Attributes

OptionsCommands — Class in namespace Drush\Commands

OptionsCommands::optionsetProcBuild() — Method in class OptionsCommands

OptionsCommands::optionsetGetEditor() — Method in class OptionsCommands

OptionsCommands::optionsetSsh() — Method in class OptionsCommands

OptionsCommands::optionsetSql() — Method in class OptionsCommands

OptionsCommands::optionsetTableSelection() — Method in class OptionsCommands

DocsCommands::outputFormatsFilters() — Method in class DocsCommands

Output formatters and filters: control the command output

DrupliconCommands::optionset() — Method in class DrupliconCommands

MkCommands::optionToArray() — Method in class MkCommands

Build an array since that's what HelpCLIFormatter expects.

NotifyCommands::optionsetNotify() — Method in class NotifyCommands

XhprofCommands::optionsetXhProf() — Method in class XhprofCommands

HelpCLIFormatter::optionRows() — Method in class HelpCLIFormatter

SanitizeUserFieldsCommands::options() — Method in class SanitizeUserFieldsCommands

SanitizeUserTableCommands::options() — Method in class SanitizeUserTableCommands

$ Environment#originalCwd — Property in class Environment

$ MigrateExecutable#output — Property in class MigrateExecutable

The Symfony console output.

MigrateExecutable::onMapSave() — Method in class MigrateExecutable

Counts up any map save events.

MigrateExecutable::onMapDelete() — Method in class MigrateExecutable

Counts up any rollback events.

MigrateExecutable::onPreImport() — Method in class MigrateExecutable

Reacts when the import is about to start.

MigrateExecutable::onMissingSourceRows() — Method in class MigrateExecutable

Reacts on detecting a list of missing source rows after an import.

MigrateExecutable::onPostImport() — Method in class MigrateExecutable

Reacts to migration completion.

MigrateExecutable::onPreRollback() — Method in class MigrateExecutable

Reacts when the rollback is about to starts.

MigrateExecutable::onPostRollback() — Method in class MigrateExecutable

Reacts to rollback completion.

MigrateExecutable::onPreRowSave() — Method in class MigrateExecutable

Reacts to an item about to be imported.

MigrateExecutable::onPostRowSave() — Method in class MigrateExecutable

Reacts aftre a row has been deleted.

MigrateExecutable::onPostRowDelete() — Method in class MigrateExecutable

Reacts to item rollback.

MigrateExecutable::onPrepareRow() — Method in class MigrateExecutable

Reacts to a new row being prepared.

Drush::output() — Method in class Drush

Return the output object

PreflightArgs::optionsWithValues() — Method in class PreflightArgs

PreflightArgs::optionConfigMap() — Method in class PreflightArgs

Map of option key to the corresponding config key to store the preflight option in. The values of the config items in this map must be BOOLEANS or STRINGS.

PreflightArgs::optionConfigPathMap() — Method in class PreflightArgs

Map of path option keys to the corresponding config key to store the preflight option in. The values of the items in this map must be STRINGS or ARRAYS OF STRINGS.

PreflightArgsInterface::optionsWithValues() — Method in class PreflightArgsInterface

Return an associative array of '--option' => 'methodName'.

$ PreflightLog#output — Property in class PreflightLog

OutputUtilsTrait — Class in namespace Drush\TestTraits

OutputUtilsTrait provides some useful utility methods for test classes that define getOutputRaw() and getErrorOutputRaw() methods.

P

$ BaseBoot#phase — Property in class BaseBoot

$ BootstrapManager#phase — Property in class BootstrapManager

ConfiguresPrompts::promptUntilValid() — Method in class ConfiguresPrompts

Prompt the user until the given validation callback passes.

DrushCommands::printFile() — Method in class DrushCommands

Print the contents of a file.

DrushCommands::preHook() — Method in class DrushCommands

Persist commandData for use in primary command callback. Used by 'topic' commands.

DrushCommands::printFileTopic() — Method in class DrushCommands

Print the contents of a file. The path comes from the @topic annotation.

ConfigPullCommands::pull() — Method in class ConfigPullCommands

Export and transfer config from one environment to another.

ArchiveDumpCommands::prepareArchiveDir() — Method in class ArchiveDumpCommands

Creates a temporary directory for the archive.

BatchCommands::process() — Method in class BatchCommands

Process operations in the specified batch set.

DocsCommands::policy() — Method in class DocsCommands

Example policy file.

$ DrupalDirectoryCommands#pathEvaluator — Property in class DrupalDirectoryCommands

$ DrupliconCommands#printed — Property in class DrupliconCommands

EditCommands::phpIniFiles() — Method in class EditCommands

ImageCommands::postInit() — Method in class ImageCommands

MessengerCommands::pre() — Method in class MessengerCommands

MessengerCommands::post() — Method in class MessengerCommands

MigrateRunnerCommands::padTableRow() — Method in class MigrateRunnerCommands

Pads an incomplete table row with empty cells.

MigrateRunnerCommands::preprocessMessageRow() — Method in class MigrateRunnerCommands

Preprocesses migrate message rows.

MkCommands::prepare() — Method in class MkCommands

Empty target directories.

PhpCommands — Class in namespace Drush\Commands\core

$ RsyncCommands#pathEvaluator — Property in class RsyncCommands

RsyncCommands::preCommandEvent() — Method in class RsyncCommands

Evaluate the path aliases in the source and destination parameters. We do this in the command-event so that we can set up the configuration object to include options from the source and target aliases, if any, so that these values may participate in configuration injection.

RunserverCommands::parseUri() — Method in class RunserverCommands

Parse a URI or partial URI (including just a port, host IP or path).

SiteInstallCommands::pre() — Method in class SiteInstallCommands

Perform setup tasks before installation.

StatusCommands::pathAliases() — Method in class StatusCommands

UpdateDBCommands::process() — Method in class UpdateDBCommands

Process operations in the specified batch set.

UserCommands::password() — Method in class UserCommands

Set the password for the user account with the specified name.

PmCommands — Class in namespace Drush\Commands\pm

PmCommands::pmList() — Method in class PmCommands

Show a list of available extensions (modules and themes).

$ ConfigLocator#processedConfigPaths — Property in class ConfigLocator

$ MigrateExecutable#preExistingItem — Property in class MigrateExecutable

Whether the destination item exists before saving.

$ MigrateExecutable#progressBar — Property in class MigrateExecutable

The Symfony progress bar.

MigrateExecutable::progressFinish() — Method in class MigrateExecutable

Removes the progress bar after operation is finished.

MigrateUtils::parseIdList() — Method in class MigrateUtils

Parses as an array the list of IDs received from console.

Drush::processManager() — Method in class Drush

Drush::process() — Method in class Drush

Run a bash fragment locally.

ExecTrait::programExists() — Method in class ExecTrait

$ DrushLog#parser — Property in class DrushLog

The message's placeholders parser.

ArgsPreprocessor::parse() — Method in class ArgsPreprocessor

Parse the argv array.

Preflight — Class in namespace Drush\Preflight

The Drush preflight determines what needs to be done for this request.

$ Preflight#preflightArgs — Property in class Preflight

Preflight::preflightArgs() — Method in class Preflight

Preprocess the args, removing any @sitealias that may be present.

Preflight::prepareConfig() — Method in class Preflight

Create the initial config locator object, and inject any needed settings, paths and so on into it.

Preflight::preflight() — Method in class Preflight

Preflight::preferredSite() — Method in class Preflight

Find the Drupal root of the preferred Drupal site (the one that shares the vendor directory with Drush).

PreflightArgs — Class in namespace Drush\Preflight

Storage for arguments preprocessed during preflight.

PreflightArgs::passArgs() — Method in class PreflightArgs

PreflightArgsInterface — Class in namespace Drush\Preflight

Storage for arguments preprocessed during preflight.

PreflightArgsInterface::passArgs() — Method in class PreflightArgsInterface

Add everything in the provided array to the list returned by args()

PreflightLog — Class in namespace Drush\Preflight

PreflightSiteLocator — Class in namespace Drush\Preflight

PreflightVerify — Class in namespace Drush\Preflight

Helper methods to verify preflight state.

ProcessManager — Class in namespace Drush\SiteAlias

The Drush ProcessManager adds a few Drush-specific service methods.

ProcessManager::process() — Method in class ProcessManager

Run a bash fragment locally.

$ SqlBase#process — Property in class SqlBase

SqlBase::paramsToOptions() — Method in class SqlBase

BootstrapCompilerPass::process() — Method in class BootstrapCompilerPass

$ CliTestTrait#process — Property in class CliTestTrait

OutputUtilsTrait::pathsToSimplify() — Method in class OutputUtilsTrait

FsUtils::prepareBackupDir() — Method in class FsUtils

Prepare a backup directory.

Q

QueueCommands — Class in namespace Drush\Commands\core

$ QueueCommands#queueService — Property in class QueueCommands

$ QueueCommands#queues — Property in class QueueCommands

Keep track of queue definitions.

QueueCommands::qList() — Method in class QueueCommands

Returns a list of all defined queues.

QueueCommands::queueComplete() — Method in class QueueCommands

SqlCommands::query() — Method in class SqlCommands

Execute a query against a database.

$ SqlBase#queryExtra — Property in class SqlBase

$ SqlBase#queryFile — Property in class SqlBase

SqlBase::query() — Method in class SqlBase

Execute a SQL query. Respect simulate mode.

SqlBase::queryPrefix() — Method in class SqlBase

SqlBase::queryFormat() — Method in class SqlBase

$ SqlMysql#queryExtra — Property in class SqlMysql

$ SqlPgsql#queryExtra — Property in class SqlPgsql

$ SqlPgsql#queryFile — Property in class SqlPgsql

SqlPgsql::queryFormat() — Method in class SqlPgsql

R

$ Application#redispatchHook — Property in class Application

Application::refineUriSelection() — Method in class Application

If the user did not explicitly select a site URI, then pick an appropriate site from the cwd.

Application::renderThrowable() — Method in class Application

Renders a caught Throwable. Omits the command docs at end.

BackendPathEvaluator::resolve() — Method in class BackendPathEvaluator

Resolve will check to see if the provided host path contains a path alias. If it does, the alias will be resolved, and the result of the resolution will be returned.

BackendPathEvaluator::request() — Method in class BackendPathEvaluator

Request the value of the path alias from the site associated with the alias record.

BaseBoot::reportCommandError() — Method in class BaseBoot

Called by Drush if a command is not found, or if the command was found, but did not meet requirements.

Boot::reportCommandError() — Method in class Boot

Called by Drush if a command is not found, or if the command was found, but did not meet requirements.

$ DrupalBoot8#request — Property in class DrupalBoot8

RemoteCommandProxy — Class in namespace Drush\Command

Create a placeholder proxy command to represent an unknown command.

$ RemoteCommandProxy#redispatchHook — Property in class RemoteCommandProxy

ConfiguresPrompts::restorePrompts() — Method in class ConfiguresPrompts

Restore the prompts output.

ConfiguresPrompts::runningUnitTests() — Method in class ConfiguresPrompts

CacheRebuildCommands::rebuild() — Method in class CacheRebuildCommands

Rebuild all caches.

DocsCommands::readme() — Method in class DocsCommands

README.md

DrupalCommands::requirements() — Method in class DrupalCommands

Information about things that may be wrong in your Drupal installation.

DrupalCommands::route() — Method in class DrupalCommands

View information about all routes or one route.

MigrateRunnerCommands::rollback() — Method in class MigrateRunnerCommands

Rollback one or more migrations.

MigrateRunnerCommands::resetStatus() — Method in class MigrateRunnerCommands

Reset an active migration's status to idle.

NotifyCommands::registerShutdown() — Method in class NotifyCommands

QueueCommands::run() — Method in class QueueCommands

Run a specific queue by name.

RoleCommands — Class in namespace Drush\Commands\core

RoleCommands::roleAddPerm() — Method in class RoleCommands

Grant specified permission(s) to a role.

RoleCommands::roleRemovePerm() — Method in class RoleCommands

Remove specified permission(s) from a role.

RoleCommands::roleList() — Method in class RoleCommands

Display roles and their permissions.

RoleCommands::renderPermsCell() — Method in class RoleCommands

RoleCommands::roleComplete() — Method in class RoleCommands

RsyncCommands — Class in namespace Drush\Commands\core

RsyncCommands::rsync() — Method in class RsyncCommands

Rsync Drupal code or files to/from another server using ssh.

RsyncCommands::rsyncOptions() — Method in class RsyncCommands

RunserverCommands — Class in namespace Drush\Commands\core

RunserverCommands::runserver() — Method in class RunserverCommands

Runs PHP's built-in http server for development.

StatusCommands::renderStatusCell() — Method in class StatusCommands

UpdateDBCommands::restoreMaintMode() — Method in class UpdateDBCommands

UserCommands::renderRolesCell() — Method in class UserCommands

UserCommands::removeRole() — Method in class UserCommands

Remove a role from the specified user accounts.

UserCommands::roleComplete() — Method in class UserCommands

FieldDefinitionRowsOfFieldsTrait::renderArray() — Method in class FieldDefinitionRowsOfFieldsTrait

FieldDefinitionRowsOfFieldsTrait::renderBoolean() — Method in class FieldDefinitionRowsOfFieldsTrait

ListCommands::renderListCLI() — Method in class ListCommands

ListCommands::renderListRaw() — Method in class ListCommands

SqlSyncCommands::rsync() — Method in class SqlSyncCommands

DrushLoggerServiceProvider::register() — Method in class DrushLoggerServiceProvider

ExtensionDiscovery::reset() — Method in class ExtensionDiscovery

MigrateExecutable::rollbackFeedbackMessage() — Method in class MigrateExecutable

Emits information on the rollback execution progress.

MigrateExecutable::resetCounters() — Method in class MigrateExecutable

Resets all the per-status counters to 0.

$ MigratePrepareRowEvent#row — Property in class MigratePrepareRowEvent

Row object.

$ Drush#runner — Property in class Drush

The Robo Runner -- manages and constructs all commandfile classes

Drush::runner() — Method in class Drush

Return the Robo runner.

Drush::redispatchOptions() — Method in class Drush

$ ArgsPreprocessor#remapper — Property in class ArgsPreprocessor

$ ArgsRemapper#remapOptions — Property in class ArgsRemapper

$ ArgsRemapper#remapCommandAliases — Property in class ArgsRemapper

ArgsRemapper::remap() — Method in class ArgsRemapper

Given an $argv array, apply all remap operations on each item within it.

ArgsRemapper::remapOptions() — Method in class ArgsRemapper

ArgsRemapper::remapCommandAlias() — Method in class ArgsRemapper

Preflight::remapOptions() — Method in class Preflight

Remapping table for arguments. Anything found in a key here will be converted to the corresponding value entry.

Preflight::remapCommandAliases() — Method in class Preflight

Symfony Console dislikes certain command aliases, because they are too similar to other Drush commands that contain the same characters. To avoid the "I don't know which command you mean"-type errors, we will replace problematic aliases with their longhand equivalents.

LegacyServiceInstantiator::resolveArguments() — Method in class LegacyServiceInstantiator

Resolve arguments against our containers. Arguments that do not map to one of our containers are returned unchanged.

LegacyServiceInstantiator::resolveArgument() — Method in class LegacyServiceInstantiator

Look up one argument in the appropriate container, or return it as-is.

LegacyServiceInstantiator::resolveFromContainer() — Method in class LegacyServiceInstantiator

Look up in the provided container; throw an exception if not found, unless the service name begins with ? (e.g.

RedispatchHook — Class in namespace Drush\Runtime

The RedispatchHook is installed as an init hook that runs before all commands. If the commandline contains an alias or a site specification that points at a remote machine, then we will stop execution of the current command and instead run the command remotely.

RedispatchHook::redispatchIfRemote() — Method in class RedispatchHook

Check to see if the target of the command is remote. Call redispatch if it is.

RedispatchHook::redispatch() — Method in class RedispatchHook

Called from RemoteCommandProxy::execute() to run remote commands.

Runtime — Class in namespace Drush\Runtime

Control the Drush runtime environment

Runtime::run() — Method in class Runtime

Run the application, catching any errors that may be thrown.

ServiceManager::requiresBootstrap() — Method in class ServiceManager

Check whether a command class requires Drupal bootstrap.

ShutdownHandler::returnStatus() — Method in class ShutdownHandler

ProcessManager::relativePathToVendorBinDrush() — Method in class ProcessManager

Return the relative path to 'vendor/bin/drush' from the Drupal root.

FsUtils::registerForDeletion() — Method in class FsUtils

Add the given directory to a list to be deleted on exit.

FsUtils::realpath() — Method in class FsUtils

Returns canonicalized absolute pathname.

StringUtils::replaceTilde() — Method in class StringUtils

Replace tilde in a path with the HOME directory.

S

$ Application#serviceManager — Property in class Application

Application::setBootstrapManager() — Method in class Application

Application::setAliasManager() — Method in class Application

Application::setRedispatchHook() — Method in class Application

Application::setTildeExpansionHook() — Method in class Application

Application::setServiceManager() — Method in class Application

Application::selectUri() — Method in class Application

Select a URI to use for the site, based on directory or config.

BaseBoot::setUri() — Method in class BaseBoot

Inject the uri for the specific site to be bootstrapped

BaseBoot::setPhase() — Method in class BaseBoot

Boot::setUri() — Method in class Boot

Inject the uri for the specific site to be bootstrapped

BootstrapManager::setPhase() — Method in class BootstrapManager

BootstrapManager::setDrupalFinder() — Method in class BootstrapManager

BootstrapManager::selectUri() — Method in class BootstrapManager

This method is called by the Application iff the user did not explicitly provide a URI.

BootstrapManager::setUri() — Method in class BootstrapManager

DrupalBoot::scanUpForUri() — Method in class DrupalBoot

DrupalBoot8::setRequest() — Method in class DrupalBoot8

DrupalBoot8::setLogger() — Method in class DrupalBoot8

Sometimes (e.g. in the integration tests), the DrupalBoot object will be cached, and re-injected into a fresh set of preflight / bootstrap objects. When this happens, the new Drush logger will be injected into the boot object. If this happens after we have created the Drupal logger adapter (i.e., after bootstrapping Drupal), then we also need to update the logger reference in that adapter.

GlobalOptionsEventListener::setGlobalOptions() — Method in class GlobalOptionsEventListener

Before a Console command runs, examine the global commandline options from the event Input, and set configuration values as appropriate.

ServiceCommandlist — Class in namespace Drush\Command

Keep a list of all of the service commands that we can find when the Drupal Kernel is booted.

LegacyCommands::saconvert() — Method in class LegacyCommands

site:alias-convert has been removed. Please use Drush 11 or convert by hand.

LegacyCommands::secphp() — Method in class LegacyCommands

pm:security-php has been removed. Please use composer audit command.

LegacyCommands::sec() — Method in class LegacyCommands

pm:security has been removed. Please use composer audit command. See https://www.drupal.org/project/project_composer/issues/3301876.

ConfigCommands::set() — Method in class ConfigCommands

Save a config value directly. Does not perform a config import.

ConfigCommands::status() — Method in class ConfigCommands

Display status of configuration (differences between the filesystem and database).

ConfigExportCommands::setExportStorage() — Method in class ConfigExportCommands

ConfigExportCommands::setConfigStorageSync() — Method in class ConfigExportCommands

ConfigImportCommands::setConfigStorageSync() — Method in class ConfigImportCommands

ConfigImportCommands::setImportTransformer() — Method in class ConfigImportCommands

CacheCommands::set() — Method in class CacheCommands

Cache an object expressed in JSON or var_export() format.

CacheCommands::setPrepareData() — Method in class CacheCommands

DocsCommands::siteAliases() — Method in class DocsCommands

Creating site aliases for running Drush on remote sites.

DocsCommands::script() — Method in class DocsCommands

An example Drush script.

DocsCommands::syncHttp() — Method in class DocsCommands

Extend sql-sync to allow transfer of the sql dump file via http.

EntityCreateCommands::setValue() — Method in class EntityCreateCommands

MaintCommands::set() — Method in class MaintCommands

Set maintenance mode.

MaintCommands::status() — Method in class MaintCommands

Fail if maintenance mode is enabled.

MigrateRunnerCommands::setMigrationPluginManager() — Method in class MigrateRunnerCommands

Provide a migration plugin manager.

MigrateRunnerCommands::status() — Method in class MigrateRunnerCommands

List all migrations with current status.

MigrateRunnerCommands::stop() — Method in class MigrateRunnerCommands

Stop an active migration operation.

NotifyCommands::shutdown() — Method in class NotifyCommands

NotifyCommands::shutdownSend() — Method in class NotifyCommands

Prepares and dispatches notifications to delivery mechanisms.

NotifyCommands::shutdownSendText() — Method in class NotifyCommands

Send text-based system notification.

PhpCommands::script() — Method in class PhpCommands

Run php a script after a full Drupal bootstrap.

$ RsyncCommands#sourceEvaluatedPath — Property in class RsyncCommands

SiteCommands — Class in namespace Drush\Commands\core

SiteCommands::siteSet() — Method in class SiteCommands

Set a site alias that will persist for the current session.

SiteCommands::siteAlias() — Method in class SiteCommands

Show site alias details, or a list of available site aliases.

SiteCommands::siteAliasExportList() — Method in class SiteCommands

SiteInstallCommands — Class in namespace Drush\Commands\core

SiteInstallCommands::serverGlobals() — Method in class SiteInstallCommands

Fake the necessary HTTP headers that the Drupal installer still needs:

SshCommands — Class in namespace Drush\Commands\core

SshCommands::ssh() — Method in class SshCommands

Connect to a webserver via SSH, and optionally run a shell command.

StateCommands — Class in namespace Drush\Commands\core

StateCommands::set() — Method in class StateCommands

Set a state value.

StatusCommands — Class in namespace Drush\Commands\core

StatusCommands::status() — Method in class StatusCommands

An overview of the environment - Drush and Drupal.

WatchdogCommands::show() — Method in class WatchdogCommands

Show watchdog messages.

WatchdogCommands::showOne() — Method in class WatchdogCommands

Show one log record by ID.

FieldCreateCommands::setContentTranslationManager() — Method in class FieldCreateCommands

SqlCommands — Class in namespace Drush\Commands\sql

SqlSyncCommands — Class in namespace Drush\Commands\sql

SqlSyncCommands::sqlsync() — Method in class SqlSyncCommands

Copy DB data from a source site to a target site. Transfers data via rsync.

SanitizeCommands — Class in namespace Drush\Commands\sql\sanitize

SanitizeCommands::sanitize() — Method in class SanitizeCommands

Sanitize the database by removing or obfuscating user data.

SanitizeCommentsCommands — Class in namespace Drush\Commands\sql\sanitize

This class is a good example of a sql:sanitize plugin.

SanitizeCommentsCommands::sanitize() — Method in class SanitizeCommentsCommands

Sanitize comment names from the DB.

SanitizePluginInterface — Class in namespace Drush\Commands\sql\sanitize

Implement this interface when building a Drush sql-sanitize plugin.

SanitizePluginInterface::sanitize() — Method in class SanitizePluginInterface

Run your sanitization logic using standard Drupal APIs.

SanitizeSessionsCommands — Class in namespace Drush\Commands\sql\sanitize

This class is a good example of how to build a sql:sanitize plugin.

SanitizeSessionsCommands::sanitize() — Method in class SanitizeSessionsCommands

Sanitize sessions from the DB.

SanitizeUserFieldsCommands — Class in namespace Drush\Commands\sql\sanitize

This class is a good example of how to build a sql:sanitize plugin.

SanitizeUserFieldsCommands::sanitize() — Method in class SanitizeUserFieldsCommands

Sanitize string fields associated with the user.

SanitizeUserTableCommands — Class in namespace Drush\Commands\sql\sanitize

A sql:sanitize plugin.

SanitizeUserTableCommands::sanitize() — Method in class SanitizeUserTableCommands

Sanitize emails and passwords. This also an example of how to write a database sanitizer for sql:sync.

$ ConfigLocator#sources — Property in class ConfigLocator

$ ConfigLocator#siteRoots — Property in class ConfigLocator

ConfigLocator::setLocal() — Method in class ConfigLocator

Put the config locator into 'local 'mode.

ConfigLocator::sources() — Method in class ConfigLocator

Return all of the sources for every configuration item. The key is the address of the configuration item, and the value is the configuration file it was loaded from. Note that this method will return just an empty array unless collectSources(true) is called prior to loading configuration files.

ConfigLocator::setComposerRoot() — Method in class ConfigLocator

Sets the composer root.

DrushConfig::simulate() — Method in class DrushConfig

Return 'true' if we are in simulated mode.

$ Environment#sharePrefix — Property in class Environment

$ Environment#siteLoader — Property in class Environment

Environment::setConfigFileVariant() — Method in class Environment

Environment::setLoader() — Method in class Environment

Set the class loader from the autload.php file, if available.

Environment::setEtcPrefix() — Method in class Environment

Set the directory prefix to locate the directory that Drush will use as /etc (e.g. during the functional tests).

Environment::setSharePrefix() — Method in class Environment

Set the directory prefix to locate the directory that Drush will use as /user/share (e.g. during the functional tests).

Environment::systemPathPrefix() — Method in class Environment

Return the appropriate system path prefix, unless an override is provided.

Environment::systemConfigPath() — Method in class Environment

Return the system configuration path (default: /etc/drush)

Environment::systemCommandFilePath() — Method in class Environment

Return the system shared commandfile path (default: /usr/share/drush/commands)

$ DrupalKernelTrait#serviceModifiers — Property in class DrupalKernelTrait

$ DrupalKernelTrait#serviceFinder — Property in class DrupalKernelTrait

DrupalKernelTrait::shouldDrushInvalidateContainer() — Method in class DrupalKernelTrait

$ MigrateExecutable#saveCounters — Property in class MigrateExecutable

Counters of map statuses.

$ MigrateExecutable#showTimestamp — Property in class MigrateExecutable

Show timestamp in progress message.

$ MigrateExecutable#showTotal — Property in class MigrateExecutable

Show internal counter in progress message.

$ MigrateIdMapFilter#sourceIdList — Property in class MigrateIdMapFilter

List of specific source IDs to filter on.

$ MigratePrepareRowEvent#source — Property in class MigratePrepareRowEvent

Migration source plugin.

Drush::sanitizeVersionString() — Method in class Drush

Convert internal Composer dev version to ".x"

Drush::setContainer() — Method in class Drush

Sets a new global container.

Drush::service() — Method in class Drush

Retrieves a service from the container.

Drush::siteProcess() — Method in class Drush

Run a bash fragment on a site alias.

Drush::shell() — Method in class Drush

Create a Process instance from a commandline string.

Drush::simulate() — Method in class Drush

Return 'true' if we are in simulated mode

ExecTrait::startBrowser() — Method in class ExecTrait

Starts a background browser/tab for the current site or a specified URL.

EntityToArraySimplifier::simplifyToArray() — Method in class EntityToArraySimplifier

DrushLoggerManager::success() — Method in class DrushLoggerManager

Log a 'success' message.

SuccessInterface — Class in namespace Drush\Log

SuccessInterface::success() — Method in class SuccessInterface

Log a 'success' message.

$ ArgsPreprocessor#specParser — Property in class ArgsPreprocessor

ArgsPreprocessor::setArgsRemapper() — Method in class ArgsPreprocessor

Preflight::setLogger() — Method in class Preflight

PreflightArgs::setHomeDir() — Method in class PreflightArgs

PreflightArgs::setCommandName() — Method in class PreflightArgs

PreflightArgs::setAlias() — Method in class PreflightArgs

PreflightArgs::selectedSite() — Method in class PreflightArgs

Get the selected site. Here, the default will typically be the cwd.

PreflightArgs::setDebug() — Method in class PreflightArgs

PreflightArgs::setSelectedSite() — Method in class PreflightArgs

Set the selected site.

PreflightArgs::setUri() — Method in class PreflightArgs

Set the uri option

PreflightArgs::setLocal() — Method in class PreflightArgs

Set local mode

PreflightArgs::setSimulate() — Method in class PreflightArgs

Set simulated mode

PreflightArgs::setCoverageFile() — Method in class PreflightArgs

Set the coverage file path.

PreflightArgs::setStrict() — Method in class PreflightArgs

Set strict mode.

PreflightArgsInterface::setCommandName() — Method in class PreflightArgsInterface

Store the command name, once it is found.

PreflightArgsInterface::setAlias() — Method in class PreflightArgsInterface

Set an alias. Should always begin with '@'.

PreflightLog::setDebug() — Method in class PreflightLog

$ PreflightSiteLocator#siteAliasManager — Property in class PreflightSiteLocator

DrushHelpCommand::setCommand() — Method in class DrushHelpCommand

Helper for setting a subcommand to retrieve help for.

Shell — Class in namespace Drush\Psysh

Runtime::setCompleted() — Method in class Runtime

Mark the current request as having completed successfully.

Runtime::setExitCode() — Method in class Runtime

Mark the exit code for current request.

ServiceManager — Class in namespace Drush\Runtime

Manage Drush services.

ServiceManager::supportsCompoundContainer() — Method in class ServiceManager

Determine if the first parameter of the create method supports our container with delegate.

ShutdownHandler — Class in namespace Drush\Runtime

Drush's shutdown handler

ShutdownHandler::shutdownHandler() — Method in class ShutdownHandler

ProcessManager::setDrupalFinder() — Method in class ProcessManager

ProcessManager::siteProcess() — Method in class ProcessManager

ProcessManager::shell() — Method in class ProcessManager

Create a Process instance from a commandline string.

SiteAliasFileLoader — Class in namespace Drush\SiteAlias

Discover alias files:

SiteAliasManagerAwareInterface — Class in namespace Drush\SiteAlias

Inflection interface for the site alias manager.

SiteAliasName — Class in namespace Drush\SiteAlias

Parse a string that contains a site alias name, and provide convenience methods to access the parts.

SiteSpecParser — Class in namespace Drush\SiteAlias

Parse a string that contains a site specification.

SqlBase — Class in namespace Drush\Sql

The base implementation for Drush database connections.

SqlBase::setProcess() — Method in class SqlBase

SqlBase::setDbSpec() — Method in class SqlBase

Set the current db spec.

SqlBase::silent() — Method in class SqlBase

SqlBase::scheme() — Method in class SqlBase

The active database driver.

SqlBase::su() — Method in class SqlBase

Adjust DB connection with superuser credentials if provided.

SqlException — Class in namespace Drush\Sql

SqlMariaDB — Class in namespace Drush\Sql

SqlMysql — Class in namespace Drush\Sql

SqlMysql::setVersion() — Method in class SqlMysql

SqlMysql::silent() — Method in class SqlMysql

SqlPgsql — Class in namespace Drush\Sql

SqlSqlite — Class in namespace Drush\Sql

SqlTableSelectionTrait — Class in namespace Drush\Sql

Note: when using this trait, also implement ConfigAwareInterface/ConfigAwareTrait.

CliTestTrait::startExecute() — Method in class CliTestTrait

Run a command and return the process without waiting for it to finish.

OutputUtilsTrait::simplifyOutput() — Method in class OutputUtilsTrait

Remove things like full paths and extra whitespace from the given string.

StringUtils — Class in namespace Drush\Utils

T

$ Application#tildeExpansionHook — Property in class Application

Topics — Class in namespace Drush\Attributes

BaseBoot::terminate() — Method in class BaseBoot

This method is called during the shutdown of drush.

Boot::terminate() — Method in class Boot

This method is called during the shutdown of drush.

DrupalBoot8::terminate() — Method in class DrupalBoot8

This method is called during the shutdown of drush.

CacheCommands::tags() — Method in class CacheCommands

Invalidate by cache tags.

$ RsyncCommands#targetEvaluatedPath — Property in class RsyncCommands

SiteInstallCommands::taskCallback() — Method in class SiteInstallCommands

TopicCommands — Class in namespace Drush\Commands\core

TopicCommands::topic() — Method in class TopicCommands

Read detailed documentation on a given topic.

TopicCommands::topicComplete() — Method in class TopicCommands

TwigCommands — Class in namespace Drush\Commands\core

TwigCommands::twigCompile() — Method in class TwigCommands

Compile all Twig template(s).

TwigCommands::twigDebug() — Method in class TwigCommands

Enables Twig debug and disables caching Twig templates.

WatchdogCommands::tail() — Method in class WatchdogCommands

Tail watchdog messages.

FieldDefinitionCommands::types() — Method in class FieldDefinitionCommands

ThemeCommands — Class in namespace Drush\Commands\pm

DrushConfig::tmp() — Method in class DrushConfig

$ LegacyServiceInstantiator#tags — Property in class LegacyServiceInstantiator

LegacyServiceInstantiator::taggedServices() — Method in class LegacyServiceInstantiator

After instantiateServices() runs, the resulting instantiated service objects can be retrieved via this method.

TildeExpansionHook — Class in namespace Drush\Runtime

The TildeExpansionHook is installed as a preValidate hook that runs before all commands. Argument or option values containing a leading tilde will be expanded to an absolute path.

$ CliTestTrait#timeout — Property in class CliTestTrait

Timeout for command.

FsUtils::tmpDir() — Method in class FsUtils

Prepare a temporary directory that will be deleted on exit.

U

Usage — Class in namespace Drush\Attributes

$ BaseBoot#uri — Property in class BaseBoot

LocaleCommands::update() — Method in class LocaleCommands

Imports the available translation updates.

$ RunserverCommands#uri — Property in class RunserverCommands

RunserverCommands::uri() — Method in class RunserverCommands

Determine the URI to use for this server.

TwigCommands::unused() — Method in class TwigCommands

Find potentially unused Twig templates.

UpdateDBCommands — Class in namespace Drush\Commands\core

UpdateDBCommands::updatedb() — Method in class UpdateDBCommands

Apply any database updates required (as with running update.php).

UpdateDBCommands::updatedbStatus() — Method in class UpdateDBCommands

List any pending database updates.

UpdateDBCommands::updateDoOne() — Method in class UpdateDBCommands

Perform one update and store the results which will later be displayed on the finished page.

UpdateDBCommands::updateDoOnePostUpdate() — Method in class UpdateDBCommands

Batch command that executes a single post-update.

UpdateDBCommands::updateFinished() — Method in class UpdateDBCommands

Batch finished callback.

UpdateDBCommands::updateBatch() — Method in class UpdateDBCommands

Start the database update batch process.

UpdateDBCommands::updateCheckRequirements() — Method in class UpdateDBCommands

Log messages for any requirements warnings/errors.

UserCommands — Class in namespace Drush\Commands\core

UserCommands::unblock() — Method in class UserCommands

Unblock the specified user(s).

PmCommands::uninstall() — Method in class PmCommands

Uninstall one or more modules and their dependent modules.

ThemeCommands::uninstall() — Method in class ThemeCommands

Uninstall themes.

DrushConfig::user() — Method in class DrushConfig

Environment::userConfigPath() — Method in class Environment

The user's Drush configuration directory, ~/.drush

MigrateExecutable::updateProgressBar() — Method in class MigrateExecutable

Advances the progress bar.

MigrateExecutable::unregisterListeners() — Method in class MigrateExecutable

Unregisters all event listeners.

UpdateKernel — Class in namespace Drush\Drupal

Overridden version of UpdateKernel adapted to the needs of Drush.

Drush::unsetContainer() — Method in class Drush

Unsets the global container.

UserAbortException — Class in namespace Drush\Exceptions

Throw an exception indicating that the user cancelled the operation.

$ ExecTrait#uri — Property in class ExecTrait

PreflightArgs::uri() — Method in class PreflightArgs

Get the selected uri

V

ValidateConfigName — Class in namespace Drush\Attributes

ValidateConfigName::validate() — Method in class ValidateConfigName

ValidateEntityLoad — Class in namespace Drush\Attributes

ValidateEntityLoad::validate() — Method in class ValidateEntityLoad

ValidateFileExists — Class in namespace Drush\Attributes

ValidateFileExists::validate() — Method in class ValidateFileExists

ValidateModulesEnabled — Class in namespace Drush\Attributes

ValidateModulesEnabled::validate() — Method in class ValidateModulesEnabled

ValidatePermissions — Class in namespace Drush\Attributes

ValidatePermissions::validate() — Method in class ValidatePermissions

ValidatePhpExtensions — Class in namespace Drush\Attributes

ValidatePhpExtensions::validate() — Method in class ValidatePhpExtensions

ValidateQueueName — Class in namespace Drush\Attributes

ValidateQueueName::validate() — Method in class ValidateQueueName

ValidatorBase — Class in namespace Drush\Attributes

ValidatorInterface — Class in namespace Drush\Attributes

ValidatorInterface::validate() — Method in class ValidatorInterface

Version — Class in namespace Drush\Attributes

BaseBoot::validRoot() — Method in class BaseBoot

This function determines if the specified path points to the root directory of a CMS that can be bootstrapped by the specific subclass that implements it.

Boot::validRoot() — Method in class Boot

This function determines if the specified path points to the root directory of a CMS that can be bootstrapped by the specific subclass that implements it.

DrupalBoot8::validRoot() — Method in class DrupalBoot8

This function determines if the specified path points to the root directory of a CMS that can be bootstrapped by the specific subclass that implements it.

EmptyBoot::validRoot() — Method in class EmptyBoot

This function determines if the specified path points to the root directory of a CMS that can be bootstrapped by the specific subclass that implements it.

ValidatorsCommands — Class in namespace Drush\Commands

ValidatorsCommands::validateEntityLoad() — Method in class ValidatorsCommands

Validate that passed entity names are valid.

ValidatorsCommands::validateModuleEnabled() — Method in class ValidatorsCommands

Validate that passed module names are enabled. We use post-init phase because interact() methods run early and they need to know that their module is enabled (e.g. image-flush).

ValidatorsCommands::validateFileExists() — Method in class ValidatorsCommands

Validate that the file path exists.

ValidatorsCommands::validatePHPExtension() — Method in class ValidatorsCommands

Validate that required PHP extension exists.

ValidatorsCommands::validatePermissions() — Method in class ValidatorsCommands

Validate that the permission exists.

ConfigCommands::validateConfigName() — Method in class ConfigCommands

Validate that a config name is valid.

ConfigExportCommands::validate() — Method in class ConfigExportCommands

ConfigImportCommands::validate() — Method in class ConfigImportCommands

Validate partial and source options.

ConfigPullCommands::validateConfigPull() — Method in class ConfigPullCommands

CacheCommands::validate() — Method in class CacheCommands

CoreCommands::version() — Method in class CoreCommands

Show Drush version.

MigrateRunnerCommands::validateMigrationId() — Method in class MigrateRunnerCommands

Validates a migration ID is valid.

RsyncCommands::validate() — Method in class RsyncCommands

Validate that passed aliases are valid.

SiteInstallCommands::validate() — Method in class SiteInstallCommands

SiteInstallCommands::validateConfigDir() — Method in class SiteInstallCommands

Assure that a config directory exists and is populated.

TopicCommands::validate() — Method in class TopicCommands

ViewsCommands — Class in namespace Drush\Commands\core

ViewsCommands::vlist() — Method in class ViewsCommands

Get a list of all views in the system.

EntityTypeBundleValidationTrait::validateEntityType() — Method in class EntityTypeBundleValidationTrait

EntityTypeBundleValidationTrait::validateBundle() — Method in class EntityTypeBundleValidationTrait

HelpCommands::validate() — Method in class HelpCommands

PmCommands::validateEnableModules() — Method in class PmCommands

Run requirements checks on the module installation.

PmCommands::validateUninstall() — Method in class PmCommands

SqlCommands::validate() — Method in class SqlCommands

Assert that mysql or similar are on the user's PATH.

SqlSyncCommands::validate() — Method in class SqlSyncCommands

$ Environment#vendorDir — Property in class Environment

Environment::vendorPath() — Method in class Environment

Return the path to Drush's vendor directory

Environment::verifyCLI() — Method in class Environment

Verify that we are running PHP through the command line interface.

ValidateMigrationId — Class in namespace Drush\Drupal\Migrate

$ Drush#version — Property in class Drush

The version of Drush from the drush.info file, or FALSE if not read yet.

Drush::verbose() — Method in class Drush

Return 'true' if we are in verbose mode

$ Preflight#verify — Property in class Preflight

PreflightVerify::verify() — Method in class PreflightVerify

Throw an exception if the environment is not right for running Drush.

TildeExpansionHook::validate() — Method in class TildeExpansionHook

$ SqlMysql#version — Property in class SqlMysql

W

MkCommands::writeYml() — Method in class MkCommands

MkCommands::writeAllMd() — Method in class MkCommands

MkCommands::writeContentFilesAndBuildNavAndBuildRedirectMap() — Method in class MkCommands

Write content files, add to nav, build a redirect map.

$ QueueCommands#workerManager — Property in class QueueCommands

WatchdogCommands — Class in namespace Drush\Commands\core

WatchdogCommands::watchdogList() — Method in class WatchdogCommands

Interactively filter the watchdog message listing.

WatchdogCommands::where() — Method in class WatchdogCommands

Build a WHERE snippet based on given parameters.

WatchdogCommands::watchdogComplete() — Method in class WatchdogCommands

FieldDefinitionCommands::widgets() — Method in class FieldDefinitionCommands

HelpCLIFormatter::write() — Method in class HelpCLIFormatter

X

XhprofCommands — Class in namespace Drush\Commands\core

Supports profiling Drush commands using either XHProf or Tideways XHProf.

XhprofCommands::xhprofPost() — Method in class XhprofCommands

Finish profiling and emit a link.

XhprofCommands::xhprofInitialize() — Method in class XhprofCommands

Enable profiling via XHProf

XhprofCommands::xhprofIsEnabled() — Method in class XhprofCommands

Determines if any profiler could be enabled.

XhprofCommands::xhprofFlags() — Method in class XhprofCommands

Determines flags.

XhprofCommands::xhprofEnable() — Method in class XhprofCommands

Enable profiling.

XhprofCommands::xhprofFinishRun() — Method in class XhprofCommands

Disable profiling and save results.

Y

YamlConfigLoader — Class in namespace Drush\Config\Loader

Load configuration files, and fill in any property values that need to be expanded.

_

Bootstrap::__construct() — Method in class Bootstrap

Format::__construct() — Method in class Format

InteractConfigName::__construct() — Method in class InteractConfigName

Kernel::__construct() — Method in class Kernel

ValidateConfigName::__construct() — Method in class ValidateConfigName

ValidateEntityLoad::__construct() — Method in class ValidateEntityLoad

ValidateFileExists::__construct() — Method in class ValidateFileExists

ValidateModulesEnabled::__construct() — Method in class ValidateModulesEnabled

ValidatePermissions::__construct() — Method in class ValidatePermissions

ValidatePhpExtensions::__construct() — Method in class ValidatePhpExtensions

ValidateQueueName::__construct() — Method in class ValidateQueueName

Version::__construct() — Method in class Version

BaseBoot::__construct() — Method in class BaseBoot

BootstrapHook::__construct() — Method in class BootstrapHook

DrupalBoot8::__construct() — Method in class DrupalBoot8

RemoteCommandProxy::__construct() — Method in class RemoteCommandProxy

DrushCommands::__construct() — Method in class DrushCommands

ConfigCommands::__construct() — Method in class ConfigCommands

ConfigExportCommands::__construct() — Method in class ConfigExportCommands

ConfigImportCommands::__construct() — Method in class ConfigImportCommands

ConfigPullCommands::__construct() — Method in class ConfigPullCommands

BrowseCommands::__construct() — Method in class BrowseCommands

CacheCommands::__construct() — Method in class CacheCommands

CacheRebuildCommands::__construct() — Method in class CacheRebuildCommands

CliCommands::__construct() — Method in class CliCommands

DeployCommands::__construct() — Method in class DeployCommands

DeployHookCommands::__construct() — Method in class DeployHookCommands

DrupalCommands::__construct() — Method in class DrupalCommands

DrupalDirectoryCommands::__construct() — Method in class DrupalDirectoryCommands

EditCommands::__construct() — Method in class EditCommands

EntityCommands::__construct() — Method in class EntityCommands

EntityCreateCommands::__construct() — Method in class EntityCreateCommands

LanguageCommands::__construct() — Method in class LanguageCommands

LinkHooks::__construct() — Method in class LinkHooks

LocaleCommands::__construct() — Method in class LocaleCommands

LoginCommands::__construct() — Method in class LoginCommands

MaintCommands::__construct() — Method in class MaintCommands

MessengerCommands::__construct() — Method in class MessengerCommands

MigrateRunnerCommands::__construct() — Method in class MigrateRunnerCommands

QueueCommands::__construct() — Method in class QueueCommands

RoleCommands::__construct() — Method in class RoleCommands

RsyncCommands::__construct() — Method in class RsyncCommands

SiteCommands::__construct() — Method in class SiteCommands

SiteInstallCommands::__construct() — Method in class SiteInstallCommands

SshCommands::__construct() — Method in class SshCommands

StateCommands::__construct() — Method in class StateCommands

StatusCommands::__construct() — Method in class StatusCommands

TwigCommands::__construct() — Method in class TwigCommands

UpdateDBCommands::__construct() — Method in class UpdateDBCommands

UserCommands::__construct() — Method in class UserCommands

ViewsCommands::__construct() — Method in class ViewsCommands

WatchdogCommands::__construct() — Method in class WatchdogCommands

FieldBaseInfoCommands::__construct() — Method in class FieldBaseInfoCommands

FieldBaseOverrideCreateCommands::__construct() — Method in class FieldBaseOverrideCreateCommands

FieldCreateCommands::__construct() — Method in class FieldCreateCommands

FieldDefinitionCommands::__construct() — Method in class FieldDefinitionCommands

FieldDeleteCommands::__construct() — Method in class FieldDeleteCommands

FieldEntityReferenceHooks::__construct() — Method in class FieldEntityReferenceHooks

FieldInfoCommands::__construct() — Method in class FieldInfoCommands

FieldTextHooks::__construct() — Method in class FieldTextHooks

ApplicationFactory::__construct() — Method in class ApplicationFactory

GenerateCommands::__construct() — Method in class GenerateCommands

PmCommands::__construct() — Method in class PmCommands

ThemeCommands::__construct() — Method in class ThemeCommands

SqlSyncCommands::__construct() — Method in class SqlSyncCommands

SanitizeCommentsCommands::__construct() — Method in class SanitizeCommentsCommands

SanitizeSessionsCommands::__construct() — Method in class SanitizeSessionsCommands

SanitizeUserFieldsCommands::__construct() — Method in class SanitizeUserFieldsCommands

SanitizeUserTableCommands::__construct() — Method in class SanitizeUserTableCommands

ConfigLocator::__construct() — Method in class ConfigLocator

ConfigLocator constructor

Environment::__construct() — Method in class Environment

Environment constructor

DrushDrupalFinder::__construct() — Method in class DrushDrupalFinder

MigrateExecutable::__construct() — Method in class MigrateExecutable

Constructs a new migrate executable instance.

MigrateIdMapFilter::__construct() — Method in class MigrateIdMapFilter

MigrateMessage::__construct() — Method in class MigrateMessage

Constructs a migrate message class.

MigrateMissingSourceRowsEvent::__construct() — Method in class MigrateMissingSourceRowsEvent

Constructs a new event instance.

MigratePrepareRowEvent::__construct() — Method in class MigratePrepareRowEvent

Constructs a prepare-row event object.

CommandFailedException::__construct() — Method in class CommandFailedException

UserAbortException::__construct() — Method in class UserAbortException

EntityToArraySimplifier::__construct() — Method in class EntityToArraySimplifier

DrushLog::__construct() — Method in class DrushLog

Constructs a DrushLog object.

Logger::__construct() — Method in class Logger

ArgsPreprocessor::__construct() — Method in class ArgsPreprocessor

ArgsPreprocessor constructor

ArgsRemapper::__construct() — Method in class ArgsRemapper

ArgsRemapper constructor

Preflight::__construct() — Method in class Preflight

Preflight constructor

PreflightArgs::__construct() — Method in class PreflightArgs

PreflightArgs constructor

PreflightLog::__construct() — Method in class PreflightLog

PreflightSiteLocator::__construct() — Method in class PreflightSiteLocator

DrushCommand::__construct() — Method in class DrushCommand

DrushCommand constructor.

LegacyServiceFinder::__construct() — Method in class LegacyServiceFinder

LegacyServiceInstantiator::__construct() — Method in class LegacyServiceInstantiator

RedispatchHook::__construct() — Method in class RedispatchHook

Runtime::__construct() — Method in class Runtime

ServiceManager::__construct() — Method in class ServiceManager

SiteAliasFileLoader::__construct() — Method in class SiteAliasFileLoader

SqlBase::__construct() — Method in class SqlBase

Typically, SqlBase instances are constructed via SqlBase::create($options).

CliTestTrait::_escapeshellargWindows() — Method in class CliTestTrait