• 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

Argument — Class in namespace Drush\Attributes

BootstrapManager::add() — Method in class BootstrapManager

Add a bootstrap object to the list of candidates.

DrupalBoot8::addDrupalModuleDrushCommands() — Method in class DrupalBoot8

Kernels::availableKernels() — Method in class Kernels

Returns the available kernels.

DrushCommandInfoAlterer::alterCommandInfo() — Method in class DrushCommandInfoAlterer

ServiceCommandlist::addCommandReference() — Method in class ServiceCommandlist

AutowireTrait — Class in namespace Drush\Commands

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

ExampleCommands::alterFormatters() — Method in class ExampleCommands

Demonstrate an alter hook with an option.

LegacyCommands::archiveRestore() — Method in class LegacyCommands

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

ArchiveDumpCommands — Class in namespace Drush\Commands\core

LanguageCommands::add() — Method in class LanguageCommands

LinkHooks::askLinkType() — Method in class LinkHooks

LinkHooks::askAllowLinkText() — Method in class LinkHooks

MkCommands::appendPostAmble() — Method in class MkCommands

MkCommands::appendAliases() — Method in class MkCommands

MkCommands::appendTopics() — Method in class MkCommands

MkCommands::appendOptions() — Method in class MkCommands

MkCommands::appendOptionsGlobal() — Method in class MkCommands

MkCommands::appendArguments() — Method in class MkCommands

MkCommands::appendUsages() — Method in class MkCommands

MkCommands::appendPreamble() — Method in class MkCommands

MkCommands::argToArray() — Method in class MkCommands

Build an array since that's what HelpCLIFormatter expects.

StatusCommands::adjustStatusOptions() — Method in class StatusCommands

UserCommands::addRole() — Method in class UserCommands

Add a role to the specified user accounts.

ViewsCommands::analyze() — Method in class ViewsCommands

Get a list of all Views and analyze warnings.

EntityTypeBundleAskTrait::askEntityType() — Method in class EntityTypeBundleAskTrait

EntityTypeBundleAskTrait::askBundle() — Method in class EntityTypeBundleAskTrait

FieldBaseOverrideCreateCommands::askFieldName() — Method in class FieldBaseOverrideCreateCommands

FieldBaseOverrideCreateCommands::askFieldLabel() — Method in class FieldBaseOverrideCreateCommands

FieldBaseOverrideCreateCommands::askFieldDescription() — Method in class FieldBaseOverrideCreateCommands

FieldBaseOverrideCreateCommands::askRequired() — Method in class FieldBaseOverrideCreateCommands

FieldCreateCommands::askExistingFieldName() — Method in class FieldCreateCommands

FieldCreateCommands::askFieldName() — Method in class FieldCreateCommands

FieldCreateCommands::askFieldLabel() — Method in class FieldCreateCommands

FieldCreateCommands::askFieldDescription() — Method in class FieldCreateCommands

FieldCreateCommands::askFieldType() — Method in class FieldCreateCommands

FieldCreateCommands::askFieldWidget() — Method in class FieldCreateCommands

FieldCreateCommands::askRequired() — Method in class FieldCreateCommands

FieldCreateCommands::askTranslatable() — Method in class FieldCreateCommands

FieldCreateCommands::askCardinality() — Method in class FieldCreateCommands

FieldDeleteCommands::askExisting() — Method in class FieldDeleteCommands

FieldDeleteCommands::askBundle() — Method in class FieldDeleteCommands

FieldEntityReferenceHooks::askReferencedEntityType() — Method in class FieldEntityReferenceHooks

FieldEntityReferenceHooks::askReferencedBundles() — Method in class FieldEntityReferenceHooks

FieldTextHooks::askAllowedFormats() — Method in class FieldTextHooks

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

ApplicationFactory — Class in namespace Drush\Commands\generate

ApplicationFactory::alterGenerators() — Method in class ApplicationFactory

Implements hook GeneratorInfoAlter.

PmCommands::addInstallDependencies() — Method in class PmCommands

PmCommands::addUninstallDependencies() — Method in class PmCommands

SanitizeCommentsCommands::applies() — Method in class SanitizeCommentsCommands

ConfigLocator::addToSources() — Method in class ConfigLocator

Accumulate the sources provided by the configuration loader.

ConfigLocator::addEnvironment() — Method in class ConfigLocator

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

ConfigLocator::addPreflightConfigFiles() — Method in class ConfigLocator

Add config paths defined in preflight configuration.

ConfigLocator::addAliasConfig() — Method in class ConfigLocator

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

ConfigLocator::addUserConfig() — Method in class ConfigLocator

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

ConfigLocator::addDrushConfig() — Method in class ConfigLocator

Add the Drush project directory as a configuration search location.

ConfigLocator::addSitewideConfig() — Method in class ConfigLocator

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

ConfigLocator::addConfigPaths() — Method in class ConfigLocator

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

ConfigLocator::addConfigFiles() — Method in class ConfigLocator

Adds $configFiles to the list of config files.

ConfigLocator::addSiteSpecificConfig() — Method in class ConfigLocator

Attempt to load site specific configuration.

Environment::applyEnvironment() — Method in class Environment

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

$ 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

ArgsPreprocessor — Class in namespace Drush\Preflight

Preprocess commandline arguments.

ArgsRemapper — Class in namespace Drush\Preflight

Map commandline arguments from one value to another during preflight.

$ Preflight#aliasManager — Property in class Preflight

Preflight::aliasManager() — Method in class Preflight

$ PreflightArgs#args — Property in class PreflightArgs

PreflightArgs::adjustHelpOption() — Method in class PreflightArgs

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

PreflightArgs::applyToConfig() — Method in class PreflightArgs

PreflightArgs::args() — Method in class PreflightArgs

PreflightArgs::applicationPath() — Method in class PreflightArgs

PreflightArgs::addArg() — Method in class PreflightArgs

PreflightArgs::alias() — Method in class PreflightArgs

PreflightArgs::addConfigPath() — Method in class PreflightArgs

Add another location where drush.yml files may be found

PreflightArgs::aliasPaths() — Method in class PreflightArgs

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

PreflightArgs::addAliasPath() — Method in class PreflightArgs

Set one more path where aliases may be found.

PreflightArgs::addCommandPath() — Method in class PreflightArgs

Add one more path where commandfiles might be found.

PreflightArgsInterface::applyToConfig() — Method in class PreflightArgsInterface

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

PreflightArgsInterface::args() — Method in class PreflightArgsInterface

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

PreflightArgsInterface::applicationPath() — Method in class PreflightArgsInterface

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

PreflightArgsInterface::addArg() — Method in class PreflightArgsInterface

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

PreflightArgsInterface::alias() — Method in class PreflightArgsInterface

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

DependencyInjection::addDrushServices() — Method in class DependencyInjection

DependencyInjection::alterServicesForDrush() — Method in class DependencyInjection

LegacyServiceFinder::addModuleDrushServiceProvider() — Method in class LegacyServiceFinder

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

LegacyServiceFinder::addDrushServiceProvider() — Method in class LegacyServiceFinder

Add a services.yml file if it exists.

LegacyServiceInstantiator::allServicesHaveClassElement() — Method in class LegacyServiceInstantiator

Check all elements for required "class" elements.

LegacyServiceInstantiator::atLeastOneValue() — Method in class LegacyServiceInstantiator

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

RedispatchHook::alterArgsForRedispatch() — Method in class RedispatchHook

Remove anything that is not necessary for the remote side.

SqlBase::addPipeFail() — Method in class SqlBase

Handle 'pipefail' option for the specified command.

SqlBase::alwaysQuery() — Method in class SqlBase

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

SqlBase::alwaysQueryCommand() — Method in class SqlBase

Start building the command to run a query.

CliTestTrait::assertOutputEquals() — Method in class CliTestTrait

Checks that the output matches the expected output.

CliTestTrait::assertErrorOutputEquals() — Method in class CliTestTrait

Checks that the error output matches the expected output.

Application — Class in namespace Robo

Application::addInitRoboFileCommand() — Method in class Application

Application::addSelfUpdateCommand() — Method in class Application

Add self update command, do nothing if null is provided

AbstractClassDiscovery — Class in namespace Robo\ClassDiscovery

Class AbstractClassDiscovery

Collection::add() — Method in class Collection

Add a task or a list of tasks to our task collection. Each task will run via its 'run()' method once (and if) all of the tasks added before it complete successfully. If the task also implements RollbackInterface, then it will be rolled back via its 'rollback()' method ONLY if its 'run()' method completes successfully, and some task added after it fails.

Collection::addCode() — Method in class Collection

Add arbitrary code to execute as a task.

Collection::addIterable() — Method in class Collection

Add arbitrary code that will be called once for every item in the provided array or iterable object. If the function result of the provided callback is a TaskInterface or Collection, then it will be executed.

Collection::after() — Method in class Collection

Add a task after an existing named task.

Collection::addBeforeOrAfter() — Method in class Collection

Add either a 'before' or 'after' function or task.

Collection::addTaskList() — Method in class Collection

Add a list of tasks to our task collection.

Collection::addToTaskList() — Method in class Collection

Add the provided task to our task list.

Collection::addCollectionElementToTaskList() — Method in class Collection

CollectionBuilder::addTask() — Method in class CollectionBuilder

CollectionBuilder::addCode() — Method in class CollectionBuilder

Add arbitrary code to execute as a task.

CollectionBuilder::addTaskList() — Method in class CollectionBuilder

Add a list of tasks to our task collection.

CollectionBuilder::addTaskToCollection() — Method in class CollectionBuilder

Called by the factory method of each task; adds the current task to the task builder.

CollectionInterface::add() — Method in class CollectionInterface

Add a task or a list of tasks to our task collection. Each task will run via its 'run()' method once (and if) all of the tasks added before it complete successfully. If the task also implements RollbackInterface, then it will be rolled back via its 'rollback()' method ONLY if its 'run()' method completes successfully, and some task added after it fails.

CollectionInterface::addCode() — Method in class CollectionInterface

Add arbitrary code to execute as a task.

CollectionInterface::addIterable() — Method in class CollectionInterface

Add arbitrary code that will be called once for every item in the provided array or iterable object. If the function result of the provided callback is a TaskInterface or Collection, then it will be executed.

CollectionInterface::after() — Method in class CollectionInterface

Add a task after an existing named task.

$ Element#after — Property in class Element

Element::after() — Method in class Element

$ CommandArguments#arguments — Property in class CommandArguments

CommandArguments::arg() — Method in class CommandArguments

Pass argument to executable. Its value will be automatically escaped.

CommandArguments::args() — Method in class CommandArguments

Pass methods parameters as arguments to executable. Argument values are automatically escaped.

$ ProgressIndicator#autoDisplayInterval — Property in class ProgressIndicator

ProgressIndicator::autoShowProgressIndicator() — Method in class ProgressIndicator

ProgressIndicator::advanceProgressIndicator() — Method in class ProgressIndicator

ProgressIndicator::advanceProgressIndicatorCachedSteps() — Method in class ProgressIndicator

ProgressIndicatorAwareTrait::advanceProgressIndicator() — Method in class ProgressIndicatorAwareTrait

AbortTasksException — Class in namespace Robo\Exception

By default, rollbacks and completions tasks or callbacks continue even if errors occur. If you would like to explicitly cancel or abort the rollback or completion, you may throw this exception to abort the subsequent tasks in the rollback or completion task list.

$ GlobalOptionsEventListener#application — Property in class GlobalOptionsEventListener

GlobalOptionsEventListener::applicationOptionDefaultValues() — Method in class GlobalOptionsEventListener

Get default option values from the Symfony Console application, if it is available.

Result::accumulate() — Method in class Result

Add the results from the most recent task to the accumulated results from all tasks that have run so far, merging data as necessary.

ResultData::alreadyPrinted() — Method in class ResultData

Indicate that the message in this data has already been displayed.

Robo::addShared() — Method in class Robo

Adds a shared instance to the container. This is to support 3.x and 4.x of league/container.

Robo::addInflectors() — Method in class Robo

Add the Robo League\Container inflectors to the container

Robo::application() — Method in class Robo

Runner::arraySearchBeginsWith() — Method in class Runner

Runner::arraySearchBeginsWith() — Method in class Runner

Data::accumulateExecutionTime() — Method in class Data

Accumulate execution time

Data::accumulateMessage() — Method in class Data

Accumulate the message.

ApiGen — Class in namespace Robo\Task\ApiGen

Executes ApiGen command to generate documentation

ApiGen::args() — Method in class ApiGen

Pass methods parameters as arguments to executable. Argument values are automatically escaped.

ApiGen::asList() — Method in class ApiGen

ApiGen::asTextBool() — Method in class ApiGen

ApiGen::allowedHtml() — Method in class ApiGen

ApiGen::autocomplete() — Method in class ApiGen

ApiGen::accessLevels() — Method in class ApiGen

Extract::archiveType() — Method in class Extract

Pack::archiveFile() — Method in class Pack

Pack::addFile() — Method in class Pack

Add an item to the archive. Like file_exists(), the parameter may be a file or a directory.

Pack::addDir() — Method in class Pack

Alias for addFile, in case anyone has angst about using addFile with a directory.

Pack::add() — Method in class Pack

Add a file or directory, or list of same to the archive.

Pack::archiveTar() — Method in class Pack

Pack::archiveZip() — Method in class Pack

Pack::addItemsToZip() — Method in class Pack

CssPreprocessor::addImportPath() — Method in class CssPreprocessor

Adds import directory

ImageMinify::advpng() — Method in class ImageMinify

SymfonyCommand::arg() — Method in class SymfonyCommand

$ Base#action — Property in class Base

Base::allowRoot() — Method in class Base

adds allow-root option to bower

$ Install#action — Property in class Install

{@inheritdoc}

$ Update#action — Property in class Update

{@inheritdoc}

$ Base#ansi — Property in class Base

$ Base#action — Property in class Base

Action to use

Base::ansi() — Method in class Base

adds ansi option to composer

$ CheckPlatformReqs#action — Property in class CheckPlatformReqs

{@inheritdoc}

$ Config#action — Property in class Config

{@inheritdoc}

$ CreateProject#action — Property in class CreateProject

{@inheritdoc}

$ DumpAutoload#action — Property in class DumpAutoload

{@inheritdoc}

$ Init#action — Property in class Init

{@inheritdoc}

Init::author() — Method in class Init

$ Install#action — Property in class Install

{@inheritdoc}

$ Remove#action — Property in class Remove

{@inheritdoc}

$ RequireDependency#action — Property in class RequireDependency

{@inheritdoc}

$ Update#action — Property in class Update

{@inheritdoc}

$ Validate#action — Property in class Validate

{@inheritdoc}

$ Changelog#anchor — Property in class Changelog

Changelog::anchor() — Method in class Changelog

$ GenerateMarkdownDoc#append — Property in class GenerateMarkdownDoc

GenerateMarkdownDoc::append() — Method in class GenerateMarkdownDoc

Inserts text at the end of markdown file.

$ GitHub#accessToken — Property in class GitHub

GitHub::accessToken() — Method in class GitHub

GitHubRelease::appendDescription() — Method in class GitHubRelease

PackPhar::addStripped() — Method in class PackPhar

PackPhar::addFile() — Method in class PackPhar

PackPhar::addFiles() — Method in class PackPhar

$ Write#append — Property in class Write

Write::append() — Method in class Write

Write::appendIfMatches() — Method in class Write

Append the provided text to the end of the buffer if the provided regex pattern matches any text already in the buffer.

Write::appendUnlessMatches() — Method in class Write

Append the provided text to the end of the buffer unless the provided regex pattern matches any text already in the buffer.

Write::appendIfMatchesCollect() — Method in class Write

$ Base#action — Property in class Base

$ Install#action — Property in class Install

{@inheritdoc}

$ Update#action — Property in class Update

{@inheritdoc}

Rsync::archive() — Method in class Rsync

StackBasedTask::addToCommandStack() — Method in class StackBasedTask

Record a function to call later.

Atoum — Class in namespace Robo\Task\Testing

Runs atoum tests

Atoum::addMultipleOption() — Method in class Atoum

GitStack::add() — Method in class GitStack

Executes git add command with files to add pattern

HgStack::add() — Method in class HgStack

Executes hg add command with files to add by pattern

SvnStack::add() — Method in class SvnStack

Executes svn add command with files to add pattern

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.

$ BootstrapHook#bootstrapManager — Property in class BootstrapHook

BootstrapManager — Class in namespace Drush\Boot

$ BootstrapManager#bootstrapCandidates — Property in class BootstrapManager

$ BootstrapManager#bootstrap — Property in class BootstrapManager

BootstrapManager::bootstrap() — Method in class BootstrapManager

Crete the bootstrap object if necessary, then return it.

BootstrapManager::bootstrapObjectForRoot() — Method in class BootstrapManager

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

BootstrapManager::bootstrapPhases() — Method in class BootstrapManager

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

BootstrapManager::bootstrapValidate() — Method in class BootstrapManager

Validate whether a bootstrap phase can be reached.

BootstrapManager::bootstrapToPhase() — Method in class BootstrapManager

Bootstrap to the specified phase.

BootstrapManager::bootstrapToPhaseIndex() — Method in class BootstrapManager

Bootstrap to the specified phase.

BootstrapManager::bootstrapMax() — Method in class BootstrapManager

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

DrupalBoot::bootstrapPhases() — Method in class DrupalBoot

Bootstrap phases used with Drupal:

DrupalBoot::bootstrapPhaseMap() — Method in class DrupalBoot

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

DrupalBoot::bootstrapDrupalRootValidate() — Method in class DrupalBoot

Validate the DRUSH_BOOTSTRAP_DRUPAL_ROOT phase.

DrupalBoot::bootstrapDrupalRoot() — Method in class DrupalBoot

Bootstrap Drush with a valid Drupal Directory.

DrupalBoot::bootstrapDrupalCore() — Method in class DrupalBoot

DrupalBoot::bootstrapDrupalSiteValidate() — Method in class DrupalBoot

VALIDATE the DRUSH_BOOTSTRAP_DRUPAL_SITE phase.

DrupalBoot::bootstrapDrupalConfiguration() — Method in class DrupalBoot

Initialize and load the Drupal configuration files.

DrupalBoot::bootstrapDrupalDatabaseValidate() — Method in class DrupalBoot

Validate the DRUSH_BOOTSTRAP_DRUPAL_DATABASE phase

DrupalBoot::bootstrapDrupalDatabase() — Method in class DrupalBoot

Bootstrap the Drupal database.

DrupalBoot::bootstrapDrupalFull() — Method in class DrupalBoot

Attempt to load the full Drupal system.

DrupalBoot8::bootstrapDrupalSiteValidate() — Method in class DrupalBoot8

VALIDATE the DRUSH_BOOTSTRAP_DRUPAL_SITE phase.

DrupalBoot8::bootstrapDoDrupalSite() — Method in class DrupalBoot8

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

DrupalBoot8::bootstrapDrupalConfigurationValidate() — Method in class DrupalBoot8

DrupalBoot8::bootstrapDrupalDatabaseValidate() — Method in class DrupalBoot8

Validate the DRUSH_BOOTSTRAP_DRUPAL_DATABASE phase

DrupalBoot8::bootstrapDrupalDatabase() — Method in class DrupalBoot8

Bootstrap the Drupal database.

DrupalBoot8::bootstrapDrupalConfiguration() — Method in class DrupalBoot8

Initialize and load the Drupal configuration files.

DrupalBoot8::bootstrapDrupalFull() — Method in class DrupalBoot8

Attempt to load the full Drupal system.

DrupalBoot8::bootstrapDrupalSite() — Method in class DrupalBoot8

Initialize a site on the Drupal root.

EmptyBoot::bootstrapPhases() — Method in class EmptyBoot

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

EmptyBoot::bootstrapInitPhases() — Method in class EmptyBoot

BatchCommands — Class in namespace Drush\Commands\core

BrowseCommands — Class in namespace Drush\Commands\core

BrowseCommands::browse() — Method in class BrowseCommands

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

DocsCommands::bisect() — Method in class DocsCommands

Drush docs for Git Bisect.

DocsCommands::bootstrap() — Method in class DocsCommands

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

DrupalDependenciesCommands::buildTree() — Method in class DrupalDependenciesCommands

Builds the nested dependency tree.

DrupalDependenciesCommands::buildDependents() — Method in class DrupalDependenciesCommands

Build the reverse the relation: dependent -> dependencies.

EditCommands::bashFiles() — Method in class EditCommands

UserCommands::block() — Method in class UserCommands

Block the specified user(s).

FieldBaseOverrideCreateCommands::baseOverrideCreateField() — Method in class FieldBaseOverrideCreateCommands

Create a new base field override

ListCommands::buildDom() — Method in class ListCommands

Drush::bootstrapManager() — Method in class Drush

Return the Bootstrap Manager.

Drush::bootstrap() — Method in class Drush

Return the Bootstrap object.

PreflightSiteLocator::buildSelf() — Method in class PreflightSiteLocator

Generate @self from the provided root and URI.

DrushCommand::buildHelpFromCommand() — Method in class DrushCommand

Build a command help from the Drush configuration array.

$ ServiceManager#bootstrapCommandClasses — Property in class ServiceManager

ServiceManager::bootstrapCommandClasses() — Method in class ServiceManager

Return cached of deferred commandhander objects.

ServiceManager::bootStrapAttributeValue() — Method in class ServiceManager

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

BootstrapCompilerPass — Class in namespace Drush\Symfony

CliTestTrait::buildProcessMessage() — Method in class CliTestTrait

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

Collection::before() — Method in class Collection

Add a task before an existing named task.

CollectionBuilder::build() — Method in class CollectionBuilder

Construct the desired task and add it to this builder.

CollectionInterface::before() — Method in class CollectionInterface

Add a task before an existing named task.

$ Element#before — Property in class Element

Element::before() — Method in class Element

BuilderAwareTrait — Class in namespace Robo\Common

$ BuilderAwareTrait#builder — Property in class BuilderAwareTrait

$ ExecTrait#background — Property in class ExecTrait

ExecTrait::background() — Method in class ExecTrait

Executes command in background mode (asynchronously)

BuilderAwareInterface — Class in namespace Robo\Contract

ApiGen::baseUrl() — Method in class ApiGen

BaseTask — Class in namespace Robo\Task

Exec::background() — Method in class Exec

Executes command in background mode (asynchronously)

$ Watch#bindTo — Property in class Watch

Base — Class in namespace Robo\Task\Bower

Base — Class in namespace Robo\Task\Composer

$ Base#built — Property in class Base

Base::buildCommand() — Method in class Base

Copy class fields into command options as directed.

CreateProject::buildCommand() — Method in class CreateProject

Copy class fields into command options as directed.

$ Changelog#body — Property in class Changelog

$ PackPhar#bin — Property in class PackPhar

Base — Class in namespace Robo\Task\Docker

Build — Class in namespace Robo\Task\Docker

Builds Docker image

$ Build#buildKit — Property in class Build

BaseDir — Class in namespace Robo\Task\Filesystem

$ TmpDir#base — Property in class TmpDir

Base — Class in namespace Robo\Task\Gulp

BaseLogfile — Class in namespace Robo\Task\Logfile

Base — Class in namespace Robo\Task\Npm

Atoum::bootstrap() — Method in class Atoum

Path to the bootstrap file.

Behat — Class in namespace Robo\Task\Testing

Executes Behat tests

PHPUnit::bootstrap() — Method in class PHPUnit

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.

$ ServiceCommandlist#commandList — Property in class ServiceCommandlist

AutowireTrait::create() — Method in class AutowireTrait

Instantiates a new instance of the implementing class using autowiring.

ConfiguresPrompts — Class in namespace Drush\Commands

ConfiguresPrompts::configurePrompts() — Method in class ConfiguresPrompts

Configure the prompt fallbacks.

$ DrushCommands#commandData — Property in class DrushCommands

ConfigCommands — Class in namespace Drush\Commands\config

ConfigCommands::configChangesTable() — Method in class ConfigCommands

Build a table of config changes.

ConfigCommands::configComplete() — Method in class ConfigCommands

ConfigCommands::copyConfig() — Method in class ConfigCommands

Copies configuration objects from source storage to target storage.

ConfigExportCommands — Class in namespace Drush\Commands\config

$ ConfigExportCommands#configStorageSync — Property in class ConfigExportCommands

$ ConfigExportCommands#configStorageExport — Property in class ConfigExportCommands

ConfigExportCommands::create() — Method in class ConfigExportCommands

ConfigImportCommands — Class in namespace Drush\Commands\config

$ ConfigImportCommands#configStorageSync — Property in class ConfigImportCommands

ConfigImportCommands::create() — Method in class ConfigImportCommands

ConfigPullCommands — Class in namespace Drush\Commands\config

ArchiveDumpCommands::convertSymlinks() — Method in class ArchiveDumpCommands

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

CacheCommands — Class in namespace Drush\Commands\core

CacheCommands::clear() — Method in class CacheCommands

Clear a specific cache, or all Drupal caches.

CacheCommands::clearDrush() — Method in class CacheCommands

Clear caches internal to Drush core.

CacheCommands::clearBins() — Method in class CacheCommands

Clear one or more cache bins.

CacheCommands::clearThemeRegistry() — Method in class CacheCommands

CacheCommands::clearRouter() — Method in class CacheCommands

CacheCommands::clearCssJs() — Method in class CacheCommands

CacheCommands::clearContainer() — Method in class CacheCommands

CacheCommands::clearRender() — Method in class CacheCommands

Clears the render cache entries.

CacheCommands::clearPlugin() — Method in class CacheCommands

CacheRebuildCommands — Class in namespace Drush\Commands\core

CacheWarmCommands — Class in namespace Drush\Commands\core

CacheWarmCommands::create() — Method in class CacheWarmCommands

CliCommands — Class in namespace Drush\Commands\core

CliCommands::cli() — Method in class CliCommands

Open an interactive shell on a Drupal site.

CliCommands::createShortClassForEntityClass() — Method in class CliCommands

CoreCommands — Class in namespace Drush\Commands\core

DeployCommands::cacheRebuild() — Method in class DeployCommands

DocsCommands::config() — Method in class DocsCommands

Drush configuration.

DocsCommands::configExport() — Method in class DocsCommands

Drupal config export instructions, including customizing config by environment.

DocsCommands::cron() — Method in class DocsCommands

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

DocsCommands::commands() — Method in class DocsCommands

Instructions on creating your own Drush commands.

DrupalCommands::cron() — Method in class DrupalCommands

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

DrupalDependenciesCommands::create() — Method in class DrupalDependenciesCommands

EditCommands::create() — Method in class EditCommands

Not using Autowire in order to implicitly test backward compat.

EditCommands::complete() — Method in class EditCommands

EntityCreateCommands::createEntity() — Method in class EntityCreateCommands

Create a content entity after prompting for field values.

LocaleCommands::check() — Method in class LocaleCommands

Checks for available translation updates.

LocaleCommands::clearStatus() — Method in class LocaleCommands

Clears the translation status.

MkCommands::createAnnotatedCommands() — Method in class MkCommands

Convert generators into Annotated commands (for Help).

MkCommands::cliTextToMarkdown() — Method in class MkCommands

Convert text like foo to foo.

RoleCommands::createRole() — Method in class RoleCommands

Create a new role.

StatusCommands::createEarly() — Method in class StatusCommands

Not using Autowire in order to implicitly test backward compat.

UpdateDBCommands::cacheRebuild() — Method in class UpdateDBCommands

Clears caches and rebuilds the container.

UserCommands::createUser() — Method in class UserCommands

Create a user account.

UserCommands::createValidate() — Method in class UserCommands

Assure that provided username is available.

UserCommands::cancel() — Method in class UserCommands

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

ViewsCommands::cacheClear() — Method in class ViewsCommands

Adds a cache clear option for views.

FieldBaseInfoCommands::complete() — Method in class FieldBaseInfoCommands

