1. class
  2. Inphinit
  3. \
  4. Experimental
  5. \
  6. Cli
  7. \
  8. Console

Console

class Console (View source)

Constants

LAST_OPTION_REGEX

Properties

protected $namespacePrefix

Methods

Command
action(string $name, string|callable|Command $callback)

Register callable, console controller, and Command instance for a CLI command

setNamespace(string $prefix)

Prefixes the namespace to command controller classes

int
exec(array $arguments)

Receives the arguments to execute the command If the command is not found, an exception will be thrown

static string
run(string $command, array $args = array(), int $code = 0)

Shortcut to execute predefined commands or commands from system/console.php

Details

at line 31
Command action(string $name, string|callable|Command $callback)

Register callable, console controller, and Command instance for a CLI command

Parameters

string $name
string|callable|Command $callback

Return Value

Command

at line 51
setNamespace(string $prefix)

Prefixes the namespace to command controller classes

Parameters

string $prefix

at line 64
int exec(array $arguments)

Receives the arguments to execute the command If the command is not found, an exception will be thrown

Parameters

array $arguments

Define $argv without changes

Return Value

int

Exceptions

Exception

at line 115
static string run(string $command, array $args = array(), int $code = 0)

Shortcut to execute predefined commands or commands from system/console.php

Parameters

string $command

The command that will be executed
array $args

Argument list
int $code

If the $code argument is present, then the return status of the executed command will be written to this variable

Return Value

string

Exceptions

Exception