RunserverCommands
final class RunserverCommands extends DrushCommands (View source)
Traits
Constants
| REQ |
|
| OPT |
|
| EXIT_SUCCESS |
|
| EXIT_FAILURE |
|
| EXIT_FAILURE_WITH_CLARITY |
|
| RUNSERVER |
|
Properties
| protected | $uri | ||
| protected CommandData|null | $commandData | from DrushCommands |
Methods
Starts a background browser/tab for the current site or a specified URL.
Replaces same method in ConfigAwareTrait in order to provide a DrushConfig as return type. Helps with IDE completion.
Prompt the user until the given validation callback passes.
Persist commandData for use in primary command callback. Used by 'topic' commands.
Persist commandData for use in primary command callback. Used by 'topic' commands.
Print the contents of a file. The path comes from the @topic annotation.
This method overrides the trait in order to provide a more specific return type.
Runs PHP's built-in http server for development.
Determine the URI to use for this server.
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.
static bool
programExists($program)
No description
static string
getEditor(string|null $editor = null)
No description
DrushConfig
getConfig()
Replaces same method in ConfigAwareTrait in order to provide a DrushConfig as return type. Helps with IDE completion.
protected void
configurePrompts(InputInterface $input)
Configure the prompt fallbacks.
protected mixed
promptUntilValid(Closure $prompt, bool|string $required, Closure|null $validate)
Prompt the user until the given validation callback passes.
protected void
restorePrompts()
Restore the prompts output.
protected bool
runningUnitTests()
No description
__construct()
No description
protected DrushStyle
io()
Override Robo's IO function with our custom style.
DrushLoggerManager|null
logger()
Returns a logger object.
protected 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.
initHook($input, AnnotationData $annotationData)
Persist commandData for use in primary command callback. Used by 'topic' commands.
protected
printFileTopic(CommandData $commandData)
Print the contents of a file. The path comes from the @topic annotation.
protected HandlerStack
getStack()
Get a Guzzle handler stack that uses the Drush logger.
ProcessManager
processManager()
This method overrides the trait in order to provide a more specific return type.
void
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.
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).