1. trait
  2. Drush
  3. \
  4. Commands
  5. \
  6. config
  7. \
  8. ConfigTrait

ConfigTrait

trait ConfigTrait (View source)

Traits

ExecTrait

Properties

protected $uri from  ExecTrait

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.

from  ExecTrait
static bool
programExists($program)

No description

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

No description

from  ExecTrait
getStorage($directory)

Get storage corresponding to a configuration directory.

static string
getDirectory(mixed $directory = null)

Determine which configuration directory to use and return directory path.

static void
copyConfig(StorageInterface $source, StorageInterface $destination)

Copies configuration objects from source storage to target storage.

static string
getDiff(StorageInterface $destination_storage, StorageInterface $source_storage, OutputInterface $output)

Get diff between two config sets.

static Table
configChangesTable(array $config_changes, OutputInterface $output, $use_color = true)

Build a table of config changes.

Details

in ExecTrait at line 28
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

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

in ExecTrait at line 90
static bool programExists($program)

No description

Parameters

$program

Return Value

bool

in ExecTrait at line 102
static string getEditor(string|null $editor = null)

No description

Parameters

string|null $editor

Return Value

string

at line 26
getStorage($directory)

Get storage corresponding to a configuration directory.

Parameters

$directory

at line 44
static string getDirectory(mixed $directory = null)

Determine which configuration directory to use and return directory path.

Directory path is determined based on the following precedence:

  1. User-provided $directory.
  2. Default sync directory

Parameters

mixed $directory

Return Value

string

at line 75
static void copyConfig(StorageInterface $source, StorageInterface $destination)

Copies configuration objects from source storage to target storage.

Parameters

StorageInterface $source

The source config storage service.
StorageInterface $destination

The destination config storage service.

Return Value

void

Exceptions

Exception

at line 107
static string getDiff(StorageInterface $destination_storage, StorageInterface $source_storage, OutputInterface $output)

Get diff between two config sets.

Parameters

StorageInterface $destination_storage
StorageInterface $source_storage
OutputInterface $output

Return Value

string

at line 143
static Table configChangesTable(array $config_changes, OutputInterface $output, $use_color = true)

Build a table of config changes.

Parameters

array $config_changes

An array of changes keyed by collection.
OutputInterface $output
$use_color

Return Value

Table