• 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

AnnotatedCommand — Class in namespace Consolidation\AnnotatedCommand

AnnotatedCommands are created automatically by the AnnotatedCommandFactory. Each command method in a command file will produce one AnnotatedCommand. These are then added to your Symfony Console Application object; nothing else is needed.

$ AnnotatedCommand#annotationData — Property in class AnnotatedCommand

AnnotatedCommand::addUsageOrExample() — Method in class AnnotatedCommand

AnnotatedCommand::addOptions() — Method in class AnnotatedCommand

AnnotatedCommandFactory — Class in namespace Consolidation\AnnotatedCommand

The AnnotatedCommandFactory creates commands for your application.

$ AnnotatedCommandFactory#automaticOptionsProviderList — Property in class AnnotatedCommandFactory

var AutomaticOptionsProvider[]

AnnotatedCommandFactory::addListener() — Method in class AnnotatedCommandFactory

Add a listener that is notified immediately before the command factory creates commands from a commandFile instance. This listener can use this opportunity to do more setup for the commandFile, and so on.

AnnotatedCommandFactory::addListernerCallback() — Method in class AnnotatedCommandFactory

Add a listener that's just a simple 'callable'.

AnnotatedCommandFactory::addIgnoredCommandsRegexp() — Method in class AnnotatedCommandFactory

Add a regular expresion used to match methods names that will not be part of the final set of commands.

AnnotatedCommandFactory::addAutomaticOptionProvider() — Method in class AnnotatedCommandFactory

AnnotatedCommandFactory::addCommandInfoAlterer() — Method in class AnnotatedCommandFactory

AnnotatedCommandFactory::alterCommandInfo() — Method in class AnnotatedCommandFactory

Give plugins an opportunity to update the commandInfo

AnnotatedCommandFactory::automaticOptions() — Method in class AnnotatedCommandFactory

Get the options that are implied by annotations, e.g.

AnnotationData — Class in namespace Consolidation\AnnotatedCommand

AnnotationData::append() — Method in class AnnotationData

Argument — Class in namespace Consolidation\AnnotatedCommand\Attributes

$ CommandData#annotationData — Property in class CommandData

var AnnotationData

CommandData::annotationData() — Method in class CommandData

CommandData::arguments() — Method in class CommandData

CommandFileDiscovery::addExclude() — Method in class CommandFileDiscovery

Add one more location to the exclude list.

CommandFileDiscovery::addSearchLocation() — Method in class CommandFileDiscovery

Add one more location to the search location list.

CommandInfoAltererInterface::alterCommandInfo() — Method in class CommandInfoAltererInterface

CommandProcessor::addPrepareFormatter() — Method in class CommandProcessor

$ HelpCommand#application — Property in class HelpCommand

var Application

HelpDocument::alterHelpDocument() — Method in class HelpDocument

Alter the DOM document per the command object

HelpDocumentBuilder::alter() — Method in class HelpDocumentBuilder

AlterResultInterface — Class in namespace Consolidation\AnnotatedCommand\Hooks

Alter the result of a command after it has been processed.

HookManager::add() — Method in class HookManager

Add a hook

HookManager::addReplaceCommandHook() — Method in class HookManager

Add a replace command hook

HookManager::addPreCommandEventDispatcher() — Method in class HookManager

HookManager::addCommandEventDispatcher() — Method in class HookManager

HookManager::addPostCommandEventDispatcher() — Method in class HookManager

HookManager::addCommandEvent() — Method in class HookManager

HookManager::addInitializeHook() — Method in class HookManager

Add an configuration provider hook

HookManager::addOptionHook() — Method in class HookManager

Add an option hook

HookManager::addInteractor() — Method in class HookManager

Add an interact hook

HookManager::addPreValidator() — Method in class HookManager

Add a pre-validator hook

HookManager::addValidator() — Method in class HookManager

Add a validator hook

HookManager::addPreCommandHook() — Method in class HookManager

Add a pre-command hook. This is the same as a validator hook, except that it will run after all of the post-validator hooks.

HookManager::addPostCommandHook() — Method in class HookManager

Add a post-command hook. This is the same as a pre-process hook, except that it will run before the first pre-process hook.

HookManager::addResultProcessor() — Method in class HookManager

Add a result processor.

HookManager::addAlterResult() — Method in class HookManager

Add a result alterer. After a result is processed by a result processor, an alter hook may be used to convert the result from one form to another.

HookManager::addStatusDeterminer() — Method in class HookManager

Add a status determiner. Usually, a command should return an integer on error, or a result object on success (which implies a status code of zero). If a result contains the status code in some other field, then a status determiner can be used to call the appropriate accessor method to determine the status code. This is usually not necessary, though; a command that fails may return a CommandError object, which contains a status code and a result message to display.

HookManager::addOutputExtractor() — Method in class HookManager

Add an output extractor. If a command returns an object object, by default it is passed directly to the output formatter (if in use) for rendering. If the result object contains more information than just the data to render, though, then an output extractor can be used to call the appopriate accessor method of the result object to get the data to rendered. This is usually not necessary, though; it is preferable to have complex result objects implement the OutputDataInterface.

HookManager::addWildcardHooksToNames() — Method in class HookManager

AlterOptionsCommandEvent — Class in namespace Consolidation\AnnotatedCommand\Options

AlterOptionsCommandEvent is a subscriber to the Command Event that looks up any additional options (e.g. from an OPTION_HOOK) that should be added to the command. Options need to be added in two circumstances:

$ AlterOptionsCommandEvent#application — Property in class AlterOptionsCommandEvent

var Application

AlterOptionsCommandEvent::alterCommandOptions() — Method in class AlterOptionsCommandEvent

AutomaticOptionsProviderInterface — Class in namespace Consolidation\AnnotatedCommand\Options

Option providers can add options to commands based on the annotations present in a command. For example, a command that specifies @fields will automatically be given --format and --fields options.

AutomaticOptionsProviderInterface::automaticOptions() — Method in class AutomaticOptionsProviderInterface

$ PrepareTerminalWidthOption#application — Property in class PrepareTerminalWidthOption

var Application

ParameterInjection::args() — Method in class ParameterInjection

$ CommandInfo#arguments — Property in class CommandInfo

$ CommandInfo#aliases — Property in class CommandInfo

CommandInfo::addAnnotation() — Method in class CommandInfo

Save any tag that we do not explicitly recognize in the 'otherAnnotations' map.

CommandInfo::arguments() — Method in class CommandInfo

Descriptions of commandline arguements for this command.

CommandInfo::addImplicitNoOptions() — Method in class CommandInfo

CommandInfo::addArgumentDescription() — Method in class CommandInfo

CommandInfo::addOption() — Method in class CommandInfo

CommandInfo::addOptionDescription() — Method in class CommandInfo

CommandInfo::addOptionOrArgumentDescription() — Method in class CommandInfo

CommandInfo::addParameterToResult() — Method in class CommandInfo

Examine the provided parameter, and determine whether it is a parameter that will be filled in with a positional commandline argument.

DefaultsWithDescriptions::approximatelyMatchingKey() — Method in class DefaultsWithDescriptions

DefaultsWithDescriptions::add() — Method in class DefaultsWithDescriptions

Add another argument to this command.

AttributesDocBlockParser — Class in namespace Consolidation\AnnotatedCommand\Parser\Internal

Given a class and method name, let each attribute handle its own properties, populating the CommandInfo object.

BespokeDocBlockParser::addOptionOrArgumentTag() — Method in class BespokeDocBlockParser

DocblockTag::appendContent() — Method in class DocblockTag

Add more content onto a tag during parsing.

TagFactory::accumulateContent() — Method in class TagFactory

AbstractDataFormatException — Class in namespace Consolidation\OutputFormatters\Exception

Contains some helper functions used by exceptions in this project.

$ FormatterManager#arraySimplifiers — Property in class FormatterManager

var SimplifyToArrayInterface[]

FormatterManager::addDefaultFormatters() — Method in class FormatterManager

FormatterManager::addDefaultSimplifiers() — Method in class FormatterManager

FormatterManager::addFormatter() — Method in class FormatterManager

Add a formatter

FormatterManager::addSimplifier() — Method in class FormatterManager

Add a simplifier

FormatterManager::automaticOptions() — Method in class FormatterManager

Return a set of InputOption based on the annotations of a command.

FormatterManager::availableFieldsList() — Method in class FormatterManager

Given a list of available fields, return a list of field descriptions.

TableFormatter::addCustomTableStyles() — Method in class TableFormatter

Add our custom table style(s) to the table.

AbstractListData — Class in namespace Consolidation\OutputFormatters\StructuredData

Base class for all list data types.

AbstractStructuredList — Class in namespace Consolidation\OutputFormatters\StructuredData

Holds an array where each element of the array is one row, and each row contains an associative array where the keys are the field names, and the values are the field data.

AssociativeList — Class in namespace Consolidation\OutputFormatters\StructuredData

Old name for PropertyList class.

RenderCellCollectionInterface::addRenderer() — Method in class RenderCellCollectionInterface

Add a renderer

RenderCellCollectionTrait::addRenderer() — Method in class RenderCellCollectionTrait

Add a renderer

RenderCellCollectionTrait::addRendererFunction() — Method in class RenderCellCollectionTrait

Add a callable as a renderer

XmlSchema::arrayToXML() — Method in class XmlSchema

XmlSchema::addXmlData() — Method in class XmlSchema

XmlSchema::addXmlChildren() — Method in class XmlSchema

XmlSchema::addXmlDataOrAttribute() — Method in class XmlSchema

XmlSchemaInterface::arrayToXml() — Method in class XmlSchemaInterface

Convert data to a format suitable for use in a list.

ColumnWidths::adjustMinimumWidths() — Method in class ColumnWidths

If the widths specified by this object do not fit within the provided avaiable width, then reduce them all proportionally.

ColumnWidths::averageWidth() — Method in class ColumnWidths

Calculate how much space is available on average for all columns.

$ HostPath#alias_record — Property in class HostPath

SiteAliasFileDiscovery::addSearchLocation() — Method in class SiteAliasFileDiscovery

Add a location that alias files may be found.

SiteAliasFileLoader::addSearchLocation() — Method in class SiteAliasFileLoader

Add a search location to our discovery object.

SiteAliasFileLoader::addLoader() — Method in class SiteAliasFileLoader

SiteAliasFileLoader::adjustIfSingleAlias() — Method in class SiteAliasFileLoader

Adjust the alias data for a single-site alias. Usually, a .yml alias file will contain multiple entries, one for each of the environments of an alias. If there are no environments

$ SiteAliasManager#aliasLoader — Property in class SiteAliasManager

SiteAliasManager::addSearchLocation() — Method in class SiteAliasManager

Add a search location to our site alias discovery object.

SiteAliasManager::addSearchLocations() — Method in class SiteAliasManager

Add search locations to our site alias discovery object.

SiteAliasManagerInitializationInterface::addSearchLocation() — Method in class SiteAliasManagerInitializationInterface

Add a search location to our site alias discovery object.

SiteAliasManagerInitializationInterface::addSearchLocations() — Method in class SiteAliasManagerInitializationInterface

Add search locations to our site alias discovery object.

Application — Class in namespace Drush

Our application object

$ Application#aliasManager — Property in class Application

Application::aliasManager() — Method in class Application

Application::addListeners() — 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

Adds module supplied commands, as well as Symfony Console commands that require bootstrap.

DrupalBoot8::addBootstrapListeners() — 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.

ArchiveDumpCommand — Class in namespace Drush\Commands\core

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.

EntityTypeBundleAskTrait::askEntityType() — Method in class EntityTypeBundleAskTrait

EntityTypeBundleAskTrait::askBundle() — Method in class EntityTypeBundleAskTrait

FieldBaseOverrideCreateCommand::askFieldName() — Method in class FieldBaseOverrideCreateCommand

FieldBaseOverrideCreateCommand::askFieldLabel() — Method in class FieldBaseOverrideCreateCommand

FieldBaseOverrideCreateCommand::askFieldDescription() — Method in class FieldBaseOverrideCreateCommand

FieldBaseOverrideCreateCommand::askRequired() — Method in class FieldBaseOverrideCreateCommand

FieldCreateCommand::askExistingFieldName() — Method in class FieldCreateCommand

FieldCreateCommand::askFieldName() — Method in class FieldCreateCommand

FieldCreateCommand::askFieldLabel() — Method in class FieldCreateCommand

FieldCreateCommand::askFieldDescription() — Method in class FieldCreateCommand

FieldCreateCommand::askFieldType() — Method in class FieldCreateCommand

FieldCreateCommand::askFieldWidget() — Method in class FieldCreateCommand

FieldCreateCommand::askRequired() — Method in class FieldCreateCommand

FieldCreateCommand::askTranslatable() — Method in class FieldCreateCommand

FieldCreateCommand::askCardinality() — Method in class FieldCreateCommand

FieldDeleteCommand::askExisting() — Method in class FieldDeleteCommand

FieldDeleteCommand::askBundle() — Method in class FieldDeleteCommand

ApplicationFactory — Class in namespace Drush\Commands\generate

ApplicationFactory::alterGenerators() — Method in class ApplicationFactory

Implements hook GeneratorInfoAlter.

PmTrait::addInstallDependencies() — Method in class PmTrait

PmTrait::addUninstallDependencies() — Method in class PmTrait

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.

$ 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}

MigrateRunnerServiceProvider::alter() — Method in class MigrateRunnerServiceProvider

{@inheritdoc}

Drush::aliasManager() — Method in class Drush

Drush::affirmative() — Method in class Drush

Return 'true' if we are in affirmative mode

CacheClearEvent::addType() — Method in class CacheClearEvent

SanitizeConfirmsEvent::addMessage() — Method in class SanitizeConfirmsEvent

FormatterTrait::alterResult() — Method in class FormatterTrait

CreateEntityReferenceFieldListener::askReferencedEntityType() — Method in class CreateEntityReferenceFieldListener

CreateEntityReferenceFieldListener::askReferencedBundles() — Method in class CreateEntityReferenceFieldListener

CreateLinkFieldListener::askLinkType() — Method in class CreateLinkFieldListener

CreateLinkFieldListener::askAllowLinkText() — Method in class CreateLinkFieldListener

CreateTextFieldListener::askAllowedFormats() — Method in class CreateTextFieldListener

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

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.

ServiceManager::addListeners() — Method in class ServiceManager

Add listeners to Drush's event dispatcher.

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.

DrushStyle::ask() — Method in class DrushStyle

Prompt the user for text input.

DrushStyle::askRequired() — Method in class DrushStyle

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

BespokeDocBlockParser — Class in namespace Consolidation\AnnotatedCommand\Parser\Internal

Given a class and method name, parse the annotations in the DocBlock comment, and provide accessor methods for all of the elements that are needed to create an annotated Command.

SiteAliasFileLoader::basenameWithoutExtension() — Method in class SiteAliasFileLoader

Chop off the aliases.yml or alias.yml part of a path. This works just like basename, except it will throw if the provided path does not end in the specified extension.

$ 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.

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

BatchCommand — Class in namespace Drush\Commands\core

BatchCommands — Class in namespace Drush\Commands\core

BrowseCommand — Class in namespace Drush\Commands\core

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.

DrupalDependenciesCommands::buildTree() — Method in class DrupalDependenciesCommands

Builds the nested dependency tree.

DrupalDependenciesCommands::buildDependents() — Method in class DrupalDependenciesCommands

Build the reverse the relation: dependent -> dependencies.

EditCommand::bashFiles() — Method in class EditCommand

ListCommand::buildDom() — Method in class ListCommand

Drush::bootstrapManager() — Method in class Drush

Return the Bootstrap Manager.

Drush::bootstrap() — Method in class Drush

Return the Bootstrap object.

BootstrapListener — Class in namespace Drush\Listeners

HelpLinksListener::bullets() — Method in class HelpLinksListener

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#bootstrapListenerClasses — Property in class ServiceManager

ServiceManager::bootstrapCommandClasses() — Method in class ServiceManager

Return cached of deferred commandhander objects.

ServiceManager::bootstrapListenerClasses() — Method in class ServiceManager

Return cached of deferred subscriber 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

$ AnnotatedCommand#commandCallback — Property in class AnnotatedCommand

$ AnnotatedCommand#completionCallback — Property in class AnnotatedCommand

$ AnnotatedCommand#commandProcessor — Property in class AnnotatedCommand

AnnotatedCommand::commandProcessor() — Method in class AnnotatedCommand

AnnotatedCommand::complete() — Method in class AnnotatedCommand

Route a completion request to the specified Callable if available.

AnnotatedCommand::createCommandData() — Method in class AnnotatedCommand

$ AnnotatedCommandFactory#commandProcessor — Property in class AnnotatedCommandFactory

var CommandProcessor

$ AnnotatedCommandFactory#commandInfoAlterers — Property in class AnnotatedCommandFactory

var CommandInfoAltererInterface

AnnotatedCommandFactory::commandProcessor() — Method in class AnnotatedCommandFactory

AnnotatedCommandFactory::createCommandsFromClass() — Method in class AnnotatedCommandFactory

n.b. This registers all hooks from the commandfile instance as a side-effect.

AnnotatedCommandFactory::createCommandInfoListFromClass() — Method in class AnnotatedCommandFactory

AnnotatedCommandFactory::createCommandInfo() — Method in class AnnotatedCommandFactory

AnnotatedCommandFactory::createCommandsFromClassInfo() — Method in class AnnotatedCommandFactory

AnnotatedCommandFactory::createSelectedCommandsFromClassInfo() — Method in class AnnotatedCommandFactory

AnnotatedCommandFactory::createCommand() — Method in class AnnotatedCommandFactory

AnnotatedCommandFactory::callAutomaticOptionsProviders() — Method in class AnnotatedCommandFactory

Get the options that are implied by annotations, e.g.

Command — Class in namespace Consolidation\AnnotatedCommand\Attributes

Complete — Class in namespace Consolidation\AnnotatedCommand\Attributes

CacheWrapper — Class in namespace Consolidation\AnnotatedCommand\Cache

Make a generic cache object conform to our expected interface.

CommandCreationListener — Class in namespace Consolidation\AnnotatedCommand

Command cration listeners can be added to the annotation command factory. These will be notified whenever a new commandfile is provided to the factory. This is useful for initializing new commandfile objects.

CommandCreationListenerInterface — Class in namespace Consolidation\AnnotatedCommand

Command cration listeners can be added to the annotation command factory. These will be notified whenever a new commandfile is provided to the factory. This is useful for initializing new commandfile objects.

CommandData — Class in namespace Consolidation\AnnotatedCommand

CommandData::cacheSpecialDefaults() — Method in class CommandData

CommandError — Class in namespace Consolidation\AnnotatedCommand

Return a CommandError as the result of a command to pass a status code and error message to be displayed.

CommandFileDiscovery — Class in namespace Consolidation\AnnotatedCommand

Do discovery presuming that the namespace of the command will contain the last component of the path. This is the convention that should be used when searching for command files that are bundled with the modules of a framework. The convention used is that the namespace for a module in a framework should start with the framework name followed by the module name.

CommandFileDiscovery::convertToNamespacedList() — Method in class CommandFileDiscovery

Given a simple list containing paths to directories, where the last component of the path should appear in the namespace, after the base namespace, this function will return an associative array mapping the path's basename (e.g. the module name) to the directory path.

CommandFileDiscovery::createFinder() — Method in class CommandFileDiscovery

Create a Finder object for use in searching a particular directory location.

CommandInfoAltererInterface — Class in namespace Consolidation\AnnotatedCommand

CommandProcessor — Class in namespace Consolidation\AnnotatedCommand

Process a command, including hooks and other callbacks.

CommandProcessor::commandErrorForException() — Method in class CommandProcessor

CommandResult — Class in namespace Consolidation\AnnotatedCommand

Return a CommandResult as the result of a command to pass both an exit code and result data from a command.

CustomEventAwareInterface — Class in namespace Consolidation\AnnotatedCommand\Events

CustomEventAwareTrait — Class in namespace Consolidation\AnnotatedCommand\Events

$ HelpDocument#command — Property in class HelpDocument

var Command

CommandEventHookDispatcher — Class in namespace Consolidation\AnnotatedCommand\Hooks\Dispatchers

Call hooks

CommandEventHookDispatcher::callCommandEventHooks() — Method in class CommandEventHookDispatcher

ExtracterHookDispatcher::callExtractor() — Method in class ExtracterHookDispatcher

InitializeHookDispatcher::callInitializeHook() — Method in class InitializeHookDispatcher

InteractHookDispatcher::callInteractor() — Method in class InteractHookDispatcher

OptionsHookDispatcher::callOptionHook() — Method in class OptionsHookDispatcher

ProcessResultHookDispatcher::callProcessor() — Method in class ProcessResultHookDispatcher

StatusDeterminerHookDispatcher::callDeterminer() — Method in class StatusDeterminerHookDispatcher

ValidateHookDispatcher::callValidator() — Method in class ValidateHookDispatcher

HookManager::callCommandEventHooks() — Method in class HookManager

Call the command event hooks.

StdinHandler::close() — Method in class StdinHandler

close closes the input stream if it was opened.

StdinHandler::contents() — Method in class StdinHandler

contents reads the entire contents of the standard input stream.

CommandInfo — Class in namespace Consolidation\AnnotatedCommand\Parser

Given a class and method name, parse the annotations in the DocBlock comment, and provide accessor methods for all of the elements that are needed to create a Symfony Console Command.

CommandInfo::create() — Method in class CommandInfo

CommandInfo::cachedFileIsModified() — Method in class CommandInfo

CommandInfo::constructFromClassAndMethod() — Method in class CommandInfo

CommandInfo::createInputOptions() — Method in class CommandInfo

CommandInfo::convertName() — Method in class CommandInfo

Convert from a method name to the corresponding command name. A method 'fooBar' will become 'foo:bar', and 'fooBarBazBoz' will become 'foo:bar-baz-boz'.

CommandInfo::convertArgumentName() — Method in class CommandInfo

Convert an argument name from snake_case or camelCase to a hyphenated-string.

CommandInfo::camelToSnake() — Method in class CommandInfo

Convert a camelCase string to a snake_case string.

CommandInfo::convertListToCommaSeparated() — Method in class CommandInfo

Given a list that might be 'a b c' or 'a, b, c' or 'a,b,c', convert the data into the last of these forms.

CommandInfoDeserializer — Class in namespace Consolidation\AnnotatedCommand\Parser

Deserialize a CommandInfo object

CommandInfoDeserializer::cachedMethodExists() — Method in class CommandInfoDeserializer

CommandInfoDeserializer::constructFromCache() — Method in class CommandInfoDeserializer

CommandInfoDeserializer::constructDefaultsWithDescriptions() — Method in class CommandInfoDeserializer

CommandInfoSerializer — Class in namespace Consolidation\AnnotatedCommand\Parser

Serialize a CommandInfo object

DefaultsWithDescriptions::clear() — Method in class DefaultsWithDescriptions

Remove an entry

$ AttributesDocBlockParser#commandInfo — Property in class AttributesDocBlockParser

$ BespokeDocBlockParser#commandInfo — Property in class BespokeDocBlockParser

BespokeDocBlockParser::convertListToCommaSeparated() — Method in class BespokeDocBlockParser

Given a list that might be 'a b c' or 'a, b, c' or 'a,b,c', convert the data into the last of these forms.

CommandDocBlockParserFactory — Class in namespace Consolidation\AnnotatedCommand\Parser\Internal

Create an appropriate CommandDocBlockParser.

CsvUtils — Class in namespace Consolidation\AnnotatedCommand\Parser\Internal

Methods to convert to / from a csv string.

CsvUtils::csvEscape() — Method in class CsvUtils

Convert a string to a csv.

$ DocblockTag#content — Property in class DocblockTag

$ FullyQualifiedClassCache#classCache — Property in class FullyQualifiedClassCache

FullyQualifiedClassCache::cached() — Method in class FullyQualifiedClassCache

$ TagFactory#current — Property in class TagFactory

TagFactory::createTag() — Method in class TagFactory

ResultWriter::chooseOutputStream() — Method in class ResultWriter

Determine whether we should use stdout or stderr.

SavableState::currentState() — Method in class SavableState

Return the current state of this object.

FormatterManager::canSimplifyToArray() — Method in class FormatterManager

FormatterManager::convertData() — Method in class FormatterManager

Convert from one format to another if necessary prior to restructuring.

CsvFormatter — Class in namespace Consolidation\OutputFormatters\Formatters

Comma-separated value formatters

CsvFormatter::csvEscape() — Method in class CsvFormatter

Generates a CSV-escaped string from an array of field data.

$ FormatterOptions#configurationData — Property in class FormatterOptions

var array

AbstractStructuredList::createTableTransformation() — Method in class AbstractStructuredList

CallableRenderer — Class in namespace Consolidation\OutputFormatters\StructuredData

ConversionInterface — Class in namespace Consolidation\OutputFormatters\StructuredData

ConversionInterface::convert() — Method in class ConversionInterface

Allow structured data to be converted -- i.e. from RowsOfFields to UnstructuredListData.

NumericCellRenderer::convertCellDataToString() — Method in class NumericCellRenderer

This formatter only works with columns whose columns are strings.

NumericCellRenderer::columnWidth() — Method in class NumericCellRenderer

Get the cached column width for the provided key.

NumericCellRenderer::calculateColumnWidth() — Method in class NumericCellRenderer

Using the cached table data, calculate the largest width for the data in the table for use when right-justifying.

PropertyList::convert() — Method in class PropertyList

RowsOfFields::convert() — Method in class RowsOfFields

DomToArraySimplifier::canSimplify() — Method in class DomToArraySimplifier

ReorderFields::convertToRegex() — Method in class ReorderFields

Convert the provided string into a regex suitable for use in preg_match.

SimplifyToArrayInterface::canSimplify() — Method in class SimplifyToArrayInterface

Indicate whether or not the given data type can be simplified to an array

TableTransformation::convertTableToList() — Method in class TableTransformation

WordWrapper::calculateWidths() — Method in class WordWrapper

Determine what widths we'll use for wrapping.

CalculateWidths — Class in namespace Consolidation\OutputFormatters\Transformations\Wrap

Calculate column widths for table cells.

CalculateWidths::calculate() — Method in class CalculateWidths

Given the total amount of available space, and the width of the columns to place, calculate the optimum column widths to use.

CalculateWidths::calculateLongestCell() — Method in class CalculateWidths

Calculate the longest cell data from any row of each of the cells.

CalculateWidths::calculateLongestWord() — Method in class CalculateWidths

Calculate the longest word and longest line in the provided data.

CalculateWidths::calculateColumnWidths() — Method in class CalculateWidths

ColumnWidths — Class in namespace Consolidation\OutputFormatters\Transformations\Wrap

Calculate the width of data in table cells in preparation for word wrapping.

ColumnWidths::count() — Method in class ColumnWidths

Return the number of columns.

ColumnWidths::combine() — Method in class ColumnWidths

Combine this set of widths with another set, and return a new set that contains the entries from both.

HostPath::create() — Method in class HostPath

Factory method to create a host path.

SiteAliasFileDiscovery::createFinder() — Method in class SiteAliasFileDiscovery

Create a Symfony Finder object to search all available search locations for the specified search pattern.

SiteAliasFileLoader::createSiteAliassFromSiteData() — Method in class SiteAliasFileLoader

