ConsoleCommandRunner

Type
Class
Namespace
Craft
Inherits
Craft\ConsoleCommandRunner » CConsoleCommandRunner » CComponent
Since
1.0

Class ConsoleCommandRunner

See also http://craftcms.com

View source

Public Properties

PropertyDescription
$commandsarray – List of all available commands (command name=>command configuration).

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__get()Returns a property value, an event handler list or a behavior based on its name.
__isset()Checks if a property value is null.
__set()Sets value of a component property.
__unset()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()Returns the named behavior object.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
attachEventHandler()Attaches an event handler to an event.
canGetProperty()Determines whether a property can be read.
canSetProperty()Determines whether a property can be set.
createCommand()
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
detachEventHandler()Detaches an existing event handler.
disableBehavior()Disables an attached behavior.
disableBehaviors()Disables all behaviors attached to this component.
enableBehavior()Enables an attached behavior.
enableBehaviors()Enables all behaviors attached to this component.
evaluateExpression()Evaluates a PHP expression or callback under the context of this component.
findCommands()Searches for commands under the specified directory.
getCommand()Returns the currently running command.
getEventHandlers()Returns the list of attached event handlers for an event.
getScriptName()
hasEvent()Determines whether an event is defined.
hasEventHandler()Checks whether the named event has attached handlers.
hasProperty()Determines whether a property is defined.
raiseEvent()Raises an event.
run()Executes the requested command.
setCommand()

addCommands()

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

View source

Arguments

  • $path (string) – The alias of the folder containing the command class files.

Returns

null

Signature

public null addCommands ( $path )

createCommand()

View source

Arguments

  • $name (string) – Command name (case-insensitive)

Returns

CConsoleCommand – The command object. Null if the name is invalid.

Signature

public CConsoleCommand createCommand ( $name )