Overview

Packages

  • application
    • commands
    • components
      • actions
      • filters
      • leftWidget
      • permissions
      • sortableWidget
      • util
      • webupdater
      • x2flow
        • actions
        • triggers
      • X2GridView
      • X2Settings
    • controllers
    • models
      • embedded
    • modules
      • accounts
        • controllers
        • models
      • actions
        • controllers
        • models
      • calendar
        • controllers
        • models
      • charts
        • models
      • contacts
        • controllers
        • models
      • docs
        • components
        • controllers
        • models
      • groups
        • controllers
        • models
      • marketing
        • components
        • controllers
        • models
      • media
        • controllers
        • models
      • mobile
        • components
      • opportunities
        • controllers
        • models
      • products
        • controllers
        • models
      • quotes
        • controllers
        • models
      • services
        • controllers
        • models
      • template
        • models
      • users
        • controllers
        • models
      • workflow
        • controllers
        • models
      • x2Leads
        • controllers
        • models
  • Net
  • None
  • PHP
  • system
    • base
    • caching
      • dependencies
    • collections
    • console
    • db
      • ar
      • schema
        • cubrid
        • mssql
        • mysql
        • oci
        • pgsql
        • sqlite
    • i18n
      • gettext
    • logging
    • test
    • utils
    • validators
    • web
      • actions
      • auth
      • filters
      • form
      • helpers
      • renderers
      • services
      • widgets
        • captcha
        • pagers
  • Text
    • Highlighter
  • zii
    • behaviors
    • widgets
      • grid
      • jui

Classes

  • CConsoleApplication
  • CConsoleCommand
  • CConsoleCommandBehavior
  • CConsoleCommandEvent
  • CConsoleCommandRunner
  • CHelpCommand
  • ThemeBuildCommand
  • Overview
  • Package
  • Class
  • Tree

Class CConsoleCommandEvent

CConsoleCommandEvent class.

CConsoleCommandEvent represents the event parameters needed by events raised by a console command.

CComponent
Extended by CEvent
Extended by CConsoleCommandEvent
Package: system\console
Copyright: 2008-2013 Yii Software LLC
License: http://www.yiiframework.com/license/
Author: Evgeny Blinov <e.a.blinov@gmail.com>
Since: 1.1.11
Located at x2engine/framework/console/CConsoleCommandEvent.php
Methods summary
public
# __construct( mixed $sender = null, string $params = null, string $action = null, integer $exitCode = 0 )

Constructor.

Constructor.

Parameters

$sender
mixed
$sender sender of the event
$params
string
$params the parameters to be passed to the action method.
$action
string
$action the action name
$exitCode
integer
$exitCode the application exit code

Overrides

CEvent::__construct()
Methods inherited from CComponent
__call(), __get(), __isset(), __set(), __unset(), asa(), attachBehavior(), attachBehaviors(), attachEventHandler(), canGetProperty(), canSetProperty(), detachBehavior(), detachBehaviors(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), getEventHandlers(), hasEvent(), hasEventHandler(), hasProperty(), raiseEvent()
Properties summary
public string $action
#

the action name

the action name

public boolean $stopCommand false
#

whether the action should be executed. If this property is set true by the event handler, the console command action will quit after handling this event. If false, which is the default, the normal execution cycles will continue, including performing the action and calling CConsoleCommand::afterAction().

whether the action should be executed. If this property is set true by the event handler, the console command action will quit after handling this event. If false, which is the default, the normal execution cycles will continue, including performing the action and calling CConsoleCommand::afterAction().

public integer $exitCode
#

exit code of application. This property is available in CConsoleCommand::onAfterAction() event and will be set to the exit code returned by the console command action. You can set it to change application exit code.

exit code of application. This property is available in CConsoleCommand::onAfterAction() event and will be set to the exit code returned by the console command action. You can set it to change application exit code.

Properties inherited from CEvent
$handled, $params, $sender
API documentation generated by ApiGen 2.8.0