SiteAliasWithConfig::create() — Method in class SiteAliasWithConfig

combine the provided site alias with configuration.

SiteAliasWithConfig::combine() — Method in class SiteAliasWithConfig

SiteAliasWithConfig::changesProhibited() — Method in class SiteAliasWithConfig

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.

ConsoleLink — Class in namespace Drush\Command

A value object for Symfony Console hyperlinks.

$ ServiceCommandlist#commandList — Property in class ServiceCommandlist

AutowireTrait::create() — Method in class AutowireTrait

Instantiates a new instance of the implementing class using autowiring.

$ DrushCommands#commandData — Property in class DrushCommands

CacheClearCommand — Class in namespace Drush\Commands\cache

CacheClearCommand::configure() — Method in class CacheClearCommand

CacheClearCommand::clearBins() — Method in class CacheClearCommand

Clear one or more cache bins.

CacheClearCommand::clearThemeRegistry() — Method in class CacheClearCommand

CacheClearCommand::clearRouter() — Method in class CacheClearCommand

CacheClearCommand::clearCssJs() — Method in class CacheClearCommand

CacheClearCommand::clearContainer() — Method in class CacheClearCommand

CacheClearCommand::clearRender() — Method in class CacheClearCommand

Clears the render cache entries.

CacheClearCommand::clearPlugin() — Method in class CacheClearCommand

CacheClearCommand::clearViews() — Method in class CacheClearCommand

CacheGetCommand — Class in namespace Drush\Commands\cache

CacheGetCommand::configure() — Method in class CacheGetCommand

CacheRebuildCommand — Class in namespace Drush\Commands\cache

CacheRebuildCommand::configure() — Method in class CacheRebuildCommand

CacheSetCommand — Class in namespace Drush\Commands\cache

CacheSetCommand::configure() — Method in class CacheSetCommand

CacheTagsCommand — Class in namespace Drush\Commands\cache

CacheTagsCommand::configure() — Method in class CacheTagsCommand

CacheWarmCommand — Class in namespace Drush\Commands\cache

CacheWarmCommand::configure() — Method in class CacheWarmCommand

CacheWarmCommand::create() — Method in class CacheWarmCommand

ConfigCommands — Class in namespace Drush\Commands\config

ConfigDeleteCommand — Class in namespace Drush\Commands\config

ConfigDeleteCommand::configure() — Method in class ConfigDeleteCommand

ConfigDeleteCommand::complete() — Method in class ConfigDeleteCommand

ConfigEditCommand — Class in namespace Drush\Commands\config

ConfigEditCommand::configure() — Method in class ConfigEditCommand

ConfigEditCommand::complete() — Method in class ConfigEditCommand

ConfigExportCommand — Class in namespace Drush\Commands\config

ConfigExportCommand::configure() — Method in class ConfigExportCommand

ConfigExportCommands — Class in namespace Drush\Commands\config

ConfigGetCommand — Class in namespace Drush\Commands\config

ConfigGetCommand::configure() — Method in class ConfigGetCommand

ConfigImportCommand — Class in namespace Drush\Commands\config

ConfigImportCommand::configure() — Method in class ConfigImportCommand

ConfigImportCommands — Class in namespace Drush\Commands\config

ConfigNameTrait — Class in namespace Drush\Commands\config

ConfigNameTrait::complete() — Method in class ConfigNameTrait

ConfigPullCommand — Class in namespace Drush\Commands\config

ConfigPullCommand::configure() — Method in class ConfigPullCommand

ConfigSetCommand — Class in namespace Drush\Commands\config

ConfigSetCommand::configure() — Method in class ConfigSetCommand

ConfigStatusCommand — Class in namespace Drush\Commands\config

ConfigStatusCommand::configure() — Method in class ConfigStatusCommand

ConfigTrait — Class in namespace Drush\Commands\config

ConfigTrait::copyConfig() — Method in class ConfigTrait

Copies configuration objects from source storage to target storage.

ConfigTrait::configChangesTable() — Method in class ConfigTrait

Build a table of config changes.

ArchiveDumpCommand::configure() — Method in class ArchiveDumpCommand

ArchiveDumpCommand::convertSymlinks() — Method in class ArchiveDumpCommand

Converts symlinks to the linked files/folders for an archive.

BatchCommand::configure() — Method in class BatchCommand

BrowseCommand::configure() — Method in class BrowseCommand

CacheCommands — Class in namespace Drush\Commands\core

CacheRebuildCommands — Class in namespace Drush\Commands\core

CliCommand — Class in namespace Drush\Commands\core

CliCommand::configure() — Method in class CliCommand

CliCommand::createShortClassForEntityClass() — Method in class CliCommand

CliCommands — Class in namespace Drush\Commands\core

CoreCommands — Class in namespace Drush\Commands\core

CoreGlobalOptionsCommand — Class in namespace Drush\Commands\core

CoreGlobalOptionsCommand::configure() — Method in class CoreGlobalOptionsCommand

CronCommand — Class in namespace Drush\Commands\core

CronCommand::configure() — Method in class CronCommand

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.

DrupalDependenciesCommands::create() — Method in class DrupalDependenciesCommands

DrupalDirectoryCommand::configure() — Method in class DrupalDirectoryCommand

EditCommand::configure() — Method in class EditCommand

EditCommand::complete() — Method in class EditCommand

ImageDeriveCommand::configure() — Method in class ImageDeriveCommand

ImageFlushCommand::configure() — Method in class ImageFlushCommand

JsonapiGetCommand::configure() — Method in class JsonapiGetCommand

LanguageAddCommand::configure() — Method in class LanguageAddCommand

LanguageInfoCommand::configure() — Method in class LanguageInfoCommand

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. Also convert to Markdown links.

PhpEvalCommand::configure() — Method in class PhpEvalCommand

PhpScriptCommand::configure() — Method in class PhpScriptCommand

RequirementsCommand::configure() — Method in class RequirementsCommand

RouteCommand::configure() — Method in class RouteCommand

RsyncCommand::configure() — Method in class RsyncCommand

RunserverCommand::configure() — Method in class RunserverCommand

SiteAliasCommand::configure() — Method in class SiteAliasCommand

SiteInstallCommand::configure() — Method in class SiteInstallCommand

SiteSetCommand::configure() — Method in class SiteSetCommand

SshCommand::configure() — Method in class SshCommand

StatusCommand::configure() — Method in class StatusCommand

ThemeDevCommand::configure() — Method in class ThemeDevCommand

TwigUnusedCommand::configure() — Method in class TwigUnusedCommand

WorkspacePublishCommand::configure() — Method in class WorkspacePublishCommand

DeployCommand::cacheRebuild() — Method in class DeployCommand

DeployHookBatchProcessCommand::configure() — Method in class DeployHookBatchProcessCommand

EntityCreateCommand::configure() — Method in class EntityCreateCommand

EntityCreateCommand::createEntity() — Method in class EntityCreateCommand

EntityDeleteCommand::configure() — Method in class EntityDeleteCommand

EntitySaveCommand::configure() — Method in class EntitySaveCommand

FieldBaseInfoCommand::configure() — Method in class FieldBaseInfoCommand

FieldBaseInfoCommand::complete() — Method in class FieldBaseInfoCommand

FieldBaseOverrideCreateCommand::configure() — Method in class FieldBaseOverrideCreateCommand

FieldBaseOverrideCreateCommand::complete() — Method in class FieldBaseOverrideCreateCommand

FieldBaseOverrideCreateCommand::createBaseFieldOverride() — Method in class FieldBaseOverrideCreateCommand

FieldCreateCommand::configure() — Method in class FieldCreateCommand

FieldCreateCommand::complete() — Method in class FieldCreateCommand

FieldCreateCommand::createField() — Method in class FieldCreateCommand

FieldCreateCommand::createFieldStorage() — Method in class FieldCreateCommand

FieldCreateCommand::createFieldDisplay() — Method in class FieldCreateCommand

FieldDeleteCommand::configure() — Method in class FieldDeleteCommand

FieldDeleteCommand::complete() — Method in class FieldDeleteCommand

FieldFormattersCommand::configure() — Method in class FieldFormattersCommand

FieldFormattersCommand::complete() — Method in class FieldFormattersCommand

FieldInfoCommand::configure() — Method in class FieldInfoCommand

FieldInfoCommand::complete() — Method in class FieldInfoCommand

FieldWidgetsCommand::configure() — Method in class FieldWidgetsCommand

FieldWidgetsCommand::complete() — Method in class FieldWidgetsCommand

ApplicationFactory::create() — Method in class ApplicationFactory

Creates Drush generate application.

GenerateCommand::configure() — Method in class GenerateCommand

GenerateCommand::complete() — Method in class GenerateCommand

Generates completion for generator names.

HelpCLIFormatter::cleanOptions() — Method in class HelpCLIFormatter

HelpCommand::configure() — Method in class HelpCommand

ListCommand::configure() — Method in class ListCommand

ListCommand::categorize() — Method in class ListCommand

LocaleExportCommand::configure() — Method in class LocaleExportCommand

LocaleImportAllCommand::configure() — Method in class LocaleImportAllCommand

LocaleImportCommand::configure() — Method in class LocaleImportCommand

$ LocaleTrait#configFactory — Property in class LocaleTrait

LocaleUpdateCommand::configure() — Method in class LocaleUpdateCommand

MaintGetCommand::configure() — Method in class MaintGetCommand

MaintSetCommand::configure() — Method in class MaintSetCommand

MaintStatusCommand::configure() — Method in class MaintStatusCommand

MigrateFieldsSourceCommand::configure() — Method in class MigrateFieldsSourceCommand

MigrateImportCommand::configure() — Method in class MigrateImportCommand

MigrateMessagesCommand::configure() — Method in class MigrateMessagesCommand

MigrateResetStatusCommand::configure() — Method in class MigrateResetStatusCommand

MigrateRollbackCommand::configure() — Method in class MigrateRollbackCommand

MigrateStatusCommand::configure() — Method in class MigrateStatusCommand

MigrateStopCommand::configure() — Method in class MigrateStopCommand

PmInstallCommand::configure() — Method in class PmInstallCommand

PmListCommand::configure() — Method in class PmListCommand

$ PmTrait#configFactory — Property in class PmTrait

PmUninstallCommand::configure() — Method in class PmUninstallCommand

ThemeInstallCommand::configure() — Method in class ThemeInstallCommand

ThemeUninstallCommand::configure() — Method in class ThemeUninstallCommand

QueueDeleteCommand::configure() — Method in class QueueDeleteCommand

QueueRunCommand::configure() — Method in class QueueRunCommand

QueueTrait::complete() — Method in class QueueTrait

RoleCreateCommand::configure() — Method in class RoleCreateCommand

RoleDeleteCommand::configure() — Method in class RoleDeleteCommand

RoleDeleteCommand::complete() — Method in class RoleDeleteCommand

RoleListCommand::configure() — Method in class RoleListCommand

RolePermAddCommand::configure() — Method in class RolePermAddCommand

RolePermAddCommand::complete() — Method in class RolePermAddCommand

RolePermRemoveCommand::configure() — Method in class RolePermRemoveCommand

RolePermRemoveCommand::complete() — Method in class RolePermRemoveCommand

SqlCliCommand::configure() — Method in class SqlCliCommand

SqlConfCommand::configure() — Method in class SqlConfCommand

SqlConnectCommand::configure() — Method in class SqlConnectCommand

SqlCreateCommand::configure() — Method in class SqlCreateCommand

SqlDropCommand::configure() — Method in class SqlDropCommand

SqlDumpCommand::configure() — Method in class SqlDumpCommand

SqlQueryCommand::configure() — Method in class SqlQueryCommand

SqlSyncCommand::configure() — Method in class SqlSyncCommand

SanitizeCommand::configure() — Method in class SanitizeCommand

StateDeleteCommand::configure() — Method in class StateDeleteCommand

StateGetCommand::configure() — Method in class StateGetCommand

StateSetCommand::configure() — Method in class StateSetCommand

UpdateDBCommand::configure() — Method in class UpdateDBCommand

UpdateDBCommand::cacheRebuild() — Method in class UpdateDBCommand

Clears caches and rebuilds the container.

UpdateDbBatchProcessCommand::configure() — Method in class UpdateDbBatchProcessCommand

UserBlockCommand::configure() — Method in class UserBlockCommand

UserCancelCommand::configure() — Method in class UserCancelCommand

UserCreateCommand::configure() — Method in class UserCreateCommand

UserInformationCommand::configure() — Method in class UserInformationCommand

UserLoginCommand::configure() — Method in class UserLoginCommand

UserPasswordCommand::configure() — Method in class UserPasswordCommand

UserRoleAddCommand::configure() — Method in class UserRoleAddCommand

UserRoleAddCommand::complete() — Method in class UserRoleAddCommand

UserRoleRemoveCommand::configure() — Method in class UserRoleRemoveCommand

UserRoleRemoveCommand::complete() — Method in class UserRoleRemoveCommand

UserUnblockCommand::configure() — Method in class UserUnblockCommand

ViewsDisableCommand::configure() — Method in class ViewsDisableCommand

ViewsEnableCommand::configure() — Method in class ViewsEnableCommand

ViewsExecuteCommand::configure() — Method in class ViewsExecuteCommand

ViewsListCommand::configure() — Method in class ViewsListCommand

WatchdogDeleteCommand::configure() — Method in class WatchdogDeleteCommand

WatchdogDeleteCommand::complete() — Method in class WatchdogDeleteCommand

WatchdogListCommand::configure() — Method in class WatchdogListCommand

WatchdogListCommand::complete() — Method in class WatchdogListCommand

WatchdogShowCommand::configure() — Method in class WatchdogShowCommand

WatchdogShowCommand::complete() — Method in class WatchdogShowCommand

WatchdogShowOneCommand::configure() — Method in class WatchdogShowOneCommand

WatchdogTailCommand::configure() — Method in class WatchdogTailCommand

WatchdogTailCommand::complete() — Method in class WatchdogTailCommand

$ WatchdogTrait#connection — Property in class WatchdogTrait

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::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#container — Property in class Drush

The currently active container object, or NULL if not initialized yet.

Drush::commandFactory() — Method in class Drush

Return command factory

Drush::config() — Method in class Drush

Return the configuration object

CacheClearEvent — Class in namespace Drush\Event

ConsoleDefinitionsEvent — Class in namespace Drush\Event

CommandFailedException — Class in namespace Drush\Exceptions

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

EntityToArraySimplifier::canSimplify() — Method in class EntityToArraySimplifier

Indicate whether or not the given data type can be simplified to an array

CreateEntityReferenceFieldListener — Class in namespace Drush\Listeners

CreateLinkFieldListener — Class in namespace Drush\Listeners

CreateTextFieldListener — Class in namespace Drush\Listeners

ValidateMigrationIdListener::create() — Method in class ValidateMigrationIdListener

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::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::configure() — Method in class DrushHelpCommand

{@inheritdoc}

ConfiguresPrompts — Class in namespace Drush\Runtime

Laravel configures prompts in a trait, so we do too to keep code aligned.

ConfiguresPromptsTrait — Class in namespace Drush\Runtime

ConfiguresPromptsTrait::configurePrompts() — Method in class ConfiguresPromptsTrait

Configure the prompt fallbacks.

DependencyInjection::configureContainer() — Method in class DependencyInjection

Register core services in the container.

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.

RelativeNamespaceDiscovery::convertPathToNamespace() — Method in class RelativeNamespaceDiscovery

RelativeNamespaceDiscovery::convertNamespaceToPath() — Method in class RelativeNamespaceDiscovery

ServiceManager::commandFromInvokable() — Method in class ServiceManager

The annotated command framework does not support invokable commands, so build a Command as needed.

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.

SqlMariaDB::command() — Method in class SqlMariaDB

The unix command used to connect to the database.

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.

DrushStyle::confirm() — Method in class DrushStyle

DrushStyle::choice() — Method in class DrushStyle

DrushStyle::caution() — Method in class DrushStyle

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

$ AnnotatedCommandFactory#dataStore — Property in class AnnotatedCommandFactory

var SimpleCacheInterface

DefaultFields — Class in namespace Consolidation\AnnotatedCommand\Attributes

DefaultTableFields — Class in namespace Consolidation\AnnotatedCommand\Attributes

$ CacheWrapper#dataStore — Property in class CacheWrapper

CommandFileDiscovery::discoverNamespaced() — Method in class CommandFileDiscovery

Given a list of directories, e.g. Drupal modules like:

CommandFileDiscovery::discover() — Method in class CommandFileDiscovery

Search for command files in the specified locations. This is the function that should be used for all locations that are NOT modules of a framework.

CommandFileDiscovery::discoverCommandFiles() — Method in class CommandFileDiscovery

Search for command files in specific locations within a single directory.

CommandFileDiscovery::discoverCommandFilesInLocation() — Method in class CommandFileDiscovery

Search for command files in just one particular location. Returns an associative array mapping from the pathname of the file to the classname that it contains. The pathname may be ignored if the search location is included in the autoloader.

$ CommandResult#data — Property in class CommandResult

CommandResult::data() — Method in class CommandResult

CommandResult::dataWithExitCode() — Method in class CommandResult

$ HelpDocument#dom — Property in class HelpDocument

var \DOMDocument

StatusDeterminerHookDispatcher::determineStatusCode() — Method in class StatusDeterminerHookDispatcher

Call all status determiners, and see if any of them know how to convert to a status code.

StatusDeterminerInterface::determineStatusCode() — Method in class StatusDeterminerInterface

Convert a result object into a status code, if possible. Return null if the result object is unknown.

$ PrepareTerminalWidthOption#defaultWidth — Property in class PrepareTerminalWidthOption

var int

$ CommandInfo#docBlockIsParsed — Property in class CommandInfo

$ CommandInfo#description — Property in class CommandInfo

CommandInfo::deserialize() — Method in class CommandInfo

CommandInfo::determineAgumentClassifications() — Method in class CommandInfo

Examine the parameters of the method for this command, and build a list of commandline arguments for them.

CommandInfo::determineOptionsFromParameters() — Method in class CommandInfo

Examine the parameters of the method for this command, and determine the disposition of the options from them.

CommandInfoDeserializer::deserialize() — Method in class CommandInfoDeserializer

CommandInfoDeserializer::defaultSerializationData() — Method in class CommandInfoDeserializer

Default data. Everything should be provided during serialization; this is just as a fallback for unusual circumstances.

DefaultsWithDescriptions — Class in namespace Consolidation\AnnotatedCommand\Parser

An associative array that maps from key to default value; each entry can also have a description and suggested values.

$ DefaultsWithDescriptions#descriptions — Property in class DefaultsWithDescriptions

$ DefaultsWithDescriptions#defaultDefault — Property in class DefaultsWithDescriptions

DefaultValueFromString — Class in namespace Consolidation\AnnotatedCommand\Parser\Internal

Hold a default value.

DocBlockUtils — Class in namespace Consolidation\AnnotatedCommand\Parser\Internal

Simple utility methods when working with docblock comments.

DocblockTag — Class in namespace Consolidation\AnnotatedCommand\Parser\Internal

Hold the tag definition for one tag in a DocBlock.

$ ResultWriter#displayErrorFunction — Property in class ResultWriter

ResultWriter::dataCanBeFormatted() — Method in class ResultWriter

AbstractDataFormatException::describeDataType() — Method in class AbstractDataFormatException

Return a description of the data type represented by the provided parameter.

AbstractDataFormatException::describeAllowedTypes() — Method in class AbstractDataFormatException

AbstractDataFormatException::describeListOfAllowedTypes() — Method in class AbstractDataFormatException

$ TableFormatter#defaultFields — Property in class TableFormatter

FormatterOptions::defaultsForKey() — Method in class FormatterOptions

Reduce provided defaults to the single item identified by '$key', if it exists, or an empty array otherwise.

AbstractListData::defaultOptions() — Method in class AbstractListData

A structured list may provide its own set of default options. These will be used in place of the command's default options (from the annotations) in instances where the user does not provide the options explicitly (on the commandline) or implicitly (via a configuration file).

AbstractStructuredList::defaultOptions() — Method in class AbstractStructuredList

A structured list may provide its own set of default options. These will be used in place of the command's default options (from the annotations) in instances where the user does not provide the options explicitly (on the commandline) or implicitly (via a configuration file).

$ MetadataHolderTrait#dataKey — Property in class MetadataHolderTrait

$ NumericCellRenderer#data — Property in class NumericCellRenderer

PropertyList::defaultOptions() — Method in class PropertyList

A structured list may provide its own set of default options. These will be used in place of the command's default options (from the annotations) in instances where the user does not provide the options explicitly (on the commandline) or implicitly (via a configuration file).

RowsOfFields::defaultOptions() — Method in class RowsOfFields

A structured list may provide its own set of default options. These will be used in place of the command's default options (from the annotations) in instances where the user does not provide the options explicitly (on the commandline) or implicitly (via a configuration file).

DomDataInterface — Class in namespace Consolidation\OutputFormatters\StructuredData\Xml

XmlSchema::determineElementName() — Method in class XmlSchema

DomToArraySimplifier — Class in namespace Consolidation\OutputFormatters\Transformations

Simplify a DOMDocument to an array.

$ UnstructuredDataFieldAccessor#data — Property in class UnstructuredDataFieldAccessor

CalculateWidths::distributeLongColumns() — Method in class CalculateWidths

Distribute the remainig space among the columns that were not included in the list of "short" columns.

ColumnWidths::distribute() — Method in class ColumnWidths

Return proportional weights

DataFileLoaderInterface — Class in namespace Consolidation\SiteAlias

HostPath::determinePathOrAlias() — Method in class HostPath

Helper method for HostPath::create(). When the host path contains no ':', this method determines whether the string that was provided is a host or a path.

$ SiteAliasFileDiscovery#depth — Property in class SiteAliasFileDiscovery

SiteAliasFileDiscovery::depth() — Method in class SiteAliasFileDiscovery

Set the search depth for finding alias files

$ SiteAliasFileLoader#discovery — Property in class SiteAliasFileLoader

SiteAliasFileLoader::discovery() — Method in class SiteAliasFileLoader

Return our discovery object.

SiteAliasFileLoader::detectSingleAlias() — Method in class SiteAliasFileLoader

A single-environment alias looks something like this:

SiteAliasName::doParse() — Method in class SiteAliasName

Convert the parts of an alias name to its various component parts.

$ SiteAliasWithConfig#defaultConfig — Property in class SiteAliasWithConfig

SiteAliasWithConfig::determineCorrectRuntimeConfig() — Method in class SiteAliasWithConfig

Determine what object to use for the runtime config. If a specific runtime config is given, use that. Otherwise, pull it from the default configuration if available.

SiteSpecParser::defaults() — Method in class SiteSpecParser

Inflate the provided array so that it always contains the required elements.

Application::doRunCommand() — Method in class Application

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

DrupalBootLevels — Class in namespace Drush\Boot

A value class with bootstrap levels.

DrushCommandInfoAlterer — Class in namespace Drush\Command

DrushCommands — Class in namespace Drush\Commands

CacheGetCommand::doExecute() — Method in class CacheGetCommand

ConfigExportCommand::doExecute() — Method in class ConfigExportCommand

ConfigGetCommand::doExecute() — Method in class ConfigGetCommand

ConfigPullCommand::doExecute() — Method in class ConfigPullCommand

ConfigStatusCommand::doExecute() — Method in class ConfigStatusCommand

ArchiveDumpCommand::dump() — Method in class ArchiveDumpCommand

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

BatchCommand::doExecute() — Method in class BatchCommand

CoreGlobalOptionsCommand::doExecute() — Method in class CoreGlobalOptionsCommand

DeployCommands — Class in namespace Drush\Commands\core

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.

DocsCommands::drupalDependencies() — Method in class DocsCommands

Inspecting Drupal dependencies.

DrupalCommands — Class in namespace Drush\Commands\core

DrupalDependenciesCommands — Class in namespace Drush\Commands\core

Drush commands revealing Drupal dependencies.

DrupalDependenciesCommands::dependentsOfModule() — Method in class DrupalDependenciesCommands

DrupalDependenciesCommands::dependentsOfConfig() — Method in class DrupalDependenciesCommands

DrupalDirectoryCommand — Class in namespace Drush\Commands\core

DrupalDirectoryCommands — Class in namespace Drush\Commands\core

JsonapiGetCommand::doExecute() — Method in class JsonapiGetCommand

LanguageInfoCommand::doExecute() — Method in class LanguageInfoCommand

PhpEvalCommand::doExecute() — Method in class PhpEvalCommand

PhpScriptCommand::doExecute() — Method in class PhpScriptCommand

RequirementsCommand::doExecute() — Method in class RequirementsCommand

RouteCommand::doExecute() — Method in class RouteCommand

SiteAliasCommand::doExecute() — Method in class SiteAliasCommand

SiteInstallCommand::doExecute() — Method in class SiteInstallCommand

SiteInstallCommand::determineRecipeOrProfile() — Method in class SiteInstallCommand

Determine if the passed parameter is a recipe directory, or a profile name.

SiteInstallCommand::determineProfile() — Method in class SiteInstallCommand

StatusCommand::doExecute() — Method in class StatusCommand

TwigUnusedCommand::doExecute() — Method in class TwigUnusedCommand

VersionCommand::doExecute() — Method in class VersionCommand

DeployCommand — Class in namespace Drush\Commands\deploy

DeployHookBatchProcessCommand — Class in namespace Drush\Commands\deploy

DeployHookBatchProcessCommand::doExecute() — Method in class DeployHookBatchProcessCommand

DeployHookCommand — Class in namespace Drush\Commands\deploy

DeployHookMarkCompleteCommand — Class in namespace Drush\Commands\deploy

DeployHookStatusCommand — Class in namespace Drush\Commands\deploy

DeployHookStatusCommand::doExecute() — Method in class DeployHookStatusCommand

DeployTrait — Class in namespace Drush\Commands\deploy

EntityDeleteCommand::doDelete() — Method in class EntityDeleteCommand

Actual delete method.

EntitySaveCommand::doSave() — Method in class EntitySaveCommand

Actual save method.

FieldBaseInfoCommand::doExecute() — Method in class FieldBaseInfoCommand

FieldDeleteCommand::deleteFieldConfig() — Method in class FieldDeleteCommand

FieldFormattersCommand::doExecute() — Method in class FieldFormattersCommand

FieldInfoCommand::doExecute() — Method in class FieldInfoCommand

FieldTypesCommand::doExecute() — Method in class FieldTypesCommand

FieldWidgetsCommand::doExecute() — Method in class FieldWidgetsCommand

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

HelpCommand::doExecute() — Method in class HelpCommand

MigrateFieldsSourceCommand::doExecute() — Method in class MigrateFieldsSourceCommand

MigrateMessagesCommand::doExecute() — Method in class MigrateMessagesCommand

MigrateStatusCommand::doExecute() — Method in class MigrateStatusCommand

PmListCommand::doExecute() — Method in class PmListCommand

QueueListCommand::doExecute() — Method in class QueueListCommand

RoleListCommand::doExecute() — Method in class RoleListCommand

SqlConfCommand::doExecute() — Method in class SqlConfCommand

SqlDumpCommand::doExecute() — Method in class SqlDumpCommand

SqlSyncCommand::databaseName() — Method in class SqlSyncCommand

SqlSyncCommand::dump() — Method in class SqlSyncCommand

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

StateGetCommand::doExecute() — Method in class StateGetCommand

