class CoreConsole extends Console implements WindwalkerApplicationInterface, DispatcherAwareInterface (View source)

The Console class.

Traits

The BootableTrait class.
The main Windwalker instantiate class.

Methods

string
getName()

getName

Structure
getConfig()

getConfig

void
boot()

boot

getPackage(string $name = null)

getPackage

addPackage(string $name, AbstractPackage $package)

addPackage

boolean
isConsole()

isConsole

boolean
isWeb()

isWeb

__construct(IOInterface $io = null, Config $config = null)

Class init.

setName(string $name)

Method to set property name

void
registerCommands()

registerCommands

int
execute()

Execute the application.

registerRootCommand()

Register default command.

EventInterface
triggerEvent(EventInterface|string $event, array $args = array())

Trigger an event.

setContainer(Container $container)

Method to set property container

Container
getContainer()

Method to get property Container

DispatcherInterface
getDispatcher()

getDispatcher

setDispatcher(DispatcherInterface $dispatcher)

setDispatcher

addMessage(string|array $messages, string $type = null)

addMessage

string
getMode()

Method to get property Mode

mixed
__get($name)

is utilized for reading data from inaccessible members.

Details

string getName()

getName

Return Value

string

Structure getConfig()

getConfig

Return Value

Structure

void boot()

boot

Return Value

void

at line line 241
AbstractPackage getPackage(string $name = null)

getPackage

Parameters

string $name

Return Value

AbstractPackage

at line line 261
WindwalkerApplicationInterface addPackage(string $name, AbstractPackage $package)

addPackage

Parameters

string $name
AbstractPackage $package

Return Value

WindwalkerApplicationInterface

boolean isConsole()

isConsole

Return Value

boolean

boolean isWeb()

isWeb

Return Value

boolean

at line line 100
__construct(IOInterface $io = null, Config $config = null)

Class init.

Parameters

IOInterface $io The Input and output handler.
Config $config Application's config object.

at line line 132
CoreConsole setName(string $name)

Method to set property name

Parameters

string $name

Return Value

CoreConsole Return self to support chaining.

at line line 144
void registerCommands()

registerCommands

Return Value

void

at line line 161
int execute()

Execute the application.

Return Value

int The Unix Console/Shell exit code.

at line line 188
CoreConsole registerRootCommand()

Register default command.

Return Value

CoreConsole Return this object to support chaining.

at line line 224
EventInterface triggerEvent(EventInterface|string $event, array $args = array())

Trigger an event.

Parameters

EventInterface|string $event The event object or name.
array $args The arguments.

Return Value

EventInterface The event after being passed through all listeners.

at line line 275
CoreConsole setContainer(Container $container)

Method to set property container

Parameters

Container $container

Return Value

CoreConsole Return self to support chaining.

at line line 287
Container getContainer()

Method to get property Container

Return Value

Container

at line line 297
DispatcherInterface getDispatcher()

getDispatcher

Return Value

DispatcherInterface

at line line 309
CoreConsole setDispatcher(DispatcherInterface $dispatcher)

setDispatcher

Parameters

DispatcherInterface $dispatcher

Return Value

CoreConsole Return self to support chaining.

at line line 324
WindwalkerApplicationInterface addMessage(string|array $messages, string $type = null)

addMessage

Parameters

string|array $messages
string $type

Return Value

WindwalkerApplicationInterface

at line line 369
string getMode()

Method to get property Mode

Return Value

string

at line line 382
mixed __get($name)

is utilized for reading data from inaccessible members.

Parameters

$name string

Return Value

mixed

Exceptions

OutOfRangeException