FieldBaseOverrideCreateCommands::complete() — Method in class FieldBaseOverrideCreateCommands

FieldBaseOverrideCreateCommands::createBaseFieldOverride() — Method in class FieldBaseOverrideCreateCommands

$ FieldCreateCommands#contentTranslationManager — Property in class FieldCreateCommands

FieldCreateCommands::create() — Method in class FieldCreateCommands

FieldCreateCommands::complete() — Method in class FieldCreateCommands

FieldCreateCommands::createField() — Method in class FieldCreateCommands

FieldCreateCommands::createFieldStorage() — Method in class FieldCreateCommands

FieldCreateCommands::createFieldDisplay() — Method in class FieldCreateCommands

FieldDefinitionCommands::complete() — Method in class FieldDefinitionCommands

FieldDeleteCommands::complete() — Method in class FieldDeleteCommands

FieldInfoCommands::complete() — Method in class FieldInfoCommands

ApplicationFactory::create() — Method in class ApplicationFactory

Creates Drush generate application.

GenerateCommands::create() — Method in class GenerateCommands

HelpCLIFormatter::cleanOptions() — Method in class HelpCLIFormatter

ListCommands::categorize() — Method in class ListCommands

SqlCommands::conf() — Method in class SqlCommands

SqlCommands::connect() — Method in class SqlCommands

A string for connecting to the DB.

SqlCommands::createDb() — Method in class SqlCommands

Create a database.

SqlCommands::cli() — Method in class SqlCommands

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

ConfigAwareTrait — Class in namespace Drush\Config

ConfigLocator — Class in namespace Drush\Config

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

$ ConfigLocator#config — Property in class ConfigLocator

$ ConfigLocator#composerRoot — Property in class ConfigLocator

$ ConfigLocator#configFilePaths — Property in class ConfigLocator

$ ConfigLocator#configFileVariant — Property in class ConfigLocator

ConfigLocator::collectSources() — Method in class ConfigLocator

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

ConfigLocator::configFilePaths() — Method in class ConfigLocator

Return a list of all configuration files that were loaded.

ConfigLocator::config() — Method in class ConfigLocator

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

DrushConfig::cwd() — Method in class DrushConfig

DrushConfig::configPaths() — Method in class DrushConfig

Return the list of paths to active Drush configuration files.

$ Environment#configFileVariant — Property in class Environment

Environment::cwd() — Method in class Environment

The original working directory

Environment::calculateColumns() — Method in class Environment

Get terminal width.

$ MigrateExecutable#counter — Property in class MigrateExecutable

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

Drush::commandFactory() — Method in class Drush

Return command factory

Drush::config() — Method in class Drush

Return the configuration object

CommandFailedException — Class in namespace Drush\Exceptions

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

EntityToArraySimplifier::canSimplify() — Method in class EntityToArraySimplifier

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

ArgsPreprocessor::checkMatchingOption() — Method in class ArgsPreprocessor

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

ArgsRemapper::checkRemap() — Method in class ArgsRemapper

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

$ Preflight#configLocator — Property in class Preflight

Preflight::createInput() — Method in class Preflight

Preflight::config() — Method in class Preflight

$ PreflightArgs#commandName — Property in class PreflightArgs

PreflightArgs::commandName() — Method in class PreflightArgs

PreflightArgs::configPaths() — Method in class PreflightArgs

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

PreflightArgs::commandPaths() — Method in class PreflightArgs

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

PreflightArgs::coverageFile() — Method in class PreflightArgs

Get the path to the coverage file.

PreflightArgs::createInput() — Method in class PreflightArgs

Create a Symfony Input object.

PreflightArgsInterface::commandName() — Method in class PreflightArgsInterface

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

PreflightVerify::confirmPhpVersion() — Method in class PreflightVerify

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

PreflightVerify::confirmUsingCLI() — Method in class PreflightVerify

Fail if not being run from the command line.

PreflightVerify::checkPhpIni() — Method in class PreflightVerify

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

Caster — Class in namespace Drush\Psysh

Caster class for VarDumper casters for the shell.

Caster::castContentEntity() — Method in class Caster

Casts \Drupal\Core\Entity\ContentEntityInterface classes.

Caster::castFieldItemList() — Method in class Caster

Casts \Drupal\Core\Field\FieldItemListInterface classes.

Caster::castFieldItem() — Method in class Caster

Casts \Drupal\Core\Field\FieldItemInterface classes.

Caster::castConfigEntity() — Method in class Caster

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

Caster::castConfig() — Method in class Caster

Casts \Drupal\Core\Config\ConfigBase classes.

Caster::castContainer() — Method in class Caster

Casts \Drupal\Component\DependencyInjection\Container classes.

Caster::castMarkup() — Method in class Caster

Casts \Drupal\Component\Render\MarkupInterface classes.

DrushCommand::configure() — Method in class DrushCommand

{@inheritdoc}

DrushHelpCommand::configure() — Method in class DrushHelpCommand

{@inheritdoc}

LegacyServiceInstantiator::create() — Method in class LegacyServiceInstantiator

Create one named service.

LegacyServiceInstantiator::call() — Method in class LegacyServiceInstantiator

Call a method of an object with the provided arguments.

ProcessManager::configureProcess() — Method in class ProcessManager

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

SqlBase::create() — Method in class SqlBase

Get a driver specific instance of this class.

SqlBase::command() — Method in class SqlBase

The unix command used to connect to the database.

SqlBase::connect() — Method in class SqlBase

A string for connecting to a database.

SqlBase::createdbSql() — Method in class SqlBase

Build a SQL string for dropping and creating a database.

SqlBase::createdb() — Method in class SqlBase

Create a new database.

SqlBase::creds() — Method in class SqlBase

Build a string containing connection credentials.

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.

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.

ClassDiscoveryInterface — Class in namespace Robo\ClassDiscovery

Interface ClassDiscoveryInterface

$ RelativeNamespaceDiscovery#classLoader — Property in class RelativeNamespaceDiscovery

RelativeNamespaceDiscovery::convertPathToNamespace() — Method in class RelativeNamespaceDiscovery

RelativeNamespaceDiscovery::convertNamespaceToPath() — Method in class RelativeNamespaceDiscovery

CallableTask — Class in namespace Robo\Collection

Creates a task wrapper that converts any Callable into an object that can be used directly with a task collection.

Collection — Class in namespace Robo\Collection

Group tasks into a collection that run together. Supports rollback operations for handling error conditions.

$ Collection#completionStack — Property in class Collection

Collection::completion() — Method in class Collection

Add a completion task to our task collection. A completion task will execute EITHER after all tasks succeed, OR immediatley after any task fails. Completion tasks never cause errors to be returned from Collection::run(), even if they fail.

Collection::completionCode() — Method in class Collection

Add arbitrary code to execute as a completion.

Collection::complete() — Method in class Collection

Force the completion functions to run

CollectionBuilder — Class in namespace Robo\Collection

Creates a collection, and adds tasks to it. The collection builder offers a streamlined chained-initialization mechanism for easily creating task groups. Facilities for creating working and temporary directories are also provided.

$ CollectionBuilder#commandFile — Property in class CollectionBuilder

$ CollectionBuilder#collection — Property in class CollectionBuilder

$ CollectionBuilder#currentTask — Property in class CollectionBuilder

CollectionBuilder::create() — Method in class CollectionBuilder

CollectionBuilder::completion() — Method in class CollectionBuilder

CollectionBuilder::completionCode() — Method in class CollectionBuilder

CollectionBuilder::callCollectionStateFunction() — Method in class CollectionBuilder

CollectionBuilder::callCollectionStateFuntion() — Method in class CollectionBuilder

CollectionBuilder::configureTask() — Method in class CollectionBuilder

Check to see if there are any setter methods defined in configuration for this task.

CollectionInterface — Class in namespace Robo\Collection

CollectionInterface::completion() — Method in class CollectionInterface

Add a completion task to our task collection. A completion task will execute EITHER after all tasks succeed, OR immediatley after any task fails. Completion tasks never cause errors to be returned from Collection::run(), even if they fail.

CollectionInterface::completionCode() — Method in class CollectionInterface

Add arbitrary code to execute as a completion.

CollectionProcessHook — Class in namespace Robo\Collection

The collection process hook is added to the annotation command hook manager in Runner::configureContainer(). This hook will be called every time a command runs. If the command result is a \Robo\Contract\TaskInterface (in particular, \Robo\Collection\Collection), then we run the collection, and return the result. We ignore results of any other type.

CompletionWrapper — Class in namespace Robo\Collection

Creates a task wrapper that will manage rollback and collection management to a task when it runs. Tasks are automatically wrapped in a CompletionWrapper when added to a task collection.

$ TaskForEach#countingStack — Property in class TaskForEach

$ TaskForEach#context — Property in class TaskForEach

TaskForEach::call() — Method in class TaskForEach

Temporary::complete() — Method in class Temporary

Call the complete method of all of the registered objects.

BuilderAwareTrait::collectionBuilder() — Method in class BuilderAwareTrait

CommandArguments — Class in namespace Robo\Common

Use this to add arguments and options to the $arguments property.

CommandReceiver — Class in namespace Robo\Common

This task can receive commands from task implementing CommandInterface.

ConfigAwareTrait — Class in namespace Robo\Common

$ ConfigAwareTrait#config — Property in class ConfigAwareTrait

ConfigAwareTrait::configPrefix() — Method in class ConfigAwareTrait

Any class that uses ConfigAwareTrait SHOULD override this method , and define a prefix for its configuration items. This is usually done in a base class. When used, this method should return a string that ends with a "."; see BaseTask::configPrefix().

ConfigAwareTrait::configClassIdentifier() — Method in class ConfigAwareTrait

ConfigAwareTrait::configPostfix() — Method in class ConfigAwareTrait

ConfigAwareTrait::configure() — Method in class ConfigAwareTrait

IO::currentState() — Method in class IO

ProcessExecutor::create() — Method in class ProcessExecutor

$ ProgressIndicator#cachedSteps — Property in class ProgressIndicator

ProgressIndicator::cleanup() — Method in class ProgressIndicator

ResourceExistenceChecker::checkResources() — Method in class ResourceExistenceChecker

Checks if the given input is a file or folder.

ResourceExistenceChecker::checkResource() — Method in class ResourceExistenceChecker

Checks a single resource, file or directory.

ResourceExistenceChecker::checkSourceAndTargetResource() — Method in class ResourceExistenceChecker

Convenience method to check the often uses "source => target" file / folder arrays.

Config — Class in namespace Robo

Config — Class in namespace Robo\Config

Config::combine() — Method in class Config

{@inheritdoc}

CommandInterface — Class in namespace Robo\Contract

Task that implements this interface can be injected as a parameter for other task.

CompletionInterface — Class in namespace Robo\Contract

Any Robo tasks that implements this interface will be called when the task collection it is added to completes.

CompletionInterface::complete() — Method in class CompletionInterface

Revert an operation that can be rolled back

ConfigAwareInterface — Class in namespace Robo\Contract

Result::cloneTask() — Method in class Result

ResultData::cancelled() — Method in class ResultData

$ Robo#container — Property in class Robo

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

Robo::createConfiguration() — Method in class Robo

Create a config object and load it from the provided paths.

Robo::createContainer() — Method in class Robo

Create a container for Robo application.

Robo::createDefaultContainer() — Method in class Robo

Create a container and initiailze it. If you wish to change anything defined in the container, then you should call Robo::createContainer() and Robo::finalizeContainer() instead of this function.

Robo::configureContainer() — Method in class Robo

Initialize a container with all of the default Robo services.

Robo::createDefaultApplication() — Method in class Robo

Robo::config() — Method in class Robo

$ Runner#configFilename — Property in class Runner

Filename to load configuration from (set to 'robo.yml' for RoboFiles).

$ Runner#classLoader — Property in class Runner

$ Runner#configFilename — Property in class Runner

Filename to load configuration from (set to 'robo.yml' for RoboFiles).

$ Runner#classLoader — Property in class Runner

Consumer — Class in namespace Robo\State

ConsoleIO — Class in namespace Robo\Symfony

ConsoleIOInjector — Class in namespace Robo\Symfony

$ ApiGen#command — Property in class ApiGen

ApiGen::config() — Method in class ApiGen

ApiGen::charset() — Method in class ApiGen

ApiGen::colors() — Method in class ApiGen

CssPreprocessor — Class in namespace Robo\Task\Assets

$ CssPreprocessor#compiler — Property in class CssPreprocessor

Default compiler to use.

$ CssPreprocessor#compilers — Property in class CssPreprocessor

Available compilers list

$ CssPreprocessor#compilerOptions — Property in class CssPreprocessor

Compiler options.

CssPreprocessor::compiler() — Method in class CssPreprocessor

Sets the compiler.

CssPreprocessor::compile() — Method in class CssPreprocessor

Compiles file

ImageMinify::camelCase() — Method in class ImageMinify

$ Less#compilers — Property in class Less

$ Scss#compilers — Property in class Scss

BaseTask::configPrefix() — Method in class BaseTask

ConfigAwareInterface uses this to decide where configuration items come from. Default is this prefix + class name + key, e.g. task.Remote.Ssh.remoteDir.

BaseTask::configPostfix() — Method in class BaseTask

ConfigAwareInterface uses this to decide where configuration items come from. Default is this prefix + class name + key, e.g. task.Ssh.remoteDir.

$ Exec#command — Property in class Exec

$ SymfonyCommand#command — Property in class SymfonyCommand

$ Watch#closure — Property in class Watch

$ Base#command — Property in class Base

CommandStack — Class in namespace Robo\Task

$ Base#command — Property in class Base

CheckPlatformReqs — Class in namespace Robo\Task\Composer

Composer Check Platform Requirements

Config — Class in namespace Robo\Task\Composer

Composer Config

CreateProject — Class in namespace Robo\Task\Composer

Composer CreateProject

Changelog — Class in namespace Robo\Task\Development

Helps to manage changelog file.

Changelog::changes() — Method in class Changelog

Changelog::change() — Method in class Changelog

$ GenerateTask#className — Property in class GenerateTask

$ GitHubRelease#changes — Property in class GitHubRelease

$ GitHubRelease#comittish — Property in class GitHubRelease

GitHubRelease::comittish() — Method in class GitHubRelease

GitHubRelease::changes() — Method in class GitHubRelease

GitHubRelease::change() — Method in class GitHubRelease

$ PackPhar#compileDir — Property in class PackPhar

$ PackPhar#compress — Property in class PackPhar

PackPhar::compress() — Method in class PackPhar

$ PhpServer#command — Property in class PhpServer

{@inheritdoc}

$ Base#command — Property in class Base

Commit — Class in namespace Robo\Task\Docker

Commits docker container to an image

$ Commit#command — Property in class Commit

$ Commit#cid — Property in class Commit

$ Exec#command — Property in class Exec

$ Exec#cid — Property in class Exec

$ Run#cidFile — Property in class Run

Run::containerWorkdir() — Method in class Run

$ Start#command — Property in class Start

$ Start#cid — Property in class Start

$ Stop#command — Property in class Stop

$ Stop#cid — Property in class Stop

Concat — Class in namespace Robo\Task\File

Merges files into one. Used for preparing assets.

TmpFile::complete() — Method in class TmpFile

Delete this file when our collection completes.

CleanDir — Class in namespace Robo\Task\Filesystem

Deletes all files from specified dir, ignoring git files.

CopyDir — Class in namespace Robo\Task\Filesystem

Copies one dir into another

$ CopyDir#chmod — Property in class CopyDir

CopyDir::copyDir() — Method in class CopyDir

Copies a directory to another location.

FilesystemStack::crossVolumeRename() — Method in class FilesystemStack

FilesystemStack::copy() — Method in class FilesystemStack

FilesystemStack::chmod() — Method in class FilesystemStack

FilesystemStack::chgrp() — Method in class FilesystemStack

FilesystemStack::chown() — Method in class FilesystemStack

$ FlattenDir#chmod — Property in class FlattenDir

FlattenDir::copyFiles() — Method in class FlattenDir

$ TmpDir#cwd — Property in class TmpDir

TmpDir::cwd() — Method in class TmpDir

Flag that we should cwd to the temporary directory when it is created, and restore the old working directory when it is deleted.

TmpDir::complete() — Method in class TmpDir

Delete this directory when our collection completes.

WorkDir::complete() — Method in class WorkDir

Move our working directory into its final destination once the collection it belongs to completes.

$ Base#command — Property in class Base

Base::color() — Method in class Base

adds --color option to gulp

$ BaseLogfile#chmod — Property in class BaseLogfile

BaseLogfile::chmod() — Method in class BaseLogfile

$ Base#command — Property in class Base

$ Rsync#command — Property in class Rsync

Rsync::checksum() — Method in class Rsync

Rsync::compress() — Method in class Rsync

$ Simulator#constructorParameters — Property in class Simulator

Simulator::convertParameter() — Method in class Simulator

StackBasedTask::callTaskMethod() — Method in class StackBasedTask

Execute one task method

$ Atoum#command — Property in class Atoum

Atoum::configFile() — Method in class Atoum

Path to the config file.

$ Behat#command — Property in class Behat

Behat::config() — Method in class Behat

Behat::colors() — Method in class Behat

Codecept — Class in namespace Robo\Task\Testing

Executes Codeception tests

$ Codecept#command — Property in class Codecept

Codecept::configFile() — Method in class Codecept

provides config file other then default codeception.yml with -c option

Codecept::coverage() — Method in class Codecept

collect codecoverage in raw format. You may pass name of cov file to save results

Codecept::coverageXml() — Method in class Codecept

collect code coverage in xml format. You may pass name of xml file to save results

Codecept::coverageHtml() — Method in class Codecept

collect code coverage and generate html report. You may pass

$ PHPUnit#command — Property in class PHPUnit

PHPUnit::configFile() — Method in class PHPUnit

$ Phpspec#command — Property in class Phpspec

Phpspec::config() — Method in class Phpspec

GitStack::cloneRepo() — Method in class GitStack

Executes git clone

GitStack::cloneShallow() — Method in class GitStack

Executes git clone with depth 1 as default

GitStack::commit() — Method in class GitStack

Executes git commit command with a message

GitStack::checkout() — Method in class GitStack

Executes git checkout command

HgStack::cloneRepo() — Method in class HgStack

Executes hg clone

HgStack::commit() — Method in class HgStack

Executes hg commit command with a message

SvnStack::commit() — Method in class SvnStack

Executes svn commit command with a message

SvnStack::checkout() — Method in class SvnStack

Executes svn checkout command

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.

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

ConfigCommands::delete() — Method in class ConfigCommands

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

ConfigExportCommands::doExport() — Method in class ConfigExportCommands

ConfigExportCommands::doAddCommit() — Method in class ConfigExportCommands

ConfigImportCommands::doImport() — Method in class ConfigImportCommands

ArchiveDumpCommands::dump() — Method in class ArchiveDumpCommands

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

CliCommands::docs() — Method in class CliCommands

Drush's PHP Shell.

DeployCommands — Class in namespace Drush\Commands\core

DeployCommands::deploy() — Method in class DeployCommands

Run several commands after performing a code deployment.

DeployHookCommands — Class in namespace Drush\Commands\core

DocsCommands — Class in namespace Drush\Commands\core

Topic commands.

DocsCommands::deploy() — Method in class DocsCommands

Deploy command for Drupal.

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

DrupalDirectoryCommands — Class in namespace Drush\Commands\core

DrupalDirectoryCommands::drupalDirectory() — Method in class DrupalDirectoryCommands

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

DrupliconCommands — Class in namespace Drush\Commands\core

DrupliconCommands::druplicon() — Method in class DrupliconCommands

Print druplicon as post-command output.

EntityCommands::delete() — Method in class EntityCommands

Delete content entities.

EntityCommands::doDelete() — Method in class EntityCommands

Actual delete method.

EntityCommands::doSave() — Method in class EntityCommands

Actual save method.

ImageCommands::derive() — Method in class ImageCommands

Create an image derivative.

MkCommands::docs() — Method in class MkCommands

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

QueueCommands::delete() — Method in class QueueCommands

Delete all items in a specific queue.

RoleCommands::delete() — Method in class RoleCommands

Delete a role.

SiteInstallCommands::determineRecipeOrProfile() — Method in class SiteInstallCommands

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

SiteInstallCommands::determineProfile() — Method in class SiteInstallCommands

StateCommands::delete() — Method in class StateCommands

Delete a state entry.

ViewsCommands::dev() — Method in class ViewsCommands

Set several Views settings to more developer-oriented values.

ViewsCommands::disable() — Method in class ViewsCommands

Disable the specified views.

WatchdogCommands::delete() — Method in class WatchdogCommands

Delete watchdog log records.

FieldDeleteCommands::delete() — Method in class FieldDeleteCommands

Delete a field

FieldDeleteCommands::deleteFieldConfig() — Method in class FieldDeleteCommands

ApplicationFactory::discover() — Method in class ApplicationFactory

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

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

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

DrushHelpDocument — Class in namespace Drush\Commands\help

SqlCommands::drop() — Method in class SqlCommands

Drop all tables in a given database.

SqlCommands::dump() — Method in class SqlCommands

Exports the Drupal DB as SQL using mysqldump or equivalent.

SqlSyncCommands::databaseName() — Method in class SqlSyncCommands

SqlSyncCommands::dump() — Method in class SqlSyncCommands

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

DrushConfig — Class in namespace Drush\Config

Accessors for common Drush config keys.

DrushConfig::drushScript() — Method in class DrushConfig

Return the path to this Drush

$ Environment#drushBasePath — Property in class Environment

$ Environment#docPrefix — Property in class Environment

Environment::drushBasePath() — Method in class Environment

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

Environment::docsPath() — Method in class Environment

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

DrushDrupalFinder — Class in namespace Drush\DrupalFinder

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

DrupalKernel — Class in namespace Drush\Drupal

Overridden version of DrupalKernel adapted to the needs of Drush.

DrupalUtil — Class in namespace Drush\Drupal

DrupalUtil::drushRender() — Method in class DrupalUtil

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

DrushLoggerServiceProvider — Class in namespace Drush\Drupal

$ MigrateExecutable#deleteCounter — Property in class MigrateExecutable

Counter of map deletions.

$ MigrateExecutable#deleteMissingSourceRows — Property in class MigrateExecutable

Whether to delete rows missing from source after an import.

$ MigrateIdMapFilter#destinationIdList — Property in class MigrateIdMapFilter

List of specific destination IDs to filter on.

MigrateMessage::display() — Method in class MigrateMessage

Outputs a message from the migration.

$ MigrateMissingSourceRowsEvent#destinationIds — Property in class MigrateMissingSourceRowsEvent

Values representing the destination IDs.

Drush — Class in namespace Drush

Static Service Container wrapper.

Drush::drush() — Method in class Drush

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

Drush::debug() — Method in class Drush

Return 'true' if we are in debug mode

DrushFormatterManager — Class in namespace Drush\Formatters

Our own output formatter

DrushLog — Class in namespace Drush\Log

Redirects Drupal logging messages to Drush log.

DrushLoggerManager — Class in namespace Drush\Log

$ Preflight#drupalFinder — Property in class Preflight

Preflight::drupalFinder() — Method in class Preflight

$ PreflightLog#debug — Property in class PreflightLog

PreflightSiteLocator::determineSelf() — Method in class PreflightSiteLocator

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

DrushCommand — Class in namespace Drush\Psysh

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

DrushHelpCommand — Class in namespace Drush\Psysh

Help command.

DependencyInjection — Class in namespace Drush\Runtime

Prepare our Dependency Injection Container

DependencyInjection::desiredHandlers() — Method in class DependencyInjection

$ LegacyServiceFinder#drushServiceYamls — Property in class LegacyServiceFinder

LegacyServiceFinder::discoverDrushServiceProviders() — Method in class LegacyServiceFinder

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

Runtime::doRun() — Method in class Runtime

Start up Drush

ServiceManager::discover() — Method in class ServiceManager

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

ServiceManager::discoverCommandsFromConfiguration() — Method in class ServiceManager

Discover commands explicitly declared in configuration.

ServiceManager::discoverCommands() — Method in class ServiceManager

Discovers command classes from a provided search path.

ServiceManager::discoverPsr4Commands() — Method in class ServiceManager

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

ServiceManager::discoverPsr4Generators() — Method in class ServiceManager

Discover PSR-4 autoloaded classes that implement DCG generators.

ServiceManager::discoverModuleCommands() — Method in class ServiceManager

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

ServiceManager::discoverModuleCommandInfoAlterers() — Method in class ServiceManager

Discover command info alterers in modules.

ServiceManager::discoverModuleGenerators() — Method in class ServiceManager

Return generators that ship in modules.

$ ProcessManager#drupalFinder — Property in class ProcessManager

ProcessManager::drush() — Method in class ProcessManager

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

ProcessManager::drushSiteProcess() — Method in class ProcessManager

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

ProcessManager::drushScript() — Method in class ProcessManager

Determine the path to Drush to use

SqlBase::dump() — Method in class SqlBase

SqlBase::dumpCmd() — Method in class SqlBase

SqlBase::dumpFile() — Method in class SqlBase

SqlBase::drop() — Method in class SqlBase

Drop specified database.

SqlBase::dropOrCreate() — Method in class SqlBase

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

SqlBase::dbExists() — Method in class SqlBase

SqlBase::dbSpecFromDbUrl() — Method in class SqlBase

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

SqlMariaDB::dumpProgram() — Method in class SqlMariaDB

SqlMysql::dumpProgram() — Method in class SqlMysql

SqlMysql::dbExists() — Method in class SqlMysql

SqlMysql::dumpCmd() — Method in class SqlMysql

SqlPgsql::drop() — Method in class SqlPgsql

Drop specified database.

SqlPgsql::dbExists() — Method in class SqlPgsql

SqlPgsql::dumpCmd() — Method in class SqlPgsql

SqlSqlite::dbExists() — Method in class SqlSqlite

SqlSqlite::drop() — Method in class SqlSqlite

Drop specified database.

SqlSqlite::dumpCmd() — Method in class SqlSqlite

DrushStyleInjector — Class in namespace Drush\Symfony

DrushTestTrait — Class in namespace Drush\TestTraits

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

DrushTestTrait::drush() — Method in class DrushTestTrait

Invoke drush in via execute().

DrushTestTrait::drushMajorVersion() — Method in class DrushTestTrait

Return the major version of Drush

$ Collection#deferredCallbacks — Property in class Collection

Collection::doStateUpdates() — Method in class Collection

Collection::deferTaskConfiguration() — Method in class Collection

Collection::defer() — Method in class Collection

Defer execution of a callback function until just before a task runs. Use this time to provide more settings for the task, e.g. from the collection's shared state, which is populated with the results of previous test runs.

Collection::doDeferredInitialization() — Method in class Collection

CollectionBuilder::deferTaskConfiguration() — Method in class CollectionBuilder

CollectionBuilder::defer() — Method in class CollectionBuilder

DynamicParams — Class in namespace Robo\Common

Simplifies generating of configuration chanined methods.

ExecTrait::detectInteractive() — Method in class ExecTrait

Sets $this->interactive() based on posix_isatty().

ExecTrait::dir() — Method in class ExecTrait

Changes working directory of command

ProgressIndicator::disableProgressIndicator() — Method in class ProgressIndicator

Erase progress indicator and ensure it never returns. Used only during error handlers or to permanently remove the progress bar.

ProgressIndicatorAwareTrait::disableProgressIndicator() — Method in class ProgressIndicatorAwareTrait

ProgressIndicatorAwareTrait::detatchProgressIndicator() — Method in class ProgressIndicatorAwareTrait

$ Config#defaults — Property in class Config

$ Runner#dir — Property in class Runner

Working dir of Robo.

Runner::discoverCommandClasses() — Method in class Runner

$ Runner#dir — Property in class Runner

Working dir of Robo.

Runner::discoverCommandClasses() — Method in class Runner