UpdateDbBatchProcessCommand::doExecute() — Method in class UpdateDbBatchProcessCommand

UpdateDbStatusCommand::doExecute() — Method in class UpdateDbStatusCommand

UserCreateCommand::doExecute() — Method in class UserCreateCommand

UserInformationCommand::doExecute() — Method in class UserInformationCommand

ViewsListCommand::doExecute() — Method in class ViewsListCommand

WatchdogListCommand::doExecute() — Method in class WatchdogListCommand

WatchdogShowCommand::doExecute() — Method in class WatchdogShowCommand

WatchdogShowOneCommand::doExecute() — Method in class WatchdogShowOneCommand

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.

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.

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

DrupliconListener — Class in namespace Drush\Listeners

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 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 extend DrushCommands and are named properly.

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::discoverListeners() — Method in class ServiceManager

Discovers Listener classes from a provided search path.

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

DrushStyle — Class in namespace Drush\Style

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

$ AnnotatedCommand#examples — Property in class AnnotatedCommand

AnnotatedCommand::execute() — Method in class AnnotatedCommand

{@inheritdoc}

$ CommandError#exitCode — Property in class CommandError

$ CommandFileDiscovery#excludeList — Property in class CommandFileDiscovery

$ CommandResult#exitCode — Property in class CommandResult

CommandResult::exitCode() — Method in class CommandResult

ExitCodeInterface — Class in namespace Consolidation\AnnotatedCommand

If an annotated command method encounters an error, then it should either throw an exception, or return a result object that implements ExitCodeInterface.

ExtracterHookDispatcher — Class in namespace Consolidation\AnnotatedCommand\Hooks\Dispatchers

Call hooks

ExtracterHookDispatcher::extractOutput() — Method in class ExtracterHookDispatcher

Convert the result object to printable output in structured form.

ExtractOutputInterface — Class in namespace Consolidation\AnnotatedCommand\Hooks

Extract Output hooks are used to select the particular data elements of the result that should be printed as the command output -- perhaps after being formatted.

ExtractOutputInterface::extractOutput() — Method in class ExtractOutputInterface

PrepareTerminalWidthOption::enableWrap() — Method in class PrepareTerminalWidthOption

$ CommandInfo#exampleUsage — Property in class CommandInfo

DefaultsWithDescriptions::exists() — Method in class DefaultsWithDescriptions

Check to see whether the speicifed key exists in the collection.

MetadataHolderInterface::extractData() — Method in class MetadataHolderInterface

MetadataHolderInterface::extractMetadata() — Method in class MetadataHolderInterface

MetadataHolderTrait::extractData() — Method in class MetadataHolderTrait

MetadataHolderTrait::extractMetadata() — Method in class MetadataHolderTrait

$ XmlSchema#elementList — Property in class XmlSchema

DomToArraySimplifier::elementToArray() — Method in class DomToArraySimplifier

Recursively convert the provided DOM element into a php array.

$ WordWrapper#extraPaddingAtBeginningOfLine — Property in class WordWrapper

$ WordWrapper#extraPaddingAtEndOfLine — Property in class WordWrapper

ColumnWidths::enforceMinimums() — Method in class ColumnWidths

Ensure that every item in $widths that has a corresponding entry in $minimumWidths is as least as large as the minimum value held there.

SiteAlias::exportConfig() — Method in class SiteAlias

SiteAliasFileDiscovery::extractKey() — Method in class SiteAliasFileDiscovery

SiteAliasInterface::exportConfig() — Method in class SiteAliasInterface

Export the configuration values in this alias record, and reconfigure them so that the layout matches that of the global configuration object.

$ SiteAliasName#env — Property in class SiteAliasName

SiteAliasName::env() — Method in class SiteAliasName

Return the 'env' portion of the alias name.

SiteAliasWithConfig::export() — Method in class SiteAliasWithConfig

Export all configuration as a nested array.

SiteAliasWithConfig::exportConfig() — Method in class SiteAliasWithConfig

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 Drupal root, or when no root is specified.

RemoteCommandProxy::execute() — Method in class RemoteCommandProxy

IoTrait::ensureIo() — Method in class IoTrait

CacheClearCommand::execute() — Method in class CacheClearCommand

CacheGetCommand::execute() — Method in class CacheGetCommand

CacheRebuildCommand::execute() — Method in class CacheRebuildCommand

CacheSetCommand::execute() — Method in class CacheSetCommand

CacheTagsCommand::execute() — Method in class CacheTagsCommand

CacheWarmCommand::execute() — Method in class CacheWarmCommand

ConfigDeleteCommand::execute() — Method in class ConfigDeleteCommand

ConfigEditCommand::execute() — Method in class ConfigEditCommand

ConfigExportCommand::execute() — Method in class ConfigExportCommand

ConfigGetCommand::execute() — Method in class ConfigGetCommand

ConfigImportCommand::execute() — Method in class ConfigImportCommand

ConfigPullCommand::execute() — Method in class ConfigPullCommand

ConfigSetCommand::execute() — Method in class ConfigSetCommand

ConfigStatusCommand::execute() — Method in class ConfigStatusCommand

ArchiveDumpCommand::execute() — Method in class ArchiveDumpCommand

BatchCommand::execute() — Method in class BatchCommand

BrowseCommand::execute() — Method in class BrowseCommand

CliCommand::execute() — Method in class CliCommand

CoreGlobalOptionsCommand::execute() — Method in class CoreGlobalOptionsCommand

CronCommand::execute() — Method in class CronCommand

DrupalDirectoryCommand::execute() — Method in class DrupalDirectoryCommand

EditCommand — Class in namespace Drush\Commands\core

EditCommand::execute() — Method in class EditCommand

EditCommands — Class in namespace Drush\Commands\core

EntityCommands — Class in namespace Drush\Commands\core

ImageDeriveCommand::execute() — Method in class ImageDeriveCommand

ImageFlushCommand::execute() — Method in class ImageFlushCommand

JsonapiGetCommand::execute() — Method in class JsonapiGetCommand

LanguageAddCommand::execute() — Method in class LanguageAddCommand

LanguageInfoCommand::execute() — Method in class LanguageInfoCommand

MkCommands::execute() — Method in class MkCommands

PhpEvalCommand::execute() — Method in class PhpEvalCommand

PhpScriptCommand::execute() — Method in class PhpScriptCommand

RequirementsCommand::execute() — Method in class RequirementsCommand

RouteCommand::execute() — Method in class RouteCommand

RsyncCommand::execute() — Method in class RsyncCommand

RunserverCommand::execute() — Method in class RunserverCommand

SiteAliasCommand::execute() — Method in class SiteAliasCommand

SiteInstallCommand::execute() — Method in class SiteInstallCommand

SiteSetCommand::execute() — Method in class SiteSetCommand

SshCommand::execute() — Method in class SshCommand

StatusCommand::execute() — Method in class StatusCommand

ThemeDevCommand::execute() — Method in class ThemeDevCommand

TwigCompileCommand::execute() — Method in class TwigCompileCommand

TwigUnusedCommand::execute() — Method in class TwigUnusedCommand

VersionCommand::execute() — Method in class VersionCommand

WorkspacePublishCommand::execute() — Method in class WorkspacePublishCommand

DeployCommand::execute() — Method in class DeployCommand

DeployHookBatchProcessCommand::execute() — Method in class DeployHookBatchProcessCommand

DeployHookCommand::execute() — Method in class DeployHookCommand

DeployHookMarkCompleteCommand::execute() — Method in class DeployHookMarkCompleteCommand

DeployHookStatusCommand::execute() — Method in class DeployHookStatusCommand

EntityCreateCommand — Class in namespace Drush\Commands\entity

EntityCreateCommand::execute() — Method in class EntityCreateCommand

EntityDeleteCommand — Class in namespace Drush\Commands\entity

EntityDeleteCommand::execute() — Method in class EntityDeleteCommand

EntitySaveCommand — Class in namespace Drush\Commands\entity

EntitySaveCommand::execute() — Method in class EntitySaveCommand

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

FieldBaseInfoCommand::execute() — Method in class FieldBaseInfoCommand

FieldBaseOverrideCreateCommand::execute() — Method in class FieldBaseOverrideCreateCommand

FieldCreateCommand::execute() — Method in class FieldCreateCommand

FieldCreateCommand::ensureOption() — Method in class FieldCreateCommand

FieldDeleteCommand::execute() — Method in class FieldDeleteCommand

FieldFormattersCommand::execute() — Method in class FieldFormattersCommand

FieldInfoCommand::execute() — Method in class FieldInfoCommand

FieldTypesCommand::execute() — Method in class FieldTypesCommand

FieldWidgetsCommand::execute() — Method in class FieldWidgetsCommand

GenerateCommand::execute() — Method in class GenerateCommand

HelpCommand::execute() — Method in class HelpCommand

ListCommand::execute() — Method in class ListCommand

LocaleCheckCommand::execute() — Method in class LocaleCheckCommand

LocaleClearStatusCommand::execute() — Method in class LocaleClearStatusCommand

LocaleExportCommand::execute() — Method in class LocaleExportCommand

LocaleImportAllCommand::execute() — Method in class LocaleImportAllCommand

LocaleImportCommand::execute() — Method in class LocaleImportCommand

LocaleUpdateCommand::execute() — Method in class LocaleUpdateCommand

MaintGetCommand::execute() — Method in class MaintGetCommand

MaintSetCommand::execute() — Method in class MaintSetCommand

MaintStatusCommand::execute() — Method in class MaintStatusCommand

MigrateFieldsSourceCommand::execute() — Method in class MigrateFieldsSourceCommand

MigrateImportCommand::execute() — Method in class MigrateImportCommand

MigrateImportCommand::executeMigration() — Method in class MigrateImportCommand

Executes a single migration.

MigrateMessagesCommand::execute() — Method in class MigrateMessagesCommand

MigrateResetStatusCommand::execute() — Method in class MigrateResetStatusCommand

MigrateRollbackCommand::execute() — Method in class MigrateRollbackCommand

MigrateStatusCommand::execute() — Method in class MigrateStatusCommand

MigrateStopCommand::execute() — Method in class MigrateStopCommand

PmInstallCommand::execute() — Method in class PmInstallCommand

PmListCommand::execute() — Method in class PmListCommand

$ PmTrait#extensionListModule — Property in class PmTrait

$ PmTrait#extensionListTheme — Property in class PmTrait

PmTrait::extensionStatus() — Method in class PmTrait

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

PmUninstallCommand::execute() — Method in class PmUninstallCommand

ThemeInstallCommand::execute() — Method in class ThemeInstallCommand

ThemeUninstallCommand::execute() — Method in class ThemeUninstallCommand

QueueDeleteCommand::execute() — Method in class QueueDeleteCommand

QueueListCommand::execute() — Method in class QueueListCommand

QueueRunCommand::execute() — Method in class QueueRunCommand

RoleCreateCommand::execute() — Method in class RoleCreateCommand

RoleDeleteCommand::execute() — Method in class RoleDeleteCommand

RoleListCommand::execute() — Method in class RoleListCommand

RolePermAddCommand::execute() — Method in class RolePermAddCommand

RolePermRemoveCommand::execute() — Method in class RolePermRemoveCommand

SqlCliCommand::execute() — Method in class SqlCliCommand

SqlConfCommand::execute() — Method in class SqlConfCommand

SqlConnectCommand::execute() — Method in class SqlConnectCommand

SqlCreateCommand::execute() — Method in class SqlCreateCommand

SqlDropCommand::execute() — Method in class SqlDropCommand

SqlDumpCommand::execute() — Method in class SqlDumpCommand

SqlQueryCommand::execute() — Method in class SqlQueryCommand

SqlSyncCommand::execute() — Method in class SqlSyncCommand

SanitizeCommand::execute() — Method in class SanitizeCommand

StateDeleteCommand::execute() — Method in class StateDeleteCommand

StateGetCommand::execute() — Method in class StateGetCommand

StateSetCommand::execute() — Method in class StateSetCommand

UpdateDBCommand::execute() — Method in class UpdateDBCommand

UpdateDbBatchProcessCommand::execute() — Method in class UpdateDbBatchProcessCommand

UpdateDbStatusCommand::execute() — Method in class UpdateDbStatusCommand

UserBlockCommand::execute() — Method in class UserBlockCommand

UserCancelCommand::execute() — Method in class UserCancelCommand

UserCreateCommand::execute() — Method in class UserCreateCommand

UserInformationCommand::execute() — Method in class UserInformationCommand

UserLoginCommand::execute() — Method in class UserLoginCommand

UserPasswordCommand::execute() — Method in class UserPasswordCommand

UserRoleAddCommand::execute() — Method in class UserRoleAddCommand

UserRoleRemoveCommand::execute() — Method in class UserRoleRemoveCommand

UserUnblockCommand::execute() — Method in class UserUnblockCommand

ViewsDevCommand::execute() — Method in class ViewsDevCommand

ViewsDisableCommand::execute() — Method in class ViewsDisableCommand

ViewsEnableCommand::execute() — Method in class ViewsEnableCommand

ViewsExecuteCommand::execute() — Method in class ViewsExecuteCommand

ViewsListCommand::execute() — Method in class ViewsListCommand

WatchdogDeleteCommand::execute() — Method in class WatchdogDeleteCommand

WatchdogListCommand::execute() — Method in class WatchdogListCommand

WatchdogShowCommand::execute() — Method in class WatchdogShowCommand

WatchdogShowOneCommand::execute() — Method in class WatchdogShowOneCommand

WatchdogTailCommand::execute() — Method in class WatchdogTailCommand

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() — 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

AnnotatedCommandFactory::filterCommandInfoList() — Method in class AnnotatedCommandFactory

FieldLabels — Class in namespace Consolidation\AnnotatedCommand\Attributes

FilterDefaultField — Class in namespace Consolidation\AnnotatedCommand\Attributes

$ CommandData#formatterOptions — Property in class CommandData

CommandData::formatterOptions() — Method in class CommandData

$ CommandFileDiscovery#followLinks — Property in class CommandFileDiscovery

CommandFileDiscovery::followLinks() — Method in class CommandFileDiscovery

Specify that the discovery object should follow symlinks. By default, symlinks are not followed.

CommandFileDiscovery::fixNamespaces() — Method in class CommandFileDiscovery

fixNamespaces will alter the namespaces in the commandFiles result to remove the Composer placement directory, if any.

$ CommandProcessor#formatterManager — Property in class CommandProcessor

CommandProcessor::formatterManager() — Method in class CommandProcessor

Return the formatter manager

AlterOptionsCommandEvent::findAndAddHookOptions() — Method in class AlterOptionsCommandEvent

CommandInfo::findMatchingOption() — Method in class CommandInfo

An option might have a name such as 'silent|s'. In this instance, we will allow the @option or @default tag to reference the option only by name (e.g. 'silent' or 's' instead of 'silent|s').

CommandInfo::findOptionAmongAlternatives() — Method in class CommandInfo

CommandInfo::findExistingOption() — Method in class CommandInfo

$ AttributesDocBlockParser#fqcnCache — Property in class AttributesDocBlockParser

$ BespokeDocBlockParser#fqcnCache — Property in class BespokeDocBlockParser

BespokeDocBlockParser::findFullyQualifiedClass() — Method in class BespokeDocBlockParser

DefaultValueFromString::fromString() — Method in class DefaultValueFromString

FullyQualifiedClassCache — Class in namespace Consolidation\AnnotatedCommand\Parser\Internal

$ ResultWriter#formatterManager — Property in class ResultWriter

var FormatterManager

ResultWriter::formatterManager() — Method in class ResultWriter

Return the formatter manager

FormatterManager — Class in namespace Consolidation\OutputFormatters

Manage a collection of formatters; return one on request.

$ FormatterManager#formatters — Property in class FormatterManager

var FormatterInterface[]

FormatterAwareInterface — Class in namespace Consolidation\OutputFormatters\Formatters

FormatterAwareTrait — Class in namespace Consolidation\OutputFormatters\Formatters

$ FormatterAwareTrait#formatter — Property in class FormatterAwareTrait

FormatterInterface — Class in namespace Consolidation\OutputFormatters\Formatters

$ TableFormatter#fieldLabels — Property in class TableFormatter

FormatterOptions — Class in namespace Consolidation\OutputFormatters\Options

FormatterOptions holds information that affects the way a formatter renders its output.

FormatterOptions::fields() — Method in class FormatterOptions

Get the fields based on the selections made by the user and the available annotation data. The fields are reported as the user selected them, and therefore may be either the field machine name, or its corresponding human-readable label.

FormatterOptions::fieldsContain() — Method in class FormatterOptions

Returns 'true' iff the fields selected by the user (or the default fields, if none explicitly selected) contain the specified field name.

FormatterOptions::fieldAlias() — Method in class FormatterOptions

FormatterOptions::fetch() — Method in class FormatterOptions

Look up a key, and return its raw value.

FormatterOptions::fetchRawValues() — Method in class FormatterOptions

Look up all of the items associated with the provided defaults.

FieldProcessor — Class in namespace Consolidation\OutputFormatters\StructuredData

FieldProcessor will do various alterations on field sets.

NumericCellRenderer::formatCellData() — Method in class NumericCellRenderer

Format the cell data.

ColumnWidths::findShortColumns() — Method in class ColumnWidths

Find all of the columns that are shorter than the specified threshold.

ColumnWidths::findUndersizedColumns() — Method in class ColumnWidths

Find all of the columns that are shorter than the corresponding minimum widths.

ColumnWidths::findColumnsUnderThreshold() — Method in class ColumnWidths

HostPath::fullyQualifiedPath() — Method in class HostPath

Return the fully resolved path, e.g. user@server:/path/to/drupalroot/sites/default/files

HostPath::fullyQualifiedPathPreservingTrailingSlash() — Method in class HostPath

Our fully qualified path passes the result through Path::makeAbsolute() which canonicallizes the path, removing any trailing slashes.

SiteAliasFileDiscovery::filterByLocation() — Method in class SiteAliasFileDiscovery

Only search for aliases that are in alias files stored in directories whose basename or key matches the specified location.

SiteAliasFileDiscovery::find() — Method in class SiteAliasFileDiscovery

Find an alias file SITENAME.site.yml in one of the specified search locations.

SiteAliasFileDiscovery::findSingleSiteAliasFile() — Method in class SiteAliasFileDiscovery

Find an alias file SITENAME.site.yml in one of the specified search locations.

SiteAliasFileDiscovery::findAllSingleAliasFiles() — Method in class SiteAliasFileDiscovery

Return a list of all SITENAME.site.yml files in any of the search locations.

SiteAliasFileDiscovery::findAllLegacyAliasFiles() — Method in class SiteAliasFileDiscovery

Return all of the legacy alias files used in previous Drush versions.

SiteAliasFileLoader::findSelfSiteAliases() — Method in class SiteAliasFileLoader

Given an array of site aliases, find the first one that is local (has no 'host' item) and also contains a 'self.site.yml' file.

SiteAliasFileLoader::fetchSiteAliasFromSiteAliasData() — Method in class SiteAliasFileLoader

Given an array containing site alias data, return an alias record containing the data for the requested record. If there is a 'common' section, then merge that in as well.

SiteSpecParser::fixAndCheckUsability() — Method in class SiteSpecParser

Validate the provided result. If the result is local, then it must have a 'root'. If it does not, then fill in the root that was provided to us in our consturctor.

FsUtils — Class in namespace Consolidation\SiteAlias\Util

Application::find() — Method in class Application

FieldLabels — Class in namespace Drush\Attributes

FilterDefaultField — Class in namespace Drush\Attributes

Format — Class in namespace Drush\Attributes

Formatter — Class in namespace Drush\Attributes

This Attribute is designed to be used with Console style commands, not Annotated Commands.

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.

EditCommand::findBashrc() — Method in class EditCommand

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

FieldBaseInfoCommand — Class in namespace Drush\Commands\field

FieldBaseInfoCommands — Class in namespace Drush\Commands\field

FieldBaseOverrideCreateCommand — Class in namespace Drush\Commands\field

FieldBaseOverrideCreateCommands — Class in namespace Drush\Commands\field

FieldCreateCommand — Class in namespace Drush\Commands\field

Create a new field.

FieldCreateCommand::fieldExists() — Method in class FieldCreateCommand

FieldCreateCommand::fieldStorageExists() — Method in class FieldCreateCommand

FieldCreateCommands — Class in namespace Drush\Commands\field

FieldDefinitionCommands — Class in namespace Drush\Commands\field

FieldDefinitionRowsOfFieldsTrait — Class in namespace Drush\Commands\field

FieldDeleteCommand — Class in namespace Drush\Commands\field

Delete a field

FieldDeleteCommands — Class in namespace Drush\Commands\field

FieldFormattersCommand — Class in namespace Drush\Commands\field

FieldInfoCommand — Class in namespace Drush\Commands\field

FieldInfoCommands — Class in namespace Drush\Commands\field

FieldTypesCommand — Class in namespace Drush\Commands\field

FieldWidgetsCommand — 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

StateSetCommand::format() — Method in class StateSetCommand

Cast a value according to the provided format

WatchdogTrait::formatResult() — Method in class WatchdogTrait

Format a watchdog database row.

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.

FieldCreateEntityDisplayValuesEvent — Class in namespace Drush\Event

FieldCreateFieldConfigValuesEvent — Class in namespace Drush\Event

FieldCreateFieldStorageConfigValuesEvent — Class in namespace Drush\Event

FieldCreateInputOptionsEvent — Class in namespace Drush\Event

FormatterConfigurationItemProviderInterface — Class in namespace Drush\Formatters

FormatterTrait — Class in namespace Drush\Formatters

$ FormatterTrait#formatterOptions — Property in class FormatterTrait

FilterDefaultFieldListener — Class in namespace Drush\Listeners

FormatterListener — Class in namespace Drush\Listeners

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

List of discovered drush.service.yml files

LegacyServiceFinder::findDefaultServicesFile() — Method in class LegacyServiceFinder

Gets one discovered drush.service.yml file

LegacyServiceFinder::findModuleDrushServiceProviderFromComposer() — Method in class LegacyServiceFinder

Get Drush services section from module's composer.json file

LegacyServiceFinder::findAppropriateServicesFile() — Method in class LegacyServiceFinder

ServiceManager::filterListeners() — Method in class ServiceManager

SqlTableSelectionTrait::filterTables() — Method in class SqlTableSelectionTrait

Filters tables.

FsUtils — Class in namespace Drush\Utils

G

AnnotatedCommand::getReturnType() — Method in class AnnotatedCommand

AnnotatedCommand::getAnnotationData() — Method in class AnnotatedCommand

AnnotatedCommand::getTopics() — Method in class AnnotatedCommand

AnnotatedCommand::getExampleUsages() — Method in class AnnotatedCommand

AnnotatedCommand::getCompletionCallback() — Method in class AnnotatedCommand

AnnotatedCommand::getCommandArgumentMode() — Method in class AnnotatedCommand

AnnotatedCommand::getNames() — Method in class AnnotatedCommand

Returns all of the hook names that may be called for this command.

AnnotatedCommandFactory::getIncludeAllPublicMethods() — Method in class AnnotatedCommandFactory

AnnotatedCommandFactory::getCommandInfoListFromClass() — Method in class AnnotatedCommandFactory

AnnotatedCommandFactory::getCommandInfoListFromCache() — Method in class AnnotatedCommandFactory

Get the command info list from the cache

AnnotatedCommandFactory::getDataStore() — Method in class AnnotatedCommandFactory

Get the data store attached to this factory.

AnnotatedCommandFactory::getNthWord() — Method in class AnnotatedCommandFactory

AnnotationData::get() — Method in class AnnotationData

AnnotationData::getList() — Method in class AnnotationData

CacheWrapper::get() — Method in class CacheWrapper

Get an entry from the cache

NullCache::get() — Method in class NullCache

Get an entry from the cache

SimpleCacheInterface::get() — Method in class SimpleCacheInterface

Get an entry from the cache

CommandData::getAdjustedOptions() — Method in class CommandData

Use 'hasParameterOption()' to attempt to disambiguate option states.

CommandData::getArgsWithoutAppName() — Method in class CommandData

CommandData::getArgsAndOptions() — Method in class CommandData

CommandError::getExitCode() — Method in class CommandError

CommandError::getOutputData() — Method in class CommandError

CommandFileDiscovery::getSearchDepth() — Method in class CommandFileDiscovery

Return a Finder search depth appropriate for our selected search depth.

CommandFileDiscovery::getBaseDirectorySearchDepth() — Method in class CommandFileDiscovery

Return a Finder search depth for the base directory. If the searchLocations array has been populated, then we will only search for files immediately inside the base directory; no traversal into deeper directories will be done, as that would conflict with the specification provided by the search locations. If there is no search location, then we will search to whatever depth was specified by the client.

CommandResult::getExitCode() — Method in class CommandResult

CommandResult::getOutputData() — Method in class CommandResult

CustomEventAwareInterface::getCustomEventHandlers() — Method in class CustomEventAwareInterface

Get all of the defined event handlers of the specified name.

CustomEventAwareTrait::getCustomEventHandlers() — Method in class CustomEventAwareTrait

{@inheritdoc}

ExitCodeInterface::getExitCode() — Method in class ExitCodeInterface

HelpCommand::getApplication() — Method in class HelpCommand

HelpCommand::getHelpDocument() — Method in class HelpCommand

Create a help document.

HelpDocument::getDomData() — Method in class HelpDocument

Convert data into a \DomDocument.

HelpDocument::generateBaseHelpDom() — Method in class HelpDocument

Create the base help DOM prior to alteration by the Command object.

HelpDocumentBuilder::getSingleElementByTagName() — Method in class HelpDocumentBuilder

HookDispatcher::getHooks() — Method in class HookDispatcher

OptionsHookDispatcher::getOptions() — Method in class OptionsHookDispatcher

ReplaceCommandHookDispatcher::getReplaceCommandHooks() — Method in class ReplaceCommandHookDispatcher

ReplaceCommandHookDispatcher::getReplacementCommand() — Method in class ReplaceCommandHookDispatcher

HookManager::getAllHooks() — Method in class HookManager

HookManager::getNames() — Method in class HookManager

HookManager::getNamesUsingCommands() — Method in class HookManager

HookManager::getClassNameFromCallback() — Method in class HookManager

If a command hook does not specify any particular command name that it should be attached to, then it will be applied to every command that is defined in the same class as the hook.

HookManager::getHookOptionsForCommand() — Method in class HookManager

HookManager::getHookOptions() — Method in class HookManager

HookManager::getHooks() — Method in class HookManager

Get a set of hooks with the provided name(s). Include the pre- and post- hooks, and also include the global hooks ('*') in addition to the named hooks provided.

HookManager::get() — Method in class HookManager

Get a set of hooks with the provided name(s).

HookManager::getHook() — Method in class HookManager

Get a single named hook.

HookManager::getSubscribedEvents() — Method in class HookManager

OptionHookInterface::getOptions() — Method in class OptionHookInterface

StdinHandler::getStream() — Method in class StdinHandler

getStream opens and returns the stdin stream (or redirect file).

StdinHandler::getOptionOrArg() — Method in class StdinHandler

AlterOptionsCommandEvent::getSubscribedEvents() — Method in class AlterOptionsCommandEvent

PrepareTerminalWidthOption::getTerminal() — Method in class PrepareTerminalWidthOption

