Documentation

Kernel extends Kernel
in package

Application

$app : Application: The application implementation.
$artisan : Application: The Artisan application instance.
$bootstrappers : array<string|int, mixed>: The bootstrap classes for the application.
$commands : array<string|int, mixed>: The Artisan commands provided by your application.
$commandsLoaded : bool: Indicates if the Closure commands have been loaded.
$events : Dispatcher: The event dispatcher implementation.
__construct() : void: Create a new console kernel instance.
all() : array<string|int, mixed>: Get all of the commands registered with the console.
bootstrap() : void: Bootstrap the application for artisan commands.
call() : int: Run an Artisan console command by name.
command() : ClosureCommand: Register a Closure based command with the application.
handle() : int: Run the console application.
output() : string: Get the output for the last run command.
queue() : PendingDispatch: Queue the given console command.
registerCommand() : void: Register the given command with the console application.
setArtisan() : void: Set the Artisan application instance.
terminate() : void: Terminate the application.
bootstrappers() : array<string|int, mixed>: Get the bootstrap classes for the application.
commands() : void: Register the Closure based commands for the application.
defineConsoleSchedule() : void: Define the application's command schedule.
getArtisan() : Application: Get the Artisan application instance.
load() : void: Register all of the commands in the given directory.
renderException() : void: Report the exception to the exception handler.
reportException() : void: Report the exception to the exception handler.
schedule() : void: Define the application's command schedule.

$app

The application implementation.


    protected
        Application
    $app

$artisan

The Artisan application instance.


    protected
        Application
    $artisan

$bootstrappers

The bootstrap classes for the application.


    protected
        array<string|int, mixed>
    $bootstrappers
     = ['\October\Rain\Foundation\Bootstrap\RegisterClassLoader', '\October\Rain\Foundation\Bootstrap\LoadEnvironmentVariables', '\October\Rain\Foundation\Bootstrap\LoadConfiguration', '\October\Rain\Foundation\Bootstrap\LoadTranslation', IlluminateFoundationBootstrapHandleExceptions::class, IlluminateFoundationBootstrapRegisterFacades::class, IlluminateFoundationBootstrapSetRequestForConsole::class, '\October\Rain\Foundation\Bootstrap\RegisterOctober', IlluminateFoundationBootstrapRegisterProviders::class, IlluminateFoundationBootstrapBootProviders::class]

$commands

The Artisan commands provided by your application.


    protected
        array<string|int, mixed>
    $commands
     = []

$commandsLoaded

Indicates if the Closure commands have been loaded.


    protected
        bool
    $commandsLoaded
     = false

$events

The event dispatcher implementation.


    protected
        Dispatcher
    $events

__construct()

Create a new console kernel instance.


    public
                __construct(Application $app, Dispatcher $events) : void

Parameters

$app : Application
$events : Dispatcher

Return values

void —

all()

Get all of the commands registered with the console.


    public
                all() : array<string|int, mixed>

Return values

array<string|int, mixed> —

bootstrap()

Bootstrap the application for artisan commands.


    public
                bootstrap() : void

Return values

void —

call()

Run an Artisan console command by name.


    public
                call(string $command[, array<string|int, mixed> $parameters = [] ][, OutputInterface $outputBuffer = null ]) : int

Parameters

$command : string
$parameters : array<string|int, mixed> = []
$outputBuffer : OutputInterface = null

Return values

int —

command()


    public
                command(string $signature, Closure $callback) : ClosureCommand

Parameters

$signature : string
$callback : Closure

Return values

ClosureCommand —

handle()

Run the console application.


    public
                handle(InputInterface $input[, OutputInterface $output = null ]) : int

Parameters

$input : InputInterface
$output : OutputInterface = null

Return values

int —

output()

Get the output for the last run command.


    public
                output() : string

Return values

string —

queue()

Queue the given console command.


    public
                queue(string $command[, array<string|int, mixed> $parameters = [] ]) : PendingDispatch

Parameters

$command : string
$parameters : array<string|int, mixed> = []

Return values

PendingDispatch —

registerCommand()


    public
                registerCommand(Command $command) : void

Parameters

$command : Command

Return values

void —

setArtisan()

Set the Artisan application instance.


    public
                setArtisan(Application $artisan) : void

Parameters

$artisan : Application

Return values

void —

terminate()

Terminate the application.


    public
                terminate(InputInterface $input, int $status) : void

Parameters

$input : InputInterface
$status : int

Return values

void —

bootstrappers()

Get the bootstrap classes for the application.


    protected
                bootstrappers() : array<string|int, mixed>

Return values

array<string|int, mixed> —

commands()


    protected
                commands() : void

Return values

void —

defineConsoleSchedule()

Define the application's command schedule.


    protected
                defineConsoleSchedule() : void

Return values

void —

getArtisan()

Get the Artisan application instance.


    protected
                getArtisan() : Application

Return values

Application —

load()


    protected
                load(array<string|int, mixed>|string $paths) : void

Parameters

$paths : array<string|int, mixed>|string

Return values

void —

renderException()

Report the exception to the exception handler.


    protected
                renderException(OutputInterface $output, Exception $e) : void

Parameters

$output : OutputInterface
$e : Exception

Return values

void —

reportException()

Report the exception to the exception handler.


    protected
                reportException(Exception $e) : void

Parameters

$e : Exception

Return values

void —

schedule()

Define the application's command schedule.


    protected
                schedule(Schedule $schedule) : void

Parameters

$schedule : Schedule

Return values

void —