final class RunserverCommands extends DrushCommands implements ConfigAwareInterface (View source)

Traits

ConfigAwareTrait
ProcessManagerAwareTrait
LoggerAwareTrait
IO
ConfigAwareTrait

Constants

REQ

OPT

EXIT_SUCCESS

EXIT_FAILURE

EXIT_FAILURE_WITH_CLARITY

RUNSERVER

Properties

protected CommandData|null $commandData from  DrushCommands
protected $uri

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.

runserver($uri = null, $options = ['default-server' => self::REQ, 'browser' => true, 'dns' => false])

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

array
uri($uri, $options)

Determine the URI to use for this server.

array
parseUri(string|null $uri)

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

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.

runserver($uri = null, $options = ['default-server' => self::REQ, 'browser' => true, 'dns' => false])

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

  • Don't use this for production, it is neither scalable nor secure for this use.
  • If you run multiple servers simultaneously, you will need to assign each a unique port.
  • Use Ctrl-C or equivalent to stop the server when complete.

Parameters

$uri
$options

array uri($uri, $options)

Determine the URI to use for this server.

Parameters

$uri
$options

Return Value

array

array parseUri(string|null $uri)

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

Parameters

string|null $uri

String that can contain partial URI.

URI array as returned by parse_url.

Return Value

array