PrepareTerminalWidthOption::getTerminalWidth() — Method in class PrepareTerminalWidthOption

PrepareTerminalWidthOption::getTerminalWidthViaApplication() — Method in class PrepareTerminalWidthOption

PrepareTerminalWidthOption::getMaxWidth() — Method in class PrepareTerminalWidthOption

PrepareTerminalWidthOption::getMinWidth() — Method in class PrepareTerminalWidthOption

OutputDataInterface::getOutputData() — Method in class OutputDataInterface

ParameterInjection::getInstanceToInject() — Method in class ParameterInjection

ParameterInjection::get() — Method in class ParameterInjection

ParameterInjector::get() — Method in class ParameterInjector

CommandInfo::getMethodName() — Method in class CommandInfo

Recover the method name provided to the constructor.

CommandInfo::getName() — Method in class CommandInfo

Return the primary name for this command.

CommandInfo::getParameterMap() — Method in class CommandInfo

CommandInfo::getReturnType() — Method in class CommandInfo

CommandInfo::getInjectedClasses() — Method in class CommandInfo

CommandInfo::getRawAnnotations() — Method in class CommandInfo

Get any annotations included in the docblock comment for the implementation method of this command that are not already handled by the primary methods of this class.

CommandInfo::getAnnotations() — Method in class CommandInfo

Get any annotations included in the docblock comment, also including default values such as @command. We add in the default @command annotation late, and only in a copy of the annotation data because we use the existance of a @command to indicate that this CommandInfo is a command, and not a hook or anything else.

CommandInfo::getAnnotationList() — Method in class CommandInfo

Return a specific named annotation for this command as a list.

CommandInfo::getAnnotation() — Method in class CommandInfo

Return a specific named annotation for this command as a string.

CommandInfo::getDescription() — Method in class CommandInfo

Get the synopsis of the command (~first line).

CommandInfo::getHelp() — Method in class CommandInfo

Get the help text of the command (the description)

CommandInfo::getAliases() — Method in class CommandInfo

Return the list of aliases for this command.

CommandInfo::getHidden() — Method in class CommandInfo

Get hidden status for the command.

CommandInfo::getExampleUsages() — Method in class CommandInfo

Return the examples for this command. This is @usage instead of

CommandInfo::getTopics() — Method in class CommandInfo

Return the topics for this command.

CommandInfo::getParameters() — Method in class CommandInfo

Return the list of refleaction parameters.

DefaultsWithDescriptions::getValues() — Method in class DefaultsWithDescriptions

Return just the key : default values mapping

DefaultsWithDescriptions::get() — Method in class DefaultsWithDescriptions

Get the value of one entry.

DefaultsWithDescriptions::getDescription() — Method in class DefaultsWithDescriptions

Get the description of one entry.

DefaultsWithDescriptions::getSuggestedValues() — Method in class DefaultsWithDescriptions

Get the suggested values for an item.

DocblockTag::getTag() — Method in class DocblockTag

Return the tag - e.g. "@foo description" returns 'foo'

DocblockTag::getContent() — Method in class DocblockTag

Return the content portion of the tag - e.g. "@foo bar baz boz" returns "bar baz boz"

TagFactory::getTags() — Method in class TagFactory

ResultWriter::getFormat() — Method in class ResultWriter

Determine the formatter that should be used to render output.

FormatterManager::getFormatter() — Method in class FormatterManager

Fetch the requested formatter.

CsvFormatter::getDefaultFormatterOptions() — Method in class CsvFormatter

Return default values for formatter options

FormatterAwareInterface::getFormatter() — Method in class FormatterAwareInterface

FormatterAwareTrait::getFormatter() — Method in class FormatterAwareTrait

TsvFormatter::getDefaultFormatterOptions() — Method in class TsvFormatter

Return default values for formatter options

FormatterOptions::get() — Method in class FormatterOptions

Get a formatter option

FormatterOptions::getXmlSchema() — Method in class FormatterOptions

Return the XmlSchema to use with --format=xml for data types that support that. This is used when an array needs to be converted into xml.

FormatterOptions::getFormat() — Method in class FormatterOptions

Determine the format that was requested by the caller.

FormatterOptions::getOptionFormat() — Method in class FormatterOptions

Given a specific key, return the class method name of the parsing method for data stored under this key.

FormatterOptions::getConfigurationData() — Method in class FormatterOptions

Return a reference to the configuration data for this object.

FormatterOptions::getOptions() — Method in class FormatterOptions

Return a reference to the user-specified options for this request.

FormatterOptions::getInputOptions() — Method in class FormatterOptions

Return all of the options from the provided $defaults array that exist in our InputInterface object.

AbstractListData::getListData() — Method in class AbstractListData

Convert data to a format suitable for use in a list.

AbstractListData::getReorderedFieldLabels() — Method in class AbstractListData

AbstractListData::getFields() — Method in class AbstractListData

HelpDocument::getDomData() — Method in class HelpDocument

Convert data into a \DomDocument.

ListDataInterface::getListData() — Method in class ListDataInterface

Convert data to a format suitable for use in a list.

MetadataHolderInterface::getDataKey() — Method in class MetadataHolderInterface

MetadataHolderInterface::getMetadataKey() — Method in class MetadataHolderInterface

MetadataHolderTrait::getDataKey() — Method in class MetadataHolderTrait

MetadataHolderTrait::getMetadataKey() — Method in class MetadataHolderTrait

MetadataInterface::getMetadata() — Method in class MetadataInterface

Return the metadata associated with the structured data (if any)

OriginalDataInterface::getOriginalData() — Method in class OriginalDataInterface

Return the original data for this table. Used by any formatter that expects an array.

PropertyList::getListData() — Method in class PropertyList

Convert data to a format suitable for use in a list.

RowsOfFields::getListData() — Method in class RowsOfFields

Convert data to a format suitable for use in a list.

RowsOfFieldsWithMetadata::getMetadata() — Method in class RowsOfFieldsWithMetadata

Return the metadata associated with the structured data (if any)

TableDataInterface::getTableData() — Method in class TableDataInterface

Convert structured data into a form suitable for use by the table formatter.

DomDataInterface::getDomData() — Method in class DomDataInterface

Convert data into a \DomDocument.

XmlSchema::getTopLevelElementName() — Method in class XmlSchema

XmlSchema::getDefaultElementName() — Method in class XmlSchema

DomToArraySimplifier::getNodeAttributes() — Method in class DomToArraySimplifier

Get all of the attributes of the provided element.

DomToArraySimplifier::getNodeChildren() — Method in class DomToArraySimplifier

Get all of the children of the provided element, with simplification.

DomToArraySimplifier::getNodeChildrenData() — Method in class DomToArraySimplifier

Get the data from the children of the provided node in preliminary form.

DomToArraySimplifier::getUniformChildren() — Method in class DomToArraySimplifier

Convert the children of the provided DOM element into an array.

DomToArraySimplifier::getIdOfValue() — Method in class DomToArraySimplifier

If the object has an 'id' or 'name' element, then use that as the array key when storing this value in its parent.

DomToArraySimplifier::getUniqueChildren() — Method in class DomToArraySimplifier

Convert the children of the provided DOM element into an array.

PropertyListTableTransformation::getOriginalData() — Method in class PropertyListTableTransformation

Return the original data for this table. Used by any formatter that expects an array.

ReorderFields::getSelectedFieldKeys() — Method in class ReorderFields

TableTransformation::getLayout() — Method in class TableTransformation

TableTransformation::getHeaders() — Method in class TableTransformation

TableTransformation::getHeader() — Method in class TableTransformation

TableTransformation::getRowLabels() — Method in class TableTransformation

TableTransformation::getRowLabel() — Method in class TableTransformation

TableTransformation::getOriginalData() — Method in class TableTransformation

Return the original data for this table. Used by any formatter that expects an array.

TableTransformation::getTableData() — Method in class TableTransformation

Convert structured data into a form suitable for use by the table formatter.

TableTransformation::getRowDataWithKey() — Method in class TableTransformation

UnstructuredDataFieldAccessor::get() — Method in class UnstructuredDataFieldAccessor

CalculateWidths::getShortColumns() — Method in class CalculateWidths

Return all of the columns whose longest line length is less than or equal to the average width.

HostPath::getSiteAlias() — Method in class HostPath

Return the alias record portion of the host path.

HostPath::getAliasRecord() — Method in class HostPath

HostPath::getOriginalPath() — Method in class HostPath

Return just the path portion, without considering the alias root.

HostPath::getOriginal() — Method in class HostPath

Return the original host path string, as provided to the create() method.

HostPath::getPath() — Method in class HostPath

Return just the path portion of the host path

HostPath::getPathAlias() — Method in class HostPath

Return just the path alias portion of the path (e.g. '%files'), or empty if there is no alias in the path.

HostPath::getHost() — Method in class HostPath

Return the host portion of the host path, including the user.

SiteAlias::getParameterSpecificOptions() — Method in class SiteAlias

Fetch the parameter-specific options from the 'alias-parameters' section of the alias.

SiteAliasFileLoader::getLoader() — Method in class SiteAliasFileLoader

SiteAliasFileLoader::getRequestedEnvData() — Method in class SiteAliasFileLoader

getRequestedEnvData fetches the data for the specified environment from the provided site record data.

SiteAliasFileLoader::getEnvironmentName() — Method in class SiteAliasFileLoader

Return the name of the environment requested.

SiteAliasFileLoader::getDefaultEnvironmentName() — Method in class SiteAliasFileLoader

Given a data array containing site alias environments, determine which envirionmnet should be used as the default environment.

SiteAliasManager::get() — Method in class SiteAliasManager

Get an alias record by name, or convert a site specification into an alias record via the site alias spec parser. If a simple alias name is provided (e.g. '@alias'), it is interpreted as a sitename, and the default environment for that site is returned.

SiteAliasManager::getSelf() — Method in class SiteAliasManager

Get the '@self' alias record.

SiteAliasManager::getAlias() — Method in class SiteAliasManager

Get an alias record from a name. Does not accept site specifications.

SiteAliasManager::getMultiple() — Method in class SiteAliasManager

Given a simple alias name, e.g. '@alias', returns all of the environments in the specified site.

SiteAliasManagerInterface::get() — Method in class SiteAliasManagerInterface

Get an alias record by name, or convert a site specification into an alias record via the site alias spec parser. If a simple alias name is provided (e.g. '@alias'), it is interpreted as a sitename, and the default environment for that site is returned.

SiteAliasManagerInterface::getSelf() — Method in class SiteAliasManagerInterface

Get the '@self' alias record.

SiteAliasManagerInterface::getAlias() — Method in class SiteAliasManagerInterface

Get an alias record from a name. Does not accept site specifications.

SiteAliasManagerInterface::getMultiple() — Method in class SiteAliasManagerInterface

Given a simple alias name, e.g. '@alias', returns all of the environments in the specified site.

SiteAliasWithConfig::get() — Method in class SiteAliasWithConfig

SiteAliasWithConfig::getDefault() — Method in class SiteAliasWithConfig

SiteSpecParser::getMultisiteDirectoryRoot() — Method in class SiteSpecParser

Application::getUri() — Method in class Application

Return the framework uri selected by the user.

DefaultFields::getConfigurationItem() — Method in class DefaultFields

DefaultTableFields::getConfigurationItem() — Method in class DefaultTableFields

FieldLabels::getConfigurationItem() — Method in class FieldLabels

TableFormat::getConfigurationItem() — Method in class TableFormat

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.

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.

CacheClearCommand::getTypes() — Method in class CacheClearCommand

Types of caches available for clearing. Listeners can add their own.

ConfigCommands::getConfigFactory() — Method in class ConfigCommands

ConfigTrait::getStorage() — Method in class ConfigTrait

Get storage corresponding to a configuration directory.

ConfigTrait::getDirectory() — Method in class ConfigTrait

Determine which configuration directory to use and return directory path.

ConfigTrait::getDiff() — Method in class ConfigTrait

Get diff between two config sets.

DocsCommands::generators() — Method in class DocsCommands

Instructions on creating your own Drush Generators.

DrupalDirectoryCommand::getPath() — Method in class DrupalDirectoryCommand

