ConsoleCommandRunner

Type
Class
Namespace
Craft
Inherits
Craft\ConsoleCommandRunner » CConsoleCommandRunner (opens new window) » CComponent (opens new window)
Since
1.0

Class ConsoleCommandRunner

See also http://craftcms.com

View source (opens new window)

# Public Properties

Property Description
$commands (opens new window) array (opens new window) – List of all available commands (command name=>command configuration).

# Public Methods

Method Description
__call() (opens new window) Calls the named method which is not a class method.
__get() (opens new window) Returns a property value, an event handler list or a behavior based on its name.
__isset() (opens new window) Checks if a property value is null.
__set() (opens new window) Sets value of a component property.
__unset() (opens new window) Sets a component property to be null.
addCommands() Adds commands from the specified command path. If a command already exists, the new one will overwrite it.
asa() (opens new window) Returns the named behavior object.
attachBehavior() (opens new window) Attaches a behavior to this component.
attachBehaviors() (opens new window) Attaches a list of behaviors to the component.
attachEventHandler() (opens new window) Attaches an event handler to an event.
canGetProperty() (opens new window) Determines whether a property can be read.
canSetProperty() (opens new window) Determines whether a property can be set.
createCommand()
detachBehavior() (opens new window) Detaches a behavior from the component.
detachBehaviors() (opens new window) Detaches all behaviors from the component.
detachEventHandler() (opens new window) Detaches an existing event handler.
disableBehavior() (opens new window) Disables an attached behavior.
disableBehaviors() (opens new window) Disables all behaviors attached to this component.
enableBehavior() (opens new window) Enables an attached behavior.
enableBehaviors() (opens new window) Enables all behaviors attached to this component.
evaluateExpression() (opens new window) Evaluates a PHP expression or callback under the context of this component.
findCommands() (opens new window) Searches for commands under the specified directory.
getCommand() (opens new window) Returns the currently running command.
getEventHandlers() (opens new window) Returns the list of attached event handlers for an event.
getScriptName() (opens new window)
hasEvent() (opens new window) Determines whether an event is defined.
hasEventHandler() (opens new window) Checks whether the named event has attached handlers.
hasProperty() (opens new window) Determines whether a property is defined.
raiseEvent() (opens new window) Raises an event.
run() (opens new window) Executes the requested command.
setCommand() (opens new window)

# addCommands()

Adds commands from the specified command path. If a command already exists, the new one will overwrite it.

View source (opens new window)

Arguments

Returns

null (opens new window)

Signature

public null addCommands ( $path )

# createCommand()

View source (opens new window)

Arguments

Returns

CConsoleCommand (opens new window) – The command object. Null if the name is invalid.

Signature

public CConsoleCommand createCommand ( $name )