final class LocaleCommands extends DrushCommands (View source)

Traits

ProcessManagerAwareTrait
LoggerAwareTrait
IO
ConfigAwareTrait

Constants

REQ

OPT

EXIT_SUCCESS

EXIT_FAILURE

EXIT_FAILURE_WITH_CLARITY

CHECK

CLEAR

UPDATE

EXPORT

IMPORT

IMPORT_ALL

Properties

protected CommandData|null $commandData from  DrushCommands

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(LanguageManagerInterface $languageManager, ConfigFactoryInterface $configFactory, ModuleHandlerInterface $moduleHandler, StateInterface $state)

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.

LanguageManagerInterface
getLanguageManager()

No description

ConfigFactoryInterface
getConfigFactory()

No description

ModuleHandlerInterface
getModuleHandler()

No description

StateInterface
getState()

No description

static LocaleCommands
create(ContainerInterface $container)

No description

void
check()

Checks for available translation updates.

void
clearStatus()

Clears the translation status.

void
update($options = ['langcodes' => self::REQ])

Imports the available translation updates.

void
export($langcode = null, $options = ['template' => false, 'types' => self::REQ])

Exports to a gettext translation file.

void
exportValidate(CommandData $commandData)

Assure that required options are set.

importAll($directory, $options = ['type' => self::REQ, 'override' => self::REQ])

Imports multiple translation files from the defined directory.

void
import($langcode, $file, $options = ['type' => 'not-customized', 'override' => self::REQ, 'autocreate-language' => false])

Imports to a gettext translation file.

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(LanguageManagerInterface $languageManager, ConfigFactoryInterface $configFactory, ModuleHandlerInterface $moduleHandler, StateInterface $state)

No description

Parameters

LanguageManagerInterface $languageManager
ConfigFactoryInterface $configFactory
ModuleHandlerInterface $moduleHandler
StateInterface $state

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.

protected LanguageManagerInterface getLanguageManager()

No description

Return Value

LanguageManagerInterface

protected ConfigFactoryInterface getConfigFactory()

No description

Return Value

ConfigFactoryInterface

ModuleHandlerInterface getModuleHandler()

No description

Return Value

ModuleHandlerInterface

StateInterface getState()

No description

Return Value

StateInterface

static LocaleCommands create(ContainerInterface $container)

No description

Parameters

ContainerInterface $container

Return Value

LocaleCommands

void check()

Checks for available translation updates.

Return Value

void

void clearStatus()

Clears the translation status.

Return Value

void

void update($options = ['langcodes' => self::REQ])

Imports the available translation updates.

This can be simplified once https://www.drupal.org/node/2631584 lands in Drupal core.

Parameters

$options

Return Value

void

See also

\Drush\Commands\core\TranslationStatusForm::buildForm()
\Drush\Commands\core\TranslationStatusForm::prepareUpdateData()
\Drush\Commands\core\TranslationStatusForm::submitForm()

void export($langcode = null, $options = ['template' => false, 'types' => self::REQ])

Exports to a gettext translation file.

See Drupal Core: \Drupal\locale\Form\ExportForm::submitForm

Parameters

$langcode
$options

Return Value

void

void exportValidate(CommandData $commandData)

Assure that required options are set.

Parameters

CommandData $commandData

Return Value

void

importAll($directory, $options = ['type' => self::REQ, 'override' => self::REQ])

Imports multiple translation files from the defined directory.

Parameters

$directory
$options

Exceptions

Exception

void import($langcode, $file, $options = ['type' => 'not-customized', 'override' => self::REQ, 'autocreate-language' => false])

Imports to a gettext translation file.

Parameters

$langcode
$file
$options

Return Value

void