Given a target (e.g.

MkCommands::getVersion() — Method in class MkCommands

MkCommands::getRedirectMap() — Method in class MkCommands

MkCommands::getFilename() — Method in class MkCommands

Get a filename from a command.

SiteInstallCommand::getLoginLinks() — Method in class SiteInstallCommand

SiteInstallCommand::getSitesSubdirFromUri() — Method in class SiteInstallCommand

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

StatusCommand::getPropertyList() — Method in class StatusCommand

TopicCommands::getAllTopics() — Method in class TopicCommands

Retrieve all defined topics

DeployTrait::getRegistry() — Method in class DeployTrait

Get the deploy hook update registry.

EntityDeleteCommand::getQuery() — Method in class EntityDeleteCommand

EntitySaveCommand::getQuery() — Method in class EntitySaveCommand

EntityTypeBundleAskTrait::getFieldableEntityTypes() — Method in class EntityTypeBundleAskTrait

FieldBaseOverrideCreateCommand::getBaseFieldDefinition() — Method in class FieldBaseOverrideCreateCommand

FieldCreateCommand::getEntityDisplay() — Method in class FieldCreateCommand

FieldCreateCommand::generateFieldName() — Method in class FieldCreateCommand

FieldCreateCommand::getExistingFieldStorageOptions() — Method in class FieldCreateCommand

FieldCreateCommand::getExistingFieldForDefaults() — Method in class FieldCreateCommand

FieldCreateCommand::getExistingEntityDisplayForDefaults() — Method in class FieldCreateCommand

FieldCreateCommand::getExistingBundleForDefaults() — Method in class FieldCreateCommand

FieldDefinitionRowsOfFieldsTrait::getRowsOfFieldsByFieldDefinitions() — Method in class FieldDefinitionRowsOfFieldsTrait

FieldDeleteCommand::getFieldConfigs() — Method in class FieldDeleteCommand

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

GenerateCommand — Class in namespace Drush\Commands\generate

GenerateCommands — Class in namespace Drush\Commands\generate

DrushAliasFile::generate() — Method in class DrushAliasFile

{@inheritdoc}

DrushCommandFile::generate() — Method in class DrushCommandFile

DrushGeneratorFile::generate() — Method in class DrushGeneratorFile

DrushHelpDocument::generateBaseHelpDom() — Method in class DrushHelpDocument

ListCommand::getTerminalWidth() — Method in class ListCommand

MigrateRunnerTrait::getMigrationSourceRowsCount() — Method in class MigrateRunnerTrait

Returns the migration source rows count.

MigrateRunnerTrait::getMigrationNeedingUpdateCount() — Method in class MigrateRunnerTrait

Returns the number of items that needs update.

MigrateRunnerTrait::getMigrationUnprocessedCount() — Method in class MigrateRunnerTrait

Returns the number of unprocessed items.

MigrateRunnerTrait::getMigrationImportedCount() — Method in class MigrateRunnerTrait

Returns the number of imported items.

MigrateRunnerTrait::getMigrationLastImportedTime() — Method in class MigrateRunnerTrait

Returns the last imported date/time if any.

MigrateRunnerTrait::getMigrationList() — Method in class MigrateRunnerTrait

Retrieves a list of active migrations.

MigrateRunnerTrait::getMigrateMessage() — Method in class MigrateRunnerTrait

Returns the migrate message logger.

MigrateRunnerTrait::getSourceIdKeys() — Method in class MigrateRunnerTrait

Get the source ID keys.

PmTrait::getModuleLinks() — Method in class PmTrait

QueueTrait::getQueues() — Method in class QueueTrait

UpdateDBCommand::getUpdateList() — Method in class UpdateDBCommand

UpdateDbStatusCommand::getUpdatedbStatus() — Method in class UpdateDbStatusCommand

Returns information about available module updates.

UserTrait::getAccounts() — Method in class UserTrait

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.

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.

CacheClearEvent::getTypes() — Method in class CacheClearEvent

ConsoleDefinitionsEvent::getApplication() — Method in class ConsoleDefinitionsEvent

FieldCreateEntityDisplayValuesEvent::getValues() — Method in class FieldCreateEntityDisplayValuesEvent

FieldCreateEntityDisplayValuesEvent::getInput() — Method in class FieldCreateEntityDisplayValuesEvent

FieldCreateEntityDisplayValuesEvent::getOutput() — Method in class FieldCreateEntityDisplayValuesEvent

FieldCreateFieldConfigValuesEvent::getValues() — Method in class FieldCreateFieldConfigValuesEvent

FieldCreateFieldConfigValuesEvent::getInput() — Method in class FieldCreateFieldConfigValuesEvent

FieldCreateFieldConfigValuesEvent::getOutput() — Method in class FieldCreateFieldConfigValuesEvent

FieldCreateFieldStorageConfigValuesEvent::getValues() — Method in class FieldCreateFieldStorageConfigValuesEvent

FieldCreateFieldStorageConfigValuesEvent::getInput() — Method in class FieldCreateFieldStorageConfigValuesEvent

FieldCreateFieldStorageConfigValuesEvent::getOutput() — Method in class FieldCreateFieldStorageConfigValuesEvent

FieldCreateInputOptionsEvent::getInput() — Method in class FieldCreateInputOptionsEvent

FieldCreateInputOptionsEvent::getOutput() — Method in class FieldCreateInputOptionsEvent

SanitizeConfirmsEvent::getInput() — Method in class SanitizeConfirmsEvent

SanitizeConfirmsEvent::getMessages() — Method in class SanitizeConfirmsEvent

ExecTrait::getEditor() — Method in class ExecTrait

FormatterConfigurationItemProviderInterface::getConfigurationItem() — Method in class FormatterConfigurationItemProviderInterface

FormatterTrait::getFormatterOptions() — Method in class FormatterTrait

FormatterTrait::getPrivatePropValue() — Method in class FormatterTrait

CreateEntityReferenceFieldListener::getTargetType() — Method in class CreateEntityReferenceFieldListener

CreateEntityReferenceFieldListener::getTargetBundles() — Method in class CreateEntityReferenceFieldListener

CreateEntityReferenceFieldListener::getExistingFieldForDefaults() — Method in class CreateEntityReferenceFieldListener

CreateEntityReferenceFieldListener::getExistingBundleForDefaults() — Method in class CreateEntityReferenceFieldListener

FormatterListener::getConfigurationData() — Method in class FormatterListener

Build the formatter configuration from the command's attributes

FormatterListener::getPrivatePropValue() — Method in class FormatterListener

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

RelativeNamespaceDiscovery::getClasses() — Method in class RelativeNamespaceDiscovery

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

Return path to the backup directory.

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

AnnotatedCommand::helpAlter() — Method in class AnnotatedCommand

AnnotatedCommandFactory::hookManager() — Method in class AnnotatedCommandFactory

AnnotatedCommandFactory::hasDataStore() — Method in class AnnotatedCommandFactory

Check to see if this factory has a cache datastore.

AnnotationData::has() — Method in class AnnotationData

Argument::handle() — Method in class Argument

Command::handle() — Method in class Command

Complete::handle() — Method in class Complete

DefaultFields::handle() — Method in class DefaultFields

DefaultTableFields::handle() — Method in class DefaultTableFields

FieldLabels::handle() — Method in class FieldLabels

FilterDefaultField::handle() — Method in class FilterDefaultField

Help — Class in namespace Consolidation\AnnotatedCommand\Attributes

Help::handle() — Method in class Help

Hook — Class in namespace Consolidation\AnnotatedCommand\Attributes

Hook::handle() — Method in class Hook

HookSelector — Class in namespace Consolidation\AnnotatedCommand\Attributes

HookSelector::handle() — Method in class HookSelector

Misc::handle() — Method in class Misc

Option::handle() — Method in class Option

Topics::handle() — Method in class Topics

Usage::handle() — Method in class Usage

CacheWrapper::has() — Method in class CacheWrapper

Test for an entry from the cache

NullCache::has() — Method in class NullCache

Test for an entry from the cache

SimpleCacheInterface::has() — Method in class SimpleCacheInterface

Test for an entry from the cache

$ CommandProcessor#hookManager — Property in class CommandProcessor

CommandProcessor::hookManager() — Method in class CommandProcessor

Return the hook manager

CommandProcessor::handleResults() — Method in class CommandProcessor

Handle the result output and status code calculation.

$ CustomEventAwareTrait#hookManager — Property in class CustomEventAwareTrait

var HookManager

HelpCommand — Class in namespace Consolidation\AnnotatedCommand\Help

HelpCommand::help() — Method in class HelpCommand

Run the help command

HelpDocument — Class in namespace Consolidation\AnnotatedCommand\Help

HelpDocumentAlter — Class in namespace Consolidation\AnnotatedCommand\Help

HelpDocumentAlter::helpAlter() — Method in class HelpDocumentAlter

HelpDocumentBuilder — Class in namespace Consolidation\AnnotatedCommand\Help

HookDispatcher — Class in namespace Consolidation\AnnotatedCommand\Hooks\Dispatchers

Call hooks

$ HookDispatcher#hookManager — Property in class HookDispatcher

var HookManager

ReplaceCommandHookDispatcher::hasReplaceCommandHook() — Method in class ReplaceCommandHookDispatcher

HookManager — Class in namespace Consolidation\AnnotatedCommand\Hooks

Manage named callback hooks

$ HookManager#hooks — Property in class HookManager

$ HookManager#hookOptions — Property in class HookManager

var CommandInfo[]

StdinHandler::hasPath() — Method in class StdinHandler

hasPath returns 'true' if the stdin handler has a path to a file.

StdinHandler::hasStream() — Method in class StdinHandler

hasStream returns 'true' if the stdin handler has opened a stream.

$ CommandInfo#help — Property in class CommandInfo

CommandInfo::hasAnnotation() — Method in class CommandInfo

Check to see if the specified annotation exists for this command.

CommandInfo::hasHelp() — Method in class CommandInfo

Determine if help was provided for this command info

$ DefaultsWithDescriptions#hasDefault — Property in class DefaultsWithDescriptions

DefaultsWithDescriptions::hasDefault() — Method in class DefaultsWithDescriptions

Check to see if the named argument definitively has a default value.

DocblockTag::hasVariable() — Method in class DocblockTag

Determine if tag is one of:

• "@tag variable description"
• "@tag $variable description"
• "@tag type $variable description"

DocblockTag::hasVariableAndDescription() — Method in class DocblockTag

Determine if tag is "@tag $variable description"

DocblockTag::hasTypeVariableAndDescription() — Method in class DocblockTag

Determine if tag is "@tag type $variable description"

DocblockTag::hasWordAndDescription() — Method in class DocblockTag

Determine if tag is "@tag word description"

ResultWriter::handle() — Method in class ResultWriter

Handle the result output and status code calculation.

FormatterManager::hasFormatter() — Method in class FormatterManager

Test to see if the stipulated format exists

HumanReadableFormat — Class in namespace Consolidation\OutputFormatters\Formatters

Marker interface that indicates that a cell data renderer (Consolidation\OutputFormatters\SturcturedData\RenderCellInterface) may test for to determine whether it is allowable to add human-readable formatting into the cell data (Consolidation\OutputFormatters\SturcturedData\NumericCallRenderer).

FieldProcessor::hasUnstructuredFieldAccess() — Method in class FieldProcessor

Determine whether the data structure has unstructured field access, e.g. a.b.c or foo as bar.

HelpDocument — Class in namespace Consolidation\OutputFormatters\StructuredData

DomToArraySimplifier::hasUniformChildren() — Method in class DomToArraySimplifier

Determine whether the children of the provided element are uniform.

$ TableTransformation#headers — Property in class TableTransformation

HostPath — Class in namespace Consolidation\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.

HostPath::hasPathAlias() — Method in class HostPath

Returns 'true' if the path portion of the host path begins with a path alias (e.g. '%files'). Path aliases must appear at the beginning of the path.

SiteAliasInterface::hasRoot() — Method in class SiteAliasInterface

Determine whether this alias has a root.

SiteAliasInterface::hasRemoteUser() — Method in class SiteAliasInterface

Return true if this alias record has a remote user

SiteAliasManagerAwareInterface::hasSiteAliasManager() — Method in class SiteAliasManagerAwareInterface

SiteAliasManagerAwareTrait::hasSiteAliasManager() — Method in class SiteAliasManagerAwareTrait

SiteAliasName::hasSitename() — Method in class SiteAliasName

In general, all aliases have a sitename. The time when one will not is when an environment name @env is used as a shortcut for @self.env

SiteAliasName::hasEnv() — Method in class SiteAliasName

Return true if this alias name contains an 'env' portion.

SiteAliasName::hasLocation() — Method in class SiteAliasName

Return true if this alias name contains a 'location' portion

SiteAliasTrait::hasRoot() — Method in class SiteAliasTrait

SiteAliasTrait::hasRemoteUser() — Method in class SiteAliasTrait

SiteAliasWithConfig::has() — Method in class SiteAliasWithConfig

SiteAliasWithConfig::hasDefault() — Method in class SiteAliasWithConfig

Bootstrap::handle() — Method in class Bootstrap

Format::handle() — Method in class Format

HandleRemoteCommands — Class in namespace Drush\Attributes

Help — Class in namespace Drush\Attributes

HelpLinks — 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.

DocsCommands::hooks() — Method in class DocsCommands

Drush hooks.

FieldCreateCommand::hasContentTranslation() — Method in class FieldCreateCommand

HelpCLIFormatter — Class in namespace Drush\Commands\help

Format an array into CLI help string.

HelpCommand — Class in namespace Drush\Commands\help

SqlCliCommand::hasPipedInput() — Method in class SqlCliCommand

Test if there is input waiting on STDIN

DrushConfig::home() — Method in class DrushConfig

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.

CreateTextFieldListener::hasAllowedFormats() — Method in class CreateTextFieldListener

HelpLinksListener — Class in namespace Drush\Listeners

$ 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

$ AnnotatedCommand#injectedClasses — Property in class AnnotatedCommand

AnnotatedCommand::inputOptionSetDescription() — Method in class AnnotatedCommand

AnnotatedCommand::interact() — Method in class AnnotatedCommand

{@inheritdoc}

AnnotatedCommand::initialize() — Method in class AnnotatedCommand

AnnotatedCommand::injectIntoCommandfileInstance() — Method in class AnnotatedCommand

Inject $input and $output into the command instance if it is set up to receive them.

$ AnnotatedCommandFactory#ignoreCommandsInTraits — Property in class AnnotatedCommandFactory

var bool

$ AnnotatedCommandFactory#ignoreCommandsInParentClasses — Property in class AnnotatedCommandFactory

var bool

$ AnnotatedCommandFactory#includeAllPublicMethods — Property in class AnnotatedCommandFactory

var boolean

$ AnnotatedCommandFactory#ignoredCommandsRegexps — Property in class AnnotatedCommandFactory

var string[]

AnnotatedCommandFactory::isMethodRecognizedAsCommand() — Method in class AnnotatedCommandFactory

AnnotatedCommandFactory::isMethodRecognizedAsHook() — Method in class AnnotatedCommandFactory

AnnotatedCommandFactory::isCommandOrHookMethod() — Method in class AnnotatedCommandFactory

AnnotatedCommandFactory::isHookMethod() — Method in class AnnotatedCommandFactory

AnnotatedCommandFactory::isCommandMethod() — Method in class AnnotatedCommandFactory

$ CommandData#input — Property in class CommandData

var InputInterface

$ CommandData#includeOptionsInArgs — Property in class CommandData

var boolean

$ CommandData#injectedInstances — Property in class CommandData

CommandData::injectInstance() — Method in class CommandData

For internal use only; inject an instance to be passed back to the command callback as a parameter.

CommandData::injectedInstances() — Method in class CommandData

Provide a reference to the instances that will be added to the beginning of the parameter list when the command callback is invoked.

CommandData::input() — Method in class CommandData

$ CommandFileDiscovery#includeFilesAtBase — Property in class CommandFileDiscovery

CommandFileDiscovery::ignoreNamespacePart() — Method in class CommandFileDiscovery

Set a particular namespace part to ignore. This is useful in plugin mechanisms where the plugin is placed by Composer.

CommandProcessor::initializeHook() — Method in class CommandProcessor

CommandProcessor::interact() — Method in class CommandProcessor

CommandProcessor::injectIntoCommandData() — Method in class CommandProcessor

InitializeHookDispatcher — Class in namespace Consolidation\AnnotatedCommand\Hooks\Dispatchers

Call hooks

InitializeHookDispatcher::initialize() — Method in class InitializeHookDispatcher

InteractHookDispatcher — Class in namespace Consolidation\AnnotatedCommand\Hooks\Dispatchers

Call hooks

InteractHookDispatcher::interact() — Method in class InteractHookDispatcher

InitializeHookInterface — Class in namespace Consolidation\AnnotatedCommand\Hooks

Non-interactively (e.g. via configuration files) apply configuration values to the Input object.

InitializeHookInterface::initialize() — Method in class InitializeHookInterface

InteractorInterface — Class in namespace Consolidation\AnnotatedCommand\Hooks

Interactively supply values for missing required arguments for the current command. Note that this hook is not called if the --no-interaction flag is set.

InteractorInterface::interact() — Method in class InteractorInterface

$ ParameterInjection#injectors — Property in class ParameterInjection

ParameterInjection::injectIntoCommandData() — Method in class ParameterInjection

$ CommandInfo#inputOptions — Property in class CommandInfo

$ CommandInfo#injectedClasses — Property in class CommandInfo

CommandInfo::invalidate() — Method in class CommandInfo

If higher-level code decides that this CommandInfo is not interesting or useful (if it is not a command method or a hook method), then we will mark it as invalid to prevent it from being created as a command.

CommandInfo::inputOptions() — Method in class CommandInfo

Get the inputOptions for the options associated with this CommandInfo object, e.g. via @option annotations, or from $options = ['someoption' => 'defaultvalue'] in the command method parameter list.

CommandInfo::isAssoc() — Method in class CommandInfo

Helper; determine if an array is associative or not. An array is not associative if its keys are numeric, and numbered sequentially from zero. All other arrays are considered to be associative.

CommandInfoDeserializer::isValidSerializedData() — Method in class CommandInfoDeserializer

DefaultsWithDescriptions::isEmpty() — Method in class DefaultsWithDescriptions

Return true if this set of options is empty

BespokeDocBlockParser::ignoredParamType() — Method in class BespokeDocBlockParser

BespokeDocBlockParser::interpretDefaultValue() — Method in class BespokeDocBlockParser

DocblockTag::isTag() — Method in class DocblockTag

Check if the provided string begins with a tag

ResultWriter::interpretStatusCode() — Method in class ResultWriter

If a status code was set, then return it; otherwise, presume success.

StateHelper::injectIntoCallbackObject() — Method in class StateHelper

Inject $input and $output into the command instance if it is set up to receive them.

StateHelper::inject() — Method in class StateHelper

Inject $input and $output into the command instance if it is set up to receive them.

IncompatibleDataException — Class in namespace Consolidation\OutputFormatters\Exception

Represents an incompatibility between the output data and selected formatter.

InvalidFormatException — Class in namespace Consolidation\OutputFormatters\Exception

Represents an incompatibility between the output data and selected formatter.

FormatterManager::isValidFormat() — Method in class FormatterManager

FormatterManager::isValidDataType() — Method in class FormatterManager

FormatterAwareInterface::isHumanReadable() — Method in class FormatterAwareInterface

FormatterAwareTrait::isHumanReadable() — Method in class FormatterAwareTrait

NoOutputFormatter::isValidDataType() — Method in class NoOutputFormatter

All data types are acceptable.

StringFormatter::isValidDataType() — Method in class StringFormatter

By default, we assume that we can convert any data type to string, unless it implements UnstructuredInterface, in which case we won't allow the string format unless the data type also implements StringTransformationInterface.

VarDumpFormatter::isValidDataType() — Method in class VarDumpFormatter

Return true if the specified format is valid for use with this formatter.

VarExportFormatter::isValidDataType() — Method in class VarExportFormatter

Return true if the specified format is valid for use with this formatter.

$ FormatterOptions#input — Property in class FormatterOptions

var InputInterface

AbstractStructuredList::instantiateTableTransformation() — Method in class AbstractStructuredList

NumericCellRenderer::isRenderedFormat() — Method in class NumericCellRenderer

Determine if this format is to be formatted.

NumericCellRenderer::isRenderedColumn() — Method in class NumericCellRenderer

Determine if this is a column that should be formatted.

NumericCellRenderer::isRenderedData() — Method in class NumericCellRenderer

Ignore cell data that should not be formatted.

PropertyList::instantiateTableTransformation() — Method in class PropertyList

XmlSchema::isAttribute() — Method in class XmlSchema

XmlSchema::inElementList() — Method in class XmlSchema

XmlSchema::isAssoc() — Method in class XmlSchema

ReorderFields::isRegex() — Method in class ReorderFields

Checks whether the string is a regex. This function is copied from MultiplePcreFilterIterator in the Symfony Finder component.

TableTransformation::isList() — Method in class TableTransformation

UnstructuredDataTransformation::isSimpleArray() — Method in class UnstructuredDataTransformation

ColumnWidths::isEmpty() — Method in class ColumnWidths

Return true if there is no data in this object

ValidDataTypesTrait::isValidDataType() — Method in class ValidDataTypesTrait

Return the list of data types acceptable to this formatter

ValidationInterface::isValidDataType() — Method in class ValidationInterface

Return true if the specified format is valid for use with this formatter.

$ HostPath#implicit — Property in class HostPath

HostPath::isRemote() — Method in class HostPath

Returns true if this host path points at a remote machine

SiteAliasFileLoader::isValidEnvName() — Method in class SiteAliasFileLoader

isValidEnvName determines if a given entry should be skipped or not (e.g. the "common" entry).

SiteAliasInterface::isRemote() — Method in class SiteAliasInterface

Return true if this alias record has a remote host that is not the local host

SiteAliasInterface::isContainer() — Method in class SiteAliasInterface

Return true if the alias record use the Docker Compose transport.

SiteAliasInterface::isLocal() — Method in class SiteAliasInterface

Return true if this alias record is for the local system

SiteAliasInterface::isNone() — Method in class SiteAliasInterface

Determine whether this alias does not represent any site. An alias record must either be remote or have a root.

SiteAliasName::isAliasName() — Method in class SiteAliasName

Determine whether or not the provided name is an alias name.

SiteAliasName::isSelf() — Method in class SiteAliasName

Return true if this alias name is the 'self' alias.

SiteAliasName::isNone() — Method in class SiteAliasName

Return true if this alias name is the 'none' alias.

SiteAliasName::isSpecialAliasName() — Method in class SiteAliasName

Determine whether the requested name is a special alias name.

SiteAliasTrait::isRemote() — Method in class SiteAliasTrait

SiteAliasTrait::isLocal() — Method in class SiteAliasTrait

SiteAliasTrait::isContainer() — Method in class SiteAliasTrait

SiteAliasTrait::isNone() — Method in class SiteAliasTrait

SiteAliasWithConfig::import() — Method in class SiteAliasWithConfig

SiteSpecParser::isAliasName() — Method in class SiteSpecParser

Determine whether or not the provided name is an alias name.

InteractConfigName — Class in namespace Drush\Attributes

BootstrapHook::initialize() — Method in class BootstrapHook

BootstrapManager::injectBootstrap() — Method in class BootstrapManager

For use in testing

$ DrushCommands#input — Property in class DrushCommands

$ DrushCommands#io — Property in class DrushCommands

DrushCommands::input() — Method in class DrushCommands

DrushCommands::io() — Method in class DrushCommands

Override to provide a DrushStyle instance.

IoTrait — Class in namespace Drush\Commands

Stores input, output and IO objects for easy access in commands.

$ IoTrait#input — Property in class IoTrait

$ IoTrait#io — Property in class IoTrait

IoTrait::io() — Method in class IoTrait

IoTrait::input() — Method in class IoTrait

CacheClearCommand::interact() — Method in class CacheClearCommand

ConfigCommands::interactConfigName() — Method in class ConfigCommands

ConfigDeleteCommand::interact() — Method in class ConfigDeleteCommand

ConfigEditCommand::interact() — Method in class ConfigEditCommand

ConfigGetCommand::interact() — Method in class ConfigGetCommand

ImageCommands — Class in namespace Drush\Commands\core

ImageDeriveCommand — Class in namespace Drush\Commands\core

ImageFlushCommand — Class in namespace Drush\Commands\core

ImageFlushCommand::interact() — Method in class ImageFlushCommand

RsyncCommand::injectAliasPathParameterOptions() — Method in class RsyncCommand

SiteInstallCommand::isValidProfileName() — Method in class SiteInstallCommand

Determine whether the provided profile name meets naming conventions.

TopicCommands::interact() — Method in class TopicCommands

$ EntityTypeBundleAskTrait#input — Property in class EntityTypeBundleAskTrait

HelpCLIFormatter::isGlobalOption() — Method in class HelpCLIFormatter

SqlSyncCommand::import() — Method in class SqlSyncCommand

Import file into target.

UserInformationCommand::infoArray() — Method in class UserInformationCommand

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

UserTrait::infoArray() — Method in class UserTrait

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

WatchdogListCommand::interact() — Method in class WatchdogListCommand

$ 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.

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

SanitizeUserTableListener::isEnabled() — Method in class SanitizeUserTableListener

Test an option value to see if it is disabled.

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::instantiateDrupalCoreBootstrappedCommands() — Method in class ServiceManager

Instantiate commands from Drupal Core 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

CommandFileDiscovery::joinNamespace() — Method in class CommandFileDiscovery

Combine the items of the provied array into a backslash-separated namespace string. Empty and numeric items are omitted.

CommandFileDiscovery::joinPaths() — Method in class CommandFileDiscovery

Combine the items of the provied array into a slash-separated pathname. Empty items are omitted.

CommandFileDiscovery::joinParts() — Method in class CommandFileDiscovery

Simple wrapper around implode and array_filter.

JsonFormatter — Class in namespace Consolidation\OutputFormatters\Formatters

Json formatter

NumericCellRenderer::justifyCellData() — Method in class NumericCellRenderer

Right-justify the cell data.

JsonapiCommands — Class in namespace Drush\Commands\core

JsonapiGetCommand — Class in namespace Drush\Commands\core

K

AnnotationData::keys() — Method in class AnnotationData

ColumnWidths::keys() — Method in class ColumnWidths

Return the available keys (column identifiers) from the calculated data set.

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.

$ MigrateRunnerTrait#keyValue — Property in class MigrateRunnerTrait

L

$ AnnotatedCommandFactory#listeners — Property in class AnnotatedCommandFactory

var CommandCreationListenerInterface[]

$ CommandCreationListener#listener — Property in class CommandCreationListener

CommandInfo::lastParameterIsOptionsArray() — Method in class CommandInfo

Determine if the last argument contains $options.

BespokeDocBlockParser::lastParameterName() — Method in class BespokeDocBlockParser

ListFormatter — Class in namespace Consolidation\OutputFormatters\Formatters

Display the data in a simple list.

ListDataFromKeys — Class in namespace Consolidation\OutputFormatters\StructuredData

ListDataInterface — Class in namespace Consolidation\OutputFormatters\StructuredData

$ TableTransformation#layout — Property in class TableTransformation

CalculateWidths::longestWordLength() — Method in class CalculateWidths

Return the length of the longest word in the string.

ColumnWidths::lastColumn() — Method in class ColumnWidths

DataFileLoaderInterface::load() — Method in class DataFileLoaderInterface

SiteAlias::legacyRecord() — Method in class SiteAlias

Convert the data in this record to the layout that was used in the legacy code, for backwards compatiblity.

$ SiteAliasFileDiscovery#locationFilter — Property in class SiteAliasFileDiscovery

SiteAliasFileDiscovery::locationFilter() — Method in class SiteAliasFileDiscovery

$ SiteAliasFileLoader#loader — Property in class SiteAliasFileLoader

SiteAliasFileLoader::load() — Method in class SiteAliasFileLoader

Load the file containing the specified alias name.

SiteAliasFileLoader::loadDefaultEnvFromSitename() — Method in class SiteAliasFileLoader

Given only a site name, load the default environment from it.

SiteAliasFileLoader::loadAll() — Method in class SiteAliasFileLoader

Return a list of all site aliases loadable from any findable path.

SiteAliasFileLoader::listAll() — Method in class SiteAliasFileLoader

Return a list of all available alias files. Does not include legacy files.

SiteAliasFileLoader::loadMultiple() — Method in class SiteAliasFileLoader

Given an alias name that might represent multiple sites, return a list of all matching alias records. If nothing was found, or the name represents a single site + env, then we take no action and return false.

SiteAliasFileLoader::loadLocation() — Method in class SiteAliasFileLoader

Given a location, return all alias files located there.

SiteAliasFileLoader::loadSingleAliasFile() — Method in class SiteAliasFileLoader

If the alias name is '@sitename', or if it is '@sitename.env', then look for a sitename.site.yml file that contains it. We also handle '@location.sitename.env' here as well.

SiteAliasFileLoader::loadSingleSiteAliasFileAtPath() — Method in class SiteAliasFileLoader

Given only the path to an alias file site.alias.yml, return all of the alias records for every environment stored in that file.

SiteAliasFileLoader::loadSingleAliasFileWithNameAtPath() — Method in class SiteAliasFileLoader

Given an alias name and a path, load the data from the path and process it as needed to generate the alias record.

SiteAliasFileLoader::loadSiteDataFromPath() — Method in class SiteAliasFileLoader

Load the yml from the given path

SiteAliasFileLoader::loadSelfSiteData() — Method in class SiteAliasFileLoader

Check to see if there is a 'drush/sites/self.site.yml' file at the provided root, or one directory up from there.

SiteAliasFileLoader::loadData() — Method in class SiteAliasFileLoader

Load the contents of the specified file.

SiteAliasInterface::localRoot() — Method in class SiteAliasInterface

Return the 'root' element of this alias if this alias record is local.

SiteAliasManager::listAllFilePaths() — Method in class SiteAliasManager

Return the paths to all alias files in all search locations known to the alias manager.

SiteAliasManagerInterface::listAllFilePaths() — Method in class SiteAliasManagerInterface

Return the paths to all alias files in all search locations known to the alias manager.

$ SiteAliasName#location — Property in class SiteAliasName

SiteAliasName::locationFromPath() — Method in class SiteAliasName

The 'location' of an alias file is defined as being the name of the immediate parent of the alias file. e.g. the path '$HOME/.drush/sites/isp/mysite.site.yml' would have a location of 'isp' and a sitename of 'mysite'. The environments of the site are defined by the alias contents.

SiteAliasName::location() — Method in class SiteAliasName

Return the 'location' portion of the alias name.

SiteAliasTrait::localRoot() — Method in class SiteAliasTrait

YamlDataFileLoader::load() — Method in class YamlDataFileLoader

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.

EditCommand::load() — Method in class EditCommand

LanguageAddCommand — Class in namespace Drush\Commands\core

LanguageCommands — Class in namespace Drush\Commands\core

LanguageInfoCommand — Class in namespace Drush\Commands\core

LocaleCommands — Class in namespace Drush\Commands\core

LoginCommands — Class in namespace Drush\Commands\core

MessengerCommands::log() — Method in class MessengerCommands

FieldBaseOverrideCreateCommand::logResult() — Method in class FieldBaseOverrideCreateCommand

FieldCreateCommand::logResult() — Method in class FieldCreateCommand

ListCommand — Class in namespace Drush\Commands\help

LocaleCheckCommand — Class in namespace Drush\Commands\locale

LocaleClearStatusCommand — Class in namespace Drush\Commands\locale

LocaleExportCommand — Class in namespace Drush\Commands\locale

LocaleImportAllCommand — Class in namespace Drush\Commands\locale

LocaleImportCommand — Class in namespace Drush\Commands\locale

LocaleTrait — Class in namespace Drush\Commands\locale

$ LocaleTrait#languageManager — Property in class LocaleTrait

$ LocaleTrait#logger — Property in class LocaleTrait

LocaleUpdateCommand — Class in namespace Drush\Commands\locale

$ WatchdogTrait#logger — Property in class WatchdogTrait

$ 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.

MessengerListener::log() — Method in class MessengerListener

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

Misc — Class in namespace Consolidation\AnnotatedCommand\Attributes

$ CommandError#message — Property in class CommandError

$ PrepareTerminalWidthOption#maxWidth — Property in class PrepareTerminalWidthOption

var int

$ PrepareTerminalWidthOption#minWidth — Property in class PrepareTerminalWidthOption

var int

$ CommandInfo#methodName — Property in class CommandInfo

MetadataFormatterInterface — Class in namespace Consolidation\OutputFormatters\Formatters

MetadataFormatterTrait — Class in namespace Consolidation\OutputFormatters\Formatters

MetadataHolderInterface — Class in namespace Consolidation\OutputFormatters\StructuredData

MetadataHolderTrait — Class in namespace Consolidation\OutputFormatters\StructuredData

A structured data object may contains some elements that are actually metadata. Metadata is not included in the output of tabular data formatters (e.g. table, csv), although some of these (e.g. table) may render the metadata alongside the data. Raw data formatters (e.g. yaml, json) will render both the data and the metadata.

$ MetadataHolderTrait#metadataKey — Property in class MetadataHolderTrait

MetadataInterface — Class in namespace Consolidation\OutputFormatters\StructuredData

ReorderFields::matchFieldInLabelMap() — Method in class ReorderFields

$ WordWrapper#minimumWidths — Property in class WordWrapper

WordWrapper::minimumWidth() — Method in class WordWrapper

Set the minimum width of just one column

$ SiteSpecParser#multisiteDirectoryRoot — Property in class SiteSpecParser

SiteSpecParser::match() — Method in class SiteSpecParser

Run through all of the available regex patterns and determine if any match the provided specification.

SiteSpecParser::mapResult() — Method in class SiteSpecParser

Take the data from the matches from the regular expression and plug them into the result array per the info in the provided map.

BootstrapManager::maxPhaseLimit() — Method in class BootstrapManager

CliCommand::makeEntitiesAvailableWithShortClassNames() — Method in class CliCommand

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

MkCommands — Class in namespace Drush\Commands\core

$ LocaleTrait#moduleHandler — Property in class LocaleTrait

MaintGetCommand — Class in namespace Drush\Commands\maint

MaintSetCommand — Class in namespace Drush\Commands\maint

MaintStatusCommand — Class in namespace Drush\Commands\maint

MigrateFieldsSourceCommand — Class in namespace Drush\Commands\migrate

MigrateImportCommand — Class in namespace Drush\Commands\migrate

MigrateMessagesCommand — Class in namespace Drush\Commands\migrate

MigrateResetStatusCommand — Class in namespace Drush\Commands\migrate

MigrateRollbackCommand — Class in namespace Drush\Commands\migrate

MigrateRunnerTrait — Class in namespace Drush\Commands\migrate

$ MigrateRunnerTrait#migrationPluginManager — Property in class MigrateRunnerTrait

MigrateStatusCommand — Class in namespace Drush\Commands\migrate

MigrateStopCommand — Class in namespace Drush\Commands\migrate

$ PmTrait#moduleHandler — Property in class PmTrait

SanitizePluginInterface::messages() — Method in class SanitizePluginInterface

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

WatchdogTrait::messageTypes() — Method in class WatchdogTrait

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

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.

MigratePrepareRowEvent — Class in namespace Drush\Drupal\Migrate

Wraps a prepare-row event for event listeners.

MigrateRunnerHooks — Class in namespace Drush\Drupal\Migrate

MigrateRunnerServiceProvider — Class in namespace Drush\Drupal\Migrate

Registers a new migrate_prepare_row hook implementation.

MigrateUtils — Class in namespace Drush\Drupal\Migrate

Utility methods.

$ Drush#majorVersion — Property in class Drush

$ Drush#minorVersion — Property in class Drush

MessengerListener — Class in namespace Drush\Listeners

Replaces MessengerCommands for non-Annotated commands. Our terminate event fires for those too,

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.

DrushStyle::multiselect() — Method in class DrushStyle

Prompt the user to select multiple options.

DrushStyle::multisearch() — Method in class DrushStyle

Allow the user to search for multiple option.

N

AnnotatedCommandFactory::notify() — Method in class AnnotatedCommandFactory

Call all command creation listeners

NullCache — Class in namespace Consolidation\AnnotatedCommand\Cache

An empty cache that never stores or fetches any objects.

CommandCreationListener::notifyCommandFileAdded() — Method in class CommandCreationListener

CommandCreationListenerInterface::notifyCommandFileAdded() — Method in class CommandCreationListenerInterface

$ HookDispatcher#names — Property in class HookDispatcher

$ CommandInfo#name — Property in class CommandInfo

BespokeDocBlockParser::nextLineIsNotEmpty() — Method in class BespokeDocBlockParser

DocBlockUtils::nextLineIsNotEmpty() — Method in class DocBlockUtils

$ FullyQualifiedClassCache#namespaceCache — Property in class FullyQualifiedClassCache

NoOutputFormatter — Class in namespace Consolidation\OutputFormatters\Formatters

No output formatter

NumericCellRenderer — Class in namespace Consolidation\OutputFormatters\StructuredData

Create a formatter to add commas to numeric data.

$ SiteAlias#name — Property in class SiteAlias

SiteAlias::name() — Method in class SiteAlias

SiteAliasInterface::name() — Method in class SiteAliasInterface

Return the name of this alias record.

SiteAliasWithConfig::name() — Method in class SiteAliasWithConfig

NoArgumentsBase — Class in namespace Drush\Attributes

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 -.

DrushStyle::note() — Method in class DrushStyle

O

AnnotatedCommand::optionsHook() — Method in class AnnotatedCommand

Add any options to this command that are defined by hook implementations

AnnotatedCommand::optionsHookForHookAnnotations() — Method in class AnnotatedCommand

Option — Class in namespace Consolidation\AnnotatedCommand\Attributes

$ CommandData#output — Property in class CommandData

var OutputInterface

CommandData::output() — Method in class CommandData

CommandData::options() — Method in class CommandData

CommandProcessor::optionsHook() — Method in class CommandProcessor

OptionsHookDispatcher — Class in namespace Consolidation\AnnotatedCommand\Hooks\Dispatchers

Call hooks

OptionHookInterface — Class in namespace Consolidation\AnnotatedCommand\Hooks

Add options to a command.

OutputDataInterface — Class in namespace Consolidation\AnnotatedCommand

If an annotated command method returns an object that implements OutputDataInterface, then the getOutputData() method is used to fetch the output to print from the result object.

OutputAwareInterface — Class in namespace Consolidation\AnnotatedCommand\Output

$ CommandInfo#options — Property in class CommandInfo

$ CommandInfo#otherAnnotations — Property in class CommandInfo

CommandInfo::options() — Method in class CommandInfo

Descriptions of commandline options for this command.

$ BespokeDocBlockParser#optionParamName — Property in class BespokeDocBlockParser

BespokeDocBlockParser::optionParamName() — Method in class BespokeDocBlockParser

Return the name of the last parameter if it holds the options.

FormatterManager::overrideRestructure() — Method in class FormatterManager

Allow the formatter access to the raw structured data prior to restructuring. For example, the 'list' formatter may wish to display the row keys when provided table output. If this function returns a result that does not evaluate to 'false', then that result will be used as-is, and restructuring and validation will not occur.

FormatterManager::overrideOptions() — Method in class FormatterManager

Allow the formatter to mess with the configuration options before any transformations et. al. get underway.

ListFormatter::overrideRestructure() — Method in class ListFormatter

StringFormatter::overrideOptions() — Method in class StringFormatter

$ FormatterOptions#options — Property in class FormatterOptions

var array

FormatterOptions::override() — Method in class FormatterOptions

Create a new FormatterOptions object with new configuration data (provided), and the same options data as this instance.

OverrideOptionsInterface — Class in namespace Consolidation\OutputFormatters\Options

OverrideOptionsInterface::overrideOptions() — Method in class OverrideOptionsInterface

Allow the formatter to mess with the configuration options before any transformations et. al. get underway.

OriginalDataInterface — Class in namespace Consolidation\OutputFormatters\StructuredData

OverrideRestructureInterface — Class in namespace Consolidation\OutputFormatters\Transformations

OverrideRestructureInterface::overrideRestructure() — Method in class OverrideRestructureInterface

Select data to use directly from the structured output, before the restructure operation has been executed.

$ TableTransformation#originalData — Property in class TableTransformation

$ UnstructuredDataListTransformation#originalData — Property in class UnstructuredDataListTransformation

$ UnstructuredDataTransformation#originalData — Property in class UnstructuredDataTransformation

$ HostPath#original_path — Property in class HostPath

SiteAliasTrait::os() — Method in class SiteAliasTrait

os returns the OS that this alias record points to. For local alias records, PHP_OS will be returned. For remote alias records, the value from the os element will be returned. If there is no os element, then the default assumption is that the remote system is Linux.

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/14.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

$ DrushCommands#output — Property in class DrushCommands

DrushCommands::output() — Method in class DrushCommands

$ IoTrait#output — Property in class IoTrait

IoTrait::output() — Method in class IoTrait

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

MkCommands::optionToArray() — Method in class MkCommands

Build an array since that's what HelpCLIFormatter expects.

HelpCLIFormatter::optionRows() — Method in class HelpCLIFormatter

$ Environment#originalCwd — Property in class Environment

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

CreateEntityReferenceFieldListener::onConsoleDefinitionEvent() — Method in class CreateEntityReferenceFieldListener

CreateEntityReferenceFieldListener::onFieldConfigValues() — Method in class CreateEntityReferenceFieldListener

CreateEntityReferenceFieldListener::onFieldStorageConfigValues() — Method in class CreateEntityReferenceFieldListener

CreateLinkFieldListener::onConsoleDefinitionEvent() — Method in class CreateLinkFieldListener

CreateLinkFieldListener::onFieldConfigValues() — Method in class CreateLinkFieldListener

CreateLinkFieldListener::onInputOptions() — Method in class CreateLinkFieldListener

CreateTextFieldListener::onConsoleDefinitionEvent() — Method in class CreateTextFieldListener

CreateTextFieldListener::onConsoleCommand() — Method in class CreateTextFieldListener

CreateTextFieldListener::onFieldConfigValues() — Method in class CreateTextFieldListener

CreateTextFieldListener::onInputOptions() — Method in class CreateTextFieldListener

DrupliconListener::onConsoleDefinitionEvent() — Method in class DrupliconListener

DrupliconListener::onConsoleTerminateEvent() — Method in class DrupliconListener

MessengerListener::onConsoleCommandEvent() — Method in class MessengerListener

MessengerListener::onConsoleTerminateEvent() — Method in class MessengerListener

OptionsetGetEditorListener — Class in namespace Drush\Listeners

OptionsetProcBuildListener — Class in namespace Drush\Listeners

OptionsetSqlListener — Class in namespace Drush\Listeners

OptionsetSshListener — Class in namespace Drush\Listeners

OptionsetTableSelectionListener — Class in namespace Drush\Listeners

SanitizeCommentsListener::onSanitizeConfirm() — Method in class SanitizeCommentsListener

SanitizeCommentsListener::onConsoleTerminate() — Method in class SanitizeCommentsListener

SanitizeSessionsListener::onSanitizeConfirm() — Method in class SanitizeSessionsListener

SanitizeSessionsListener::onConsoleTerminate() — Method in class SanitizeSessionsListener

SanitizeUserFieldsListener::onDefinition() — Method in class SanitizeUserFieldsListener

SanitizeUserFieldsListener::onSanitizeConfirm() — Method in class SanitizeUserFieldsListener

SanitizeUserFieldsListener::onConsoleTerminate() — Method in class SanitizeUserFieldsListener

SanitizeUserTableListener::onDefinition() — Method in class SanitizeUserTableListener

SanitizeUserTableListener::onSanitizeConfirm() — Method in class SanitizeUserTableListener

SanitizeUserTableListener::onConsoleTerminate() — Method in class SanitizeUserTableListener

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

$ AnnotatedCommand#parameterMap — Property in class AnnotatedCommand

AnnotatedCommand::processResults() — Method in class AnnotatedCommand

This function is available for use by a class that may wish to extend this class rather than use annotations to define commands. Using this technique does allow for the use of annotations to define hooks.

$ CommandData#parameterMap — Property in class CommandData

$ CommandProcessor#prepareOptionsList — Property in class CommandProcessor

$ CommandProcessor#passExceptions — Property in class CommandProcessor

$ CommandProcessor#parameterInjection — Property in class CommandProcessor

CommandProcessor::parameterInjection() — Method in class CommandProcessor

CommandProcessor::process() — Method in class CommandProcessor

CommandProcessor::processResults() — Method in class CommandProcessor

ProcessResultHookDispatcher — Class in namespace Consolidation\AnnotatedCommand\Hooks\Dispatchers

Call hooks

ProcessResultHookDispatcher::process() — Method in class ProcessResultHookDispatcher

Process result and decide what to do with it.

ProcessResultInterface — Class in namespace Consolidation\AnnotatedCommand\Hooks

A result processor takes a result object, processes it, and returns another result object. For example, if a result object represents a 'task', then a task-runner hook could run the task and return the result from that execution.

ProcessResultInterface::process() — Method in class ProcessResultInterface

After a command has executed, if the result is something that needs to be processed, e.g. a collection of tasks to run, then execute it and return the new result.

$ StdinHandler#path — Property in class StdinHandler

StdinHandler::path() — Method in class StdinHandler

path returns the path to any file that was set as a redirection source, or php://stdin if none have been.

StdinHandler::pathProvided() — Method in class StdinHandler

Returns 'true' if a path was specfied, and that path was not '-'.

PrepareFormatter — Class in namespace Consolidation\AnnotatedCommand\Options

PrepareFormatter::prepare() — Method in class PrepareFormatter

PrepareTerminalWidthOption — Class in namespace Consolidation\AnnotatedCommand\Options

PrepareTerminalWidthOption::prepare() — Method in class PrepareTerminalWidthOption

ParameterInjection — Class in namespace Consolidation\AnnotatedCommand

Prepare parameter list for execurion. Handle injection of any special values (e.g. $input and $output) into the parameter list.

ParameterInjector — Class in namespace Consolidation\AnnotatedCommand

Provide an object for the specified interface or class name.

$ CommandInfo#parsingInProgress — Property in class CommandInfo

$ CommandInfo#parameterMap — Property in class CommandInfo

CommandInfo::parseDocBlock() — Method in class CommandInfo

Parse the docBlock comment for this command, and set the fields of this class with the data thereby obtained.

AttributesDocBlockParser::parse() — Method in class AttributesDocBlockParser

Call the handle method of each attribute, which alters the CommandInfo object.

BespokeDocBlockParser::parse() — Method in class BespokeDocBlockParser

Parse the docBlock comment for this command, and set the fields of this class with the data thereby obtained.

BespokeDocBlockParser::processGenericTag() — Method in class BespokeDocBlockParser

Save any tag that we do not explicitly recognize in the 'otherAnnotations' map.

BespokeDocBlockParser::processCommandTag() — Method in class BespokeDocBlockParser

Set the name of the command from a @command or @name annotation.

BespokeDocBlockParser::processAlternateDescriptionTag() — Method in class BespokeDocBlockParser

The @description and @desc annotations may be used in place of the synopsis (which we call 'description').

BespokeDocBlockParser::processParamTag() — Method in class BespokeDocBlockParser

Store the data from a @param annotation in our argument descriptions.

BespokeDocBlockParser::processArgumentTag() — Method in class BespokeDocBlockParser

Store the data from a @arg annotation in our argument descriptions.

BespokeDocBlockParser::processOptionTag() — Method in class BespokeDocBlockParser

Store the data from an @option annotation in our option descriptions.

BespokeDocBlockParser::processDefaultTag() — Method in class BespokeDocBlockParser

Store the data from a @default annotation in our argument or option store, as appropriate.

BespokeDocBlockParser::processUsageTag() — Method in class BespokeDocBlockParser

Store the data from a @usage annotation in our example usage list.

BespokeDocBlockParser::processAliases() — Method in class BespokeDocBlockParser

Process the comma-separated list of aliases

BespokeDocBlockParser::processReturnTag() — Method in class BespokeDocBlockParser

Store the data from a @return annotation in our argument descriptions.

BespokeDocBlockParser::processDescriptionAndHelp() — Method in class BespokeDocBlockParser

BespokeDocBlockParser::processAllTags() — Method in class BespokeDocBlockParser

CommandDocBlockParserFactory::parse() — Method in class CommandDocBlockParserFactory

FullyQualifiedClassCache::primeCache() — Method in class FullyQualifiedClassCache

FullyQualifiedClassCache::primeNamespaceCache() — Method in class FullyQualifiedClassCache

FullyQualifiedClassCache::primeUseCache() — Method in class FullyQualifiedClassCache

TagFactory::parseLine() — Method in class TagFactory

PrintRFormatter — Class in namespace Consolidation\OutputFormatters\Formatters

Print_r formatter

FormatterOptions::parse() — Method in class FormatterOptions

Given the raw value for a specific key, do any type conversion (e.g. from a textual list to an array) needed for the data.

FormatterOptions::parsePropertyList() — Method in class FormatterOptions

Convert from a textual list to an array

FieldProcessor::processFieldAliases() — Method in class FieldProcessor

PropertyList — Class in namespace Consolidation\OutputFormatters\StructuredData

Holds an array where each element of the array is one key : value pair. The keys must be unique, as is typically the case for associative arrays.

PropertyListTableTransformation — Class in namespace Consolidation\OutputFormatters\Transformations

PropertyParser — Class in namespace Consolidation\OutputFormatters\Transformations

Transform a string of properties into a PHP associative array.

PropertyParser::parse() — Method in class PropertyParser

$ WordWrapper#paddingInEachCell — Property in class WordWrapper

ColumnWidths::paddingSpace() — Method in class ColumnWidths

$ HostPath#path — Property in class HostPath

SiteAliasName::parse() — Method in class SiteAliasName

Create a new site alias name

SiteAliasName::processSingleItem() — Method in class SiteAliasName

Process an alias name provided as '@sitename'.

SiteSpecParser::parse() — Method in class SiteSpecParser

Parse a site specification

SiteSpecParser::patterns() — Method in class SiteSpecParser

Return the set of regular expression patterns that match the available site specification formats.

$ BaseBoot#phase — Property in class BaseBoot

$ BootstrapManager#phase — Property in class BootstrapManager

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.

DrushCommands::processManager() — Method in class DrushCommands

This method overrides the trait in order to provide a more specific return type.

ArchiveDumpCommand::prepareArchiveDir() — Method in class ArchiveDumpCommand

Creates a temporary directory for the archive.

DocsCommands::policy() — Method in class DocsCommands

Example policy file.

$ DrupalDirectoryCommand#pathEvaluator — Property in class DrupalDirectoryCommand

EditCommand::phpIniFiles() — Method in class EditCommand

MessengerCommands::pre() — Method in class MessengerCommands

MkCommands::prepare() — Method in class MkCommands

Empty target directories.

PhpCommands — Class in namespace Drush\Commands\core

PhpEvalCommand — Class in namespace Drush\Commands\core

PhpScriptCommand — Class in namespace Drush\Commands\core

$ RsyncCommand#pathEvaluator — Property in class RsyncCommand

RunserverCommand::parseUri() — Method in class RunserverCommand

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

SiteInstallCommand::pre() — Method in class SiteInstallCommand

StatusCommand::pathAliases() — Method in class StatusCommand

MigrateRunnerTrait::padTableRow() — Method in class MigrateRunnerTrait

Pads an incomplete table row with empty cells.

MigrateRunnerTrait::preprocessMessageRow() — Method in class MigrateRunnerTrait

Preprocesses migrate message rows.

PmCommands — Class in namespace Drush\Commands\pm

PmInstallCommand — Class in namespace Drush\Commands\pm

PmListCommand — Class in namespace Drush\Commands\pm

PmTrait — Class in namespace Drush\Commands\pm

$ PmTrait#permissionHandler — Property in class PmTrait

PmUninstallCommand — Class in namespace Drush\Commands\pm

$ 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.

MigrateRunnerHooks::prepareRow() — Method in class MigrateRunnerHooks

Implements hook_migrate_prepare_row().

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

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.

ConfiguresPromptsTrait::promptUntilValid() — Method in class ConfiguresPromptsTrait

Prompt the user until the given validation callback passes.

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

DrushStyle::password() — Method in class DrushStyle

Prompt the user for input, hiding the value.

DrushStyle::progress() — Method in class DrushStyle

Display a progress bar.

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

FullyQualifiedClassCache::qualify() — Method in class FullyQualifiedClassCache

QueueCommands — Class in namespace Drush\Commands\core

QueueDeleteCommand — Class in namespace Drush\Commands\queue

QueueListCommand — Class in namespace Drush\Commands\queue

QueueRunCommand — Class in namespace Drush\Commands\queue

QueueTrait — Class in namespace Drush\Commands\queue

$ QueueTrait#queues — Property in class QueueTrait

$ 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

$ AnnotatedCommand#returnType — Property in class AnnotatedCommand

AnnotatedCommandFactory::registerCommandHooksFromClassInfo() — Method in class AnnotatedCommandFactory

AnnotatedCommandFactory::registerCommandHook() — Method in class AnnotatedCommandFactory

Register a command hook given the CommandInfo for a method.

$ CommandProcessor#resultWriter — Property in class CommandProcessor

CommandProcessor::resultWriter() — Method in class CommandProcessor

CommandProcessor::runCommandCallback() — Method in class CommandProcessor

Run the main command callback

ReplaceCommandHookDispatcher — Class in namespace Consolidation\AnnotatedCommand\Hooks\Dispatchers

Call hooks.

HookManager::recordHookOptions() — Method in class HookManager

StdinHandler::redirect() — Method in class StdinHandler

redirect specifies a path to a file that should serve as the source to read from. If the input path is '-' or empty, then output will be taken from php://stdin (or whichever source was provided via the 'redirect' method).

ParameterInjection::register() — Method in class ParameterInjection

$ CommandInfo#reflection — Property in class CommandInfo

$ CommandInfo#returnType — Property in class CommandInfo

CommandInfo::replaceRawAnnotations() — Method in class CommandInfo

Replace the annotation data.

CommandInfo::removeAnnotation() — Method in class CommandInfo

Remove an annotation that was previoudly set.

CommandInfo::replaceExampleUsages() — Method in class CommandInfo

Overwrite all example usages

CommandInfo::requireConsistentState() — Method in class CommandInfo

Guard against invalid usage of CommandInfo during parsing.

DefaultsWithDescriptions::removeMatching() — Method in class DefaultsWithDescriptions

Remove a matching entry, if it exists.

DefaultsWithDescriptions::rename() — Method in class DefaultsWithDescriptions

Rename an existing option to something else.

$ AttributesDocBlockParser#reflection — Property in class AttributesDocBlockParser

$ BespokeDocBlockParser#reflection — Property in class BespokeDocBlockParser

BespokeDocBlockParser::removeLineBreaks() — Method in class BespokeDocBlockParser

Take a multiline description and convert it into a single long unbroken line.

FullyQualifiedClassCache::readNamespace() — Method in class FullyQualifiedClassCache

FullyQualifiedClassCache::readUseStatements() — Method in class FullyQualifiedClassCache

FullyQualifiedClassCache::readNextRelevantLine() — Method in class FullyQualifiedClassCache

ResultWriter — Class in namespace Consolidation\AnnotatedCommand

Write the results of a command. Inject your ResultWriter into the CommandProcessor.

State::restore() — Method in class State

Restore state to a previously cached value.

State::restore() — Method in class State

Restore state to a previously cached value.

StateHelper::restore() — Method in class StateHelper

FormatterManager::renderData() — Method in class FormatterManager

Render the data as necessary (e.g. to select or reorder fields).

FormatterManager::restructureData() — Method in class FormatterManager

Restructure the data as necessary (e.g. to select or reorder fields).

ListFormatter::renderData() — Method in class ListFormatter

ListFormatter::renderEachCell() — Method in class ListFormatter

RenderDataInterface — Class in namespace Consolidation\OutputFormatters\Formatters

RenderDataInterface::renderData() — Method in class RenderDataInterface

Convert the contents of the output data just before it is to be printed, prior to output but after restructuring and validation.

RenderTableDataTrait — Class in namespace Consolidation\OutputFormatters\Formatters

RenderTableDataTrait::renderData() — Method in class RenderTableDataTrait

RenderTableDataTrait::renderEachCell() — Method in class RenderTableDataTrait

StringFormatter::reduceToSigleFieldAndWrite() — Method in class StringFormatter

If the data provided to a 'string' formatter is a table, then try to emit it in a simplified form (by default, TSV).

AbstractStructuredList::restructure() — Method in class AbstractStructuredList

Allow structured data to be restructured -- i.e. to select fields to show, reorder fields, etc.

$ CallableRenderer#renderFunction — Property in class CallableRenderer

CallableRenderer::renderCell() — Method in class CallableRenderer

Convert the contents of one table cell into a string, so that it may be placed in the table. Renderer should return the $cellData passed to it if it does not wish to process it.

MetadataHolderInterface::reconstruct() — Method in class MetadataHolderInterface

MetadataHolderTrait::reconstruct() — Method in class MetadataHolderTrait

$ NumericCellRenderer#renderedColumns — Property in class NumericCellRenderer

NumericCellRenderer::renderCell() — Method in class NumericCellRenderer

PropertyList::restructure() — Method in class PropertyList

Restructure this data for output by converting it into a table transformation object.

RenderCellCollectionInterface — Class in namespace Consolidation\OutputFormatters\StructuredData

RenderCellCollectionTrait — Class in namespace Consolidation\OutputFormatters\StructuredData

$ RenderCellCollectionTrait#rendererList — Property in class RenderCellCollectionTrait

RenderCellCollectionTrait::renderCell() — Method in class RenderCellCollectionTrait

{@inheritdoc}

RenderCellInterface — Class in namespace Consolidation\OutputFormatters\StructuredData

RenderCellInterface::renderCell() — Method in class RenderCellInterface

Convert the contents of one table cell into a string, so that it may be placed in the table. Renderer should return the $cellData passed to it if it does not wish to process it.

RestructureInterface — Class in namespace Consolidation\OutputFormatters\StructuredData

RestructureInterface::restructure() — Method in class RestructureInterface

Allow structured data to be restructured -- i.e. to select fields to show, reorder fields, etc.

RowsOfFields — Class in namespace Consolidation\OutputFormatters\StructuredData

Holds an array where each element of the array is one row, and each row contains an associative array where the keys are the field names, and the values are the field data.

RowsOfFields::restructure() — Method in class RowsOfFields

Restructure this data for output by converting it into a table transformation object.

RowsOfFieldsWithMetadata — Class in namespace Consolidation\OutputFormatters\StructuredData

A RowsOfFields data structure that also contains metadata.

RowsOfFieldsWithMetadata::restructure() — Method in class RowsOfFieldsWithMetadata

Restructure this data for output by converting it into a table transformation object. First, though, remove any metadata items.

UnstructuredData::restructure() — Method in class UnstructuredData

Allow structured data to be restructured -- i.e. to select fields to show, reorder fields, etc.

UnstructuredListData::restructure() — Method in class UnstructuredListData

Allow structured data to be restructured -- i.e. to select fields to show, reorder fields, etc.

ReorderFields — Class in namespace Consolidation\OutputFormatters\Transformations

Reorder the field labels based on the user-selected fields to display.

ReorderFields::reorder() — Method in class ReorderFields

Given a simple list of user-supplied field keys or field labels, return a reordered version of the field labels matching the user selection.

ReorderFields::reorderFieldLabels() — Method in class ReorderFields

$ TableTransformation#rowLabels — Property in class TableTransformation

ColumnWidths::removeColumns() — Method in class ColumnWidths

Remove all of the specified columns from this data structure.

HostPath::replacePathAlias() — Method in class HostPath

Replaces the path alias portion of the path with the resolved path.

SiteAlias::remap() — Method in class SiteAlias

Reconfigure data exported from the form it is expected to be in inside an alias record to the form it is expected to be in when inside a configuration file.

SiteAlias::remapOptionTable() — Method in class SiteAlias

Conversion table from old to new option names. These all implicitly go in options, although they can come from different locations.

$ SiteAliasFileLoader#referenceData — Property in class SiteAliasFileLoader

$ SiteAliasFileLoader#root — Property in class SiteAliasFileLoader

SiteAliasInterface::root() — Method in class SiteAliasInterface

Get the root

SiteAliasInterface::remoteHostWithUser() — Method in class SiteAliasInterface

Return user@host, or just host if there is no user. Returns an empty string if there is no host.

SiteAliasInterface::remoteUser() — Method in class SiteAliasInterface

Get the remote user

SiteAliasInterface::remoteHost() — Method in class SiteAliasInterface

Get the remote host

$ SiteAliasManager#root — Property in class SiteAliasManager

SiteAliasTrait::root() — Method in class SiteAliasTrait

SiteAliasTrait::remoteHostWithUser() — Method in class SiteAliasTrait

SiteAliasTrait::remoteUser() — Method in class SiteAliasTrait

SiteAliasTrait::remoteHost() — Method in class SiteAliasTrait

$ SiteAliasWithConfig#runtimeConfig — Property in class SiteAliasWithConfig

SiteAliasWithConfig::runtimeConfig() — Method in class SiteAliasWithConfig

SiteAliasWithConfig::replace() — Method in class SiteAliasWithConfig

FsUtils::realpath() — Method in class FsUtils

Returns canonicalized absolute pathname.

$ 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.

Application::registerCommandInstances() — Method in class Application

Register command handler instances with the application.

Application::redispatchIfRemote() — Method in class Application

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.

DocsCommands::readme() — Method in class DocsCommands

README.md

RequirementsCommand — Class in namespace Drush\Commands\core

RoleCommands — Class in namespace Drush\Commands\core

RouteCommand — Class in namespace Drush\Commands\core

RsyncCommand — Class in namespace Drush\Commands\core

RsyncCommand::rsyncOptions() — Method in class RsyncCommand

RsyncCommands — Class in namespace Drush\Commands\core

RunserverCommand — Class in namespace Drush\Commands\core

RunserverCommands — Class in namespace Drush\Commands\core

StatusCommand::renderStatusCell() — Method in class StatusCommand

FieldDefinitionRowsOfFieldsTrait::renderArray() — Method in class FieldDefinitionRowsOfFieldsTrait

FieldDefinitionRowsOfFieldsTrait::renderBoolean() — Method in class FieldDefinitionRowsOfFieldsTrait

FieldFormattersCommand::renderArray() — Method in class FieldFormattersCommand

FieldTypesCommand::renderArray() — Method in class FieldTypesCommand

FieldWidgetsCommand::renderArray() — Method in class FieldWidgetsCommand

ListCommand::renderListCLI() — Method in class ListCommand

ListCommand::renderListRaw() — Method in class ListCommand

RoleCreateCommand — Class in namespace Drush\Commands\role

RoleDeleteCommand — Class in namespace Drush\Commands\role

RoleListCommand — Class in namespace Drush\Commands\role

RoleListCommand::renderPermsCell() — Method in class RoleListCommand

RolePermAddCommand — Class in namespace Drush\Commands\role

RolePermRemoveCommand — Class in namespace Drush\Commands\role

SqlSyncCommand::rsync() — Method in class SqlSyncCommand

UpdateDBCommand::restoreMaintMode() — Method in class UpdateDBCommand

UserCreateCommand::renderRolesCell() — Method in class UserCreateCommand

UserInformationCommand::renderRolesCell() — Method in class UserInformationCommand

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.

Drush::redispatchOptions() — Method in class Drush

$ ArgsPreprocessor#remapper — Property in class ArgsPreprocessor

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.

ConfiguresPromptsTrait::restorePrompts() — Method in class ConfiguresPromptsTrait

Restore the prompts output.

ConfiguresPromptsTrait::runningUnitTests() — Method in class ConfiguresPromptsTrait

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.

RelativeNamespaceDiscovery — Class in namespace Drush\Runtime

Discovers classes in a relative namespace using the Composer ClassLoader.

$ RelativeNamespaceDiscovery#relativeNamespace — Property in class RelativeNamespaceDiscovery

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

AnnotatedCommand::setCommandCallback() — Method in class AnnotatedCommand

AnnotatedCommand::setCompletionCallback() — Method in class AnnotatedCommand

AnnotatedCommand::setCommandProcessor() — Method in class AnnotatedCommand

AnnotatedCommand::setReturnType() — Method in class AnnotatedCommand

AnnotatedCommand::setAnnotationData() — Method in class AnnotatedCommand

AnnotatedCommand::setTopics() — Method in class AnnotatedCommand

AnnotatedCommand::setCommandInfo() — Method in class AnnotatedCommand

AnnotatedCommand::setCommandArguments() — Method in class AnnotatedCommand

AnnotatedCommand::setCommandArgumentsFromParameters() — Method in class AnnotatedCommand

AnnotatedCommand::setCommandOptions() — Method in class AnnotatedCommand

AnnotatedCommandFactory::setIgnoreCommandsInTraits() — Method in class AnnotatedCommandFactory

Typically, traits should not contain commands; however, some applications make use of this feature to package commands in libraries, so we must allow command files in traits to maintain backwards compatibility. Call this method to skip the parsing of trait files for a performance boost.

AnnotatedCommandFactory::setIgnoreCommandsInParentClasses() — Method in class AnnotatedCommandFactory

Typically, commands should not be inherited from parent classes; however, some applications make use of this feature to package commands in libraries, so we must allow command files in traits to maintain backwards compatibility. Call this method to skip the parsing of trait files for a performance boost.

AnnotatedCommandFactory::setCommandProcessor() — Method in class AnnotatedCommandFactory

AnnotatedCommandFactory::setIncludeAllPublicMethods() — Method in class AnnotatedCommandFactory

Set the 'include all public methods flag'. If true (the default), then every public method of each commandFile will be used to create commands.

AnnotatedCommandFactory::storeCommandInfoListInCache() — Method in class AnnotatedCommandFactory

AnnotatedCommandFactory::setDataStore() — Method in class AnnotatedCommandFactory

Set a cache datastore for this factory. Any object with 'set' and 'get' methods is acceptable. The key is the classname being cached, and the value is a nested associative array of strings.

AnnotationData::set() — Method in class AnnotationData

CacheWrapper::set() — Method in class CacheWrapper

Store an entry in the cache

NullCache::set() — Method in class NullCache

Store an entry in the cache

SimpleCacheInterface — Class in namespace Consolidation\AnnotatedCommand\Cache

Documentation interface.

SimpleCacheInterface::set() — Method in class SimpleCacheInterface

Store an entry in the cache

$ CommandData#specialDefaults — Property in class CommandData

var array

CommandData::setIncludeOptionsInArgs() — Method in class CommandData

For backwards-compatibility mode only: disable addition of options on the end of the arguments list.

CommandData::setFormatterOptions() — Method in class CommandData

CommandData::shouldConvertOptionToFalse() — Method in class CommandData

$ CommandFileDiscovery#searchLocations — Property in class CommandFileDiscovery

$ CommandFileDiscovery#searchPattern — Property in class CommandFileDiscovery

$ CommandFileDiscovery#searchDepth — Property in class CommandFileDiscovery

$ CommandFileDiscovery#strippedNamespaces — Property in class CommandFileDiscovery

CommandFileDiscovery::setIncludeFilesAtBase() — Method in class CommandFileDiscovery

Specify whether to search for files at the base directory ($directoryList parameter to discover and discoverNamespaced methods), or only in the directories listed in the search paths.

CommandFileDiscovery::setExcludeList() — Method in class CommandFileDiscovery

Set the list of excludes to add to the finder, replacing whatever was there before.

CommandFileDiscovery::setSearchDepth() — Method in class CommandFileDiscovery

Set the search depth. By default, fills immediately in the base directory are searched, plus all of the search locations to this specified depth. If the search locations is set to an empty array, then the base directory is searched to this depth.

CommandFileDiscovery::setSearchLocations() — Method in class CommandFileDiscovery

Set the list of search locations to examine in each directory where command files may be found. This replaces whatever was there before.

CommandFileDiscovery::setSearchPattern() — Method in class CommandFileDiscovery

Specify the pattern / regex used by the finder to search for command files.

CommandProcessor::setResultWriter() — Method in class CommandProcessor

CommandProcessor::setParameterInjection() — Method in class CommandProcessor

CommandProcessor::setFormatterManager() — Method in class CommandProcessor

CommandProcessor::setDisplayErrorFunction() — Method in class CommandProcessor

CommandProcessor::setPassExceptions() — Method in class CommandProcessor

Set a mode to make the annotated command library re-throw any exception that it catches while processing a command.

CommandResult::setOutputData() — Method in class CommandResult

CustomEventAwareInterface::setHookManager() — Method in class CustomEventAwareInterface

Set a reference to the hook manager for later use

CustomEventAwareTrait::setHookManager() — Method in class CustomEventAwareTrait

{@inheritdoc}

StatusDeterminerHookDispatcher — Class in namespace Consolidation\AnnotatedCommand\Hooks\Dispatchers

Call hooks

StatusDeterminerInterface — Class in namespace Consolidation\AnnotatedCommand\Hooks

StdinAwareInterface — Class in namespace Consolidation\AnnotatedCommand\Input

StdinAwareInterface should be implemented by classes that read from standard input. This class contains facilities to redirect stdin to instead read from a file, e.g. in response to an option or argument value.

StdinAwareInterface::setStdinHandler() — Method in class StdinAwareInterface

Sets the standard input handler.

StdinAwareInterface::stdin() — Method in class StdinAwareInterface

Returns the standard input handler.

StdinAwareTrait — Class in namespace Consolidation\AnnotatedCommand\Input

StdinAwareTrait provides the implementation for StdinAwareInterface.

$ StdinAwareTrait#stdinHandler — Property in class StdinAwareTrait

StdinAwareTrait::setStdinHandler() — Method in class StdinAwareTrait

StdinAwareTrait::stdin() — Method in class StdinAwareTrait

StdinHandler — Class in namespace Consolidation\AnnotatedCommand\Input

StdinHandler is a thin wrapper around php://stdin. It provides methods for redirecting input from a file, possibly conditionally under the control of an Input object.

$ StdinHandler#stream — Property in class StdinHandler

StdinHandler::selectStream() — Method in class StdinHandler

StdinHandler::select() — Method in class StdinHandler

select chooses the source of the input stream based on whether or not the user provided the specified option or argument on the commandline.

StdinHandler::setStream() — Method in class StdinHandler

setStream functions like 'select', and also sets up the $input object to read from the selected input stream e.g. when used with a question helper.

$ PrepareTerminalWidthOption#shouldWrap — Property in class PrepareTerminalWidthOption

PrepareTerminalWidthOption::setApplication() — Method in class PrepareTerminalWidthOption

PrepareTerminalWidthOption::setTerminal() — Method in class PrepareTerminalWidthOption

OutputAwareInterface::setOutput() — Method in class OutputAwareInterface

Sets the Console Output.

$ CommandInfo#simpleOptionParametersAllowed — Property in class CommandInfo

CommandInfo::setName() — Method in class CommandInfo

Set the primary name for this command.

CommandInfo::setInjectedClasses() — Method in class CommandInfo

CommandInfo::setReturnType() — Method in class CommandInfo

CommandInfo::setDescription() — Method in class CommandInfo

Set the command description.

CommandInfo::setHelp() — Method in class CommandInfo

Set the help text for this command.

CommandInfo::setAliases() — Method in class CommandInfo

Set aliases that can be used in place of the command's primary name.

CommandInfo::setHidden() — Method in class CommandInfo

Set hidden status. List command omits hidden commands.

CommandInfo::setExampleUsage() — Method in class CommandInfo

Add an example usage for this command.

CommandInfo::splitOutDefault() — Method in class CommandInfo

CommandInfoSerializer::serialize() — Method in class CommandInfoSerializer

CommandInfoSerializer::serializeDefaultsWithDescriptions() — Method in class CommandInfoSerializer

$ DefaultsWithDescriptions#suggestedValues — Property in class DefaultsWithDescriptions

DefaultsWithDescriptions::simplifyKey() — Method in class DefaultsWithDescriptions

DefaultsWithDescriptions::setDefaultValue() — Method in class DefaultsWithDescriptions

Change the default value of an entry.

BespokeDocBlockParser::splitOutDefault() — Method in class BespokeDocBlockParser

DocBlockUtils::stripLeadingCommentCharacters() — Method in class DocBlockUtils

DocblockTag::splitTagAndContent() — Method in class DocblockTag

Use a regular expression to separate the tag from the content.

TagFactory::storeCurrentTag() — Method in class TagFactory

ResultWriter::setFormatterManager() — Method in class ResultWriter

ResultWriter::setDisplayErrorFunction() — Method in class ResultWriter

State — Class in namespace Consolidation\AnnotatedCommand

SavableState — Class in namespace Consolidation\AnnotatedCommand\State

State — Class in namespace Consolidation\AnnotatedCommand\State

StateHelper — Class in namespace Consolidation\AnnotatedCommand\State

FormatterManager::simplifyToArray() — Method in class FormatterManager

FormatterAwareInterface::setFormatter() — Method in class FormatterAwareInterface

FormatterAwareTrait::setFormatter() — Method in class FormatterAwareTrait

SectionsFormatter — Class in namespace Consolidation\OutputFormatters\Formatters

Display sections of data.

SerializeFormatter — Class in namespace Consolidation\OutputFormatters\Formatters

Serialize formatter

StringFormatter — Class in namespace Consolidation\OutputFormatters\Formatters

String formatter

FormatterOptions::setTableStyle() — Method in class FormatterOptions

FormatterOptions::setDelimiter() — Method in class FormatterOptions

FormatterOptions::setCsvEnclosure() — Method in class FormatterOptions

FormatterOptions::setCsvEscapeChar() — Method in class FormatterOptions

FormatterOptions::setListDelimiter() — Method in class FormatterOptions

FormatterOptions::setIncludeFieldLables() — Method in class FormatterOptions

FormatterOptions::setListOrientation() — Method in class FormatterOptions

FormatterOptions::setRowLabels() — Method in class FormatterOptions

FormatterOptions::setDefaultFields() — Method in class FormatterOptions

FormatterOptions::setFieldLabels() — Method in class FormatterOptions

FormatterOptions::setTableEmptyMessage() — Method in class FormatterOptions

FormatterOptions::setTableDefaultFields() — Method in class FormatterOptions

FormatterOptions::setDefaultStringField() — Method in class FormatterOptions

FormatterOptions::setWidth() — Method in class FormatterOptions

FormatterOptions::setHumanReadable() — Method in class FormatterOptions

FormatterOptions::setConfigurationData() — Method in class FormatterOptions

Change the configuration data for this formatter options object.

FormatterOptions::setConfigurationValue() — Method in class FormatterOptions

Change one configuration value for this formatter option.

FormatterOptions::setConfigurationDefault() — Method in class FormatterOptions

Change one configuration value for this formatter option, but only if it does not already have a value set.

FormatterOptions::setOptions() — Method in class FormatterOptions

Set all of the options that were specified by the user for this request.

FormatterOptions::setOption() — Method in class FormatterOptions

Change one option value specified by the user for this request.

FormatterOptions::setInput() — Method in class FormatterOptions

Provide a Symfony Console InputInterface containing the user-specified options for this request.

MetadataHolderInterface::setDataKey() — Method in class MetadataHolderInterface

MetadataHolderInterface::setMetadataKey() — Method in class MetadataHolderInterface

MetadataHolderTrait::setDataKey() — Method in class MetadataHolderTrait

MetadataHolderTrait::setMetadataKey() — Method in class MetadataHolderTrait

XmlSchema::singularForm() — Method in class XmlSchema

DomToArraySimplifier::simplifyToArray() — Method in class DomToArraySimplifier

Convert structured data into a generic array, usable by generic array-based formatters. Objects that implement this interface may be attached to the FormatterManager, and will be used on any data structure that needs to be simplified into an array. An array simplifier should take no action other than to return its input data if it cannot simplify the provided data into an array.

SimplifyToArrayInterface — Class in namespace Consolidation\OutputFormatters\Transformations

SimplifyToArrayInterface::simplifyToArray() — Method in class SimplifyToArrayInterface

Convert structured data into a generic array, usable by generic array-based formatters. Objects that implement this interface may be attached to the FormatterManager, and will be used on any data structure that needs to be simplified into an array. An array simplifier should take no action other than to return its input data if it cannot simplify the provided data into an array.

StringTransformationInterface — Class in namespace Consolidation\OutputFormatters\Transformations

StringTransformationInterface::simplifyToString() — Method in class StringTransformationInterface

simplifyToString is called by the string formatter to convert structured data to a simple string.

TableTransformation::setLayout() — Method in class TableTransformation

TableTransformation::simplifyToString() — Method in class TableTransformation

TableTransformation::setOriginalData() — Method in class TableTransformation

UnstructuredDataListTransformation::simplifyToString() — Method in class UnstructuredDataListTransformation

simplifyToString is called by the string formatter to convert structured data to a simple string.

UnstructuredDataTransformation::simplifyToString() — Method in class UnstructuredDataTransformation

simplifyToString is called by the string formatter to convert structured data to a simple string.

UnstructuredDataTransformation::simplifyRow() — Method in class UnstructuredDataTransformation

WordWrapper::setPaddingFromStyle() — Method in class WordWrapper

Calculate our padding widths from the specified table style.

WordWrapper::setPaddingFromSymfony5Style() — Method in class WordWrapper

Calculate our padding widths from the specified table style.

WordWrapper::setMinimumWidths() — Method in class WordWrapper

If columns have minimum widths, then set them here.

ColumnWidths::setWidth() — Method in class ColumnWidths

Set the length of the specified column.

ColumnWidths::sumWidth() — Method in class ColumnWidths

Return the sum of the lengths of the provided widths.

ColumnWidths::selectColumns() — Method in class ColumnWidths

Select all columns that exist in the provided list of keys.

SiteAlias — Class in namespace Consolidation\SiteAlias

An alias record is a configuration record containing well-known items.

SiteAliasFileDiscovery — Class in namespace Consolidation\SiteAlias

Discover alias files named:

$ SiteAliasFileDiscovery#searchLocations — Property in class SiteAliasFileDiscovery

SiteAliasFileDiscovery::searchLocations() — Method in class SiteAliasFileDiscovery

Return all of the paths where alias files may be found.

SiteAliasFileDiscovery::searchForAliasFiles() — Method in class SiteAliasFileDiscovery

Return a list of all alias files matching the provided pattern.

SiteAliasFileDiscovery::splitLocationFromSite() — Method in class SiteAliasFileDiscovery

splitLocationFromSite returns the part of 'site' before the first '.' as the "path match" component, and the part after the first '.' as the "site" component.

SiteAliasFileLoader — Class in namespace Consolidation\SiteAlias

Discover alias files:

SiteAliasFileLoader::setReferenceData() — Method in class SiteAliasFileLoader

Allow configuration data to be used in replacements in the alias file.

SiteAliasFileLoader::setRoot() — Method in class SiteAliasFileLoader

Allow 'self.site.yml' to be applied to any alias record found.

SiteAliasFileLoader::storeSiteAliasInResut() — Method in class SiteAliasFileLoader

Store an alias record in a list. If the alias record has a known name, then the key of the list will be the record's name.

SiteAliasFileLoader::siteNameFromPath() — Method in class SiteAliasFileLoader

Given the path to a single site alias file site.alias.yml, return the site part.

SiteAliasFileLoader::siteEnvExists() — Method in class SiteAliasFileLoader

Determine whether there is a valid-looking environment '$env' in the provided site alias data.

SiteAliasInterface — Class in namespace Consolidation\SiteAlias

An alias record is a configuration record containing well-known items.

SiteAliasInterface::setUri() — Method in class SiteAliasInterface

Record the uri

SiteAliasManager — Class in namespace Consolidation\SiteAlias

Site Alias manager

$ SiteAliasManager#selfSiteAlias — Property in class SiteAliasManager

$ SiteAliasManager#specParser — Property in class SiteAliasManager

SiteAliasManager::setReferenceData() — Method in class SiteAliasManager

Allow configuration data to be used in replacements in the alias file.

SiteAliasManager::setRoot() — Method in class SiteAliasManager

Inject the root of the selected site

SiteAliasManager::searchLocations() — Method in class SiteAliasManager

Return all of the paths where alias files may be found.

SiteAliasManager::setSelf() — Method in class SiteAliasManager

Force-set the current @self alias.

SiteAliasManagerAwareInterface — Class in namespace Consolidation\SiteAlias

Inflection interface for the site alias manager.

SiteAliasManagerAwareInterface::setSiteAliasManager() — Method in class SiteAliasManagerAwareInterface

SiteAliasManagerAwareInterface::siteAliasManager() — Method in class SiteAliasManagerAwareInterface

SiteAliasManagerAwareTrait — Class in namespace Consolidation\SiteAlias

Inflection trait for the site alias manager.

$ SiteAliasManagerAwareTrait#siteAliasManager — Property in class SiteAliasManagerAwareTrait

SiteAliasManagerAwareTrait::setSiteAliasManager() — Method in class SiteAliasManagerAwareTrait

SiteAliasManagerAwareTrait::siteAliasManager() — Method in class SiteAliasManagerAwareTrait

SiteAliasManagerInitializationInterface — Class in namespace Consolidation\SiteAlias

Site Alias manager methods used to set up the object.

SiteAliasManagerInitializationInterface::setReferenceData() — Method in class SiteAliasManagerInitializationInterface

Allow configuration data to be used in replacements in the alias file.

SiteAliasManagerInitializationInterface::setRoot() — Method in class SiteAliasManagerInitializationInterface

Inject the root of the selected site

SiteAliasManagerInitializationInterface::setSelf() — Method in class SiteAliasManagerInitializationInterface

Force-set the current @self alias.

SiteAliasManagerInterface — Class in namespace Consolidation\SiteAlias

Site Alias manager

SiteAliasManagerInterface::searchLocations() — Method in class SiteAliasManagerInterface

Return all of the paths where alias files may be found.

SiteAliasName — Class in namespace Consolidation\SiteAlias

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

$ SiteAliasName#sitename — Property in class SiteAliasName

SiteAliasName::sitename() — Method in class SiteAliasName

Return the sitename portion of the alias name. By definition, every alias must have a sitename. If the site name is implicit, then 'self' is assumed.

SiteAliasName::sitenameWithLocation() — Method in class SiteAliasName

Return the sitename portion of the alias name. By definition, every alias must have a sitename. If the site name is implicit, then 'self' is assumed.

SiteAliasName::setSitename() — Method in class SiteAliasName

Set the sitename portion of the alias name

SiteAliasName::setEnv() — Method in class SiteAliasName

Set the environment portion of the alias name.

SiteAliasName::setLocation() — Method in class SiteAliasName

Set the 'loation' portion of the alias name.

SiteAliasTrait — Class in namespace Consolidation\SiteAlias

Common implementation of some SiteAlias methods.

SiteAliasTrait::setUri() — Method in class SiteAliasTrait

SiteAliasWithConfig — Class in namespace Consolidation\SiteAlias

SiteAliasWithConfig delegates to a site alias, and also combines it with two config stores:

$ SiteAliasWithConfig#siteAlias — Property in class SiteAliasWithConfig

SiteAliasWithConfig::set() — Method in class SiteAliasWithConfig

SiteAliasWithConfig::setDefault() — Method in class SiteAliasWithConfig

SiteSpecParser — Class in namespace Consolidation\SiteAlias

Parse a string that contains a site specification.

SiteSpecParser::setMultisiteDirectoryRoot() — Method in class SiteSpecParser

$ 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

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.

DrushCommands::setInput() — Method in class DrushCommands

DrushCommands::setOutput() — Method in class DrushCommands

Sets the Console Output.

IoTrait::setIo() — Method in class IoTrait

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.

DrupalDependenciesCommands::scanConfigs() — Method in class DrupalDependenciesCommands

Scans all config entities and store their module and config dependencies.

MigrateRunnerCommands::setMigrationPluginManager() — Method in class MigrateRunnerCommands

Provide a migration plugin manager.

SiteAliasCommand — Class in namespace Drush\Commands\core

SiteAliasCommand::siteAliasExportList() — Method in class SiteAliasCommand

SiteCommands — Class in namespace Drush\Commands\core

SiteInstallCommand — Class in namespace Drush\Commands\core

SiteInstallCommand::serverGlobals() — Method in class SiteInstallCommand

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

SiteInstallCommands — Class in namespace Drush\Commands\core

SiteSetCommand — Class in namespace Drush\Commands\core

SshCommand — Class in namespace Drush\Commands\core

SshCommands — Class in namespace Drush\Commands\core

StateCommands — Class in namespace Drush\Commands\core

StatusCommand — Class in namespace Drush\Commands\core

StatusCommands — Class in namespace Drush\Commands\core

EntityCreateCommand::setValue() — Method in class EntityCreateCommand

$ LocaleTrait#state — Property in class LocaleTrait

MigrateRunnerTrait::setMigrationPluginManager() — Method in class MigrateRunnerTrait

Provide a migration plugin manager.

SqlCliCommand — Class in namespace Drush\Commands\sql

SqlCommands — Class in namespace Drush\Commands\sql

SqlConfCommand — Class in namespace Drush\Commands\sql

SqlConnectCommand — Class in namespace Drush\Commands\sql

SqlCreateCommand — Class in namespace Drush\Commands\sql

SqlDropCommand — Class in namespace Drush\Commands\sql

SqlDumpCommand — Class in namespace Drush\Commands\sql

SqlQueryCommand — Class in namespace Drush\Commands\sql

SqlSyncCommand — Class in namespace Drush\Commands\sql

SqlSyncCommands — Class in namespace Drush\Commands\sql

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

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

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.

StateDeleteCommand — Class in namespace Drush\Commands\state

StateGetCommand — Class in namespace Drush\Commands\state

StateSetCommand — Class in namespace Drush\Commands\state

$ 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)

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