Data — Class in namespace Robo\State

A State\Data object contains a "message" (the primary result) and a data array (the persistent state). The message is transient, and does not move into the persistent state unless explicitly copied there.

ConsoleIO::decorationCharacter() — Method in class ConsoleIO

ApiGen::destination() — Method in class ApiGen

ApiGen::deprecated() — Method in class ApiGen

ApiGen::download() — Method in class ApiGen

ApiGen::debug() — Method in class ApiGen

$ ImageMinify#dirs — Property in class ImageMinify

Array of the source files.

$ Minify#dst — Property in class Minify

$ Base#dev — Property in class Base

Base::dev() — Method in class Base

adds dev option to composer

Base::disablePlugins() — Method in class Base

disable plugins

Config::disableRepository() — Method in class Config

DumpAutoload — Class in namespace Robo\Task\Composer

Composer Dump Autoload

Init::description() — Method in class Init

Init::dependency() — Method in class Init

'require' is a keyword, so it cannot be a method name.

Remove::dependency() — Method in class Remove

'remove' is a keyword, so it cannot be a method name.

Remove::dev() — Method in class Remove

RequireDependency::dependency() — Method in class RequireDependency

'require' is a keyword, so it cannot be a method name.

$ GenerateMarkdownDoc#docClass — Property in class GenerateMarkdownDoc

GenerateMarkdownDoc::docClass() — Method in class GenerateMarkdownDoc

Put a class you want to be documented.

GenerateMarkdownDoc::documentClass() — Method in class GenerateMarkdownDoc

GenerateMarkdownDoc::documentClassSignature() — Method in class GenerateMarkdownDoc

GenerateMarkdownDoc::documentClassDocBlock() — Method in class GenerateMarkdownDoc

GenerateMarkdownDoc::documentMethod() — Method in class GenerateMarkdownDoc

GenerateMarkdownDoc::documentProperty() — Method in class GenerateMarkdownDoc

GenerateMarkdownDoc::documentPropertySignature() — Method in class GenerateMarkdownDoc

GenerateMarkdownDoc::documentPropertyDocBlock() — Method in class GenerateMarkdownDoc

GenerateMarkdownDoc::documentParam() — Method in class GenerateMarkdownDoc

GenerateMarkdownDoc::documentMethodSignature() — Method in class GenerateMarkdownDoc

GenerateMarkdownDoc::documentMethodDocBlock() — Method in class GenerateMarkdownDoc

GenerateMarkdownDoc::documentMethodParametersAndReturnType() — Method in class GenerateMarkdownDoc

$ GitHubRelease#description — Property in class GitHubRelease

$ GitHubRelease#draft — Property in class GitHubRelease

GitHubRelease::draft() — Method in class GitHubRelease

GitHubRelease::description() — Method in class GitHubRelease

PhpServer::dir() — Method in class PhpServer

SemVer::dump() — Method in class SemVer

Exec::detached() — Method in class Exec

$ Run#dir — Property in class Run

Run::detached() — Method in class Run

$ Concat#dst — Property in class Concat

$ BaseDir#dirs — Property in class BaseDir

CopyDir::dirPermissions() — Method in class CopyDir

Sets the default folder permissions for the destination if it doesn't exist

DeleteDir — Class in namespace Robo\Task\Filesystem

Deletes dir

FlattenDir::dirPermissions() — Method in class FlattenDir

Sets the default folder permissions for the destination if it does not exist.

TmpDir::deleteTmpDir() — Method in class TmpDir

Rsync::delete() — Method in class Rsync

Rsync::dryRun() — Method in class Rsync

Atoum::debug() — Method in class Atoum

Use atoum's debug mode.

Atoum::directories() — Method in class Atoum

Test directory or directories to run.

Codecept::debug() — Method in class Codecept

PHPUnit::debug() — Method in class PHPUnit

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

ExampleCommands — Class in namespace Drush\Commands

ExampleCommands::exampleTable() — Method in class ExampleCommands

Demonstrate output formatters. Default format is 'table'.

ConfigCommands::edit() — Method in class ConfigCommands

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

ConfigExportCommands::export() — Method in class ConfigExportCommands

Export Drupal configuration to a directory.

DocsCommands::exampleCommand() — Method in class DocsCommands

Example Drush command file.

EditCommands — Class in namespace Drush\Commands\core

EditCommands::edit() — Method in class EditCommands

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

EntityCommands — Class in namespace Drush\Commands\core

EntityCreateCommands — Class in namespace Drush\Commands\core

LocaleCommands::export() — Method in class LocaleCommands

Exports to a gettext translation file.

LocaleCommands::exportValidate() — Method in class LocaleCommands

Assure that required options are set.

MigrateRunnerCommands::executeMigration() — Method in class MigrateRunnerCommands

Executes a single migration.

PhpCommands::evaluate() — Method in class PhpCommands

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

ViewsCommands::execute() — Method in class ViewsCommands

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

ViewsCommands::enable() — Method in class ViewsCommands

Enable the specified views.

EntityTypeBundleAskTrait — Class in namespace Drush\Commands\field

$ EntityTypeBundleAskTrait#entityTypeBundleInfo — Property in class EntityTypeBundleAskTrait

$ EntityTypeBundleAskTrait#entityTypeManager — Property in class EntityTypeBundleAskTrait

EntityTypeBundleValidationTrait — Class in namespace Drush\Commands\field

$ EntityTypeBundleValidationTrait#entityTypeManager — Property in class EntityTypeBundleValidationTrait

FieldCreateCommands::ensureOption() — Method in class FieldCreateCommands

PmCommands::extensionStatus() — Method in class PmCommands

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

ConfigLocator::expandCandidates() — Method in class ConfigLocator

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

Environment — Class in namespace Drush\Config

Store information about the environment

$ Environment#etcPrefix — Property in class Environment

Environment::exportConfigData() — Method in class Environment

Convert the environment object into an exported configuration array.

ExtensionDiscovery — Class in namespace Drush\Drupal

$ MigrateExecutable#exposeProgressBar — Property in class MigrateExecutable

If the execution exposes a progress bar.

ExecTrait — Class in namespace Drush\Exec

EntityToArraySimplifier — Class in namespace Drush\Formatters

Simplify a EntityInterface to an array.

$ Preflight#environment — Property in class Preflight

Preflight::environment() — Method in class Preflight

DrushCommand::execute() — Method in class DrushCommand

{@inheritdoc}

DrushHelpCommand::execute() — Method in class DrushHelpCommand

{@inheritdoc}

ErrorHandler — Class in namespace Drush\Runtime

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

ErrorHandler::errorHandler() — Method in class ErrorHandler

RedispatchHook::exitEarly() — Method in class RedispatchHook

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

Runtime::exitCode() — Method in class Runtime

Get the exit code for current request.

SqlTableSelectionTrait::expandAndFilterTables() — Method in class SqlTableSelectionTrait

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

SqlTableSelectionTrait::expandWildcardTables() — Method in class SqlTableSelectionTrait

Expand wildcard tables.

CliTestTrait::execute() — Method in class CliTestTrait

Actually runs the command.

CliTestTrait::escapeshellarg() — Method in class CliTestTrait

Element — Class in namespace Robo\Collection

One element in a collection. Each element consists of a task all of its before tasks, and all of its after tasks.

CommandArguments::escape() — Method in class CommandArguments

Escape the provided value, unless it contains only alphanumeric plus a few other basic characters.

ExecCommand — Class in namespace Robo\Common

This task is supposed to be executed as shell command.

$ ExecCommand#execTimer — Property in class ExecCommand

ExecCommand::executeCommand() — Method in class ExecCommand

ExecOneCommand — Class in namespace Robo\Common

This task specifies exactly one shell command.

ExecTrait — Class in namespace Robo\Common

Class ExecTrait

$ ExecTrait#env — Property in class ExecTrait

ExecTrait::env() — Method in class ExecTrait

Set a single environment variable, or multiple.

ExecTrait::envVars() — Method in class ExecTrait

Sets the environment variables for the command

ExecTrait::execute() — Method in class ExecTrait

ProcessUtils::escapeArgument() — Method in class ProcessUtils

Escapes a string to be used as a shell argument.

TimeKeeper::elapsed() — Method in class TimeKeeper

Result::ensureResult() — Method in class Result

Tasks should always return a Result. However, they are also allowed to return NULL or an array to indicate success.

Result::errorMissingExtension() — Method in class Result

Result::errorMissingPackage() — Method in class Result

Result::error() — Method in class Result

$ ResultData#exitCode — Property in class ResultData

$ Runner#errorConditions — Property in class Runner

$ Runner#envConfigPrefix — Property in class Runner

Runner::errorCondition() — Method in class Runner

Runner::execute() — Method in class Runner

$ Runner#errorConditions — Property in class Runner

$ Runner#envConfigPrefix — Property in class Runner

Runner::errorCondition() — Method in class Runner

Runner::execute() — Method in class Runner

ApiGen::extensions() — Method in class ApiGen

ApiGen::exclude() — Method in class ApiGen

Extract — Class in namespace Robo\Task\Archive

Extracts an archive.

Extract::extractAppropriateType() — Method in class Extract

Extract::extractZip() — Method in class Extract

Extract::extractTar() — Method in class Extract

Pack::exclude() — Method in class Pack

Allow files or folder to be excluded from the archive. Use regex, without enclosing slashes.

$ ImageMinify#executableTargetDir — Property in class ImageMinify

Target directory for the downloaded binary executables.

$ ImageMinify#executablePaths — Property in class ImageMinify

Array for the downloaded binary executables.

ImageMinify::executeCommand() — Method in class ImageMinify

Exec — Class in namespace Robo\Task\Base

Executes shell script. Closes it when running in background mode.

ExecStack — Class in namespace Robo\Task\Base

Execute commands one by one in stack.

$ CommandStack#executable — Property in class CommandStack

$ CommandStack#exec — Property in class CommandStack

CommandStack::executable() — Method in class CommandStack

CommandStack::exec() — Method in class CommandStack

Config::enableRepository() — Method in class Config

PackPhar::executable() — Method in class PackPhar

Build::enableBuildKit() — Method in class Build

Exec — Class in namespace Robo\Task\Docker

Executes command inside running Docker container

Exec::exec() — Method in class Exec

Run::exec() — Method in class Run

Run::envVars() — Method in class Run

Set environment variables.

CleanDir::emptyDir() — Method in class CleanDir

$ CopyDir#exclude — Property in class CopyDir

Files to exclude on copying.

CopyDir::exclude() — Method in class CopyDir

List files to exclude.

CopyDir::excluded() — Method in class CopyDir

Check to see if the current item is excluded.

Rsync::excludeVcs() — Method in class Rsync

Excludes .git, .svn and .hg items at any depth.

Rsync::exclude() — Method in class Rsync

Rsync::excludeFrom() — Method in class Rsync

$ Ssh#exec — Property in class Ssh

Ssh::exec() — Method in class Ssh

Codecept::excludeGroup() — Method in class Codecept

Codecept::env() — Method in class Codecept

PHPUnit::excludeGroup() — Method in class PHPUnit

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

BaseBoot::findUri() — Method in class BaseBoot

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

Boot::findUri() — Method in class Boot

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

DrupalBoot::findUri() — Method in class DrupalBoot

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

EditCommands::findBashrc() — Method in class EditCommands

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

ImageCommands::flush() — Method in class ImageCommands

Flush all derived images for a given style.

MigrateRunnerCommands::fieldsSource() — Method in class MigrateRunnerCommands

List the fields available for mapping in a source.

StateCommands::format() — Method in class StateCommands

WatchdogCommands::formatResult() — Method in class WatchdogCommands

Format a watchdog database row.

FieldBaseInfoCommands — Class in namespace Drush\Commands\field

FieldBaseOverrideCreateCommands — Class in namespace Drush\Commands\field

FieldCreateCommands — Class in namespace Drush\Commands\field

FieldCreateCommands::fieldCreate() — Method in class FieldCreateCommands

Create a new field

FieldCreateCommands::fieldExists() — Method in class FieldCreateCommands

FieldCreateCommands::fieldStorageExists() — Method in class FieldCreateCommands

FieldDefinitionCommands — Class in namespace Drush\Commands\field

FieldDefinitionCommands::formatters() — Method in class FieldDefinitionCommands

FieldDefinitionRowsOfFieldsTrait — Class in namespace Drush\Commands\field

FieldDeleteCommands — Class in namespace Drush\Commands\field

FieldEntityReferenceHooks — Class in namespace Drush\Commands\field

FieldInfoCommands — Class in namespace Drush\Commands\field

FieldTextHooks — Class in namespace Drush\Commands\field

ApplicationFactory::filterClassExists() — Method in class ApplicationFactory

Check each class for existence.

HelpCLIFormatter::formatOptionKeys() — Method in class HelpCLIFormatter

HelpCLIFormatter::formatOptionDescription() — Method in class HelpCLIFormatter

HelpCLIFormatter::formatArgumentName() — Method in class HelpCLIFormatter

ConfigLocator::findConfigFiles() — Method in class ConfigLocator

Given an array of paths, separates files and directories.

Environment::findDocsPath() — Method in class Environment

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

Environment::findFromCandidates() — Method in class Environment

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

$ MigrateExecutable#feedback — Property in class MigrateExecutable

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

Logger::formatSize() — Method in class Logger

ArgsPreprocessor::findMethodForOptionWithValues() — Method in class ArgsPreprocessor

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

PreflightSiteLocator::findSite() — Method in class PreflightSiteLocator

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

LegacyServiceFinder::findModuleDrushServiceProvider() — Method in class LegacyServiceFinder

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

SqlTableSelectionTrait::filterTables() — Method in class SqlTableSelectionTrait

Filters tables.

FsUtils — Class in namespace Drush\Utils

$ CallableTask#fn — Property in class CallableTask

Collection::fail() — Method in class Collection

Force the rollback functions to run

CollectionBuilder::fixTask() — Method in class CollectionBuilder

$ TaskForEach#functionStack — Property in class TaskForEach

ExecCommand::findExecutablePhar() — Method in class ExecCommand

Look for a "{$cmd}.phar" in the current working directory; return a string to exec it if it is found. Otherwise, look for an executable command of the same name via findExecutable.

ExecCommand::findExecutable() — Method in class ExecCommand

Return the best path to the executable program with the provided name. Favor vendor/bin in the current project. If not found there, use whatever is on the $PATH.

ExecCommand::findProjectBin() — Method in class ExecCommand

ExecTrait::formatCommandDisplay() — Method in class ExecTrait

TaskIO::formatBytes() — Method in class TaskIO

Format a quantity of bytes.

$ TimeKeeper#finishedAt — Property in class TimeKeeper

TimeKeeper::formatDuration() — Method in class TimeKeeper

Format a duration into a human-readable time.

RoboLogStyle::formatMessageByLevel() — Method in class RoboLogStyle

Log style customization for Robo: replace the log level with the task name.

RoboLogStyle::formatMessage() — Method in class RoboLogStyle

Log style customization for Robo: add the time indicator to the end of the log message if it exists in the context.

Result::fromException() — Method in class Result

Robo::finalizeContainer() — Method in class Robo

Do final initialization to the provided container. Make any necessary modifications to the container before calling this method.

ConsoleIO::formattedOutput() — Method in class ConsoleIO

TaskInfo::formatTaskName() — Method in class TaskInfo

ApiGen::forceTraversable() — Method in class ApiGen

$ Extract#filename — Property in class Extract

$ CssPreprocessor#files — Property in class CssPreprocessor

$ ImageMinify#fs — Property in class ImageMinify

Symfony 2 filesystem.

ImageMinify::findFiles() — Method in class ImageMinify

Minify::fromText() — Method in class Minify

Sets text from string source.

Minify::fromFile() — Method in class Minify

Sets text from asset file path. Tries to guess type and set default destination.

Base::forceLatest() — Method in class Base

adds force-latest option to bower

$ Changelog#filename — Property in class Changelog

Changelog::filename() — Method in class Changelog

$ GenerateMarkdownDoc#filterMethods — Property in class GenerateMarkdownDoc

$ GenerateMarkdownDoc#filterClasses — Property in class GenerateMarkdownDoc

$ GenerateMarkdownDoc#filterProperties — Property in class GenerateMarkdownDoc

$ GenerateMarkdownDoc#filename — Property in class GenerateMarkdownDoc

GenerateMarkdownDoc::filterMethods() — Method in class GenerateMarkdownDoc

Using a callback function filter out methods that won't be documented.

GenerateMarkdownDoc::filterClasses() — Method in class GenerateMarkdownDoc

Using a callback function filter out classes that won't be documented.

GenerateMarkdownDoc::filterProperties() — Method in class GenerateMarkdownDoc

Using a callback function filter out properties that won't be documented.

GenerateMarkdownDoc::filename() — Method in class GenerateMarkdownDoc

$ PackPhar#filename — Property in class PackPhar

$ PackPhar#files — Property in class PackPhar

$ SemVer#format — Property in class SemVer

$ Concat#files — Property in class Concat

$ Replace#filename — Property in class Replace

$ Replace#from — Property in class Replace

Replace::filename() — Method in class Replace

Replace::from() — Method in class Replace

String(s) to be replaced.

$ Write#filename — Property in class Write

Write::filename() — Method in class Write

$ BaseDir#fs — Property in class BaseDir

FilesystemStack — Class in namespace Robo\Task\Filesystem

Wrapper for Symfony Filesystem Component.

$ FilesystemStack#fs — Property in class FilesystemStack

FlattenDir — Class in namespace Robo\Task\Filesystem

Searches for files in a nested directory structure and copies them to a target directory with or without the parent directories. The task was inspired by gulp-flatten.

FlattenDir::findFiles() — Method in class FlattenDir

$ WorkDir#finalDestination — Property in class WorkDir

$ BaseLogfile#filesystem — Property in class BaseLogfile

$ Rsync#fromUser — Property in class Rsync

$ Rsync#fromHost — Property in class Rsync

$ Rsync#fromPath — Property in class Rsync

Rsync::fromPath() — Method in class Rsync

This can either be a full rsync path spec (user@host:path) or just a path.

Rsync::fromUser() — Method in class Rsync

Rsync::fromHost() — Method in class Rsync

Rsync::filter() — Method in class Rsync

Rsync::filesFrom() — Method in class Rsync

Ssh::forcePseudoTty() — Method in class Ssh

Simulator::formatParameters() — Method in class Simulator

Atoum::files() — Method in class Atoum

Test file or test files to run.

$ Behat#formaters — Property in class Behat

Behat::format() — Method in class Behat

Codecept::failGroup() — Method in class Codecept

$ PHPUnit#files — Property in class PHPUnit

Directory of test files or single test file to run. Appended to the command and arguments.

PHPUnit::filter() — Method in class PHPUnit

PHPUnit::files() — Method in class PHPUnit

Directory of test files or single test file to run.

PHPUnit::file() — Method in class PHPUnit

Test the provided file.

$ Phpspec#formaters — Property in class Phpspec

Phpspec::format() — Method in class Phpspec

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.

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.

ConfigCommands::getConfigFactory() — Method in class ConfigCommands

ConfigCommands::getImportTransformer() — Method in class ConfigCommands

ConfigCommands::get() — Method in class ConfigCommands

Display a config value, or a whole configuration object.

ConfigCommands::getDirectory() — Method in class ConfigCommands

Determine which configuration directory to use and return directory path.

ConfigCommands::getChanges() — Method in class ConfigCommands

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

ConfigCommands::getStorage() — Method in class ConfigCommands

Get storage corresponding to a configuration directory.

ConfigCommands::getDiff() — Method in class ConfigCommands

Get diff between two config sets.

ConfigExportCommands::getConfigManager() — Method in class ConfigExportCommands

ConfigExportCommands::getConfigStorageExport() — Method in class ConfigExportCommands

ConfigExportCommands::getConfigStorage() — Method in class ConfigExportCommands

ConfigExportCommands::getConfigStorageSync() — Method in class ConfigExportCommands

ConfigImportCommands::getConfigManager() — Method in class ConfigImportCommands

ConfigImportCommands::getConfigStorage() — Method in class ConfigImportCommands

ConfigImportCommands::getConfigStorageSync() — Method in class ConfigImportCommands

ConfigImportCommands::getConfigCache() — Method in class ConfigImportCommands

ConfigImportCommands::getModuleHandler() — Method in class ConfigImportCommands

ConfigImportCommands::getEventDispatcher() — Method in class ConfigImportCommands

ConfigImportCommands::getLock() — Method in class ConfigImportCommands

ConfigImportCommands::getConfigTyped() — Method in class ConfigImportCommands

ConfigImportCommands::getModuleInstaller() — Method in class ConfigImportCommands

ConfigImportCommands::getThemeHandler() — Method in class ConfigImportCommands

ConfigImportCommands::getStringTranslation() — Method in class ConfigImportCommands

ConfigImportCommands::getImportTransformer() — Method in class ConfigImportCommands

ConfigImportCommands::getModuleExtensionList() — Method in class ConfigImportCommands

ConfigImportCommands::getThemeExtensionList() — Method in class ConfigImportCommands

CacheCommands::get() — Method in class CacheCommands

Fetch a cached object and display it.

CacheCommands::getTypes() — Method in class CacheCommands

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

CliCommands::getDrushCommands() — Method in class CliCommands

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

CliCommands::getCasters() — Method in class CliCommands

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

CliCommands::getPhpKeywords() — Method in class CliCommands

Returns a list of PHP keywords.

CoreCommands::globalOptions() — Method in class CoreCommands

All global options.

DeployHookCommands::getRegistry() — Method in class DeployHookCommands

Get the deploy hook update registry.

DocsCommands::generators() — Method in class DocsCommands

Instructions on creating your own Drush Generators.

DrupalCommands::getCron() — Method in class DrupalCommands

DrupalCommands::getModuleHandler() — Method in class DrupalCommands

DrupalCommands::getRouteProvider() — Method in class DrupalCommands

DrupalDirectoryCommands::getPath() — Method in class DrupalDirectoryCommands

