final class RsyncCommands extends DrushCommands implements SiteAliasManagerAwareInterface (View source)

Traits

SiteAliasManagerAwareTrait
ProcessManagerAwareTrait
LoggerAwareTrait
IO
ConfigAwareTrait

Constants

REQ

OPT

EXIT_SUCCESS

EXIT_FAILURE

EXIT_FAILURE_WITH_CLARITY

RSYNC

These are arguments after the aliases and paths have been evaluated.

Properties

protected CommandData|null $commandData from  DrushCommands
HostPath $sourceEvaluatedPath
HostPath $targetEvaluatedPath
protected BackendPathEvaluator $pathEvaluator

Methods

bool
startBrowser(string|null $uri = null, int $sleep = 0, int|null $port = null, string|bool $browser = false)

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

static bool
programExists($program)

No description

static string
getEditor(string|null $editor = null)

No description

getConfig()

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

__construct()

No description

SymfonyStyle
io()

Override Robo's IO function with our custom style.

DrushLoggerManager|null
logger()

Returns a logger object.

void
printFile(string $file)

Print the contents of a file.

preHook(CommandData $commandData)

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

printFileTopic(CommandData $commandData)

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

HandlerStack
getStack()

Get a Guzzle handler stack that uses the Drush logger.

void
rsync($source, $target, array $extra, $options = ['exclude-paths' => self::REQ, 'include-paths' => self::REQ, 'mode' => 'akz'])

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

string
rsyncOptions($options)

No description

void
preCommandEvent(ConsoleCommandEvent $event)

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.

injectAliasPathParameterOptions($input, $parameterName)

No description

void
validate(CommandData $commandData)

Validate that passed aliases are valid.

Details

bool startBrowser(string|null $uri = null, int $sleep = 0, int|null $port = null, string|bool $browser = false)

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

Uses a non-blocking Process call, so Drush execution will continue.

Parameters

string|null $uri

Optional URI or site path to open in browser. If omitted, or if a site path is specified, the current site home page uri will be prepended if the site's hostname resolves.

int $sleep
int|null $port
string|bool $browser

Return Value

bool

if browser was opened. FALSE if browser was disabled by the user or a default browser could not be found.

static bool programExists($program)

No description

Parameters

$program

Return Value

bool

static string getEditor(string|null $editor = null)

No description

Parameters

string|null $editor

Return Value

string

DrushConfig getConfig()

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

__construct()

No description

protected SymfonyStyle io()

Override Robo's IO function with our custom style.

Return Value

SymfonyStyle

protected DrushLoggerManager|null logger()

Returns a logger object.

Return Value

DrushLoggerManager|null

protected void printFile(string $file)

Print the contents of a file.

Parameters

string $file

Full path to a file.

Return Value

void

preHook(CommandData $commandData)

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

Parameters

CommandData $commandData

protected printFileTopic(CommandData $commandData)

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

Parameters

CommandData $commandData

Full path to a file.

protected HandlerStack getStack()

Get a Guzzle handler stack that uses the Drush logger.

void rsync($source, $target, array $extra, $options = ['exclude-paths' => self::REQ, 'include-paths' => self::REQ, 'mode' => 'akz'])

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

Parameters

$source
$target
array $extra
$options

Return Value

void

string rsyncOptions($options)

No description

Parameters

$options

Return Value

string

void preCommandEvent(ConsoleCommandEvent $event)

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.

Parameters

ConsoleCommandEvent $event

Return Value

void

protected injectAliasPathParameterOptions($input, $parameterName)

No description

Parameters

$input
$parameterName

void validate(CommandData $commandData)

Validate that passed aliases are valid.

Parameters

CommandData $commandData

Return Value

void