$ 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.

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

ConsoleDefinitionsEvent::setApplication() — Method in class ConsoleDefinitionsEvent

FieldCreateEntityDisplayValuesEvent::setValues() — Method in class FieldCreateEntityDisplayValuesEvent

FieldCreateFieldConfigValuesEvent::setValues() — Method in class FieldCreateFieldConfigValuesEvent

FieldCreateFieldStorageConfigValuesEvent::setValues() — Method in class FieldCreateFieldStorageConfigValuesEvent

SanitizeConfirmsEvent — Class in namespace Drush\Event

SanitizeConfirmsEvent::setInput() — Method in class SanitizeConfirmsEvent

SanitizeConfirmsEvent::setMessages() — Method in class SanitizeConfirmsEvent

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

Convert structured data into a generic array, usable by generic array-based formatters. Objects that implement this interface may be attached to the FormatterManager, and will be used on any data structure that needs to be simplified into an array. An array simplifier should take no action other than to return its input data if it cannot simplify the provided data into an array.

FormatterTrait::setFormatterOptions() — Method in class FormatterTrait

Public because is used by FormatterListener.

SanitizeCommentsListener — Class in namespace Drush\Listeners\sanitize

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

SanitizeSessionsListener — Class in namespace Drush\Listeners\sanitize

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