Given a target (e.g.

EntityCommands::getQuery() — Method in class EntityCommands

JsonapiCommands::get() — Method in class JsonapiCommands

Execute a JSONAPI request.

LanguageCommands::getLanguageManager() — Method in class LanguageCommands

LanguageCommands::getModuleHandler() — Method in class LanguageCommands

LocaleCommands::getLanguageManager() — Method in class LocaleCommands

LocaleCommands::getConfigFactory() — Method in class LocaleCommands

LocaleCommands::getState() — Method in class LocaleCommands

MaintCommands::getState() — Method in class MaintCommands

MaintCommands::get() — Method in class MaintCommands

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

MigrateRunnerCommands::getMigrationSourceRowsCount() — Method in class MigrateRunnerCommands

Returns the migration source rows count.

MigrateRunnerCommands::getMigrationNeedingUpdateCount() — Method in class MigrateRunnerCommands

Returns the number of items that needs update.

MigrateRunnerCommands::getMigrationUnprocessedCount() — Method in class MigrateRunnerCommands

Returns the number of unprocessed items.

MigrateRunnerCommands::getMigrationImportedCount() — Method in class MigrateRunnerCommands

Returns the number of imported items.

MigrateRunnerCommands::getMigrationLastImportedTime() — Method in class MigrateRunnerCommands

Returns the last imported date/time if any.

MigrateRunnerCommands::getMigrationList() — Method in class MigrateRunnerCommands

Retrieves a list of active migrations.

MigrateRunnerCommands::getMigrateMessage() — Method in class MigrateRunnerCommands

Returns the migrate message logger.

MigrateRunnerCommands::getSourceIdKeys() — Method in class MigrateRunnerCommands

Get the source ID keys.

MkCommands::getRedirectMap() — Method in class MkCommands

MkCommands::getFilename() — Method in class MkCommands

Get a filename from a command.

QueueCommands::getWorkerManager() — Method in class QueueCommands

QueueCommands::getQueueService() — Method in class QueueCommands

QueueCommands::getQueues() — Method in class QueueCommands

QueueCommands::getQueue() — Method in class QueueCommands

SiteInstallCommands::getSitesSubdirFromUri() — Method in class SiteInstallCommands

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

StateCommands::getState() — Method in class StateCommands

StateCommands::get() — Method in class StateCommands

Display a state value.

StatusCommands::getPropertyList() — Method in class StatusCommands

TopicCommands::getAllTopics() — Method in class TopicCommands

Retrieve all defined topics

UpdateDBCommands::getUpdateList() — Method in class UpdateDBCommands

UpdateDBCommands::getUpdatedbStatus() — Method in class UpdateDBCommands

Returns information about available module updates.

UserCommands::getAccounts() — Method in class UserCommands

Get accounts from name variables or uid & mail options.

ViewsCommands::getConfigFactory() — Method in class ViewsCommands

ViewsCommands::getModuleHandler() — Method in class ViewsCommands

ViewsCommands::getEntityTypeManager() — Method in class ViewsCommands

ViewsCommands::getRenderer() — Method in class ViewsCommands

EntityTypeBundleAskTrait::getFieldableEntityTypes() — Method in class EntityTypeBundleAskTrait

FieldBaseOverrideCreateCommands::getBaseFieldDefinition() — Method in class FieldBaseOverrideCreateCommands

FieldCreateCommands::getEntityDisplay() — Method in class FieldCreateCommands

FieldCreateCommands::generateFieldName() — Method in class FieldCreateCommands

FieldCreateCommands::getExistingFieldStorageOptions() — Method in class FieldCreateCommands

FieldDefinitionRowsOfFieldsTrait::getRowsOfFieldsByFieldDefinitions() — Method in class FieldDefinitionRowsOfFieldsTrait

FieldDeleteCommands::getFieldConfigs() — Method in class FieldDeleteCommands

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

FieldEntityReferenceHooks::getTargetType() — Method in class FieldEntityReferenceHooks

FieldEntityReferenceHooks::getTargetBundles() — Method in class FieldEntityReferenceHooks

GenerateCommands — Class in namespace Drush\Commands\generate

GenerateCommands::generate() — Method in class GenerateCommands

Generate boilerplate code for modules/plugins/services etc.

GenerateCommands::generatorNameComplete() — Method in class GenerateCommands

Generates completion for generator names.

DrushAliasFile::generate() — Method in class DrushAliasFile

{@inheritdoc}

DrushCommandFile::generate() — Method in class DrushCommandFile

{@inheritdoc}

DrushGeneratorFile::generate() — Method in class DrushGeneratorFile

DrushHelpDocument::generateBaseHelpDom() — Method in class DrushHelpDocument

ListCommands::getTerminalWidth() — Method in class ListCommands

PmCommands::getConfigFactory() — Method in class PmCommands

PmCommands::getModuleInstaller() — Method in class PmCommands

PmCommands::getModuleHandler() — Method in class PmCommands

PmCommands::getThemeHandler() — Method in class PmCommands

PmCommands::getExtensionListModule() — Method in class PmCommands

PmCommands::getPermissionHandler() — Method in class PmCommands

PmCommands::getModuleLinks() — Method in class PmCommands

ThemeCommands::getThemeInstaller() — Method in class ThemeCommands

SanitizeUserFieldsCommands::getDatabase() — Method in class SanitizeUserFieldsCommands

SanitizeUserFieldsCommands::getEntityFieldManager() — Method in class SanitizeUserFieldsCommands

ConfigAwareTrait::getConfig() — Method in class ConfigAwareTrait

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

ConfigLocator::getSiteAliasPaths() — Method in class ConfigLocator

Get the site aliases according to preflight arguments and environment.

ConfigLocator::getCommandFilePaths() — Method in class ConfigLocator

Get the commandfile paths according to preflight arguments.

ConfigLocator::getBuiltinCommandFilePaths() — Method in class ConfigLocator

Return all of the built-in commandfile locations

ConfigLocator::getIncludedCommandFilePaths() — Method in class ConfigLocator

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

ConfigLocator::getSiteCommandFilePaths() — Method in class ConfigLocator

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

Environment::getUsername() — Method in class Environment

Return the name of the user running drush.

Environment::getTmp() — Method in class Environment

Environment::getSiteSetAliasName() — Method in class Environment

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

Environment::getConfigFileVariant() — Method in class Environment

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

Environment::getSiteSetAliasFilePath() — Method in class Environment

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

DrushDrupalFinder::getDrupalRoot() — Method in class DrushDrupalFinder

Get the Drupal root.

DrushDrupalFinder::getComposerRoot() — Method in class DrushDrupalFinder

Get the Composer root.

DrushDrupalFinder::getVendorDir() — Method in class DrushDrupalFinder

Get the vendor path.

MigrateExecutable::getIdMap() — Method in class MigrateExecutable

{@inheritdoc}

MigrateExecutable::getCreatedCount() — Method in class MigrateExecutable

Returns the number of items created.

MigrateExecutable::getUpdatedCount() — Method in class MigrateExecutable

Returns the number of items updated.

MigrateExecutable::getIgnoredCount() — Method in class MigrateExecutable

Returns the number of items ignored.

MigrateExecutable::getFailedCount() — Method in class MigrateExecutable

Returns the number of items that failed.

MigrateExecutable::getProcessedCount() — Method in class MigrateExecutable

Returns the total number of items processed.

MigrateExecutable::getRollbackCount() — Method in class MigrateExecutable

Returns the number of items rolled back.

MigrateMissingSourceRowsEvent::getMigration() — Method in class MigrateMissingSourceRowsEvent

Gets the migration plugin instance.

MigrateMissingSourceRowsEvent::getDestinationIds() — Method in class MigrateMissingSourceRowsEvent

Gets the destination ID values.

MigratePrepareRowEvent::getRow() — Method in class MigratePrepareRowEvent

Gets the row object.

MigratePrepareRowEvent::getSource() — Method in class MigratePrepareRowEvent

Gets the source plugin.

MigratePrepareRowEvent::getMigration() — Method in class MigratePrepareRowEvent

Gets the migration plugin.

Drush::getTimeout() — Method in class Drush

Drush::getVersion() — Method in class Drush

Return the current Drush version.

Drush::getMajorVersion() — Method in class Drush

Drush::getMinorVersion() — Method in class Drush

Drush::getContainer() — Method in class Drush

Returns the currently active global container.

Drush::getApplication() — Method in class Drush

Get the current Symfony Console Application.

ExecTrait::getEditor() — Method in class ExecTrait

Preflight::getCommandFilePaths() — Method in class Preflight

PreflightArgs::getOptionNameList() — Method in class PreflightArgs

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

PreflightLog::getDebug() — Method in class PreflightLog

Caster::getShortClass() — Method in class Caster

DrushCommand::getNamespace() — Method in class DrushCommand

Get the namespace of this command.

Shell::getCommand() — Method in class Shell

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

Shell::getCommandFromInput() — Method in class Shell

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

LegacyServiceFinder::getDrushServiceFiles() — Method in class LegacyServiceFinder

Get all service files that this class can discover.

LegacyServiceFinder::getModuleFileNames() — Method in class LegacyServiceFinder

Find Drupal modules

ProcessManager::getDrupalFinder() — Method in class ProcessManager

SqlBase::getEnv() — Method in class SqlBase

Get environment variables to pass to Process.

SqlBase::getProcess() — Method in class SqlBase

Get the last used Process.

SqlBase::getInstance() — Method in class SqlBase

SqlBase::getDbSpec() — Method in class SqlBase

SqlBase::getOptions() — Method in class SqlBase

SqlBase::getOption() — Method in class SqlBase

SqlMysql::getVersion() — Method in class SqlMysql

The server version.

SqlPgsql::getEnv() — Method in class SqlPgsql

Get environment variables to pass to Process.

SqlPgsql::getPasswordFile() — Method in class SqlPgsql

SqlTableSelectionTrait::getExpandedTableSelection() — Method in class SqlTableSelectionTrait

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

SqlTableSelectionTrait::getTableSelection() — Method in class SqlTableSelectionTrait

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

SqlTableSelectionTrait::getRawTableList() — Method in class SqlTableSelectionTrait

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

DrushStyleInjector::get() — Method in class DrushStyleInjector

CliTestTrait::getOutputRaw() — Method in class CliTestTrait

Accessor for the last output, non-trimmed.

CliTestTrait::getErrorOutputRaw() — Method in class CliTestTrait

Accessor for the last stderr output, non-trimmed.

DrushTestTrait::getPathToDrush() — Method in class DrushTestTrait

OutputUtilsTrait::getOutputRaw() — Method in class OutputUtilsTrait

Accessor for the last output, non-trimmed.

OutputUtilsTrait::getErrorOutputRaw() — Method in class OutputUtilsTrait

Accessor for the last stderr output, non-trimmed.

OutputUtilsTrait::getSimplifiedOutput() — Method in class OutputUtilsTrait

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

OutputUtilsTrait::getSimplifiedErrorOutput() — Method in class OutputUtilsTrait

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

OutputUtilsTrait::getOutput() — Method in class OutputUtilsTrait

Accessor for the last output, trimmed.

OutputUtilsTrait::getErrorOutput() — Method in class OutputUtilsTrait

Accessor for the last stderr output, trimmed.

OutputUtilsTrait::getOutputAsList() — Method in class OutputUtilsTrait

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

OutputUtilsTrait::getErrorOutputAsList() — Method in class OutputUtilsTrait

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

OutputUtilsTrait::getOutputFromJSON() — Method in class OutputUtilsTrait

Accessor for the last output, decoded from json.

FsUtils::getBackupDir() — Method in class FsUtils

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.

ClassDiscoveryInterface::getClasses() — Method in class ClassDiscoveryInterface

ClassDiscoveryInterface::getFile() — Method in class ClassDiscoveryInterface

RelativeNamespaceDiscovery::getClasses() — Method in class RelativeNamespaceDiscovery

RelativeNamespaceDiscovery::getFile() — Method in class RelativeNamespaceDiscovery

CallableTask::getState() — Method in class CallableTask

Collection::getParentCollection() — Method in class Collection

Get the appropriate parent collection to use

Collection::getCommand() — Method in class Collection

A Collection of tasks can provide a command via getCommand() if it contains a single task, and that task implements CommandInterface.

CollectionBuilder::getState() — Method in class CollectionBuilder

CollectionBuilder::getCollectionBuilderCurrentTask() — Method in class CollectionBuilder

Return the current task for this collection builder.

CollectionBuilder::getCommand() — Method in class CollectionBuilder

Returns command that can be executed.

CollectionBuilder::getCollection() — Method in class CollectionBuilder

Return the collection of tasks associated with this builder.

Element::getBefore() — Method in class Element

Element::getAfter() — Method in class Element

Element::getTask() — Method in class Element

Element::getTaskList() — Method in class Element

Temporary::getCollection() — Method in class Temporary

Provides direct access to the collection of temporaries, if necessary.

BuilderAwareTrait::getBuilder() — Method in class BuilderAwareTrait

ConfigAwareTrait::getConfig() — Method in class ConfigAwareTrait

Get the config management object.

ConfigAwareTrait::getConfigValue() — Method in class ConfigAwareTrait

ExecCommand::getExecTimer() — Method in class ExecCommand

ExecCommand::getCommandDescription() — Method in class ExecCommand

{@inheritdoc}

ExecTrait::getCommandDescription() — Method in class ExecTrait

ExecTrait::getExecutionTime() — Method in class ExecTrait

ExecTrait::getPrinted() — Method in class ExecTrait

Is command printing its output to screen

ExecTrait::getResultData() — Method in class ExecTrait

Gets the data array to be passed to Result().

InputAwareTrait::getInput() — Method in class InputAwareTrait

Backwards compatibility.

OutputAwareTrait::getOutput() — Method in class OutputAwareTrait

Backwards compatibility

ProcessExecutor::getCommandDescription() — Method in class ProcessExecutor

{@inheritdoc}

ProgressIndicatorAwareTrait::getTotalExecutionTime() — Method in class ProgressIndicatorAwareTrait

TaskIO::getPrintedTaskName() — Method in class TaskIO

Get the formatted task name for use in task output.

TaskIO::getTaskContext() — Method in class TaskIO

Timer::getExecutionTime() — Method in class Timer

Config::getGlobalOptionDefaultValues() — Method in class Config

Return an associative array containing all of the global configuration options and their default values.

GlobalOptionDefaultValuesInterface — Class in namespace Robo\Config

BuilderAwareInterface::getBuilder() — Method in class BuilderAwareInterface

Get the builder reference

CommandInterface::getCommand() — Method in class CommandInterface

Returns command that can be executed.

PrintedInterface::getPrinted() — Method in class PrintedInterface

GlobalOptionsEventListener — Class in namespace Robo

GlobalOptionsEventListener::getSubscribedEvents() — Method in class GlobalOptionsEventListener

{@inheritdoc}

Result::getContext() — Method in class Result

Return a context useful for logging messages.

Result::getTask() — Method in class Result

ResultData::getExitCode() — Method in class ResultData

ResultData::getOutputData() — Method in class ResultData

Robo::getContainer() — Method in class Robo

Returns the currently active global container.

Runner::getAppForTesting() — Method in class Runner

Return an initialized application loaded with specified commands and configuration.

Runner::getConfigFilePaths() — Method in class Runner

Get a list of locations where config files may be loaded

Runner::getRoboFileCommands() — Method in class Runner

Runner::getSelfUpdateRepository() — Method in class Runner

Runner::getAppForTesting() — Method in class Runner

Return an initialized application loaded with specified commands and configuration.

Runner::getConfigFilePaths() — Method in class Runner

Get a list of locations where config files may be loaded

Runner::getRoboFileCommands() — Method in class Runner

Runner::getSelfUpdateRepository() — Method in class Runner

Data::getData() — Method in class Data

Data::getMessage() — Method in class Data

Data::getExecutionTime() — Method in class Data

StateAwareInterface::getState() — Method in class StateAwareInterface

StateAwareTrait::getState() — Method in class StateAwareTrait

ConsoleIOInjector::get() — Method in class ConsoleIOInjector

SymfonyStyleInjector::get() — Method in class SymfonyStyleInjector

TaskAccessor::getBuiltTask() — Method in class TaskAccessor

Provides the collection builder with access to all of the protected 'task' methods available on this object.

TaskInfo::getTaskContext() — Method in class TaskInfo

Return a context useful for logging messages.

ApiGen::googleCseId() — Method in class ApiGen

ApiGen::googleAnalytics() — Method in class ApiGen

ApiGen::groups() — Method in class ApiGen

ApiGen::getCommand() — Method in class ApiGen

Returns command that can be executed.

Extract::getTempDir() — Method in class Extract

Extract::getTmpDir() — Method in class Extract

Pack::getPrinted() — Method in class Pack

Satisfy the parent requirement.

ImageMinify::getTarget() — Method in class ImageMinify

ImageMinify::getOS() — Method in class ImageMinify

ImageMinify::gifsicle() — Method in class ImageMinify

Minify::getExtension() — Method in class Minify

Gets file extension from path.

Minify::getMinifiedText() — Method in class Minify

Minifies and returns text.

Exec::getCommandDescription() — Method in class Exec

{@inheritdoc}

Exec::getCommand() — Method in class Exec

Returns command that can be executed.

ParallelExec::getPrinted() — Method in class ParallelExec

ParallelExec::getCommand() — Method in class ParallelExec

Returns command that can be executed.

Base::getCommand() — Method in class Base

CommandStack::getCommand() — Method in class CommandStack

Returns command that can be executed.

Base::getCommand() — Method in class Base

Returns command that can be executed.

Changelog::getChanges() — Method in class Changelog

Changelog::generateBody() — Method in class Changelog

Changelog::generateHeader() — Method in class Changelog

GenerateMarkdownDoc — Class in namespace Robo\Task\Development

Simple documentation generator from source files.

GenerateTask — Class in namespace Robo\Task\Development

Generate a Robo Task that is a wrapper around an existing class.

GitHub — Class in namespace Robo\Task\Development

GitHub::getUri() — Method in class GitHub

GitHubRelease — Class in namespace Robo\Task\Development

Publishes new GitHub release.

GitHubRelease::getBody() — Method in class GitHubRelease

PackPhar::getPrinted() — Method in class PackPhar

PhpServer::getCommand() — Method in class PhpServer

Returns command that can be executed.

Base::getCommand() — Method in class Base

Returns command that can be executed.

Build::getCommand() — Method in class Build

Returns command that can be executed.

Commit::getCommand() — Method in class Commit

Returns command that can be executed.

Exec::getCommand() — Method in class Exec

Returns command that can be executed.

Pull::getCommand() — Method in class Pull

Returns command that can be executed.

Remove::getCommand() — Method in class Remove

Returns command that can be executed.

Result::getCid() — Method in class Result

Result::getContainerName() — Method in class Result

Run::getPrinted() — Method in class Run

Is command printing its output to screen

Run::getCommand() — Method in class Run

Returns command that can be executed.

Run::getTmpDir() — Method in class Run

Run::getUniqId() — Method in class Run

Run::getCid() — Method in class Run

Start::getCommand() — Method in class Start

Returns command that can be executed.

Stop::getCommand() — Method in class Stop

Returns command that can be executed.

Write::getContentsToWrite() — Method in class Write

Write::getPath() — Method in class Write

FilesystemStack::getDelegate() — Method in class FilesystemStack

FlattenDir::getTarget() — Method in class FlattenDir

TmpDir::getPath() — Method in class TmpDir

Get a reference to the path to the temporary directory, so that it may be used to create other tasks. Note that the directory is not actually created until the task runs.

WorkDir::getPath() — Method in class WorkDir

Get a reference to the path to the temporary directory, so that it may be used to create other tasks. Note that the directory is not actually created until the task runs.

Base::getCommand() — Method in class Base

Base::getCommand() — Method in class Base

Rsync::group() — Method in class Rsync

Rsync::getCommand() — Method in class Rsync

Returns command that can be executed.

Rsync::getFromPathSpec() — Method in class Rsync

Rsync::getToPathSpec() — Method in class Rsync

Rsync::getPathSpec() — Method in class Rsync

Ssh::getCommand() — Method in class Ssh

Returns command that can be executed.

Simulator::getCommand() — Method in class Simulator

Danger: reach through the simulated wrapper and pull out the command to be executed. This is used when using a simulated task with another simulated task that runs commands, e.g. the Remote\Ssh task. Using a simulated CommandInterface task with a non-simulated task may produce unexpected results (e.g. execution!).

StackBasedTask::getDelegate() — Method in class StackBasedTask

Derived classes should override the getDelegate() method, and return an instance of the API class being wrapped. When this is done, any method of the delegate is available as a method of this class. Calling one of the delegate's methods will defer execution until the run() method is called.

StackBasedTask::getDelegateCommandList() — Method in class StackBasedTask

Derived classes that have more than one delegate may override getCommandList to add as many delegate commands as desired to the list of potential functions that __call() tried to find.

Atoum::getCommand() — Method in class Atoum

Returns command that can be executed.

Behat::getCommand() — Method in class Behat

Returns command that can be executed.

Codecept::group() — Method in class Codecept

set group option. Can be called multiple times

Codecept::getCommand() — Method in class Codecept

Returns command that can be executed.

PHPUnit::group() — Method in class PHPUnit

PHPUnit::getCommand() — Method in class PHPUnit

Returns command that can be executed.

Phpspec::getCommand() — Method in class Phpspec

Returns command that can be executed.

GitStack — Class in namespace Robo\Task\Vcs

Runs Git commands in stack. You can use stopOnFail() to point that stack should be terminated on first fail.

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

Hook — Class in namespace Drush\Attributes

HookSelector — Class in namespace Drush\Attributes

InteractConfigName::handle() — Method in class InteractConfigName

Kernel::handle() — Method in class Kernel

NoArgumentsBase::handle() — Method in class NoArgumentsBase

Obsolete::handle() — Method in class Obsolete

OptionsetGetEditor::handle() — Method in class OptionsetGetEditor

OptionsetProcBuild::handle() — Method in class OptionsetProcBuild

OptionsetSql::handle() — Method in class OptionsetSql

OptionsetSsh::handle() — Method in class OptionsetSsh

OptionsetTableSelection::handle() — Method in class OptionsetTableSelection

ValidatorBase::handle() — Method in class ValidatorBase

Version::handle() — Method in class Version

BaseBoot::hasRegisteredSymfonyCommand() — Method in class BaseBoot

BootstrapManager::hasBootstrap() — Method in class BootstrapManager

hasBootstrap determines whether the manager has a bootstrap object yet.

BootstrapManager::hasBootstrapped() — Method in class BootstrapManager

Determine whether a given bootstrap phase has been completed.

ConfigCommands::hasImportTransformer() — Method in class ConfigCommands

ConfigImportCommands::hasImportTransformer() — Method in class ConfigImportCommands

CliCommands::historyPath() — Method in class CliCommands

Returns the file path for the CLI history.

DocsCommands::hooks() — Method in class DocsCommands

Drush hooks.

LinkHooks::hookOption() — Method in class LinkHooks

LinkHooks::hookSetOptions() — Method in class LinkHooks

LinkHooks::hookFieldConfig() — Method in class LinkHooks

SiteInstallCommands::hasConfigFiles() — Method in class SiteInstallCommands

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

FieldCreateCommands::hasContentTranslation() — Method in class FieldCreateCommands

FieldEntityReferenceHooks::hookFieldStorage() — Method in class FieldEntityReferenceHooks

FieldEntityReferenceHooks::hookFieldConfig() — Method in class FieldEntityReferenceHooks

FieldTextHooks::hookOption() — Method in class FieldTextHooks

FieldTextHooks::hookValidate() — Method in class FieldTextHooks

FieldTextHooks::hookSetOptions() — Method in class FieldTextHooks

FieldTextHooks::hookFieldConfig() — Method in class FieldTextHooks

FieldTextHooks::hasAllowedFormats() — Method in class FieldTextHooks

HelpCLIFormatter — Class in namespace Drush\Commands\help

Format an array into CLI help string.

HelpCommands — Class in namespace Drush\Commands\help

HelpCommands::help() — Method in class HelpCommands

Display usage details for a command.

ListCommands::helpList() — Method in class ListCommands

List available commands.

DrushConfig::home() — Method in class DrushConfig

$ Environment#homeDir — Property in class Environment

Environment::homeDir() — Method in class Environment

User's home directory

MigrateExecutable::handleMissingSourceRows() — Method in class MigrateExecutable

Handles missing source rows after import.

Drush::hasContainer() — Method in class Drush

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

Drush::hasService() — Method in class Drush

Indicates if a service is defined in the container.

$ PreflightArgs#homeDir — Property in class PreflightArgs

PreflightArgs::homeDir() — Method in class PreflightArgs

PreflightArgs::hasAlias() — Method in class PreflightArgs

PreflightArgs::hasUri() — Method in class PreflightArgs

PreflightArgsInterface::hasAlias() — Method in class PreflightArgsInterface

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

Caster::handleReferences() — Method in class Caster

Shell::hasCommand() — Method in class Shell

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

$ DependencyInjection#handlers — Property in class DependencyInjection

HandlerInterface — Class in namespace Drush\Runtime

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

ServiceManager::hasStaticCreateFactory() — Method in class ServiceManager

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

ServiceManager::hasStaticMethod() — Method in class ServiceManager

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

ServiceManager::hasStaticCreateEarlyFactory() — Method in class ServiceManager

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

HostPath — Class in namespace Drush\SiteAlias

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

Collection::hasTask() — Method in class Collection

Test to see if a specified task name exists.

ExecTrait::hideTaskProgress() — Method in class ExecTrait

ProgressIndicator::hideProgressIndicator() — Method in class ProgressIndicator

ProgressIndicatorAwareTrait::hideProgressIndicator() — Method in class ProgressIndicatorAwareTrait

TaskIO::hideTaskProgress() — Method in class TaskIO

VerbosityThresholdTrait::hasOutputAdapter() — Method in class VerbosityThresholdTrait

VerbosityThresholdInterface::hasOutputAdapter() — Method in class VerbosityThresholdInterface

GlobalOptionsEventListener::handleCommandEvent() — Method in class GlobalOptionsEventListener

Run all of our individual operations when a command event is received.

Robo::hasContainer() — Method in class Robo

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

Robo::hasService() — Method in class Robo

Indicates if a service is defined in the container.

Runner::handleError() — Method in class Runner

This is just a proxy error handler that checks the current error_reporting level.

Runner::handleError() — Method in class Runner

This is just a proxy error handler that checks the current error_reporting level.

Data::hasExecutionTime() — Method in class Data

Init::homepage() — Method in class Init

$ Changelog#header — Property in class Changelog

$ PhpServer#host — Property in class PhpServer

PhpServer::host() — Method in class PhpServer

Rsync::humanReadable() — Method in class Rsync

$ Ssh#hostname — Property in class Ssh

Ssh::hostname() — Method in class Ssh

Codecept::html() — Method in class Codecept

Generate html report

HgStack — Class in namespace Robo\Task\Vcs

Runs hg commands in stack. You can use stopOnFail() to point that stack should be terminated on first fail.

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::io() — Method in class DrushCommands

Override Robo's IO function with our custom style.

DrushCommands::initHook() — Method in class DrushCommands

Configure Laravel prompts package.

ConfigCommands::interactConfigName() — Method in class ConfigCommands

$ ConfigImportCommands#importStorageTransformer — Property in class ConfigImportCommands

ConfigImportCommands::import() — Method in class ConfigImportCommands

Import config from the config directory.

CacheCommands::interact() — Method in class CacheCommands

ImageCommands — Class in namespace Drush\Commands\core

ImageCommands::interactFlush() — Method in class ImageCommands

LanguageCommands::info() — Method in class LanguageCommands

Print the currently available languages.

LinkHooks::isInstalled() — Method in class LinkHooks

LocaleCommands::importAll() — Method in class LocaleCommands

Imports multiple translation files from the defined directory.

LocaleCommands::import() — Method in class LocaleCommands

Imports to a gettext translation file.

MigrateRunnerCommands::import() — Method in class MigrateRunnerCommands

Perform one or more migration processes.

NotifyCommands::isAllowed() — Method in class NotifyCommands

Identify if the given Drush request should trigger a notification.

RsyncCommands::injectAliasPathParameterOptions() — Method in class RsyncCommands

SiteInstallCommands::install() — Method in class SiteInstallCommands

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

SiteInstallCommands::isValidProfileName() — Method in class SiteInstallCommands

Determine whether the provided profile name meets naming conventions.

TopicCommands::interact() — Method in class TopicCommands

UserCommands::information() — Method in class UserCommands

Print information about the specified user(s).

UserCommands::infoArray() — Method in class UserCommands

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

WatchdogCommands::interactList() — Method in class WatchdogCommands

$ EntityTypeBundleAskTrait#input — Property in class EntityTypeBundleAskTrait

FieldBaseInfoCommands::info() — Method in class FieldBaseInfoCommands

List all base fields of an entity type

FieldInfoCommands::info() — Method in class FieldInfoCommands

List all configurable fields of an entity bundle

HelpCLIFormatter::isGlobalOption() — Method in class HelpCLIFormatter

PmCommands::install() — Method in class PmCommands

Enable one or more modules.

ThemeCommands::install() — Method in class ThemeCommands

Install one or more themes.

SqlSyncCommands::import() — Method in class SqlSyncCommands

Import file into target.

SanitizeUserTableCommands::isEnabled() — Method in class SanitizeUserTableCommands

Test an option value to see if it is disabled.

$ ConfigLocator#isLocal — Property in class ConfigLocator

ConfigLocator::identifyCandidates() — Method in class ConfigLocator

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

ConfigLocator::identifyCandidatesAtPath() — Method in class ConfigLocator

Search for all matching candidate locations at a single path.

DrushConfig::isWindows() — Method in class DrushConfig

Environment::isWindows() — Method in class Environment

Determine whether current OS is a Windows variant.

InstallerKernel — Class in namespace Drush\Drupal

Overridden version of InstallerKernel adapted to the needs of Drush.

$ MigrateExecutable#idlist — Property in class MigrateExecutable

List of specific source IDs to import.

$ MigrateExecutable#idMap — Property in class MigrateExecutable

Static cached ID map.

MigrateExecutable::importFeedbackMessage() — Method in class MigrateExecutable

Emits information on the import progress.

MigrateExecutable::initProgressBar() — Method in class MigrateExecutable

Initializes the command progress bar if possible.

Drush::input() — Method in class Drush

Return the input object

ArgsPreprocessor::isAliasOrSiteSpec() — Method in class ArgsPreprocessor

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

LegacyPreflight::includeCode() — Method in class LegacyPreflight

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

Preflight::init() — Method in class Preflight

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

PreflightArgs::isLocal() — Method in class PreflightArgs

Determine whether Drush is in "local" mode

PreflightArgs::isSimulated() — Method in class PreflightArgs

Determine whether Drush is in "simulated" mode.

PreflightArgs::isStrict() — Method in class PreflightArgs

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

PreflightVerify::invalidIniValue() — Method in class PreflightVerify

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

DependencyInjection::initContainer() — Method in class DependencyInjection

Set up our dependency injection container.

DependencyInjection::installHandlers() — Method in class DependencyInjection

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

DependencyInjection::injectApplicationServices() — Method in class DependencyInjection

ErrorHandler::installHandler() — Method in class ErrorHandler

HandlerInterface::installHandler() — Method in class HandlerInterface

$ LegacyServiceInstantiator#instantiatedDrushServices — Property in class LegacyServiceInstantiator

LegacyServiceInstantiator::isValidServiceData() — Method in class LegacyServiceInstantiator

Validate service data before using it.

LegacyServiceInstantiator::instantiateServices() — Method in class LegacyServiceInstantiator

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

LegacyServiceInstantiator::instantiateObject() — Method in class LegacyServiceInstantiator

Instantiate an object with the given arguments.

LegacyServiceInstantiator::isRequired() — Method in class LegacyServiceInstantiator

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

RedispatchHook::initialize() — Method in class RedispatchHook

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

ServiceManager::instantiateYamlCliCommands() — Method in class ServiceManager

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

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

Collection::ignoreErrorsTaskWrapper() — Method in class Collection

Wrap the provided task in a wrapper that will ignore any errors or exceptions that may be produced. This is useful, for example, in adding optional cleanup tasks at the beginning of a task collection, to remove previous results which may or may not exist.

Collection::ignoreErrorsCodeWrapper() — Method in class Collection

CollectionBuilder::isSimulated() — Method in class CollectionBuilder

CollectionBuilder::injectDependencies() — Method in class CollectionBuilder

Take all dependencies availble to this task and inject any that are needed into the provided task. The general pattern is that, for every FooAwareInterface that this class implements, it should test to see if the child also implements the same interface, and if so, should call $child->setFoo($this->foo).

$ TaskForEach#iterable — Property in class TaskForEach

TaskForEach::iterationMessage() — Method in class TaskForEach

$ ExecTrait#idleTimeout — Property in class ExecTrait

$ ExecTrait#input — Property in class ExecTrait

$ ExecTrait#interactive — Property in class ExecTrait

$ ExecTrait#isPrinted — Property in class ExecTrait

$ ExecTrait#isMetadataPrinted — Property in class ExecTrait

ExecTrait::idleTimeout() — Method in class ExecTrait

Stops command if it does not output something for a while

ExecTrait::interactive() — Method in class ExecTrait

Attach tty to process for interactive input

IO — Class in namespace Robo\Common

$ IO#io — Property in class IO

$ IO#input — Property in class IO

InflectionTrait — Class in namespace Robo\Common

InflectionTrait::inflect() — Method in class InflectionTrait

Ask the provided parent class to inject all of the dependencies that it has and we need.

InputAwareTrait — Class in namespace Robo\Common

$ InputAwareTrait#input — Property in class InputAwareTrait

InputAwareTrait::input() — Method in class InputAwareTrait

ProgressIndicator::inProgress() — Method in class ProgressIndicator

ProgressIndicatorAwareTrait::inProgress() — Method in class ProgressIndicatorAwareTrait

ResourceExistenceChecker::isDir() — Method in class ResourceExistenceChecker

Wrapper method around phps is_dir()

ResourceExistenceChecker::isFile() — Method in class ResourceExistenceChecker

Wrapper method around phps file_exists()

Config::import() — Method in class Config

{@inheritdoc}

Config::isSimulated() — Method in class Config

Config::isInteractive() — Method in class Config

Config::isDecorated() — Method in class Config

IOAwareInterface — Class in namespace Robo\Contract

InflectionInterface — Class in namespace Robo\Contract

InflectionInterface::inflect() — Method in class InflectionInterface

Based on league/container inflection: https://container.thephpleague.com/4.x/inflectors/

InflectionInterface::injectDependencies() — Method in class InflectionInterface

Take all dependencies availble to this task and inject any that are needed into the provided task. The general pattern is that, for every FooAwareInterface that this class implements, it should test to see if the child also implements the same interface, and if so, should call $child->setFoo($this->foo).

Result::isUnnamed() — Method in class Result

We assume that named values (e.g. for associative array keys) are non-numeric; numeric keys are presumed to simply be the index of an array, and therefore insignificant.

Result::injectDependencies() — Method in class Result

Take all dependencies availble to this task and inject any that are needed into the provided task. The general pattern is that, for every FooAwareInterface that this class implements, it should test to see if the child also implements the same interface, and if so, should call $child->setFoo($this->foo).

Robo::input() — Method in class Robo

Return the input object.

Robo::instantiate() — Method in class Robo

Runner::instantiateCommandClass() — Method in class Runner

Runner::installRoboHandlers() — Method in class Runner

Runner::isShebangFile() — Method in class Runner

Determine if the specified argument is a path to a shebang script.

Runner::isShebangLine() — Method in class Runner

Test to see if the provided line is a robo 'shebang' line.

Runner::instantiateCommandClass() — Method in class Runner

Runner::installRoboHandlers() — Method in class Runner

Runner::isShebangFile() — Method in class Runner

Determine if the specified argument is a path to a shebang script.

Runner::isShebangLine() — Method in class Runner

Test to see if the provided line is a robo 'shebang' line.

$ ConsoleIO#input — Property in class ConsoleIO

ConsoleIO::input() — Method in class ConsoleIO

ConsoleIO::injectDependencies() — Method in class ConsoleIO

Take all dependencies availble to this task and inject any that are needed into the provided task. The general pattern is that, for every FooAwareInterface that this class implements, it should test to see if the child also implements the same interface, and if so, should call $child->setFoo($this->foo).

ApiGen::internal() — Method in class ApiGen

CssPreprocessor::importDir() — Method in class CssPreprocessor

Sets import directories Alias for setImportPaths

ImageMinify — Class in namespace Robo\Task\Assets

Minifies images.

$ ImageMinify#imageminRepos — Property in class ImageMinify

Binary repositories of Imagemin.

ImageMinify::installFromImagemin() — Method in class ImageMinify

BaseTask::injectDependencies() — Method in class BaseTask

Take all dependencies availble to this task and inject any that are needed into the provided task. The general pattern is that, for every FooAwareInterface that this class implements, it should test to see if the child also implements the same interface, and if so, should call $child->setFoo($this->foo).

$ Exec#instances — Property in class Exec

$ ParallelExec#idleTimeout — Property in class ParallelExec

$ ParallelExec#isPrinted — Property in class ParallelExec

ParallelExec::idleTimeout() — Method in class ParallelExec

Stops process if it does not output for time longer then $timeout (seconds).

$ SymfonyCommand#input — Property in class SymfonyCommand

Install — Class in namespace Robo\Task\Bower

Bower Install

Base::interaction() — Method in class Base

Base::ignorePlatformRequirements() — Method in class Base

adds ignore-platform-reqs option to composer

Init — Class in namespace Robo\Task\Composer

Composer Init

Install — Class in namespace Robo\Task\Composer

Composer Install

GenerateMarkdownDoc::init() — Method in class GenerateMarkdownDoc

GenerateMarkdownDoc::indentDoc() — Method in class GenerateMarkdownDoc

SemVer::increment() — Method in class SemVer

Exec::interactive() — Method in class Exec

Attach tty to process for interactive input

$ Run#image — Property in class Run

Run::interactive() — Method in class Run

Attach tty to process for interactive input

FlattenDir::includeParents() — Method in class FlattenDir

Sets the value from which direction and how much parent dirs should be included.

Install — Class in namespace Robo\Task\Npm

Npm Install

Rsync::init() — Method in class Rsync

Rsync::itemizeChanges() — Method in class Rsync

Rsync::includeFilter() — Method in class Rsync

Ssh::identityFile() — Method in class Ssh

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

ImageMinify::jpegtran() — Method in class ImageMinify

ImageMinify::jpegoptim() — Method in class ImageMinify

ImageMinify::jpegRecompress() — Method in class ImageMinify

Codecept::json() — Method in class Codecept

generate json report

PHPUnit::json() — Method in class PHPUnit

adds log-json option to runner

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.

$ MigrateRunnerCommands#keyValue — Property in class MigrateRunnerCommands

Minify::keepImportantComments() — Method in class Minify

keepImportantComments option for the JS minimisation.

CreateProject::keepVcs() — Method in class CreateProject

$ RotateLog#keep — Property in class RotateLog

RotateLog::keep() — Method in class RotateLog

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.

LegacyCommands — Class in namespace Drush\Commands

EditCommands::load() — Method in class EditCommands

EntityCommands::loadSave() — Method in class EntityCommands

Re-save entities, and publish/unpublish is specified.

LanguageCommands — Class in namespace Drush\Commands\core

LinkHooks — Class in namespace Drush\Commands\core

LocaleCommands — Class in namespace Drush\Commands\core

LoginCommands — Class in namespace Drush\Commands\core

LoginCommands::login() — Method in class LoginCommands

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

MessengerCommands::log() — Method in class MessengerCommands

FieldBaseOverrideCreateCommands::logResult() — Method in class FieldBaseOverrideCreateCommands

FieldCreateCommands::logResult() — Method in class FieldCreateCommands

ApplicationFactory::logger() — Method in class ApplicationFactory

ListCommands — Class in namespace Drush\Commands\help

$ Environment#loader — Property in class Environment

Environment::loader() — Method in class Environment

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

YamlConfigLoader::load() — Method in class YamlConfigLoader

$ MigrateExecutable#limit — Property in class MigrateExecutable

Maximum number of items to process in this migration.

$ MigrateExecutable#listeners — Property in class MigrateExecutable

List of event listeners we have registered.

Drush::logger() — Method in class Drush

Return the Drush logger object.

DrushLog::log() — Method in class DrushLog

{@inheritdoc}

Logger — Class in namespace Drush\Log

Contains \Drush\Log\Logger.

Logger::log() — Method in class Logger

LegacyPreflight — Class in namespace Drush\Preflight

Prepare to bootstrap Drupal

$ Preflight#logger — Property in class Preflight

Preflight::logger() — Method in class Preflight

Preflight::loadSymfonyCompatabilityAutoloader() — Method in class Preflight

PreflightLog::log() — Method in class PreflightLog

PreflightVerify::loadedPhpIniMessage() — Method in class PreflightVerify

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

LegacyServiceFinder — Class in namespace Drush\Runtime

Find drush.services.yml files.

LegacyServiceInstantiator — Class in namespace Drush\Runtime

Use the Symfony Dependency Injection Container to instantiate services.

LegacyServiceInstantiator::loadServiceFiles() — Method in class LegacyServiceInstantiator

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

ServiceManager::loadCommandClasses() — Method in class ServiceManager

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

InternalYamlDataFileLoader::load() — Method in class InternalYamlDataFileLoader

SqlBase::logQueryInDebugMode() — Method in class SqlBase

Show the query in debug mode and simulate mode

SqlBase::listTables() — Method in class SqlBase

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

SqlBase::listTablesQuoted() — Method in class SqlBase

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

SqlMysql::listTables() — Method in class SqlMysql

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

SqlMysql::listTablesQuoted() — Method in class SqlMysql

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

SqlPgsql::listTables() — Method in class SqlPgsql

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

SqlSqlite::listTables() — Method in class SqlSqlite

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

TaskIO::logger() — Method in class TaskIO

LoadAllTasks — Class in namespace Robo

Robo::loadConfiguration() — Method in class Robo

Use a simple config loader to load configuration values from specified paths

Robo::logger() — Method in class Robo

Runner::loadRoboFile() — Method in class Runner

Runner::loadRoboFile() — Method in class Runner

ConsoleIO::lightText() — Method in class ConsoleIO

{@inheritdoc}

Less — Class in namespace Robo\Task\Assets

Compiles less files.

Less::lessphp() — Method in class Less

lessphp compiler

Less::less() — Method in class Less

less compiler

Init::license() — Method in class Init

$ Changelog#log — Property in class Changelog

Changelog::log() — Method in class Changelog

Run::link() — Method in class Run

$ Replace#limit — Property in class Replace

Replace::limit() — Method in class Replace

If used with $this->regexp() how many counts will be replaced

Write::line() — Method in class Write

add a line.

Write::lines() — Method in class Write

add more lines.

$ BaseLogfile#logfiles — Property in class BaseLogfile

Atoum::lightReport() — Method in class Atoum

Display result using the light reporter.

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

CliCommands::makeEntitiesAvailableWithShortClassNames() — Method in class CliCommands

DocsCommands::migrate() — Method in class DocsCommands

Defining and running migrations.

MaintCommands — Class in namespace Drush\Commands\core

MessengerCommands — Class in namespace Drush\Commands\core

MigrateRunnerCommands — Class in namespace Drush\Commands\core

$ MigrateRunnerCommands#migrationPluginManager — Property in class MigrateRunnerCommands

MigrateRunnerCommands::messages() — Method in class MigrateRunnerCommands

View any messages associated with a migration.

MkCommands — Class in namespace Drush\Commands\core

WatchdogCommands::messageTypes() — Method in class WatchdogCommands

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

SanitizeCommentsCommands::messages() — Method in class SanitizeCommentsCommands

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

SanitizePluginInterface::messages() — Method in class SanitizePluginInterface

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

SanitizeSessionsCommands::messages() — Method in class SanitizeSessionsCommands

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

SanitizeUserFieldsCommands::messages() — Method in class SanitizeUserFieldsCommands

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

SanitizeUserTableCommands::messages() — Method in class SanitizeUserTableCommands

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

MigrateEvents — Class in namespace Drush\Drupal\Migrate

Defines the row preparation event for the migration system.

MigrateExecutable — Class in namespace Drush\Drupal\Migrate

MigrateIdMapFilter — Class in namespace Drush\Drupal\Migrate

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

MigrateMessage — Class in namespace Drush\Drupal\Migrate

Print message in drush from migrate message.

MigrateMissingSourceRowsEvent — Class in namespace Drush\Drupal\Migrate

Missing source rows event.

$ MigrateMissingSourceRowsEvent#migration — Property in class MigrateMissingSourceRowsEvent

The migration plugin instance.

MigratePrepareRowEvent — Class in namespace Drush\Drupal\Migrate

Wraps a prepare-row event for event listeners.

$ MigratePrepareRowEvent#migration — Property in class MigratePrepareRowEvent

Migration plugin.

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

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.

$ Collection#messageStoreKeys — Property in class Collection

$ TaskForEach#message — Property in class TaskForEach

ResultData::message() — Method in class ResultData

$ Data#message — Property in class Data

Data::merge() — Method in class Data

Merge another result into this result. Data already existing in this result takes precedence over the data in the Result being merged.

Data::mergeData() — Method in class Data

Merge another result into this result. Data already existing in this result takes precedence over the data in the Result being merged.

ApiGen::mainProjectNamePrefix() — Method in class ApiGen

$ ImageMinify#minifier — Property in class ImageMinify

Default minifier to use.

$ ImageMinify#minifierOptions — Property in class ImageMinify

Array for minifier options.

$ ImageMinify#minifiers — Property in class ImageMinify

Supported minifiers.

ImageMinify::minifier() — Method in class ImageMinify

Sets the minifier.

ImageMinify::minify() — Method in class ImageMinify

Minify — Class in namespace Robo\Task\Assets

Minifies an asset file (CSS or JS).

$ Watch#monitor — Property in class Watch

Watch::monitor() — Method in class Watch

$ SemVer#metadataSeparator — Property in class SemVer

SemVer::metadata() — Method in class SemVer

FilesystemStack::mkdir() — Method in class FilesystemStack

FilesystemStack::mirror() — Method in class FilesystemStack

MirrorDir — Class in namespace Robo\Task\Filesystem

Mirrors a directory to another

GitStack::merge() — Method in class GitStack

Performs git merge

HgStack::merge() — Method in class HgStack

Performs hg merge

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

NotifyCommands — Class in namespace Drush\Commands\core

Drush::negative() — Method in class Drush

Return 'true' if we are in negative mode

ArgsPreprocessor::nextCouldBeValue() — Method in class ArgsPreprocessor

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

Collection::namedTask() — Method in class Collection

Find an existing named task.

CollectionBuilder::newBuilder() — Method in class CollectionBuilder

Create a new builder with its own task collection

NestedCollectionInterface — Class in namespace Robo\Collection

Base::noDev() — Method in class Base

adds production option to bower

$ Base#nointeraction — Property in class Base

Base::noDev() — Method in class Base

adds no-dev option to composer

Base::noAnsi() — Method in class Base

adds no-ansi option to composer

Base::noInteraction() — Method in class Base

adds no-interaction option to composer

Base::noScripts() — Method in class Base

skip scripts

CreateProject::noInstall() — Method in class CreateProject

Install::noSuggest() — Method in class Install

adds no-suggest option to composer

Remove::noProgress() — Method in class Remove

Remove::noUpdate() — Method in class Remove

Remove::noUpdateWithDependencies() — Method in class Remove

RequireDependency::noSuggest() — Method in class RequireDependency

adds no-suggest option to composer

RequireDependency::noUpdate() — Method in class RequireDependency

adds no-update option to composer

Update::noSuggest() — Method in class Update

adds no-suggest option to composer

Validate::noCheckAll() — Method in class Validate

Validate::noCheckLock() — Method in class Validate

Validate::noCheckPublish() — Method in class Validate

$ GitHubRelease#name — Property in class GitHubRelease

GitHubRelease::name() — Method in class GitHubRelease

$ Commit#name — Property in class Commit

Commit::name() — Method in class Commit

$ Run#name — Property in class Run

Run::name() — Method in class Run

Base::noColor() — Method in class Base

adds --no-color option to gulp

Base::noDev() — Method in class Base

adds production option to npm

Behat::noInteraction() — Method in class Behat

Behat::noColors() — Method in class Behat

Codecept::noRebuild() — Method in class Codecept

Codecept::noExit() — Method in class Codecept

Phpspec::noCodeGeneration() — Method in class Phpspec

Phpspec::noAnsi() — Method in class Phpspec

Phpspec::noInteraction() — Method in class Phpspec

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/13.x/src/Commands/LegacyCommands.php

Option — Class in namespace Drush\Attributes

OptionsetGetEditor — Class in namespace Drush\Attributes

OptionsetProcBuild — Class in namespace Drush\Attributes

OptionsetSql — Class in namespace Drush\Attributes

OptionsetSsh — Class in namespace Drush\Attributes

OptionsetTableSelection — Class in namespace Drush\Attributes

OptionsCommands — Class in namespace Drush\Commands

OptionsCommands::optionsetProcBuild() — Method in class OptionsCommands

OptionsCommands::optionsetGetEditor() — Method in class OptionsCommands

OptionsCommands::optionsetSsh() — Method in class OptionsCommands

OptionsCommands::optionsetSql() — Method in class OptionsCommands

OptionsCommands::optionsetTableSelection() — Method in class OptionsCommands

DocsCommands::outputFormatsFilters() — Method in class DocsCommands

Output formatters and filters: control the command output

DrupliconCommands::optionset() — Method in class DrupliconCommands

MkCommands::optionToArray() — Method in class MkCommands

Build an array since that's what HelpCLIFormatter expects.

NotifyCommands::optionsetNotify() — Method in class NotifyCommands

XhprofCommands::optionsetXhProf() — Method in class XhprofCommands

HelpCLIFormatter::optionRows() — Method in class HelpCLIFormatter

SanitizeUserFieldsCommands::options() — Method in class SanitizeUserFieldsCommands

SanitizeUserTableCommands::options() — Method in class SanitizeUserTableCommands

$ Environment#originalCwd — Property in class Environment

$ MigrateExecutable#output — Property in class MigrateExecutable

The Symfony console output.

MigrateExecutable::onMapSave() — Method in class MigrateExecutable

Counts up any map save events.

MigrateExecutable::onMapDelete() — Method in class MigrateExecutable

Counts up any rollback events.

MigrateExecutable::onPreImport() — Method in class MigrateExecutable

Reacts when the import is about to start.

MigrateExecutable::onMissingSourceRows() — Method in class MigrateExecutable

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

MigrateExecutable::onPostImport() — Method in class MigrateExecutable

Reacts to migration completion.

MigrateExecutable::onPreRollback() — Method in class MigrateExecutable

Reacts when the rollback is about to starts.

MigrateExecutable::onPostRollback() — Method in class MigrateExecutable

Reacts to rollback completion.

MigrateExecutable::onPreRowSave() — Method in class MigrateExecutable

Reacts to an item about to be imported.

MigrateExecutable::onPostRowSave() — Method in class MigrateExecutable

Reacts aftre a row has been deleted.

MigrateExecutable::onPostRowDelete() — Method in class MigrateExecutable

Reacts to item rollback.

MigrateExecutable::onPrepareRow() — Method in class MigrateExecutable

Reacts to a new row being prepared.

Drush::output() — Method in class Drush

Return the output object

PreflightArgs::optionsWithValues() — Method in class PreflightArgs

PreflightArgs::optionConfigMap() — Method in class PreflightArgs

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

PreflightArgs::optionConfigPathMap() — Method in class PreflightArgs

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

PreflightArgsInterface::optionsWithValues() — Method in class PreflightArgsInterface

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

$ PreflightLog#output — Property in class PreflightLog

OutputUtilsTrait — Class in namespace Drush\TestTraits

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

CollectionBuilder::original() — Method in class CollectionBuilder

CompletionWrapper::original() — Method in class CompletionWrapper

CommandArguments::option() — Method in class CommandArguments

Pass option to executable. Options are prefixed with -- , value can be provided in second parameter.

CommandArguments::options() — Method in class CommandArguments

Pass multiple options to executable. The associative array contains the key:value pairs that become --key value, for each item in the array.

CommandArguments::optionList() — Method in class CommandArguments

Pass an option with multiple values to executable. Value can be a string or array.

$ IO#obj — Property in class IO

$ IO#output — Property in class IO

OutputAdapter — Class in namespace Robo\Common

Adapt OutputInterface or other output function to the VerbosityThresholdInterface.

OutputAwareTrait — Class in namespace Robo\Common

$ OutputAwareTrait#output — Property in class OutputAwareTrait

OutputAwareTrait::output() — Method in class OutputAwareTrait

$ ProgressIndicator#output — Property in class ProgressIndicator

$ ProgressIndicator#owner — Property in class ProgressIndicator

$ TaskIO#output — Property in class TaskIO

$ VerbosityThresholdTrait#outputAdapter — Property in class VerbosityThresholdTrait

VerbosityThresholdTrait::outputAdapter() — Method in class VerbosityThresholdTrait

OutputAdapterInterface — Class in namespace Robo\Contract

Adapt OutputInterface or other output function to the VerbosityThresholdInterface.

OutputAwareInterface — Class in namespace Robo\Contract

VerbosityThresholdInterface::outputAdapter() — Method in class VerbosityThresholdInterface

WrappedTaskInterface::original() — Method in class WrappedTaskInterface

Robo::output() — Method in class Robo

Return the output object.

$ ConsoleIO#output — Property in class ConsoleIO

ConsoleIO::output() — Method in class ConsoleIO

$ ApiGen#operation — Property in class ApiGen

ImageMinify::optipng() — Method in class ImageMinify

SymfonyCommand::opt() — Method in class SymfonyCommand

$ Base#opts — Property in class Base

Base::offline() — Method in class Base

adds offline option to bower

Base::optimizeAutoloader() — Method in class Base

adds optimize-autoloader option to composer

$ DumpAutoload#optimize — Property in class DumpAutoload

DumpAutoload::optimize() — Method in class DumpAutoload

$ GitHub#owner — Property in class GitHub

GitHub::owner() — Method in class GitHub

OpenBrowser — Class in namespace Robo\Task\Development

Opens the default's user browser code inspired from openBrowser() function in https://github.com/composer/composer/blob/master/src/Composer/Command/HomeCommand.php

$ Write#originalContents — Property in class Write

Write::originalContents() — Method in class Write

$ CopyDir#overwrite — Property in class CopyDir

Overwrite destination files newer than source files.

CopyDir::overwrite() — Method in class CopyDir

Destination files newer than source files are overwritten.

$ Base#opts — Property in class Base

$ Base#opts — Property in class Base

Rsync::owner() — Method in class Rsync

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

ConfiguresPrompts::promptUntilValid() — Method in class ConfiguresPrompts

Prompt the user until the given validation callback passes.

DrushCommands::printFile() — Method in class DrushCommands

Print the contents of a file.

DrushCommands::preHook() — Method in class DrushCommands

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

DrushCommands::printFileTopic() — Method in class DrushCommands

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

DrushCommands::processManager() — Method in class DrushCommands

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

ConfigPullCommands::pull() — Method in class ConfigPullCommands

Export and transfer config from one environment to another.

ArchiveDumpCommands::prepareArchiveDir() — Method in class ArchiveDumpCommands

Creates a temporary directory for the archive.

BatchCommands::process() — Method in class BatchCommands

Process operations in the specified batch set.

DocsCommands::policy() — Method in class DocsCommands

Example policy file.

$ DrupalDirectoryCommands#pathEvaluator — Property in class DrupalDirectoryCommands

$ DrupliconCommands#printed — Property in class DrupliconCommands

EditCommands::phpIniFiles() — Method in class EditCommands

ImageCommands::postInit() — Method in class ImageCommands

MessengerCommands::pre() — Method in class MessengerCommands

MessengerCommands::post() — Method in class MessengerCommands

MigrateRunnerCommands::padTableRow() — Method in class MigrateRunnerCommands

Pads an incomplete table row with empty cells.

MigrateRunnerCommands::preprocessMessageRow() — Method in class MigrateRunnerCommands

Preprocesses migrate message rows.

MkCommands::prepare() — Method in class MkCommands

Empty target directories.

PhpCommands — Class in namespace Drush\Commands\core

$ RsyncCommands#pathEvaluator — Property in class RsyncCommands

RsyncCommands::preCommandEvent() — Method in class RsyncCommands

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

RunserverCommands::parseUri() — Method in class RunserverCommands

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

SiteInstallCommands::pre() — Method in class SiteInstallCommands

Perform setup tasks before installation.

StatusCommands::pathAliases() — Method in class StatusCommands

UpdateDBCommands::process() — Method in class UpdateDBCommands

Process operations in the specified batch set.

UserCommands::password() — Method in class UserCommands

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

PmCommands — Class in namespace Drush\Commands\pm

PmCommands::pmList() — Method in class PmCommands

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

$ ConfigLocator#processedConfigPaths — Property in class ConfigLocator

$ MigrateExecutable#preExistingItem — Property in class MigrateExecutable

Whether the destination item exists before saving.

$ MigrateExecutable#progressBar — Property in class MigrateExecutable

The Symfony progress bar.

MigrateExecutable::progressFinish() — Method in class MigrateExecutable

Removes the progress bar after operation is finished.

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

$ DrushLog#parser — Property in class DrushLog

The message's placeholders parser.

ArgsPreprocessor::parse() — Method in class ArgsPreprocessor

Parse the argv array.

Preflight — Class in namespace Drush\Preflight

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

$ Preflight#preflightArgs — Property in class Preflight

Preflight::preflightArgs() — Method in class Preflight

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

Preflight::prepareConfig() — Method in class Preflight

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

Preflight::preflight() — Method in class Preflight

Preflight::preferredSite() — Method in class Preflight

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

PreflightArgs — Class in namespace Drush\Preflight

Storage for arguments preprocessed during preflight.

PreflightArgs::passArgs() — Method in class PreflightArgs

PreflightArgsInterface — Class in namespace Drush\Preflight

Storage for arguments preprocessed during preflight.

PreflightArgsInterface::passArgs() — Method in class PreflightArgsInterface

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

PreflightLog — Class in namespace Drush\Preflight

PreflightSiteLocator — Class in namespace Drush\Preflight

PreflightVerify — Class in namespace Drush\Preflight

Helper methods to verify preflight state.

ProcessManager — Class in namespace Drush\SiteAlias

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

ProcessManager::process() — Method in class ProcessManager

Run a bash fragment locally.

$ SqlBase#process — Property in class SqlBase

SqlBase::paramsToOptions() — Method in class SqlBase

BootstrapCompilerPass::process() — Method in class BootstrapCompilerPass

$ CliTestTrait#process — Property in class CliTestTrait

OutputUtilsTrait::pathsToSimplify() — Method in class OutputUtilsTrait

FsUtils::prepareBackupDir() — Method in class FsUtils

Prepare a backup directory.

$ Collection#parentCollection — Property in class Collection

Collection::progressMessage() — Method in class Collection

Print a progress message after Collection::run() has executed all of the tasks that were added prior to the point when this method was called. If one of the previous tasks fail, then this message will not be printed.

Collection::progressIndicatorSteps() — Method in class Collection

Return the count of steps in this collection

CollectionBuilder::progressMessage() — Method in class CollectionBuilder

CollectionInterface::progressMessage() — Method in class CollectionInterface

Print a progress message after Collection::run() has executed all of the tasks that were added prior to the point when this method was called. If one of the previous tasks fail, then this message will not be printed.

CollectionProcessHook::process() — Method in class CollectionProcessHook

Element::progressIndicatorSteps() — Method in class Element

$ TaskForEach#parentCollection — Property in class TaskForEach

TaskForEach::progressIndicatorSteps() — Method in class TaskForEach

$ ExecTrait#process — Property in class ExecTrait

ExecTrait::printTaskInfo() — Method in class ExecTrait

ExecTrait::printed() — Method in class ExecTrait

Should command output be printed

ExecTrait::printOutput() — Method in class ExecTrait

Should command output be printed

ExecTrait::printMetadata() — Method in class ExecTrait

Should command metadata be printed. I,e., command and timer.

ExecTrait::printAction() — Method in class ExecTrait

ProcessExecutor — Class in namespace Robo\Common

ProcessUtils — Class in namespace Robo\Common

ProcessUtils is a bunch of utility methods. We want to allow Robo 1.x to work with Symfony 4.x while remaining backwards compatibility. This requires us to replace some deprecated functionality removed in Symfony.

ProgressIndicator — Class in namespace Robo\Common

Wrapper around \Symfony\Component\Console\Helper\ProgressBar

$ ProgressIndicator#progressBar — Property in class ProgressIndicator

$ ProgressIndicator#progressIndicatorRunning — Property in class ProgressIndicator

$ ProgressIndicator#progressBarDisplayed — Property in class ProgressIndicator

ProgressIndicatorAwareTrait — Class in namespace Robo\Common

$ ProgressIndicatorAwareTrait#progressIndicator — Property in class ProgressIndicatorAwareTrait

ProgressIndicatorAwareTrait::progressIndicatorSteps() — Method in class ProgressIndicatorAwareTrait

TaskIO::printTaskInfo() — Method in class TaskIO

Print information about a task in progress.

TaskIO::printTaskSuccess() — Method in class TaskIO

Provide notification that some part of the task succeeded.

TaskIO::printTaskWarning() — Method in class TaskIO

Provide notification that there is something wrong, but execution can continue.

TaskIO::printTaskError() — Method in class TaskIO

Provide notification that some operation in the task failed, and the task cannot continue.

TaskIO::printTaskDebug() — Method in class TaskIO

Provide debugging notification. These messages are only displayed if the log level is VERBOSITY_DEBUG.

TaskIO::printTaskOutput() — Method in class TaskIO

PrintedInterface — Class in namespace Robo\Contract

If task prints anything to console

ProgressIndicatorAwareInterface — Class in namespace Robo\Contract

Any Robo task that uses the Timer trait and implements ProgressIndicatorAwareInterface will display a progress bar while the timer is running.

ProgressIndicatorAwareInterface::progressIndicatorSteps() — Method in class ProgressIndicatorAwareInterface

ProgressInterface — Class in namespace Robo\Contract

Robo tasks that take multiple steps to complete should implement this interface.

ProgressInterface::progressSteps() — Method in class ProgressInterface

$ GlobalOptionsEventListener#prefix — Property in class GlobalOptionsEventListener

ResultPrinter::printResult() — Method in class ResultPrinter

Log the result of a Robo task.

ResultPrinter::printStopOnFail() — Method in class ResultPrinter

Log that we are about to abort due to an error being encountered in 'stop on fail' mode.

ResultPrinter::printError() — Method in class ResultPrinter

Log the result of a Robo task that returned an error.

ResultPrinter::printSuccess() — Method in class ResultPrinter

Log the result of a Robo task that was successful.

ResultPrinter::printMessage() — Method in class ResultPrinter

Result::printResult() — Method in class Result

ResultData::provideOutputdata() — Method in class ResultData

Opt-in to providing the result message as the output data

Robo::process() — Method in class Robo

Runner::processRoboOptions() — Method in class Runner

Check for Robo-specific arguments such as --load-from, process them, and remove them from the array. We have to process --load-from before we set up Symfony Console.

Runner::processRoboOptions() — Method in class Runner

Check for Robo-specific arguments such as --load-from, process them, and remove them from the array. We have to process --load-from before we set up Symfony Console.

ApiGen::php() — Method in class ApiGen

ApiGen::progressbar() — Method in class ApiGen

Extract::preserveTopDirectory() — Method in class Extract

Pack — Class in namespace Robo\Task\Archive

Creates a zip or tar archive.

ImageMinify::pngquant() — Method in class ImageMinify

ImageMinify::pngout() — Method in class ImageMinify

ImageMinify::pngcrush() — Method in class ImageMinify

ParallelExec — Class in namespace Robo\Task\Base

Class ParallelExecTask

$ ParallelExec#processes — Property in class ParallelExec

ParallelExec::printOutput() — Method in class ParallelExec

ParallelExec::printed() — Method in class ParallelExec

ParallelExec::process() — Method in class ParallelExec

ParallelExec::progressIndicatorSteps() — Method in class ParallelExec

$ Base#prefer — Property in class Base

Base::preferDist() — Method in class Base

adds prefer-dist option to composer

Base::preferSource() — Method in class Base

adds prefer-source option to composer

Init::projectName() — Method in class Init

Init::projectType() — Method in class Init

Changelog::processLogRow() — Method in class Changelog

$ GenerateMarkdownDoc#processClass — Property in class GenerateMarkdownDoc

$ GenerateMarkdownDoc#processClassSignature — Property in class GenerateMarkdownDoc

$ GenerateMarkdownDoc#processClassDocBlock — Property in class GenerateMarkdownDoc

$ GenerateMarkdownDoc#processMethod — Property in class GenerateMarkdownDoc

$ GenerateMarkdownDoc#processMethodSignature — Property in class GenerateMarkdownDoc

$ GenerateMarkdownDoc#processMethodDocBlock — Property in class GenerateMarkdownDoc

$ GenerateMarkdownDoc#processProperty — Property in class GenerateMarkdownDoc

$ GenerateMarkdownDoc#processPropertySignature — Property in class GenerateMarkdownDoc

$ GenerateMarkdownDoc#processPropertyDocBlock — Property in class GenerateMarkdownDoc

$ GenerateMarkdownDoc#prepend — Property in class GenerateMarkdownDoc

GenerateMarkdownDoc::processClass() — Method in class GenerateMarkdownDoc

Post-process class documentation.

GenerateMarkdownDoc::processClassSignature() — Method in class GenerateMarkdownDoc

Post-process class signature. Provide false to skip.

GenerateMarkdownDoc::processClassDocBlock() — Method in class GenerateMarkdownDoc

Post-process class docblock contents. Provide false to skip.

GenerateMarkdownDoc::processMethod() — Method in class GenerateMarkdownDoc

Post-process method documentation. Provide false to skip.

GenerateMarkdownDoc::processMethodSignature() — Method in class GenerateMarkdownDoc

Post-process method signature. Provide false to skip.

GenerateMarkdownDoc::processMethodDocBlock() — Method in class GenerateMarkdownDoc

Post-process method docblock contents. Provide false to skip.

GenerateMarkdownDoc::processProperty() — Method in class GenerateMarkdownDoc

Post-process property documentation. Provide false to skip.

GenerateMarkdownDoc::processPropertySignature() — Method in class GenerateMarkdownDoc

Post-process property signature. Provide false to skip.

GenerateMarkdownDoc::processPropertyDocBlock() — Method in class GenerateMarkdownDoc

Post-process property docblock contents. Provide false to skip.

GenerateMarkdownDoc::prepend() — Method in class GenerateMarkdownDoc

Inserts text at the beginning of markdown file.

$ GitHub#password — Property in class GitHub

GitHub::password() — Method in class GitHub

$ GitHubRelease#prerelease — Property in class GitHubRelease

GitHubRelease::prerelease() — Method in class GitHubRelease

PackPhar — Class in namespace Robo\Task\Development

Creates Phar.

$ PackPhar#phar — Property in class PackPhar

PackPhar::progressIndicatorSteps() — Method in class PackPhar

PhpServer — Class in namespace Robo\Task\Development

Runs PHP server and stops it when task finishes.

$ PhpServer#port — Property in class PhpServer

$ SemVer#path — Property in class SemVer

SemVer::prerelease() — Method in class SemVer

SemVer::parseString() — Method in class SemVer

SemVer::parseFile() — Method in class SemVer

$ Build#path — Property in class Build

Pull — Class in namespace Robo\Task\Docker

Pulls an image from DockerHub

Result::printResult() — Method in class Result

Do not print result, as it was already printed

Run::publish() — Method in class Run

Run::privileged() — Method in class Run

Write::place() — Method in class Write

substitute a placeholder with value, placeholder must be enclosed by {}.

$ FlattenDir#parents — Property in class FlattenDir

$ FlattenDir#parentDir — Property in class FlattenDir

FlattenDir::parentDir() — Method in class FlattenDir

Sets the parent directory from which the relative parent directories will be calculated.

$ TmpDir#prefix — Property in class TmpDir

Rsync::progress() — Method in class Rsync

Ssh::port() — Method in class Ssh

StackBasedTask::printTaskProgress() — Method in class StackBasedTask

Print progress about the commands being executed

StackBasedTask::processResult() — Method in class StackBasedTask

Derived classes can override processResult to add more logic to result handling from functions. By default, it is assumed that if a function returns in int, then 0 == success, and any other value is the error code.

StackBasedTask::progressIndicatorSteps() — Method in class StackBasedTask

$ Codecept#providedPathToCodeception — Property in class Codecept

PHPUnit — Class in namespace Robo\Task\Testing

Runs PHPUnit tests

Phpspec — Class in namespace Robo\Task\Testing

Executes Phpspec tests

GitStack::pull() — Method in class GitStack

Executes git pull command.

GitStack::push() — Method in class GitStack

Executes git push command

HgStack::pull() — Method in class HgStack

Executes hg pull command.

HgStack::push() — Method in class HgStack

Executes hg push command

Q

FullyQualifiedClassCache::qualify() — Method in class FullyQualifiedClassCache

QueueCommands — Class in namespace Drush\Commands\core

$ QueueCommands#queues — Property in class QueueCommands

QueueCommands::qList() — Method in class QueueCommands

Returns a list of all defined queues.

QueueCommands::queueComplete() — Method in class QueueCommands

SqlCommands::query() — Method in class SqlCommands

Execute a query against a database.

$ SqlBase#queryExtra — Property in class SqlBase

$ SqlBase#queryFile — Property in class SqlBase

SqlBase::query() — Method in class SqlBase

Execute a SQL query. Respect simulate mode.

SqlBase::queryPrefix() — Method in class SqlBase

SqlBase::queryFormat() — Method in class SqlBase

$ SqlMysql#queryExtra — Property in class SqlMysql

$ SqlPgsql#queryExtra — Property in class SqlPgsql

$ SqlPgsql#queryFile — Property in class SqlPgsql

SqlPgsql::queryFormat() — Method in class SqlPgsql

ApiGen::quiet() — Method in class ApiGen

Ssh::quiet() — Method in class Ssh

Phpspec::quiet() — Method in class Phpspec

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.

BackendPathEvaluator::resolve() — Method in class BackendPathEvaluator

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

BackendPathEvaluator::request() — Method in class BackendPathEvaluator

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

BaseBoot::reportCommandError() — Method in class BaseBoot

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

Boot::reportCommandError() — Method in class Boot

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

$ DrupalBoot8#request — Property in class DrupalBoot8

RemoteCommandProxy — Class in namespace Drush\Command

Create a placeholder proxy command to represent an unknown command.

$ RemoteCommandProxy#redispatchHook — Property in class RemoteCommandProxy

ConfiguresPrompts::restorePrompts() — Method in class ConfiguresPrompts

Restore the prompts output.

ConfiguresPrompts::runningUnitTests() — Method in class ConfiguresPrompts

CacheRebuildCommands::rebuild() — Method in class CacheRebuildCommands

Rebuild all caches.

DocsCommands::readme() — Method in class DocsCommands

README.md

DrupalCommands::requirements() — Method in class DrupalCommands

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

DrupalCommands::route() — Method in class DrupalCommands

View information about all routes or one route.

MigrateRunnerCommands::rollback() — Method in class MigrateRunnerCommands

Rollback one or more migrations.

MigrateRunnerCommands::resetStatus() — Method in class MigrateRunnerCommands

Reset an active migration's status to idle.

NotifyCommands::registerShutdown() — Method in class NotifyCommands

QueueCommands::run() — Method in class QueueCommands

Run a specific queue by name.

RoleCommands — Class in namespace Drush\Commands\core

RoleCommands::roleAddPerm() — Method in class RoleCommands

Grant specified permission(s) to a role.

RoleCommands::roleRemovePerm() — Method in class RoleCommands

Remove specified permission(s) from a role.

RoleCommands::roleList() — Method in class RoleCommands

Display roles and their permissions.

RoleCommands::renderPermsCell() — Method in class RoleCommands

RoleCommands::roleComplete() — Method in class RoleCommands

RsyncCommands — Class in namespace Drush\Commands\core

RsyncCommands::rsync() — Method in class RsyncCommands

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

RsyncCommands::rsyncOptions() — Method in class RsyncCommands

RunserverCommands — Class in namespace Drush\Commands\core

RunserverCommands::runserver() — Method in class RunserverCommands

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

StatusCommands::renderStatusCell() — Method in class StatusCommands

UpdateDBCommands::restoreMaintMode() — Method in class UpdateDBCommands

UserCommands::renderRolesCell() — Method in class UserCommands

UserCommands::removeRole() — Method in class UserCommands

Remove a role from the specified user accounts.

UserCommands::roleComplete() — Method in class UserCommands

FieldDefinitionRowsOfFieldsTrait::renderArray() — Method in class FieldDefinitionRowsOfFieldsTrait

FieldDefinitionRowsOfFieldsTrait::renderBoolean() — Method in class FieldDefinitionRowsOfFieldsTrait

ListCommands::renderListCLI() — Method in class ListCommands

ListCommands::renderListRaw() — Method in class ListCommands

SqlSyncCommands::rsync() — Method in class SqlSyncCommands

DrushLoggerServiceProvider::register() — Method in class DrushLoggerServiceProvider

ExtensionDiscovery::reset() — Method in class ExtensionDiscovery

MigrateExecutable::rollbackFeedbackMessage() — Method in class MigrateExecutable

Emits information on the rollback execution progress.

MigrateExecutable::resetCounters() — Method in class MigrateExecutable

Resets all the per-status counters to 0.

$ MigratePrepareRowEvent#row — Property in class MigratePrepareRowEvent

Row object.

$ Drush#runner — Property in class Drush

The Robo Runner -- manages and constructs all commandfile classes

Drush::runner() — Method in class Drush

Return the Robo runner.

Drush::redispatchOptions() — Method in class Drush

$ ArgsPreprocessor#remapper — Property in class ArgsPreprocessor

$ ArgsRemapper#remapOptions — Property in class ArgsRemapper

$ ArgsRemapper#remapCommandAliases — Property in class ArgsRemapper

ArgsRemapper::remap() — Method in class ArgsRemapper

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

ArgsRemapper::remapOptions() — Method in class ArgsRemapper

ArgsRemapper::remapCommandAlias() — Method in class ArgsRemapper

Preflight::remapOptions() — Method in class Preflight

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

Preflight::remapCommandAliases() — Method in class Preflight

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

LegacyServiceInstantiator::resolveArguments() — Method in class LegacyServiceInstantiator

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

LegacyServiceInstantiator::resolveArgument() — Method in class LegacyServiceInstantiator

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

LegacyServiceInstantiator::resolveFromContainer() — Method in class LegacyServiceInstantiator

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

RedispatchHook — Class in namespace Drush\Runtime

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

RedispatchHook::redispatchIfRemote() — Method in class RedispatchHook

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

RedispatchHook::redispatch() — Method in class RedispatchHook

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

Runtime — Class in namespace Drush\Runtime

Control the Drush runtime environment

Runtime::run() — Method in class Runtime

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

ServiceManager::requiresBootstrap() — Method in class ServiceManager

Check whether a command class requires Drupal bootstrap.

ShutdownHandler::returnStatus() — Method in class ShutdownHandler

ProcessManager::relativePathToVendorBinDrush() — Method in class ProcessManager

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

FsUtils::registerForDeletion() — Method in class FsUtils

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

FsUtils::realpath() — Method in class FsUtils

Returns canonicalized absolute pathname.

StringUtils::replaceTilde() — Method in class StringUtils

Replace tilde in a path with the HOME directory.

RelativeNamespaceDiscovery — Class in namespace Robo\ClassDiscovery

Class RelativeNamespaceDiscovery

$ RelativeNamespaceDiscovery#relativeNamespace — Property in class RelativeNamespaceDiscovery

$ CallableTask#reference — Property in class CallableTask

CallableTask::run() — Method in class CallableTask

$ Collection#rollbackStack — Property in class Collection

Collection::rollback() — Method in class Collection

Add a rollback task to our task collection. A rollback task will execute ONLY if all of the tasks added before it complete successfully, AND some task added after it fails.

Collection::rollbackCode() — Method in class Collection

Add arbitrary code to execute as a rollback.

Collection::registerRollback() — Method in class Collection

Register a rollback task to run if there is any failure.

Collection::registerCompletion() — Method in class Collection

Register a completion task to run once all other tasks finish.

Collection::run() — Method in class Collection

Run our tasks, and roll back if necessary.

Collection::reset() — Method in class Collection

Reset this collection, removing all tasks.

Collection::runRollbackTasks() — Method in class Collection

Run all of our rollback tasks.

Collection::runSubtask() — Method in class Collection

Collection::runTaskListIgnoringFailures() — Method in class Collection

Run all of the tasks in a provided list, ignoring failures.

CollectionBuilder::rollback() — Method in class CollectionBuilder

CollectionBuilder::rollbackCode() — Method in class CollectionBuilder

CollectionBuilder::run() — Method in class CollectionBuilder

When we run the collection builder, run everything in the collection.

CollectionBuilder::runTasks() — Method in class CollectionBuilder

If there is a single task, run it; if there is a collection, run all of its tasks.

CollectionInterface::rollback() — Method in class CollectionInterface

Add a rollback task to our task collection. A rollback task will execute ONLY if all of the tasks added before it complete successfully, AND some task added after it fails.

CollectionInterface::rollbackCode() — Method in class CollectionInterface

Add arbitrary code to execute as a rollback.

CompletionWrapper::run() — Method in class CompletionWrapper

Before running this task, register its rollback and completion handlers on its collection. The reason this class exists is to defer registration of rollback and completion tasks until 'run()' time.

TaskForEach::run() — Method in class TaskForEach

CommandArguments::rawArg() — Method in class CommandArguments

Pass the provided string in its raw (as provided) form as an argument to executable.

CommandReceiver::receiveCommand() — Method in class CommandReceiver

IO::restore() — Method in class IO

ProcessExecutor::run() — Method in class ProcessExecutor

ProgressIndicator::restoreProgressIndicator() — Method in class ProgressIndicator

ProgressIndicatorAwareTrait::restoreProgressIndicator() — Method in class ProgressIndicatorAwareTrait

ResourceExistenceChecker — Class in namespace Robo\Common

TimeKeeper::reset() — Method in class TimeKeeper

Timer::resetTimer() — Method in class Timer

Config::replace() — Method in class Config

{@inheritdoc}

RollbackInterface — Class in namespace Robo\Contract

Any Robo tasks that implements this interface will be called when the task collection it is added to fails, and runs its rollback operation.

RollbackInterface::rollback() — Method in class RollbackInterface

Revert an operation that can be rolled back

TaskInterface::run() — Method in class TaskInterface

ResultPrinter — Class in namespace Robo\Log

Log the creation of Result objects.

RoboLogLevel — Class in namespace Robo\Log

RoboLogStyle — Class in namespace Robo\Log

Robo Log Styler.

RoboLogger — Class in namespace Robo\Log

Robo's default logger

Result — Class in namespace Robo

Result::resultPrinter() — Method in class Result

ResultData — Class in namespace Robo

Robo — Class in namespace Robo

Manages the container reference and other static data. Favor using dependency injection wherever possible. Avoid using this class directly, unless setting up a custom DI container.

Robo::run() — Method in class Robo

Entrypoint for standalone Robo-based tools. See docs/framework.md.

Robo::resultPrinter() — Method in class Robo

Return the result printer object.

Robo::register() — Method in class Robo

Robo::registerSingle() — Method in class Robo

Runner — Class in namespace Robo

$ Runner#roboClass — Property in class Runner

$ Runner#roboFile — Property in class Runner

$ Runner#relativePluginNamespace — Property in class Runner

Runner::run() — Method in class Runner

Runner::registerCommandClasses() — Method in class Runner

Runner::registerCommandClass() — Method in class Runner

Runner — Class in namespace Robo\Runtime

$ Runner#roboClass — Property in class Runner

$ Runner#roboFile — Property in class Runner

$ Runner#relativePluginNamespace — Property in class Runner

Runner::run() — Method in class Runner

Runner::registerCommandClasses() — Method in class Runner

Runner::registerCommandClass() — Method in class Runner

Consumer::receiveState() — Method in class Consumer

StateAwareInterface::resetState() — Method in class StateAwareInterface

StateAwareTrait::resetState() — Method in class StateAwareTrait

ApiGen::report() — Method in class ApiGen

ApiGen::run() — Method in class ApiGen

Extract::run() — Method in class Extract

Pack::run() — Method in class Pack

Create a zip archive for distribution.

CssPreprocessor::run() — Method in class CssPreprocessor

$ ImageMinify#results — Property in class ImageMinify

Array for the individual results of all the files.

ImageMinify::run() — Method in class ImageMinify

Minify::run() — Method in class Minify

Exec::run() — Method in class Exec

ParallelExec::run() — Method in class ParallelExec

SymfonyCommand::run() — Method in class SymfonyCommand

Watch::run() — Method in class Watch

Install::run() — Method in class Install

Update::run() — Method in class Update

$ CommandStack#result — Property in class CommandStack

CommandStack::result() — Method in class CommandStack

CommandStack::run() — Method in class CommandStack

CheckPlatformReqs::run() — Method in class CheckPlatformReqs

Config::repository() — Method in class Config

Config::removeRepository() — Method in class Config

Config::run() — Method in class Config

CreateProject::repository() — Method in class CreateProject

CreateProject::run() — Method in class CreateProject

DumpAutoload::run() — Method in class DumpAutoload

Init::repository() — Method in class Init

Init::run() — Method in class Init

Install::run() — Method in class Install

Remove — Class in namespace Robo\Task\Composer

Composer Remove

Remove::run() — Method in class Remove

RequireDependency — Class in namespace Robo\Task\Composer

Composer Require

RequireDependency::run() — Method in class RequireDependency

Update::run() — Method in class Update

Validate::run() — Method in class Validate

Changelog::run() — Method in class Changelog

$ GenerateMarkdownDoc#reorder — Property in class GenerateMarkdownDoc

$ GenerateMarkdownDoc#reorderMethods — Property in class GenerateMarkdownDoc

$ GenerateMarkdownDoc#reorderProperties — Property in class GenerateMarkdownDoc

GenerateMarkdownDoc::reorder() — Method in class GenerateMarkdownDoc

Use a function to reorder classes.

GenerateMarkdownDoc::reorderMethods() — Method in class GenerateMarkdownDoc

Use a function to reorder methods in class.

GenerateMarkdownDoc::reorderProperties() — Method in class GenerateMarkdownDoc

GenerateMarkdownDoc::run() — Method in class GenerateMarkdownDoc

GenerateTask::run() — Method in class GenerateTask

$ GitHub#repo — Property in class GitHub

GitHub::repo() — Method in class GitHub

GitHubRelease::run() — Method in class GitHubRelease

OpenBrowser::run() — Method in class OpenBrowser

PackPhar::run() — Method in class PackPhar

SemVer::run() — Method in class SemVer

Base::run() — Method in class Base

$ Exec#run — Property in class Exec

Remove — Class in namespace Robo\Task\Docker

Remove docker container

Result — Class in namespace Robo\Task\Docker

Run — Class in namespace Robo\Task\Docker

Performs docker run on a container.

$ Run#run — Property in class Run

Run::run() — Method in class Run

Concat::run() — Method in class Concat

Replace — Class in namespace Robo\Task\File

Performs search and replace inside a files.

$ Replace#regex — Property in class Replace

Replace::regex() — Method in class Replace

Regex to match string to be replaced.

Replace::run() — Method in class Replace

Write::replace() — Method in class Write

replace any string with value.

Write::regexReplace() — Method in class Write

replace any string with value using regular expression.

Write::replaceCollect() — Method in class Write

Write::regexReplaceCollect() — Method in class Write

Write::run() — Method in class Write

CleanDir::run() — Method in class CleanDir

CopyDir::run() — Method in class CopyDir

DeleteDir::run() — Method in class DeleteDir

FilesystemStack::remove() — Method in class FilesystemStack

FilesystemStack::rename() — Method in class FilesystemStack

FlattenDir::run() — Method in class FlattenDir

MirrorDir::run() — Method in class MirrorDir

TmpDir::randomLocation() — Method in class TmpDir

Add a random part to a path, ensuring that the directory does not (currently) exist.

TmpDir::randomString() — Method in class TmpDir

Generate a suitably random string to use as the suffix for our temporary directory.

TmpDir::run() — Method in class TmpDir

TmpDir::restoreWorkingDirectory() — Method in class TmpDir

WorkDir::run() — Method in class WorkDir

Create our working directory.

WorkDir::rollback() — Method in class WorkDir

Delete our working directory

Run — Class in namespace Robo\Task\Gulp

Gulp Run

Run::run() — Method in class Run

RotateLog — Class in namespace Robo\Task\Logfile

Rotates a log (or any other) file

RotateLog::run() — Method in class RotateLog

TruncateLog::run() — Method in class TruncateLog

Install::run() — Method in class Install

Update::run() — Method in class Update

Rsync — Class in namespace Robo\Task\Remote

Executes rsync in a flexible manner.

Rsync::recursive() — Method in class Rsync

Rsync::remoteShell() — Method in class Rsync

Rsync::run() — Method in class Rsync

$ Ssh#remoteDir — Property in class Ssh

Changes to the given directory before running commands.

Ssh::remoteDir() — Method in class Ssh

Changes to the given directory before running commands.

Ssh::run() — Method in class Ssh

Simulator::run() — Method in class Simulator

StackBasedTask::run() — Method in class StackBasedTask

Run all of the queued objects on the stack

Atoum::run() — Method in class Atoum

Behat::run() — Method in class Behat

Codecept::run() — Method in class Codecept

PHPUnit::run() — Method in class PHPUnit

Phpspec::run() — Method in class Phpspec

GitStack::run() — Method in class GitStack

HgStack::run() — Method in class HgStack

$ SvnStack#result — Property in class SvnStack

{@inheritdoc}

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

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.

LegacyCommands::saconvert() — Method in class LegacyCommands

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

LegacyCommands::secphp() — Method in class LegacyCommands

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

LegacyCommands::sec() — Method in class LegacyCommands

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

ConfigCommands::set() — Method in class ConfigCommands

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

ConfigCommands::status() — Method in class ConfigCommands

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

ConfigExportCommands::setExportStorage() — Method in class ConfigExportCommands

ConfigExportCommands::setConfigStorageSync() — Method in class ConfigExportCommands

ConfigImportCommands::setConfigStorageSync() — Method in class ConfigImportCommands

ConfigImportCommands::setImportTransformer() — Method in class ConfigImportCommands

CacheCommands::set() — Method in class CacheCommands

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

CacheCommands::setPrepareData() — Method in class CacheCommands

DocsCommands::siteAliases() — Method in class DocsCommands

Creating site aliases for running Drush on remote sites.

DocsCommands::script() — Method in class DocsCommands

An example Drush script.

DocsCommands::syncHttp() — Method in class DocsCommands

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

DrupalDependenciesCommands::scanConfigs() — Method in class DrupalDependenciesCommands

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

EntityCreateCommands::setValue() — Method in class EntityCreateCommands

MaintCommands::set() — Method in class MaintCommands

Set maintenance mode.

MaintCommands::status() — Method in class MaintCommands

Fail if maintenance mode is enabled.

MigrateRunnerCommands::setMigrationPluginManager() — Method in class MigrateRunnerCommands

Provide a migration plugin manager.

MigrateRunnerCommands::status() — Method in class MigrateRunnerCommands

List all migrations with current status.

MigrateRunnerCommands::stop() — Method in class MigrateRunnerCommands

Stop an active migration operation.

NotifyCommands::shutdown() — Method in class NotifyCommands

NotifyCommands::shutdownSend() — Method in class NotifyCommands

Prepares and dispatches notifications to delivery mechanisms.

NotifyCommands::shutdownSendText() — Method in class NotifyCommands

Send text-based system notification.

PhpCommands::script() — Method in class PhpCommands

Run php a script after a full Drupal bootstrap.

$ RsyncCommands#sourceEvaluatedPath — Property in class RsyncCommands

SiteCommands — Class in namespace Drush\Commands\core

SiteCommands::siteSet() — Method in class SiteCommands

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

SiteCommands::siteAlias() — Method in class SiteCommands

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

SiteCommands::siteAliasExportList() — Method in class SiteCommands

SiteInstallCommands — Class in namespace Drush\Commands\core

SiteInstallCommands::serverGlobals() — Method in class SiteInstallCommands

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

SshCommands — Class in namespace Drush\Commands\core

SshCommands::ssh() — Method in class SshCommands

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

StateCommands — Class in namespace Drush\Commands\core

StateCommands::set() — Method in class StateCommands

Set a state value.

StatusCommands — Class in namespace Drush\Commands\core

StatusCommands::status() — Method in class StatusCommands

An overview of the environment - Drush and Drupal.

WatchdogCommands::show() — Method in class WatchdogCommands

Show watchdog messages.

WatchdogCommands::showOne() — Method in class WatchdogCommands

Show one log record by ID.

FieldCreateCommands::setContentTranslationManager() — Method in class FieldCreateCommands

SqlCommands — Class in namespace Drush\Commands\sql

SqlSyncCommands — Class in namespace Drush\Commands\sql

SqlSyncCommands::sqlsync() — Method in class SqlSyncCommands

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

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

SanitizeCommands::sanitize() — Method in class SanitizeCommands

Sanitize the database by removing or obfuscating user data.

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

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

SanitizeCommentsCommands::sanitize() — Method in class SanitizeCommentsCommands

Sanitize comment names from the DB.

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

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

SanitizePluginInterface::sanitize() — Method in class SanitizePluginInterface

Run your sanitization logic using standard Drupal APIs.

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

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

SanitizeSessionsCommands::sanitize() — Method in class SanitizeSessionsCommands

Sanitize sessions from the DB.

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

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

SanitizeUserFieldsCommands::sanitize() — Method in class SanitizeUserFieldsCommands

Sanitize string fields associated with the user.

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

A sql:sanitize plugin.

SanitizeUserTableCommands::sanitize() — Method in class SanitizeUserTableCommands

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

$ ConfigLocator#sources — Property in class ConfigLocator

$ ConfigLocator#siteRoots — Property in class ConfigLocator

ConfigLocator::setLocal() — Method in class ConfigLocator

Put the config locator into 'local 'mode.

ConfigLocator::sources() — Method in class ConfigLocator

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

ConfigLocator::setComposerRoot() — Method in class ConfigLocator

Sets the composer root.

DrushConfig::simulate() — Method in class DrushConfig

Return 'true' if we are in simulated mode.

$ Environment#sharePrefix — Property in class Environment

$ Environment#siteLoader — Property in class Environment

Environment::setConfigFileVariant() — Method in class Environment

Environment::setLoader() — Method in class Environment

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

Environment::setEtcPrefix() — Method in class Environment

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

Environment::setSharePrefix() — Method in class Environment

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

Environment::systemPathPrefix() — Method in class Environment

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

Environment::systemConfigPath() — Method in class Environment

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

Environment::systemCommandFilePath() — Method in class Environment

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

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.

$ MigratePrepareRowEvent#source — Property in class MigratePrepareRowEvent

Migration source plugin.

Drush::sanitizeVersionString() — Method in class Drush

Convert internal Composer dev version to ".x"

Drush::setContainer() — Method in class Drush

Sets a new global container.

Drush::service() — Method in class Drush

Retrieves a service from the container.

Drush::siteProcess() — Method in class Drush

Run a bash fragment on a site alias.

Drush::shell() — Method in class Drush

Create a Process instance from a commandline string.

Drush::simulate() — Method in class Drush

Return 'true' if we are in simulated mode

ExecTrait::startBrowser() — Method in class ExecTrait

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

EntityToArraySimplifier::simplifyToArray() — Method in class EntityToArraySimplifier

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.

DrushLoggerManager::success() — Method in class DrushLoggerManager

Log a 'success' message.

SuccessInterface — Class in namespace Drush\Log

SuccessInterface::success() — Method in class SuccessInterface

Log a 'success' message.

$ ArgsPreprocessor#specParser — Property in class ArgsPreprocessor

ArgsPreprocessor::setArgsRemapper() — Method in class ArgsPreprocessor

Preflight::setLogger() — Method in class Preflight

PreflightArgs::setHomeDir() — Method in class PreflightArgs

PreflightArgs::setCommandName() — Method in class PreflightArgs

PreflightArgs::setAlias() — Method in class PreflightArgs

PreflightArgs::selectedSite() — Method in class PreflightArgs

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

PreflightArgs::setDebug() — Method in class PreflightArgs

PreflightArgs::setSelectedSite() — Method in class PreflightArgs

Set the selected site.

PreflightArgs::setUri() — Method in class PreflightArgs

Set the uri option

PreflightArgs::setLocal() — Method in class PreflightArgs

Set local mode

PreflightArgs::setSimulate() — Method in class PreflightArgs

Set simulated mode

PreflightArgs::setCoverageFile() — Method in class PreflightArgs

Set the coverage file path.

PreflightArgs::setStrict() — Method in class PreflightArgs

Set strict mode.

PreflightArgsInterface::setCommandName() — Method in class PreflightArgsInterface

Store the command name, once it is found.

PreflightArgsInterface::setAlias() — Method in class PreflightArgsInterface

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

PreflightLog::setDebug() — Method in class PreflightLog

$ PreflightSiteLocator#siteAliasManager — Property in class PreflightSiteLocator

Shell — Class in namespace Drush\Psysh

Runtime::setCompleted() — Method in class Runtime

Mark the current request as having completed successfully.

Runtime::setExitCode() — Method in class Runtime

Mark the exit code for current request.

ServiceManager — Class in namespace Drush\Runtime

Manage Drush services.

ServiceManager::supportsCompoundContainer() — Method in class ServiceManager

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

ShutdownHandler — Class in namespace Drush\Runtime

Drush's shutdown handler

ShutdownHandler::shutdownHandler() — Method in class ShutdownHandler

ProcessManager::setDrupalFinder() — Method in class ProcessManager

ProcessManager::siteProcess() — Method in class ProcessManager

ProcessManager::shell() — Method in class ProcessManager

Create a Process instance from a commandline string.

SiteAliasFileLoader — Class in namespace Drush\SiteAlias

Discover alias files:

SiteAliasManagerAwareInterface — Class in namespace Drush\SiteAlias

Inflection interface for the site alias manager.

SiteAliasName — Class in namespace Drush\SiteAlias

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

SiteSpecParser — Class in namespace Drush\SiteAlias

Parse a string that contains a site specification.

SqlBase — Class in namespace Drush\Sql

The base implementation for Drush database connections.

SqlBase::setProcess() — Method in class SqlBase

SqlBase::setDbSpec() — Method in class SqlBase

Set the current db spec.

SqlBase::silent() — Method in class SqlBase

SqlBase::scheme() — Method in class SqlBase

The active database driver.

SqlBase::su() — Method in class SqlBase

Adjust DB connection with superuser credentials if provided.

SqlException — Class in namespace Drush\Sql

SqlMariaDB — Class in namespace Drush\Sql

SqlMysql — Class in namespace Drush\Sql

SqlMysql::setVersion() — Method in class SqlMysql

SqlMysql::silent() — Method in class SqlMysql

SqlPgsql — Class in namespace Drush\Sql

SqlSqlite — Class in namespace Drush\Sql

SqlTableSelectionTrait — Class in namespace Drush\Sql

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

CliTestTrait::startExecute() — Method in class CliTestTrait

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

OutputUtilsTrait::simplifyOutput() — Method in class OutputUtilsTrait

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

StringUtils — Class in namespace Drush\Utils

$ AbstractClassDiscovery#searchPattern — Property in class AbstractClassDiscovery

AbstractClassDiscovery::setSearchPattern() — Method in class AbstractClassDiscovery

ClassDiscoveryInterface::setSearchPattern() — Method in class ClassDiscoveryInterface

RelativeNamespaceDiscovery::setRelativeNamespace() — Method in class RelativeNamespaceDiscovery

RelativeNamespaceDiscovery::search() — Method in class RelativeNamespaceDiscovery

Collection::setProgressBarAutoDisplayInterval() — Method in class Collection

Collection::setParentCollection() — Method in class Collection

Set the parent collection. This is necessary so that nested collections' rollback and completion tasks can be added to the top-level collection, ensuring that the rollbacks for a collection will run if any later task fails.

Collection::storeState() — Method in class Collection

Collection::setParentCollectionForTask() — Method in class Collection

$ CollectionBuilder#simulated — Property in class CollectionBuilder

CollectionBuilder::simulated() — Method in class CollectionBuilder

CollectionBuilder::setParentCollection() — Method in class CollectionBuilder

CollectionBuilder::storeState() — Method in class CollectionBuilder

CollectionBuilder::setVerbosityThreshold() — Method in class CollectionBuilder

NestedCollectionInterface::setParentCollection() — Method in class NestedCollectionInterface

TaskForEach::setIterable() — Method in class TaskForEach

TaskForEach::showIterationMessage() — Method in class TaskForEach

TaskForEach::setParentCollection() — Method in class TaskForEach

BuilderAwareTrait::setBuilder() — Method in class BuilderAwareTrait

ConfigAwareTrait::setConfig() — Method in class ConfigAwareTrait

Set the config management object.

ExecTrait::startTimer() — Method in class ExecTrait

ExecTrait::stopTimer() — Method in class ExecTrait

ExecTrait::showTaskProgress() — Method in class ExecTrait

ExecTrait::setProcessInput() — Method in class ExecTrait

Pass an input to the process. Can be resource created with fopen() or string

ExecTrait::setInput() — Method in class ExecTrait

Pass an input to the process. Can be resource created with fopen() or string

ExecTrait::silent() — Method in class ExecTrait

Shortcut for setting isPrinted() and isMetadataPrinted() to false.

ExecTrait::stop() — Method in class ExecTrait

InputAwareTrait::setInput() — Method in class InputAwareTrait

OutputAwareTrait::setOutput() — Method in class OutputAwareTrait

OutputAwareTrait::stderr() — Method in class OutputAwareTrait

ProgressIndicator::setProgressBarAutoDisplayInterval() — Method in class ProgressIndicator

ProgressIndicator::showProgressIndicator() — Method in class ProgressIndicator

ProgressIndicator::startProgressIndicator() — Method in class ProgressIndicator

ProgressIndicator::stopProgressIndicator() — Method in class ProgressIndicator

ProgressIndicatorAwareTrait::setProgressIndicator() — Method in class ProgressIndicatorAwareTrait

ProgressIndicatorAwareTrait::showProgressIndicator() — Method in class ProgressIndicatorAwareTrait

ProgressIndicatorAwareTrait::startProgressIndicator() — Method in class ProgressIndicatorAwareTrait

ProgressIndicatorAwareTrait::stopProgressIndicator() — Method in class ProgressIndicatorAwareTrait

TaskIO::setOutput() — Method in class TaskIO

TaskIO::showTaskProgress() — Method in class TaskIO

$ TimeKeeper#startedAt — Property in class TimeKeeper

TimeKeeper::start() — Method in class TimeKeeper

TimeKeeper::stop() — Method in class TimeKeeper

Timer::startTimer() — Method in class Timer

Timer::stopTimer() — Method in class Timer

VerbosityThresholdTrait::setVerbosityThreshold() — Method in class VerbosityThresholdTrait

Required verbosity level before any TaskIO output will be produced.

VerbosityThresholdTrait::setOutputAdapter() — Method in class VerbosityThresholdTrait

Config::setSimulated() — Method in class Config

Config::setInteractive() — Method in class Config

Config::setDecorated() — Method in class Config

Config::setProgressBarAutoDisplayInterval() — Method in class Config

BuilderAwareInterface::setBuilder() — Method in class BuilderAwareInterface

Set the builder reference

ProgressIndicatorAwareInterface::setProgressIndicator() — Method in class ProgressIndicatorAwareInterface

SimulatedInterface — Class in namespace Robo\Contract

Task that implements this interface can be injected as a parameter for other task.

SimulatedInterface::simulate() — Method in class SimulatedInterface

Called in place of run() for simulated tasks.

VerbosityThresholdInterface::setVerbosityThreshold() — Method in class VerbosityThresholdInterface

VerbosityThresholdInterface::setOutputAdapter() — Method in class VerbosityThresholdInterface

GlobalOptionsEventListener::setApplication() — Method in class GlobalOptionsEventListener

Add a reference to the Symfony Console application object.

GlobalOptionsEventListener::setGlobalOptionsPrefix() — Method in class GlobalOptionsEventListener

Stipulate the prefix to use for option injection.

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.

GlobalOptionsEventListener::setConfigurationValues() — Method in class GlobalOptionsEventListener

Examine the commandline --define / -D options, and apply the provided values to the active configuration.

GlobalOptionsEventListener::splitConfigKeyValue() — Method in class GlobalOptionsEventListener

Split up the key=value config setting into its component parts. If the input string contains no '=' character, then the value will be 'true'.

ResultPrinter::setOutput() — Method in class ResultPrinter

Sets the Console Output.

$ Result#stopOnFail — Property in class Result

Result::success() — Method in class Result

Result::stopOnFail() — Method in class Result

Robo::setContainer() — Method in class Robo

Sets a new global container.

Robo::service() — Method in class Robo

Retrieves a service from the container.

$ Runner#selfUpdateRepository — Property in class Runner

GitHub Repo for SelfUpdate.

Runner::shebang() — Method in class Runner

Process a shebang script, if one was used to launch this Runner.

Runner::shutdown() — Method in class Runner

Runner::setSelfUpdateRepository() — Method in class Runner

Runner::setConfigurationFilename() — Method in class Runner

Runner::setEnvConfigPrefix() — Method in class Runner

Runner::setClassLoader() — Method in class Runner

Runner::setRelativePluginNamespace() — Method in class Runner

$ Runner#selfUpdateRepository — Property in class Runner

GitHub Repo for SelfUpdate.

Runner::shebang() — Method in class Runner

Process a shebang script, if one was used to launch this Runner.

Runner::shutdown() — Method in class Runner

Runner::setSelfUpdateRepository() — Method in class Runner

Runner::setConfigurationFilename() — Method in class Runner

Runner::setEnvConfigPrefix() — Method in class Runner

Runner::setClassLoader() — Method in class Runner

Runner::setRelativePluginNamespace() — Method in class Runner

Data::setMessage() — Method in class Data

StateAwareInterface — Class in namespace Robo\State

StateAwareInterface::setState() — Method in class StateAwareInterface

StateAwareInterface::setStateValue() — Method in class StateAwareInterface

StateAwareTrait — Class in namespace Robo\State

$ StateAwareTrait#state — Property in class StateAwareTrait

StateAwareTrait::setState() — Method in class StateAwareTrait

StateAwareTrait::setStateValue() — Method in class StateAwareTrait

ConsoleIO::say() — Method in class ConsoleIO

SymfonyStyleInjector — Class in namespace Robo\Symfony

ApiGen::source() — Method in class ApiGen

ApiGen::skipDocPath() — Method in class ApiGen

ApiGen::skipDocPrefix() — Method in class ApiGen

ApiGen::sourceCode() — Method in class ApiGen

CssPreprocessor::setDefaultCompiler() — Method in class CssPreprocessor

CssPreprocessor::setImportPaths() — Method in class CssPreprocessor

Sets import directories

CssPreprocessor::setFormatter() — Method in class CssPreprocessor

ImageMinify::setExecutableDir() — Method in class ImageMinify

Sets the target directory for executables (vendor/bin/ by default)

ImageMinify::svgo() — Method in class ImageMinify

$ Minify#squeezeOptions — Property in class Minify

Minify::singleLine() — Method in class Minify

Single line option for the JS minimisation.

Minify::specialVarRx() — Method in class Minify

Set specialVarRx option for the JS minimisation.

Scss — Class in namespace Robo\Task\Assets

Compiles scss files.

Scss::scssphp() — Method in class Scss

scssphp compiler

Scss::setFormatter() — Method in class Scss

Sets the formatter for scssphp

Exec::simulate() — Method in class Exec

Called in place of run() for simulated tasks.

Exec::stopRunningJobs() — Method in class Exec

Shortcuts — Class in namespace Robo\Task\Base

SymfonyCommand — Class in namespace Robo\Task\Base

Executes Symfony Command

$ CommandStack#stopOnFail — Property in class CommandStack

CommandStack::stopOnFail() — Method in class CommandStack

CommandStack::stripExecutableFromCommand() — Method in class CommandStack

Config::set() — Method in class Config

Set a configuration value.

$ CreateProject#source — Property in class CreateProject

CreateProject::source() — Method in class CreateProject

CreateProject::stability() — Method in class CreateProject

Init::stability() — Method in class Init

Validate::strict() — Method in class Validate

Changelog::setBody() — Method in class Changelog

Sets the changelog body text.

Changelog::setHeader() — Method in class Changelog

GenerateMarkdownDoc::stringifyNamedType() — Method in class GenerateMarkdownDoc

GitHub::sendRequest() — Method in class GitHub

$ PackPhar#stub — Property in class PackPhar

$ PackPhar#stubTemplate — Property in class PackPhar

PackPhar::stub() — Method in class PackPhar

SemVer — Class in namespace Robo\Task\Development

Helps to maintain .semver file.

$ SemVer#specialSeparator — Property in class SemVer

SemVer::setFormat() — Method in class SemVer

SemVer::setMetadataSeparator() — Method in class SemVer

SemVer::setPrereleaseSeparator() — Method in class SemVer

Run::setDockerEnv() — Method in class Run

Start — Class in namespace Robo\Task\Docker

Starts Docker container

Stop — Class in namespace Robo\Task\Docker

Stops Docker container

$ Write#stack — Property in class Write

CopyDir::simplifyForCompare() — Method in class CopyDir

Avoid problems comparing paths on Windows that may have a combination of DIRECTORY_SEPARATOR and /.

FilesystemStack::symlink() — Method in class FilesystemStack

Shortcuts — Class in namespace Robo\Task\Filesystem

$ TmpDir#savedWorkingDirectory — Property in class TmpDir

Base::silent() — Method in class Base

adds silent option to gulp

Base::simple() — Method in class Base

adds --tasks-simple option to gulp

Shortcuts — Class in namespace Robo\Task\Logfile

Rsync::stats() — Method in class Rsync

Ssh — Class in namespace Robo\Task\Remote

Runs multiple commands on a remote server.

$ Ssh#stopOnFail — Property in class Ssh

Ssh::stopOnFail() — Method in class Ssh

Whether or not to chain commands together with && and stop the chain if one command fails.

Ssh::simulate() — Method in class Ssh

Called in place of run() for simulated tasks.

Ssh::sshCommand() — Method in class Ssh

Returns an ssh command string running $command on the remote.

Simulator — Class in namespace Robo\Task

$ Simulator#stack — Property in class Simulator

Simulator::shortenParameter() — Method in class Simulator

StackBasedTask — Class in namespace Robo\Task

Extend StackBasedTask to create a Robo task that runs a sequence of commands.

$ StackBasedTask#stack — Property in class StackBasedTask

$ StackBasedTask#stopOnFail — Property in class StackBasedTask

StackBasedTask::stopOnFail() — Method in class StackBasedTask

Behat::stopOnFail() — Method in class Behat

Behat::suite() — Method in class Behat

Codecept::suite() — Method in class Codecept

Codecept::silent() — Method in class Codecept

execute in silent mode

Phpspec::stopOnFail() — Method in class Phpspec

Shortcuts — Class in namespace Robo\Task\Vcs

SvnStack — Class in namespace Robo\Task\Vcs

Runs Svn commands in stack. You can use stopOnFail() to point that stack should be terminated on first fail.

$ SvnStack#stopOnFail — Property in class SvnStack

Tasks::stopOnFail() — Method in class Tasks

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

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.

LegacyCommands::twigDebug() — Method in class LegacyCommands

twig:debug has been removed. Please use the theme:dev command.

CacheCommands::tags() — Method in class CacheCommands

Invalidate by cache tags.

$ RsyncCommands#targetEvaluatedPath — Property in class RsyncCommands

SiteInstallCommands::taskCallback() — Method in class SiteInstallCommands

ThemeDevCommands — Class in namespace Drush\Commands\core

ThemeDevCommands::toggleDevMode() — Method in class ThemeDevCommands

Toggle Twig development and cache aggregation settings.

TopicCommands — Class in namespace Drush\Commands\core

TopicCommands::topic() — Method in class TopicCommands

Read detailed documentation on a given topic.

TopicCommands::topicComplete() — Method in class TopicCommands

TwigCommands — Class in namespace Drush\Commands\core

TwigCommands::twigCompile() — Method in class TwigCommands

Compile all Twig template(s).

WatchdogCommands::tail() — Method in class WatchdogCommands

Tail watchdog messages.

FieldDefinitionCommands::types() — Method in class FieldDefinitionCommands

ThemeCommands — Class in namespace Drush\Commands\pm

DrushConfig::tmp() — Method in class DrushConfig

$ LegacyServiceInstantiator#tags — Property in class LegacyServiceInstantiator

LegacyServiceInstantiator::taggedServices() — Method in class LegacyServiceInstantiator

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

TildeExpansionHook — Class in namespace Drush\Runtime

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

$ CliTestTrait#timeout — Property in class CliTestTrait

Timeout for command.

FsUtils::tmpDir() — Method in class FsUtils

Prepare a temporary directory that will be deleted on exit.

$ Collection#taskList — Property in class Collection

Collection::taskNames() — Method in class Collection

Return the list of task names added to this collection.

Collection::transferTasks() — Method in class Collection

Give all of our tasks to the provided collection builder.

CollectionBuilder::tmpDir() — Method in class CollectionBuilder

Create a temporary directory to work in. When the collection completes or rolls back, the temporary directory will be deleted.

$ Element#task — Property in class Element

TaskForEach — Class in namespace Robo\Collection

Creates a task wrapper that converts any Callable into an object that will execute the callback once for each item in the provided collection.

Tasks — Class in namespace Robo\Collection

Tasks::taskForEach() — Method in class Tasks

Run a callback function on each item in a collection

Temporary — Class in namespace Robo\Collection

The temporary collection keeps track of the global collection of temporary cleanup tasks in instances where temporary-generating tasks are executed directly via their run() method, rather than as part of a collection.

$ ExecTrait#timeout — Property in class ExecTrait

ExecTrait::timeout() — Method in class ExecTrait

Stop command if it runs longer then $timeout in seconds

$ ProgressIndicator#totalSteps — Property in class ProgressIndicator

TaskIO — Class in namespace Robo\Common

Task input/output methods. TaskIO is 'used' in BaseTask, so any task that extends this class has access to all of the methods here.

TimeKeeper — Class in namespace Robo\Common

Timer — Class in namespace Robo\Common

$ Timer#timer — Property in class Timer

Config::trimPrefixFromGlobalOptions() — Method in class Config

Remove the 'options.' prefix from the global options list.

TaskInterface — Class in namespace Robo\Contract

All Robo tasks should implement this interface.

TaskException — Class in namespace Robo\Exception

TaskExitException — Class in namespace Robo\Exception

$ Result#task — Property in class Result

TaskAccessor — Class in namespace Robo

TaskAccessor::task() — Method in class TaskAccessor

Alternative access to instantiate. Use:

TaskInfo — Class in namespace Robo

ApiGen::title() — Method in class ApiGen

ApiGen::templateConfig() — Method in class ApiGen

ApiGen::tree() — Method in class ApiGen

ApiGen::todo() — Method in class ApiGen

Tasks — Class in namespace Robo\Task\ApiGen

Tasks::taskApiGen() — Method in class Tasks

$ Extract#to — Property in class Extract

Extract::to() — Method in class Extract

Location to store extracted files.

Tasks — Class in namespace Robo\Task\Archive

Tasks::taskPack() — Method in class Tasks

Tasks::taskExtract() — Method in class Tasks

$ ImageMinify#to — Property in class ImageMinify

Destination directory for the minified images.

ImageMinify::to() — Method in class ImageMinify

Sets the target directory where the files will be copied to.

$ Minify#types — Property in class Minify

$ Minify#text — Property in class Minify

$ Minify#type — Property in class Minify

Minify::to() — Method in class Minify

Sets destination. Tries to guess type from it.

Minify::type() — Method in class Minify

Sets type with validation.

Tasks — Class in namespace Robo\Task\Assets

Tasks::taskMinify() — Method in class Tasks

Tasks::taskImageMinify() — Method in class Tasks

Tasks::taskLess() — Method in class Tasks

Tasks::taskScss() — Method in class Tasks

$ ParallelExec#timeout — Property in class ParallelExec

ParallelExec::timeout() — Method in class ParallelExec

Stops process if it runs longer then $timeout (seconds).

Tasks — Class in namespace Robo\Task\Base

Tasks::taskExec() — Method in class Tasks

Tasks::taskExecStack() — Method in class Tasks

Tasks::taskParallelExec() — Method in class Tasks

Tasks::taskSymfonyCommand() — Method in class Tasks

Tasks::taskWatch() — Method in class Tasks

Tasks — Class in namespace Robo\Task\Bower

Tasks::taskBowerInstall() — Method in class Tasks

Tasks::taskBowerUpdate() — Method in class Tasks

$ CreateProject#target — Property in class CreateProject

CreateProject::target() — Method in class CreateProject

Tasks — Class in namespace Robo\Task\Composer

Tasks::taskComposerInstall() — Method in class Tasks

Tasks::taskComposerUpdate() — Method in class Tasks

Tasks::taskComposerDumpAutoload() — Method in class Tasks

Tasks::taskComposerInit() — Method in class Tasks

Tasks::taskComposerConfig() — Method in class Tasks

Tasks::taskComposerValidate() — Method in class Tasks

Tasks::taskComposerRemove() — Method in class Tasks

Tasks::taskComposerRequire() — Method in class Tasks

Tasks::taskComposerCreateProject() — Method in class Tasks

Tasks::taskCheckPlatformReqs() — Method in class Tasks

$ GenerateMarkdownDoc#text — Property in class GenerateMarkdownDoc

$ GenerateMarkdownDoc#textForClass — Property in class GenerateMarkdownDoc

GenerateMarkdownDoc::text() — Method in class GenerateMarkdownDoc

GenerateMarkdownDoc::textForClass() — Method in class GenerateMarkdownDoc

$ GitHubRelease#tag — Property in class GitHubRelease

GitHubRelease::tag() — Method in class GitHubRelease

Tasks — Class in namespace Robo\Task\Development

Tasks::taskChangelog() — Method in class Tasks

Tasks::taskGenDoc() — Method in class Tasks

Tasks::taskGenTask() — Method in class Tasks

Tasks::taskSemVer() — Method in class Tasks

Tasks::taskServer() — Method in class Tasks

Tasks::taskPackPhar() — Method in class Tasks

Tasks::taskGitHubRelease() — Method in class Tasks

Tasks::taskOpenBrowser() — Method in class Tasks

Build::tag() — Method in class Build

Run::tmpDir() — Method in class Run

Tasks — Class in namespace Robo\Task\Docker

Tasks::taskDockerRun() — Method in class Tasks

Tasks::taskDockerPull() — Method in class Tasks

Tasks::taskDockerBuild() — Method in class Tasks

Tasks::taskDockerStop() — Method in class Tasks

Tasks::taskDockerCommit() — Method in class Tasks

Tasks::taskDockerStart() — Method in class Tasks

Tasks::taskDockerRemove() — Method in class Tasks

Tasks::taskDockerExec() — Method in class Tasks

Concat::to() — Method in class Concat

set the destination file

$ Replace#to — Property in class Replace

Replace::to() — Method in class Replace

Value(s) to be set as a replacement.

Tasks — Class in namespace Robo\Task\File

Tasks::taskConcat() — Method in class Tasks

Tasks::taskReplaceInFile() — Method in class Tasks

Tasks::taskWriteToFile() — Method in class Tasks

Tasks::taskTmpFile() — Method in class Tasks

TmpFile — Class in namespace Robo\Task\File

Create a temporary file that is automatically cleaned up once the task collection is is part of completes. When created, it is given a random filename.

Write::text() — Method in class Write

add a text.

Write::textFromFile() — Method in class Write

add a text from a file.

Write::textFromFileCollect() — Method in class Write

Write::textCollect() — Method in class Write

FilesystemStack::touch() — Method in class FilesystemStack

$ FlattenDir#to — Property in class FlattenDir

FlattenDir::to() — Method in class FlattenDir

Sets the target directory where the files will be copied to.

Tasks — Class in namespace Robo\Task\Filesystem

Tasks::taskCleanDir() — Method in class Tasks

Tasks::taskDeleteDir() — Method in class Tasks

Tasks::taskTmpDir() — Method in class Tasks

Tasks::taskWorkDir() — Method in class Tasks

Tasks::taskCopyDir() — Method in class Tasks

Tasks::taskMirrorDir() — Method in class Tasks

Tasks::taskFlattenDir() — Method in class Tasks

Tasks::taskFilesystemStack() — Method in class Tasks

TmpDir — Class in namespace Robo\Task\Filesystem

Create a temporary directory that is automatically cleaned up once the task collection is is part of completes.

$ Base#task — Property in class Base

Tasks — Class in namespace Robo\Task\Gulp

Tasks::taskGulpRun() — Method in class Tasks

Tasks — Class in namespace Robo\Task\Logfile

Tasks::taskRotateLog() — Method in class Tasks

Tasks::taskTruncateLog() — Method in class Tasks

TruncateLog — Class in namespace Robo\Task\Logfile

Truncates a log (or any other) file

Tasks — Class in namespace Robo\Task\Npm

Tasks::taskNpmInstall() — Method in class Tasks

Tasks::taskNpmUpdate() — Method in class Tasks

$ Rsync#toUser — Property in class Rsync

$ Rsync#toHost — Property in class Rsync

$ Rsync#toPath — Property in class Rsync

Rsync::toPath() — Method in class Rsync

This can either be a full rsync path spec (user@host:path) or just a path.

Rsync::toUser() — Method in class Rsync

Rsync::toHost() — Method in class Rsync

Rsync::times() — Method in class Rsync

Rsync::timeout() — Method in class Rsync

Tasks — Class in namespace Robo\Task\Remote

Tasks::taskRsync() — Method in class Tasks

Tasks::taskSshExec() — Method in class Tasks

$ Simulator#task — Property in class Simulator

Atoum::tags() — Method in class Atoum

Tag or Tags to filter.

Atoum::tap() — Method in class Atoum

Display result using the tap reporter.

Codecept::test() — Method in class Codecept

Codecept::tap() — Method in class Codecept

generate tap report

PHPUnit::tap() — Method in class PHPUnit

Tasks — Class in namespace Robo\Task\Testing

Tasks::taskCodecept() — Method in class Tasks

Tasks::taskPhpUnit() — Method in class Tasks

Tasks::taskPhpspec() — Method in class Tasks

Tasks::taskAtoum() — Method in class Tasks

Tasks::taskBehat() — Method in class Tasks

GitStack::tag() — Method in class GitStack

Executes git tag command

HgStack::tag() — Method in class HgStack

Executes hg tag command

Tasks — Class in namespace Robo\Task\Vcs

Tasks::taskSvnStack() — Method in class Tasks

Tasks::taskGitStack() — Method in class Tasks

Tasks::taskHgStack() — Method in class Tasks

Tasks — Class in namespace Robo

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

LocaleCommands::update() — Method in class LocaleCommands

Imports the available translation updates.

$ RunserverCommands#uri — Property in class RunserverCommands

RunserverCommands::uri() — Method in class RunserverCommands

Determine the URI to use for this server.

TwigCommands::unused() — Method in class TwigCommands

Find potentially unused Twig templates.

UpdateDBCommands — Class in namespace Drush\Commands\core

UpdateDBCommands::updatedb() — Method in class UpdateDBCommands

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

UpdateDBCommands::updatedbStatus() — Method in class UpdateDBCommands

List any pending database updates.

UpdateDBCommands::updateDoOne() — Method in class UpdateDBCommands

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

UpdateDBCommands::updateDoOnePostUpdate() — Method in class UpdateDBCommands

Batch command that executes a single post-update.

UpdateDBCommands::updateFinished() — Method in class UpdateDBCommands

Batch finished callback.

UpdateDBCommands::updateBatch() — Method in class UpdateDBCommands

Start the database update batch process.

UpdateDBCommands::updateCheckRequirements() — Method in class UpdateDBCommands

Log messages for any requirements warnings/errors.

UserCommands — Class in namespace Drush\Commands\core

UserCommands::unblock() — Method in class UserCommands

Unblock the specified user(s).

PmCommands::uninstall() — Method in class PmCommands

Uninstall one or more modules and their dependent modules.

ThemeCommands::uninstall() — Method in class ThemeCommands

Uninstall themes.

DrushConfig::user() — Method in class DrushConfig

Environment::userConfigPath() — Method in class Environment

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

MigrateExecutable::updateProgressBar() — Method in class MigrateExecutable

Advances the progress bar.

MigrateExecutable::unregisterListeners() — Method in class MigrateExecutable

Unregisters all event listeners.

UpdateKernel — Class in namespace Drush\Drupal

Overridden version of UpdateKernel adapted to the needs of Drush.

Drush::unsetContainer() — Method in class Drush

Unsets the global container.

UserAbortException — Class in namespace Drush\Exceptions

Throw an exception indicating that the user cancelled the operation.

$ ExecTrait#uri — Property in class ExecTrait

PreflightArgs::uri() — Method in class PreflightArgs

Get the selected uri

ExecCommand::useCallOnWindows() — Method in class ExecCommand

Wrap Windows executables in 'call' per 7a88757d

Robo::unsetContainer() — Method in class Robo

Unsets the global container.

Data::update() — Method in class Data

Update the current data with the data provided in the parameter.

StateAwareInterface::updateState() — Method in class StateAwareInterface

StateAwareTrait::updateState() — Method in class StateAwareTrait

ApiGen::updateCheck() — Method in class ApiGen

Update — Class in namespace Robo\Task\Bower

Bower Update

Config::useGlobal() — Method in class Config

Operate on the global repository

Remove::updateNoDev() — Method in class Remove

Update — Class in namespace Robo\Task\Composer

Composer Update

$ GitHub#user — Property in class GitHub

GitHub::uri() — Method in class GitHub

GitHub::user() — Method in class GitHub

$ OpenBrowser#urls — Property in class OpenBrowser

Run::user() — Method in class Run

Update — Class in namespace Robo\Task\Npm

Npm Update

$ Ssh#user — Property in class Ssh

Ssh::user() — Method in class Ssh

SvnStack::update() — Method in class SvnStack

Updates svn update command

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.

ConfigExportCommands::validate() — Method in class ConfigExportCommands

ConfigImportCommands::validate() — Method in class ConfigImportCommands

Validate partial and source options.

ConfigPullCommands::validateConfigPull() — Method in class ConfigPullCommands

CacheCommands::validate() — Method in class CacheCommands

CoreCommands::version() — Method in class CoreCommands

Show Drush version.

DrupalDependenciesCommands::validateDependentsOfModule() — Method in class DrupalDependenciesCommands

DrupalDependenciesCommands::validateDependentsOfConfig() — Method in class DrupalDependenciesCommands

EntityCreateCommands::validate() — Method in class EntityCreateCommands

MigrateRunnerCommands::validateMigrationId() — Method in class MigrateRunnerCommands

Validates a migration ID is valid.

RsyncCommands::validate() — Method in class RsyncCommands

Validate that passed aliases are valid.

SiteInstallCommands::validateRecipe() — Method in class SiteInstallCommands

Validates a user provided recipe.

SiteInstallCommands::validate() — Method in class SiteInstallCommands

SiteInstallCommands::validateConfigDir() — Method in class SiteInstallCommands

Assure that a config directory exists and is populated.

TopicCommands::validate() — Method in class TopicCommands

ViewsCommands — Class in namespace Drush\Commands\core

ViewsCommands::vlist() — Method in class ViewsCommands

Get a list of all views in the system.

EntityTypeBundleValidationTrait::validateEntityType() — Method in class EntityTypeBundleValidationTrait

EntityTypeBundleValidationTrait::validateBundle() — Method in class EntityTypeBundleValidationTrait

HelpCommands::validate() — Method in class HelpCommands

PmCommands::validateEnableModules() — Method in class PmCommands

Run requirements checks on the module installation.

PmCommands::validateUninstall() — Method in class PmCommands

SqlCommands::validate() — Method in class SqlCommands

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

SqlSyncCommands::validate() — Method in class SqlSyncCommands

$ Environment#vendorDir — Property in class Environment

Environment::vendorPath() — Method in class Environment

Return the path to Drush's vendor directory

Environment::verifyCLI() — Method in class Environment

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

ValidateMigrationId — Class in namespace Drush\Drupal\Migrate

$ Drush#version — Property in class Drush

The version of Drush from Composer Runtime, or FALSE if not populated yet.

Drush::verbose() — Method in class Drush

Return 'true' if we are in verbose mode

$ Preflight#verify — Property in class Preflight

PreflightVerify::verify() — Method in class PreflightVerify

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

TildeExpansionHook::validate() — Method in class TildeExpansionHook

$ SqlMysql#version — Property in class SqlMysql

ExecTrait::verbosityMeetsThreshold() — Method in class ExecTrait

$ OutputAdapter#verbosityMap — Property in class OutputAdapter

OutputAdapter::verbosityMeetsThreshold() — Method in class OutputAdapter

VerbosityThresholdTrait — Class in namespace Robo\Common

Task input/output methods. TaskIO is 'used' in BaseTask, so any task that extends this class has access to all of the methods here.

$ VerbosityThresholdTrait#verbosityThreshold — Property in class VerbosityThresholdTrait

VerbosityThresholdTrait::verbosityThreshold() — Method in class VerbosityThresholdTrait

VerbosityThresholdTrait::verbosityMeetsThreshold() — Method in class VerbosityThresholdTrait

OutputAdapterInterface::verbosityMeetsThreshold() — Method in class OutputAdapterInterface

VerbosityThresholdInterface — Class in namespace Robo\Contract

Record and determine whether the current verbosity level exceeds the desired threshold level to produce output.

VerbosityThresholdInterface::verbosityThreshold() — Method in class VerbosityThresholdInterface

VerbosityThresholdInterface::verbosityMeetsThreshold() — Method in class VerbosityThresholdInterface

Robo::version() — Method in class Robo

Only provide access to the Robo version via Robo::version() so that roave/backward-compatibility-check does not complain about b/c breaks when the version number changes.

$ CreateProject#version — Property in class CreateProject

CreateProject::version() — Method in class CreateProject

Validate — Class in namespace Robo\Task\Composer

Composer Validate

$ Changelog#version — Property in class Changelog

Changelog::version() — Method in class Changelog

$ SemVer#version — Property in class SemVer

SemVer::version() — Method in class SemVer

Run::volume() — Method in class Run

Rsync::verbose() — Method in class Rsync

Ssh::verbose() — Method in class Ssh

Ssh::validateParameters() — Method in class Ssh

$ Behat#verbose_levels — Property in class Behat

Behat::verbose() — Method in class Behat

$ Phpspec#verbose_levels — Property in class Phpspec

Phpspec::verbose() — Method in class Phpspec

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

CacheWarmCommands::warm() — Method in class CacheWarmCommands

Pre-warm all caches.

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

WatchdogCommands::watchdogList() — Method in class WatchdogCommands

Interactively filter the watchdog message listing.

WatchdogCommands::where() — Method in class WatchdogCommands

Build a WHERE snippet based on given parameters.

WatchdogCommands::watchdogComplete() — Method in class WatchdogCommands

FieldDefinitionCommands::widgets() — Method in class FieldDefinitionCommands

HelpCLIFormatter::write() — Method in class HelpCLIFormatter

Collection::wrapAndRegisterRollback() — Method in class Collection

CollectionBuilder::workDir() — Method in class CollectionBuilder

Create a working directory to hold results. A temporary directory is first created to hold the intermediate results. After the builder finishes, the work directory is moved into its final location; any results already in place will be moved out of the way and then deleted.

TaskForEach::withEachKeyValueCall() — Method in class TaskForEach

TaskForEach::withBuilder() — Method in class TaskForEach

$ ExecTrait#workingDirectory — Property in class ExecTrait

ExecTrait::writeMessage() — Method in class ExecTrait

OutputAdapter::writeMessage() — Method in class OutputAdapter

VerbosityThresholdTrait::writeMessage() — Method in class VerbosityThresholdTrait

Print a message if the selected verbosity level is over this task's verbosity threshold.

OutputAdapterInterface::writeMessage() — Method in class OutputAdapterInterface

VerbosityThresholdInterface::writeMessage() — Method in class VerbosityThresholdInterface

WrappedTaskInterface — Class in namespace Robo\Contract

ResultData::wasSuccessful() — Method in class ResultData

ResultData::wasCancelled() — Method in class ResultData

ApiGen::wipeout() — Method in class ApiGen

$ ParallelExec#waitInterval — Property in class ParallelExec

ParallelExec::waitInterval() — Method in class ParallelExec

Parallel processing will wait $waitInterval seconds after launching each process and before the next one.

Watch — Class in namespace Robo\Task\Base

Runs task when specified file or dir was changed.

Base::workingDir() — Method in class Base

adds --working-dir $dir option to composer

Validate::withDependencies() — Method in class Validate

$ GenerateTask#wrapperClassName — Property in class GenerateTask

Write — Class in namespace Robo\Task\File

Writes to file.

Write::wouldChange() — Method in class Write

WorkDir — Class in namespace Robo\Task\Filesystem

Create a temporary working directory that is automatically renamed to its final desired location if all of the tasks in the collection succeed. If there is a rollback, then the working directory is deleted.

Rsync::wholeFile() — Method in class Rsync

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.

XhprofCommands — Class in namespace Drush\Commands\core

Supports profiling Drush commands using either XHProf or Tideways XHProf.

XhprofCommands::xhprofPost() — Method in class XhprofCommands

Finish profiling and emit a link.

XhprofCommands::xhprofInitialize() — Method in class XhprofCommands

Enable profiling via XHProf

XhprofCommands::xhprofIsEnabled() — Method in class XhprofCommands

Determines if any profiler could be enabled.

XhprofCommands::xhprofFlags() — Method in class XhprofCommands

Determines flags.

XhprofCommands::xhprofEnable() — Method in class XhprofCommands

Enable profiling.

XhprofCommands::xhprofFinishRun() — Method in class XhprofCommands

Disable profiling and save results.

Codecept::xml() — Method in class Codecept

generate xml JUnit report

PHPUnit::xml() — Method in class PHPUnit

adds log-junit option

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.

ConsoleIO::yell() — Method in class ConsoleIO

Z

ImageMinify::zopflipng() — Method in class ImageMinify

_

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

InteractConfigName::__construct() — Method in class InteractConfigName

Kernel::__construct() — Method in class Kernel

ValidateConfigName::__construct() — Method in class ValidateConfigName

ValidateEntityLoad::__construct() — Method in class ValidateEntityLoad

ValidateFileExists::__construct() — Method in class ValidateFileExists

ValidateModulesEnabled::__construct() — Method in class ValidateModulesEnabled

ValidatePermissions::__construct() — Method in class ValidatePermissions

ValidatePhpExtensions::__construct() — Method in class ValidatePhpExtensions

ValidateQueueName::__construct() — Method in class ValidateQueueName

Version::__construct() — Method in class Version

BaseBoot::__construct() — Method in class BaseBoot

BootstrapHook::__construct() — Method in class BootstrapHook

DrupalBoot8::__construct() — Method in class DrupalBoot8

RemoteCommandProxy::__construct() — Method in class RemoteCommandProxy

DrushCommands::__construct() — Method in class DrushCommands

ConfigCommands::__construct() — Method in class ConfigCommands

ConfigExportCommands::__construct() — Method in class ConfigExportCommands

ConfigImportCommands::__construct() — Method in class ConfigImportCommands

ConfigPullCommands::__construct() — Method in class ConfigPullCommands

BrowseCommands::__construct() — Method in class BrowseCommands

CacheCommands::__construct() — Method in class CacheCommands

CacheRebuildCommands::__construct() — Method in class CacheRebuildCommands

CacheWarmCommands::__construct() — Method in class CacheWarmCommands

CliCommands::__construct() — Method in class CliCommands

DeployCommands::__construct() — Method in class DeployCommands

DeployHookCommands::__construct() — Method in class DeployHookCommands

DrupalCommands::__construct() — Method in class DrupalCommands

DrupalDependenciesCommands::__construct() — Method in class DrupalDependenciesCommands

DrupalDirectoryCommands::__construct() — Method in class DrupalDirectoryCommands

EditCommands::__construct() — Method in class EditCommands

EntityCommands::__construct() — Method in class EntityCommands

EntityCreateCommands::__construct() — Method in class EntityCreateCommands

LanguageCommands::__construct() — Method in class LanguageCommands

LinkHooks::__construct() — Method in class LinkHooks

LocaleCommands::__construct() — Method in class LocaleCommands

LoginCommands::__construct() — Method in class LoginCommands

MaintCommands::__construct() — Method in class MaintCommands

MessengerCommands::__construct() — Method in class MessengerCommands

MigrateRunnerCommands::__construct() — Method in class MigrateRunnerCommands

QueueCommands::__construct() — Method in class QueueCommands

RoleCommands::__construct() — Method in class RoleCommands

RsyncCommands::__construct() — Method in class RsyncCommands

SiteCommands::__construct() — Method in class SiteCommands

SiteInstallCommands::__construct() — Method in class SiteInstallCommands

SshCommands::__construct() — Method in class SshCommands

StateCommands::__construct() — Method in class StateCommands

StatusCommands::__construct() — Method in class StatusCommands

ThemeDevCommands::__construct() — Method in class ThemeDevCommands

TwigCommands::__construct() — Method in class TwigCommands

UpdateDBCommands::__construct() — Method in class UpdateDBCommands

UserCommands::__construct() — Method in class UserCommands

ViewsCommands::__construct() — Method in class ViewsCommands

WatchdogCommands::__construct() — Method in class WatchdogCommands

FieldBaseInfoCommands::__construct() — Method in class FieldBaseInfoCommands

FieldBaseOverrideCreateCommands::__construct() — Method in class FieldBaseOverrideCreateCommands

FieldCreateCommands::__construct() — Method in class FieldCreateCommands

FieldDefinitionCommands::__construct() — Method in class FieldDefinitionCommands

FieldDeleteCommands::__construct() — Method in class FieldDeleteCommands

FieldEntityReferenceHooks::__construct() — Method in class FieldEntityReferenceHooks

FieldInfoCommands::__construct() — Method in class FieldInfoCommands

FieldTextHooks::__construct() — Method in class FieldTextHooks

ApplicationFactory::__construct() — Method in class ApplicationFactory

GenerateCommands::__construct() — Method in class GenerateCommands

PmCommands::__construct() — Method in class PmCommands

ThemeCommands::__construct() — Method in class ThemeCommands

SqlSyncCommands::__construct() — Method in class SqlSyncCommands

SanitizeCommentsCommands::__construct() — Method in class SanitizeCommentsCommands

SanitizeSessionsCommands::__construct() — Method in class SanitizeSessionsCommands

SanitizeUserFieldsCommands::__construct() — Method in class SanitizeUserFieldsCommands

SanitizeUserTableCommands::__construct() — Method in class SanitizeUserTableCommands

ConfigLocator::__construct() — Method in class ConfigLocator

ConfigLocator constructor

Environment::__construct() — Method in class Environment

Environment constructor

DrushDrupalFinder::__construct() — Method in class DrushDrupalFinder

MigrateExecutable::__construct() — Method in class MigrateExecutable

Constructs a new migrate executable instance.

MigrateIdMapFilter::__construct() — Method in class MigrateIdMapFilter

MigrateMessage::__construct() — Method in class MigrateMessage

Constructs a migrate message class.

MigrateMissingSourceRowsEvent::__construct() — Method in class MigrateMissingSourceRowsEvent

Constructs a new event instance.

MigratePrepareRowEvent::__construct() — Method in class MigratePrepareRowEvent

Constructs a prepare-row event object.

MigrateRunnerHooks::__construct() — Method in class MigrateRunnerHooks

CommandFailedException::__construct() — Method in class CommandFailedException

UserAbortException::__construct() — Method in class UserAbortException

EntityToArraySimplifier::__construct() — Method in class EntityToArraySimplifier

DrushLog::__construct() — Method in class DrushLog

Constructs a DrushLog object.

Logger::__construct() — Method in class Logger

ArgsPreprocessor::__construct() — Method in class ArgsPreprocessor

ArgsPreprocessor constructor

ArgsRemapper::__construct() — Method in class ArgsRemapper

ArgsRemapper constructor

Preflight::__construct() — Method in class Preflight

Preflight constructor

PreflightArgs::__construct() — Method in class PreflightArgs

PreflightArgs constructor

PreflightLog::__construct() — Method in class PreflightLog

PreflightSiteLocator::__construct() — Method in class PreflightSiteLocator

DrushCommand::__construct() — Method in class DrushCommand

DrushCommand constructor.

LegacyServiceFinder::__construct() — Method in class LegacyServiceFinder

LegacyServiceInstantiator::__construct() — Method in class LegacyServiceInstantiator

RedispatchHook::__construct() — Method in class RedispatchHook

Runtime::__construct() — Method in class Runtime

ServiceManager::__construct() — Method in class ServiceManager

SiteAliasFileLoader::__construct() — Method in class SiteAliasFileLoader

SiteAliasFileLoader constructor

SqlBase::__construct() — Method in class SqlBase

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

CliTestTrait::_escapeshellargWindows() — Method in class CliTestTrait

Application::__construct() — Method in class Application

RelativeNamespaceDiscovery::__construct() — Method in class RelativeNamespaceDiscovery

RelativeNamespaceDiscovery constructor.

CallableTask::__construct() — Method in class CallableTask

Collection::__construct() — Method in class Collection

Constructor.

CollectionBuilder::__construct() — Method in class CollectionBuilder

CollectionBuilder::__call() — Method in class CollectionBuilder

Calling the task builder with methods of the current task calls through to that method of the task.

CompletionWrapper::__construct() — Method in class CompletionWrapper

Create a CompletionWrapper.

CompletionWrapper::__call() — Method in class CompletionWrapper

Make this wrapper object act like the class it wraps.

Element::__construct() — Method in class Element

TaskForEach::__construct() — Method in class TaskForEach

DynamicParams::__call() — Method in class DynamicParams

IO::__construct() — Method in class IO

ProcessExecutor::__construct() — Method in class ProcessExecutor

ProgressIndicator::__construct() — Method in class ProgressIndicator

Config::__construct() — Method in class Config

Create a new configuration object, and initialize it with the provided nested array containing configuration data.

TaskException::__construct() — Method in class TaskException

TaskException constructor.

TaskExitException::__construct() — Method in class TaskExitException

TaskExitException constructor.

GlobalOptionsEventListener::__construct() — Method in class GlobalOptionsEventListener

GlobalOptionsEventListener listener

RoboLogStyle::__construct() — Method in class RoboLogStyle

RoboLogStyle constructor.

RoboLogger::__construct() — Method in class RoboLogger

Result::__construct() — Method in class Result

Result::__invoke() — Method in class Result

ResultData::__construct() — Method in class ResultData

Runner::__construct() — Method in class Runner

Class Constructor

Runner::__construct() — Method in class Runner

Class Constructor

Data::__construct() — Method in class Data

ConsoleIO::__construct() — Method in class ConsoleIO

ApiGen::__construct() — Method in class ApiGen

Extract::__construct() — Method in class Extract

Pack::__construct() — Method in class Pack

Construct the class.

CssPreprocessor::__construct() — Method in class CssPreprocessor

Constructor. Accepts array of file paths.

ImageMinify::__construct() — Method in class ImageMinify

Minify::__construct() — Method in class Minify

Constructor. Accepts asset file path or string source.

Minify::__toString() — Method in class Minify

Exec::__construct() — Method in class Exec

Exec::__destruct() — Method in class Exec

Shortcuts::_exec() — Method in class Shortcuts

Executes shell command

SymfonyCommand::__construct() — Method in class SymfonyCommand

Watch::__construct() — Method in class Watch

Base::__construct() — Method in class Base

Base constructor.

Base::__construct() — Method in class Base

Changelog::__construct() — Method in class Changelog

GenerateMarkdownDoc::__construct() — Method in class GenerateMarkdownDoc

GenerateTask::__construct() — Method in class GenerateTask

GitHubRelease::__construct() — Method in class GitHubRelease

OpenBrowser::__construct() — Method in class OpenBrowser

PackPhar::__construct() — Method in class PackPhar

PhpServer::__construct() — Method in class PhpServer

SemVer::__construct() — Method in class SemVer

SemVer::__toString() — Method in class SemVer

Build::__construct() — Method in class Build

Commit::__construct() — Method in class Commit

Exec::__construct() — Method in class Exec

Pull::__construct() — Method in class Pull

Remove::__construct() — Method in class Remove

Run::__construct() — Method in class Run

Start::__construct() — Method in class Start

Stop::__construct() — Method in class Stop

Concat::__construct() — Method in class Concat

Constructor.

Replace::__construct() — Method in class Replace

TmpFile::__construct() — Method in class TmpFile

Write::__construct() — Method in class Write

BaseDir::__construct() — Method in class BaseDir

CopyDir::__construct() — Method in class CopyDir

Explicitly declare our consturctor, so that our copyDir() method does not look like a php4 constructor.

FilesystemStack::__construct() — Method in class FilesystemStack

FilesystemStack::_copy() — Method in class FilesystemStack

FilesystemStack::_chmod() — Method in class FilesystemStack

FilesystemStack::_chgrp() — Method in class FilesystemStack

FilesystemStack::_chown() — Method in class FilesystemStack

FilesystemStack::_rename() — Method in class FilesystemStack

FlattenDir::__construct() — Method in class FlattenDir

Shortcuts::_copyDir() — Method in class Shortcuts

Shortcuts::_mirrorDir() — Method in class Shortcuts

Shortcuts::_deleteDir() — Method in class Shortcuts

Shortcuts::_cleanDir() — Method in class Shortcuts

Shortcuts::_rename() — Method in class Shortcuts

Shortcuts::_mkdir() — Method in class Shortcuts

Shortcuts::_tmpDir() — Method in class Shortcuts

Shortcuts::_touch() — Method in class Shortcuts

Shortcuts::_remove() — Method in class Shortcuts

Shortcuts::_chgrp() — Method in class Shortcuts

Shortcuts::_chmod() — Method in class Shortcuts

Shortcuts::_symlink() — Method in class Shortcuts

Shortcuts::_copy() — Method in class Shortcuts

Shortcuts::_flattenDir() — Method in class Shortcuts

TmpDir::__construct() — Method in class TmpDir

WorkDir::__construct() — Method in class WorkDir

Base::__construct() — Method in class Base

BaseLogfile::__construct() — Method in class BaseLogfile

RotateLog::__construct() — Method in class RotateLog

Shortcuts::_rotateLog() — Method in class Shortcuts

Shortcuts::_truncateLog() — Method in class Shortcuts

Base::__construct() — Method in class Base

Rsync::__construct() — Method in class Rsync

Ssh::__construct() — Method in class Ssh

Simulator::__construct() — Method in class Simulator

Simulator::__call() — Method in class Simulator

StackBasedTask::__call() — Method in class StackBasedTask

Any API function provided by the delegate that executes immediately may be handled by __call automatically. These operations will all be deferred until this task's run() method is called.

Atoum::__construct() — Method in class Atoum

Atoum constructor.

Behat::__construct() — Method in class Behat

Behat constructor.

Codecept::__construct() — Method in class Codecept

PHPUnit::__construct() — Method in class PHPUnit

PHPUnit constructor.

Phpspec::__construct() — Method in class Phpspec

Phpspec constructor.

GitStack::__construct() — Method in class GitStack

HgStack::__construct() — Method in class HgStack

Shortcuts::_svnCheckout() — Method in class Shortcuts

Shortcuts::_gitClone() — Method in class Shortcuts

Shortcuts::_hgClone() — Method in class Shortcuts

SvnStack::__construct() — Method in class SvnStack