SanitizeUserFieldsListener — Class in namespace Drush\Listeners\sanitize

Sanitize user fields. This also an example of how to write a database sanitizer.

SanitizeUserTableListener — Class in namespace Drush\Listeners\sanitize

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

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

Shell — Class in namespace Drush\Psysh

$ RelativeNamespaceDiscovery#searchPattern — Property in class RelativeNamespaceDiscovery

RelativeNamespaceDiscovery::setSearchPattern() — Method in class RelativeNamespaceDiscovery

RelativeNamespaceDiscovery::setRelativeNamespace() — Method in class RelativeNamespaceDiscovery

RelativeNamespaceDiscovery::search() — Method in class RelativeNamespaceDiscovery

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.

DrushStyle::success() — Method in class DrushStyle

DrushStyle::select() — Method in class DrushStyle

Prompt the user to select an option.

DrushStyle::suggest() — Method in class DrushStyle

Prompt the user for text input with auto-completion.

DrushStyle::search() — Method in class DrushStyle

Allow the user to search for an option.

DrushStyle::spin() — Method in class DrushStyle

Render a spinner while the given callback is executing.

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

$ AnnotatedCommand#topics — Property in class AnnotatedCommand

Topics — Class in namespace Consolidation\AnnotatedCommand\Attributes

$ PrepareTerminalWidthOption#terminal — Property in class PrepareTerminalWidthOption

$ BespokeDocBlockParser#tagProcessors — Property in class BespokeDocBlockParser

CsvUtils::toString() — Method in class CsvUtils

Ensure that the provided data is a string.

CsvUtils::toList() — Method in class CsvUtils

Return a specific named annotation for this command.

$ DocblockTag#tag — Property in class DocblockTag

TagFactory — Class in namespace Consolidation\AnnotatedCommand\Parser\Internal

Hold some state. Collect tags.

$ TagFactory#tags — Property in class TagFactory

TableFormatter — Class in namespace Consolidation\OutputFormatters\Formatters

Display a table of data with the Symfony Table class.

TsvFormatter — Class in namespace Consolidation\OutputFormatters\Formatters

Tab-separated value formatters

TsvFormatter::tsvEscape() — Method in class TsvFormatter

TableDataInterface — Class in namespace Consolidation\OutputFormatters\StructuredData

TableTransformation — Class in namespace Consolidation\OutputFormatters\Transformations

TableTransformation::transformRows() — Method in class TableTransformation

TableTransformation::transformRow() — Method in class TableTransformation

UnstructuredDataListTransformation::transformRows() — Method in class UnstructuredDataListTransformation

UnstructuredDataTransformation::transformRow() — Method in class UnstructuredDataTransformation

ColumnWidths::totalWidth() — Method in class ColumnWidths

Return the sum of the lengths of the provided widths.

$ Application#tildeExpansionHook — Property in class Application

TableFormat — Class in namespace Drush\Attributes

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.

SiteInstallCommand::taskCallback() — Method in class SiteInstallCommand

ThemeDevCommand — Class in namespace Drush\Commands\core

ThemeDevCommands — Class in namespace Drush\Commands\core

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

TwigCompileCommand — Class in namespace Drush\Commands\core

TwigUnusedCommand — Class in namespace Drush\Commands\core

ThemeCommands — Class in namespace Drush\Commands\pm

ThemeInstallCommand — Class in namespace Drush\Commands\pm

ThemeUninstallCommand — 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 Consolidation\AnnotatedCommand\Attributes

CommandProcessor::updateFormatterOptions() — Method in class CommandProcessor

Update the FormatterOptions object with validated command options.

UnknownFieldException — Class in namespace Consolidation\OutputFormatters\Exception

Indicates that the requested format does not exist.

UnknownFormatException — Class in namespace Consolidation\OutputFormatters\Exception

Indicates that the requested format does not exist.

UnstructuredData — Class in namespace Consolidation\OutputFormatters\StructuredData

Represents aribtrary unstructured array data where the data to display in --list format comes from the array keys.

UnstructuredInterface — Class in namespace Consolidation\OutputFormatters\StructuredData

UnstructuredInterface is a marker interface that indicates that the data type is unstructured, and has no default conversion to a string.

UnstructuredListData — Class in namespace Consolidation\OutputFormatters\StructuredData

Represents aribtrary unstructured array data where the data to display in --list format comes from the array keys.

UnstructuredDataFieldAccessor — Class in namespace Consolidation\OutputFormatters\Transformations

UnstructuredDataListTransformation — Class in namespace Consolidation\OutputFormatters\Transformations

UnstructuredDataTransformation — Class in namespace Consolidation\OutputFormatters\Transformations

SiteAliasInterface::uri() — Method in class SiteAliasInterface

Get the uri

SiteAliasTrait::uri() — Method in class SiteAliasTrait

Usage — Class in namespace Drush\Attributes

$ BaseBoot#uri — Property in class BaseBoot

$ RunserverCommand#uri — Property in class RunserverCommand

RunserverCommand::uri() — Method in class RunserverCommand

Determine the URI to use for this server.

UpdateDBCommands — Class in namespace Drush\Commands\core

UserCommands — Class in namespace Drush\Commands\core

DeployHookCommand::updateDoOneDeployHook() — Method in class DeployHookCommand

Batch command that executes a single deploy hook.

DeployHookCommand::updateFinished() — Method in class DeployHookCommand

Batch finished callback.

UpdateDBCommand — Class in namespace Drush\Commands\updatedb

UpdateDBCommand::updateCheckRequirements() — Method in class UpdateDBCommand

Log messages for any requirements warnings/errors.

UpdateDBCommand::updateBatch() — Method in class UpdateDBCommand

Start the database update batch process.

UpdateDBCommand::updateDoOne() — Method in class UpdateDBCommand

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

UpdateDBCommand::updateDoOnePostUpdate() — Method in class UpdateDBCommand

Batch command that executes a single post-update.

UpdateDBCommand::updateFinished() — Method in class UpdateDBCommand

Batch finished callback.

UpdateDbBatchProcessCommand — Class in namespace Drush\Commands\updatedb

UpdateDbStatusCommand — Class in namespace Drush\Commands\updatedb

UserBlockCommand — Class in namespace Drush\Commands\user

UserCancelCommand — Class in namespace Drush\Commands\user

UserCreateCommand — Class in namespace Drush\Commands\user

UserInformationCommand — Class in namespace Drush\Commands\user

UserLoginCommand — Class in namespace Drush\Commands\user

UserPasswordCommand — Class in namespace Drush\Commands\user

UserRoleAddCommand — Class in namespace Drush\Commands\user

UserRoleRemoveCommand — Class in namespace Drush\Commands\user

UserTrait — Class in namespace Drush\Commands\user

UserUnblockCommand — Class in namespace Drush\Commands\user

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

CommandProcessor::validateRunAndAlter() — Method in class CommandProcessor

ValidateHookDispatcher — Class in namespace Consolidation\AnnotatedCommand\Hooks\Dispatchers

Call hooks

ValidateHookDispatcher::validate() — Method in class ValidateHookDispatcher

ValidatorInterface — Class in namespace Consolidation\AnnotatedCommand\Hooks

Validate the arguments for the current command.

ValidatorInterface::validate() — Method in class ValidatorInterface

CommandInfo::valid() — Method in class CommandInfo

Return whether or not this method represents a valid command or hook.

$ DefaultsWithDescriptions#values — Property in class DefaultsWithDescriptions

$ DefaultValueFromString#value — Property in class DefaultValueFromString

DefaultValueFromString::value() — Method in class DefaultValueFromString

FormatterManager::validFormats() — Method in class FormatterManager

Return the identifiers for all valid data types that have been registered.

FormatterManager::validateAndRestructure() — Method in class FormatterManager

FormatterManager::validateData() — Method in class FormatterManager

Determine if the provided data is compatible with the formatter being used.

CsvFormatter::validDataTypes() — Method in class CsvFormatter

Return the list of data types acceptable to this formatter

CsvFormatter::validate() — Method in class CsvFormatter

Throw an IncompatibleDataException if the provided data cannot be processed by this formatter. Return the source data if it is valid. The data may be encapsulated or converted if necessary.

NoOutputFormatter::validate() — Method in class NoOutputFormatter

SectionsFormatter::validDataTypes() — Method in class SectionsFormatter

Return the list of data types acceptable to this formatter

SectionsFormatter::validate() — Method in class SectionsFormatter

StringFormatter::validate() — Method in class StringFormatter

Always validate any data, though. This format will never cause an error if it is selected for an incompatible data type; at worse, it simply does not print any data.

TableFormatter::validDataTypes() — Method in class TableFormatter

Return the list of data types acceptable to this formatter

TableFormatter::validate() — Method in class TableFormatter

VarDumpFormatter — Class in namespace Consolidation\OutputFormatters\Formatters

Var_dump formatter

VarDumpFormatter::validate() — Method in class VarDumpFormatter

Throw an IncompatibleDataException if the provided data cannot be processed by this formatter. Return the source data if it is valid. The data may be encapsulated or converted if necessary.

VarExportFormatter — Class in namespace Consolidation\OutputFormatters\Formatters

Var_export formatter

VarExportFormatter::validate() — Method in class VarExportFormatter

Throw an IncompatibleDataException if the provided data cannot be processed by this formatter. Return the source data if it is valid. The data may be encapsulated or converted if necessary.

XmlFormatter::validDataTypes() — Method in class XmlFormatter

Return the list of data types acceptable to this formatter

XmlFormatter::validate() — Method in class XmlFormatter

DomToArraySimplifier::valueCanBeSimplified() — Method in class DomToArraySimplifier

Determine whether the provided value has additional unnecessary nesting. {"color": "red"} is converted to "red". No other simplification is done.

ValidDataTypesInterface — Class in namespace Consolidation\OutputFormatters\Validate

Formatters may implement ValidDataTypesInterface in order to indicate exactly which formats they support. The validDataTypes method can be called to retrieve a list of data types useful in providing hints in exception messages about which data types can be used with the formatter.

ValidDataTypesInterface::validDataTypes() — Method in class ValidDataTypesInterface

Return the list of data types acceptable to this formatter

ValidDataTypesTrait — Class in namespace Consolidation\OutputFormatters\Validate

Provides a default implementation of isValidDataType.

ValidDataTypesTrait::validDataTypes() — Method in class ValidDataTypesTrait

Return the list of data types acceptable to this formatter

ValidationInterface — Class in namespace Consolidation\OutputFormatters\Validate

Formatters may implement ValidationInterface in order to indicate whether a particular data structure is supported. Any formatter that does not implement ValidationInterface is assumed to only operate on arrays, or data types that implement SimplifyToArrayInterface.

ValidationInterface::validate() — Method in class ValidationInterface

Throw an IncompatibleDataException if the provided data cannot be processed by this formatter. Return the source data if it is valid. The data may be encapsulated or converted if necessary.

SiteSpecParser::validSiteSpec() — Method in class SiteSpecParser

Determine if the provided specification is valid. Note that this tests only for syntactic validity; to see if the specification is usable, call 'parse()', which will also filter out specifications for local sites that specify a multidev site that does not exist.

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.

ConfigPullCommand::validateConfigPull() — Method in class ConfigPullCommand

DrupalDependenciesCommands::validateDependentsOfModule() — Method in class DrupalDependenciesCommands

DrupalDependenciesCommands::validateDependentsOfConfig() — Method in class DrupalDependenciesCommands

MigrateRunnerCommands::validateMigrationId() — Method in class MigrateRunnerCommands

Validates a migration ID is valid.

SiteInstallCommand::validate() — Method in class SiteInstallCommand

SiteInstallCommand::validateRecipe() — Method in class SiteInstallCommand

Validates a user provided recipe.

TopicCommands::validate() — Method in class TopicCommands

VersionCommand — Class in namespace Drush\Commands\core

ViewsCommands — Class in namespace Drush\Commands\core

EntityCreateCommand::validate() — Method in class EntityCreateCommand

EntityTypeBundleValidationTrait::validateEntityType() — Method in class EntityTypeBundleValidationTrait

EntityTypeBundleValidationTrait::validateBundle() — Method in class EntityTypeBundleValidationTrait

LocaleExportCommand::validateExport() — Method in class LocaleExportCommand

PmInstallCommand::validateModules() — Method in class PmInstallCommand

PmUninstallCommand::validateUninstall() — Method in class PmUninstallCommand

SqlSyncCommand::validateSync() — Method in class SqlSyncCommand

ViewsDevCommand — Class in namespace Drush\Commands\views

ViewsDisableCommand — Class in namespace Drush\Commands\views

ViewsEnableCommand — Class in namespace Drush\Commands\views

ViewsExecuteCommand — Class in namespace Drush\Commands\views

ViewsListCommand — Class in namespace Drush\Commands\views

$ 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 Composer Runtime, or FALSE if not populated yet.

Drush::verbose() — Method in class Drush

Return 'true' if we are in verbose mode

ValidateConfigNameListener — Class in namespace Drush\Listeners

ValidateEntityLoadListener — Class in namespace Drush\Listeners

ValidateFileExistsListener — Class in namespace Drush\Listeners

ValidateMigrationIdListener — Class in namespace Drush\Listeners

ValidateModulesEnabledListener — Class in namespace Drush\Listeners

ValidatePHPExtensionsListener — Class in namespace Drush\Listeners

ValidatePermissionsListener — Class in namespace Drush\Listeners

ValidateQueueNameListener — Class in namespace Drush\Listeners

$ 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

ResultWriter::writeUsingFormatter() — Method in class ResultWriter

Call the formatter to output the provided data.

ResultWriter::writeErrorMessage() — Method in class ResultWriter

Description

ResultWriter::writeCommandOutput() — Method in class ResultWriter

If the result object is a string, then print it.

FormatterManager::write() — Method in class FormatterManager

Format and write output

CsvFormatter::write() — Method in class CsvFormatter

CsvFormatter::writeOneLine() — Method in class CsvFormatter

Writes a single a single line of formatted CSV data to the output stream.

FormatterInterface::write() — Method in class FormatterInterface

Given structured data, apply appropriate formatting, and return a printable string.

JsonFormatter::write() — Method in class JsonFormatter

ListFormatter::write() — Method in class ListFormatter

MetadataFormatterInterface::writeMetadata() — Method in class MetadataFormatterInterface

Given some metadata, decide how to display it.

MetadataFormatterTrait::writeMetadata() — Method in class MetadataFormatterTrait

NoOutputFormatter::write() — Method in class NoOutputFormatter

PrintRFormatter::write() — Method in class PrintRFormatter

SectionsFormatter::write() — Method in class SectionsFormatter

SerializeFormatter::write() — Method in class SerializeFormatter

StringFormatter::write() — Method in class StringFormatter

TableFormatter::write() — Method in class TableFormatter

TableFormatter::wrap() — Method in class TableFormatter

Wrap the table data

TsvFormatter::writeOneLine() — Method in class TsvFormatter

Writes a single a single line of formatted CSV data to the output stream.

VarDumpFormatter::write() — Method in class VarDumpFormatter

VarExportFormatter::write() — Method in class VarExportFormatter

XmlFormatter::write() — Method in class XmlFormatter

YamlFormatter::write() — Method in class YamlFormatter

$ NumericCellRenderer#widths — Property in class NumericCellRenderer

WordWrapper — Class in namespace Consolidation\OutputFormatters\Transformations

$ WordWrapper#width — Property in class WordWrapper

WordWrapper::wrap() — Method in class WordWrapper

Wrap the cells in each part of the provided data table

WordWrapper::wrapCell() — Method in class WordWrapper

Wrap one cell. Guard against modifying non-strings and then call through to wordwrap().

$ ColumnWidths#widths — Property in class ColumnWidths

ColumnWidths::width() — Method in class ColumnWidths

Return the length of the specified column.

ColumnWidths::widths() — Method in class ColumnWidths

Return all of the lengths

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.

WatchdogCommands — Class in namespace Drush\Commands\core

WorkspacePublishCommand — Class in namespace Drush\Commands\core

$ WorkspacePublishCommand#workspacesOperationFactory — Property in class WorkspacePublishCommand

HelpCLIFormatter::write() — Method in class HelpCLIFormatter

WatchdogDeleteCommand — Class in namespace Drush\Commands\watchdog

WatchdogListCommand — Class in namespace Drush\Commands\watchdog

WatchdogShowCommand — Class in namespace Drush\Commands\watchdog

WatchdogShowOneCommand — Class in namespace Drush\Commands\watchdog

WatchdogTailCommand — Class in namespace Drush\Commands\watchdog

WatchdogTrait — Class in namespace Drush\Commands\watchdog

WatchdogTrait::where() — Method in class WatchdogTrait

Build a WHERE snippet based on given parameters.

FormatterTrait::writeFormattedOutput() — Method in class FormatterTrait

Filter, format, and write to the output

FormatterTrait::wrapFilteredResult() — Method in class FormatterTrait

If the source data was wrapped in a marker class such as RowsOfFields, then re-apply the wrapper.

DrushStyle::warning() — Method in class DrushStyle

X

XmlFormatter — Class in namespace Consolidation\OutputFormatters\Formatters

Display a table of data with the Symfony Table class.

XmlSchema — Class in namespace Consolidation\OutputFormatters\StructuredData\Xml

XmlSchemaInterface — Class in namespace Consolidation\OutputFormatters\StructuredData\Xml

When using arrays, we could represent XML data in a number of different ways.

Y

YamlFormatter — Class in namespace Consolidation\OutputFormatters\Formatters

Yaml formatter

YamlDataFileLoader — Class in namespace Consolidation\SiteAlias\Util

YamlConfigLoader — Class in namespace Drush\Config\Loader

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

_

AnnotatedCommand::__construct() — Method in class AnnotatedCommand

AnnotatedCommandFactory::__construct() — Method in class AnnotatedCommandFactory

Argument::__construct() — Method in class Argument

Command::__construct() — Method in class Command

Complete::__construct() — Method in class Complete

DefaultFields::__construct() — Method in class DefaultFields

DefaultTableFields::__construct() — Method in class DefaultTableFields

FieldLabels::__construct() — Method in class FieldLabels

FilterDefaultField::__construct() — Method in class FilterDefaultField

Help::__construct() — Method in class Help

Hook::__construct() — Method in class Hook

HookSelector::__construct() — Method in class HookSelector

Misc::__construct() — Method in class Misc

Option::__construct() — Method in class Option

Topics::__construct() — Method in class Topics

Usage::__construct() — Method in class Usage

CacheWrapper::__construct() — Method in class CacheWrapper

CommandCreationListener::__construct() — Method in class CommandCreationListener

CommandData::__construct() — Method in class CommandData

CommandError::__construct() — Method in class CommandError

CommandFileDiscovery::__construct() — Method in class CommandFileDiscovery

CommandProcessor::__construct() — Method in class CommandProcessor

CommandResult::__construct() — Method in class CommandResult

HelpCommand::__construct() — Method in class HelpCommand

Create a help document from a Symfony Console command

HelpDocument::__construct() — Method in class HelpDocument

Create a help document from a Symfony Console command

HookDispatcher::__construct() — Method in class HookDispatcher

HookManager::__construct() — Method in class HookManager

AlterOptionsCommandEvent::__construct() — Method in class AlterOptionsCommandEvent

PrepareTerminalWidthOption::__construct() — Method in class PrepareTerminalWidthOption

ParameterInjection::__construct() — Method in class ParameterInjection

CommandInfo::__construct() — Method in class CommandInfo

Create a new CommandInfo class for a particular method of a class.

DefaultsWithDescriptions::__construct() — Method in class DefaultsWithDescriptions

AttributesDocBlockParser::__construct() — Method in class AttributesDocBlockParser

BespokeDocBlockParser::__construct() — Method in class BespokeDocBlockParser

DefaultValueFromString::__construct() — Method in class DefaultValueFromString

DocblockTag::__construct() — Method in class DocblockTag

DockblockTag constructor

DocblockTag::__toString() — Method in class DocblockTag

Convert tag back into a string.

TagFactory::__construct() — Method in class TagFactory

DocblockTag constructor

IncompatibleDataException::__construct() — Method in class IncompatibleDataException

InvalidFormatException::__construct() — Method in class InvalidFormatException

UnknownFieldException::__construct() — Method in class UnknownFieldException

UnknownFormatException::__construct() — Method in class UnknownFormatException

FormatterManager::__construct() — Method in class FormatterManager

TableFormatter::__construct() — Method in class TableFormatter

XmlFormatter::__construct() — Method in class XmlFormatter

FormatterOptions::__construct() — Method in class FormatterOptions

Create a new FormatterOptions with the configuration data and the user-specified options for this request.

AbstractListData::__construct() — Method in class AbstractListData

AbstractStructuredList::__construct() — Method in class AbstractStructuredList

CallableRenderer::__construct() — Method in class CallableRenderer

NumericCellRenderer::__construct() — Method in class NumericCellRenderer

NumericCellRenderer constructor

UnstructuredData::__construct() — Method in class UnstructuredData

UnstructuredListData::__construct() — Method in class UnstructuredListData

XmlSchema::__construct() — Method in class XmlSchema

DomToArraySimplifier::__construct() — Method in class DomToArraySimplifier

TableTransformation::__construct() — Method in class TableTransformation

UnstructuredDataFieldAccessor::__construct() — Method in class UnstructuredDataFieldAccessor

UnstructuredDataListTransformation::__construct() — Method in class UnstructuredDataListTransformation

UnstructuredDataTransformation::__construct() — Method in class UnstructuredDataTransformation

WordWrapper::__construct() — Method in class WordWrapper

CalculateWidths::__construct() — Method in class CalculateWidths

ColumnWidths::__construct() — Method in class ColumnWidths

HostPath::__construct() — Method in class HostPath

HostPath constructor

SiteAlias::__construct() — Method in class SiteAlias

SiteAliasFileDiscovery::__construct() — Method in class SiteAliasFileDiscovery

SiteAliasFileLoader::__construct() — Method in class SiteAliasFileLoader

SiteAliasFileLoader constructor

SiteAliasManager::__construct() — Method in class SiteAliasManager

Constructor for SiteAliasManager

SiteAliasName::__construct() — Method in class SiteAliasName

Creae a SiteAliasName object from an alias name string.

SiteAliasName::__toString() — Method in class SiteAliasName

Convert an alias name back to a string.

SiteAliasWithConfig::__construct() — Method in class SiteAliasWithConfig

Bootstrap::__construct() — Method in class Bootstrap

Format::__construct() — Method in class Format

Formatter::__construct() — Method in class Formatter

HelpLinks::__construct() — Method in class HelpLinks

InteractConfigName::__construct() — Method in class InteractConfigName

Kernel::__construct() — Method in class Kernel

TableFormat::__construct() — Method in class TableFormat

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

ConsoleLink::__construct() — Method in class ConsoleLink

RemoteCommandProxy::__construct() — Method in class RemoteCommandProxy

DrushCommands::__construct() — Method in class DrushCommands

CacheClearCommand::__construct() — Method in class CacheClearCommand

CacheGetCommand::__construct() — Method in class CacheGetCommand

CacheRebuildCommand::__construct() — Method in class CacheRebuildCommand

CacheSetCommand::__construct() — Method in class CacheSetCommand

CacheTagsCommand::__construct() — Method in class CacheTagsCommand

CacheWarmCommand::__construct() — Method in class CacheWarmCommand

ConfigCommands::__construct() — Method in class ConfigCommands

ConfigDeleteCommand::__construct() — Method in class ConfigDeleteCommand

ConfigEditCommand::__construct() — Method in class ConfigEditCommand

ConfigExportCommand::__construct() — Method in class ConfigExportCommand

ConfigGetCommand::__construct() — Method in class ConfigGetCommand

ConfigImportCommand::__construct() — Method in class ConfigImportCommand

ConfigPullCommand::__construct() — Method in class ConfigPullCommand

ConfigSetCommand::__construct() — Method in class ConfigSetCommand

ConfigStatusCommand::__construct() — Method in class ConfigStatusCommand

ArchiveDumpCommand::__construct() — Method in class ArchiveDumpCommand

BatchCommand::__construct() — Method in class BatchCommand

BrowseCommand::__construct() — Method in class BrowseCommand

CliCommand::__construct() — Method in class CliCommand

CoreGlobalOptionsCommand::__construct() — Method in class CoreGlobalOptionsCommand

CronCommand::__construct() — Method in class CronCommand

DrupalDependenciesCommands::__construct() — Method in class DrupalDependenciesCommands

DrupalDirectoryCommand::__construct() — Method in class DrupalDirectoryCommand

EditCommand::__construct() — Method in class EditCommand

ImageDeriveCommand::__construct() — Method in class ImageDeriveCommand

ImageFlushCommand::__construct() — Method in class ImageFlushCommand

JsonapiGetCommand::__construct() — Method in class JsonapiGetCommand

LanguageAddCommand::__construct() — Method in class LanguageAddCommand

LanguageInfoCommand::__construct() — Method in class LanguageInfoCommand

MessengerCommands::__construct() — Method in class MessengerCommands

MigrateRunnerCommands::__construct() — Method in class MigrateRunnerCommands

MkCommands::__construct() — Method in class MkCommands

PhpEvalCommand::__construct() — Method in class PhpEvalCommand

PhpScriptCommand::__construct() — Method in class PhpScriptCommand

RequirementsCommand::__construct() — Method in class RequirementsCommand

RouteCommand::__construct() — Method in class RouteCommand

RsyncCommand::__construct() — Method in class RsyncCommand

RunserverCommand::__construct() — Method in class RunserverCommand

SiteAliasCommand::__construct() — Method in class SiteAliasCommand

SiteInstallCommand::__construct() — Method in class SiteInstallCommand

SiteSetCommand::__construct() — Method in class SiteSetCommand

SshCommand::__construct() — Method in class SshCommand

StatusCommand::__construct() — Method in class StatusCommand

ThemeDevCommand::__construct() — Method in class ThemeDevCommand

TwigCompileCommand::__construct() — Method in class TwigCompileCommand

TwigUnusedCommand::__construct() — Method in class TwigUnusedCommand

VersionCommand::__construct() — Method in class VersionCommand

WorkspacePublishCommand::__construct() — Method in class WorkspacePublishCommand

Constructs a WorkspacesCommands object.

DeployCommand::__construct() — Method in class DeployCommand

DeployHookBatchProcessCommand::__construct() — Method in class DeployHookBatchProcessCommand

DeployHookCommand::__construct() — Method in class DeployHookCommand

DeployHookStatusCommand::__construct() — Method in class DeployHookStatusCommand

DeployTrait::__construct() — Method in class DeployTrait

EntityCreateCommand::__construct() — Method in class EntityCreateCommand

EntityDeleteCommand::__construct() — Method in class EntityDeleteCommand

EntitySaveCommand::__construct() — Method in class EntitySaveCommand

FieldBaseInfoCommand::__construct() — Method in class FieldBaseInfoCommand

FieldBaseOverrideCreateCommand::__construct() — Method in class FieldBaseOverrideCreateCommand

FieldCreateCommand::__construct() — Method in class FieldCreateCommand

FieldDeleteCommand::__construct() — Method in class FieldDeleteCommand

FieldFormattersCommand::__construct() — Method in class FieldFormattersCommand

FieldInfoCommand::__construct() — Method in class FieldInfoCommand

FieldTypesCommand::__construct() — Method in class FieldTypesCommand

FieldWidgetsCommand::__construct() — Method in class FieldWidgetsCommand

ApplicationFactory::__construct() — Method in class ApplicationFactory

GenerateCommand::__construct() — Method in class GenerateCommand

HelpCommand::__construct() — Method in class HelpCommand

ListCommand::__construct() — Method in class ListCommand

LocaleCheckCommand::__construct() — Method in class LocaleCheckCommand

LocaleClearStatusCommand::__construct() — Method in class LocaleClearStatusCommand

LocaleExportCommand::__construct() — Method in class LocaleExportCommand

LocaleImportAllCommand::__construct() — Method in class LocaleImportAllCommand

LocaleImportCommand::__construct() — Method in class LocaleImportCommand

LocaleUpdateCommand::__construct() — Method in class LocaleUpdateCommand

MaintGetCommand::__construct() — Method in class MaintGetCommand

MaintSetCommand::__construct() — Method in class MaintSetCommand

MaintStatusCommand::__construct() — Method in class MaintStatusCommand

MigrateFieldsSourceCommand::__construct() — Method in class MigrateFieldsSourceCommand

MigrateImportCommand::__construct() — Method in class MigrateImportCommand

MigrateMessagesCommand::__construct() — Method in class MigrateMessagesCommand

MigrateResetStatusCommand::__construct() — Method in class MigrateResetStatusCommand

MigrateRollbackCommand::__construct() — Method in class MigrateRollbackCommand

MigrateStatusCommand::__construct() — Method in class MigrateStatusCommand

MigrateStopCommand::__construct() — Method in class MigrateStopCommand

PmInstallCommand::__construct() — Method in class PmInstallCommand

PmListCommand::__construct() — Method in class PmListCommand

PmUninstallCommand::__construct() — Method in class PmUninstallCommand

ThemeInstallCommand::__construct() — Method in class ThemeInstallCommand

ThemeUninstallCommand::__construct() — Method in class ThemeUninstallCommand

QueueDeleteCommand::__construct() — Method in class QueueDeleteCommand

QueueListCommand::__construct() — Method in class QueueListCommand

QueueRunCommand::__construct() — Method in class QueueRunCommand

RoleListCommand::__construct() — Method in class RoleListCommand

RolePermRemoveCommand::__construct() — Method in class RolePermRemoveCommand

SqlCliCommand::__construct() — Method in class SqlCliCommand

SqlConfCommand::__construct() — Method in class SqlConfCommand

SqlCreateCommand::__construct() — Method in class SqlCreateCommand

SqlDumpCommand::__construct() — Method in class SqlDumpCommand

SqlSyncCommand::__construct() — Method in class SqlSyncCommand

SanitizeCommand::__construct() — Method in class SanitizeCommand

StateDeleteCommand::__construct() — Method in class StateDeleteCommand

StateGetCommand::__construct() — Method in class StateGetCommand

StateSetCommand::__construct() — Method in class StateSetCommand

UpdateDBCommand::__construct() — Method in class UpdateDBCommand

Note - can't inject @database since a method below is static.

UpdateDbBatchProcessCommand::__construct() — Method in class UpdateDbBatchProcessCommand

UpdateDbStatusCommand::__construct() — Method in class UpdateDbStatusCommand

UserBlockCommand::__construct() — Method in class UserBlockCommand

UserCancelCommand::__construct() — Method in class UserCancelCommand

UserCreateCommand::__construct() — Method in class UserCreateCommand

UserInformationCommand::__construct() — Method in class UserInformationCommand

UserLoginCommand::__construct() — Method in class UserLoginCommand

UserPasswordCommand::__construct() — Method in class UserPasswordCommand

UserRoleAddCommand::__construct() — Method in class UserRoleAddCommand

UserRoleRemoveCommand::__construct() — Method in class UserRoleRemoveCommand

UserUnblockCommand::__construct() — Method in class UserUnblockCommand

ViewsDevCommand::__construct() — Method in class ViewsDevCommand

ViewsDisableCommand::__construct() — Method in class ViewsDisableCommand

ViewsEnableCommand::__construct() — Method in class ViewsEnableCommand

ViewsExecuteCommand::__construct() — Method in class ViewsExecuteCommand

ViewsListCommand::__construct() — Method in class ViewsListCommand

WatchdogDeleteCommand::__construct() — Method in class WatchdogDeleteCommand

WatchdogListCommand::__construct() — Method in class WatchdogListCommand

WatchdogShowCommand::__construct() — Method in class WatchdogShowCommand

WatchdogShowOneCommand::__construct() — Method in class WatchdogShowOneCommand

WatchdogTailCommand::__construct() — Method in class WatchdogTailCommand

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.

MigrateRunnerHooks::__construct() — Method in class MigrateRunnerHooks

CacheClearEvent::__construct() — Method in class CacheClearEvent

ConsoleDefinitionsEvent::__construct() — Method in class ConsoleDefinitionsEvent

FieldCreateEntityDisplayValuesEvent::__construct() — Method in class FieldCreateEntityDisplayValuesEvent

FieldCreateFieldConfigValuesEvent::__construct() — Method in class FieldCreateFieldConfigValuesEvent

FieldCreateFieldStorageConfigValuesEvent::__construct() — Method in class FieldCreateFieldStorageConfigValuesEvent

FieldCreateInputOptionsEvent::__construct() — Method in class FieldCreateInputOptionsEvent

SanitizeConfirmsEvent::__construct() — Method in class SanitizeConfirmsEvent

CommandFailedException::__construct() — Method in class CommandFailedException

UserAbortException::__construct() — Method in class UserAbortException

EntityToArraySimplifier::__construct() — Method in class EntityToArraySimplifier

BootstrapListener::__construct() — Method in class BootstrapListener

BootstrapListener::__invoke() — Method in class BootstrapListener

Bootstrap command up to the level specified by the #[Bootstrap] attribute.

CreateEntityReferenceFieldListener::__construct() — Method in class CreateEntityReferenceFieldListener

CreateTextFieldListener::__construct() — Method in class CreateTextFieldListener

DrupliconListener::__construct() — Method in class DrupliconListener

FilterDefaultFieldListener::__invoke() — Method in class FilterDefaultFieldListener

FormatterListener::__construct() — Method in class FormatterListener

FormatterListener::__invoke() — Method in class FormatterListener

HelpLinksListener::__invoke() — Method in class HelpLinksListener

MessengerListener::__construct() — Method in class MessengerListener

OptionsetGetEditorListener::__invoke() — Method in class OptionsetGetEditorListener

OptionsetProcBuildListener::__invoke() — Method in class OptionsetProcBuildListener

OptionsetSqlListener::__invoke() — Method in class OptionsetSqlListener

OptionsetSshListener::__invoke() — Method in class OptionsetSshListener

OptionsetTableSelectionListener::__invoke() — Method in class OptionsetTableSelectionListener

ValidateConfigNameListener::__construct() — Method in class ValidateConfigNameListener

ValidateConfigNameListener::__invoke() — Method in class ValidateConfigNameListener

This subscriber operates on commands which put #[ValidateConfigName] on the class.

ValidateEntityLoadListener::__construct() — Method in class ValidateEntityLoadListener

ValidateEntityLoadListener::__invoke() — Method in class ValidateEntityLoadListener

This subscriber affects commands which put #[ValidateEntityLoad] on the class.

ValidateFileExistsListener::__construct() — Method in class ValidateFileExistsListener

ValidateFileExistsListener::__invoke() — Method in class ValidateFileExistsListener

This subscriber affects commands which put #[ValidateFileExists] on the class.

ValidateMigrationIdListener::__construct() — Method in class ValidateMigrationIdListener

ValidateMigrationIdListener::__invoke() — Method in class ValidateMigrationIdListener

This subscriber affects commands which put #[ValidateMigrationId] on the class.

ValidateModulesEnabledListener::__construct() — Method in class ValidateModulesEnabledListener

ValidateModulesEnabledListener::__invoke() — Method in class ValidateModulesEnabledListener

This subscriber affects commands which put #[ValidateModulesEnabled] on the class.

ValidatePHPExtensionsListener::__construct() — Method in class ValidatePHPExtensionsListener

ValidatePHPExtensionsListener::__invoke() — Method in class ValidatePHPExtensionsListener

This subscriber affects commands which put #[ValidatePhpExtensions] on the class.

ValidatePermissionsListener::__construct() — Method in class ValidatePermissionsListener

ValidatePermissionsListener::__invoke() — Method in class ValidatePermissionsListener

This subscriber affects commands which put #[ValidatePermissionsListener] on the class.

ValidateQueueNameListener::__construct() — Method in class ValidateQueueNameListener

ValidateQueueNameListener::__invoke() — Method in class ValidateQueueNameListener

This subscriber affects commands which put #[ValidateQueueName] on the class.

SanitizeCommentsListener::__construct() — Method in class SanitizeCommentsListener

SanitizeSessionsListener::__construct() — Method in class SanitizeSessionsListener

SanitizeUserFieldsListener::__construct() — Method in class SanitizeUserFieldsListener

SanitizeUserTableListener::__construct() — Method in class SanitizeUserTableListener

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.

ConfiguresPrompts::__construct() — Method in class ConfiguresPrompts

LegacyServiceFinder::__construct() — Method in class LegacyServiceFinder

LegacyServiceInstantiator::__construct() — Method in class LegacyServiceInstantiator

RedispatchHook::__construct() — Method in class RedispatchHook

RelativeNamespaceDiscovery::__construct() — Method in class RelativeNamespaceDiscovery

Runtime::__construct() — Method in class Runtime

ServiceManager::__construct() — Method in class ServiceManager

SiteAliasFileLoader::__construct() — Method in class SiteAliasFileLoader

SiteAliasFileLoader constructor

SqlBase::__construct() — Method in class SqlBase

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

CliTestTrait::_escapeshellargWindows() — Method in class CliTestTrait