CConsoleCommandBehavior.php 1.69 KB
Newer Older
JULIO JARAMILLO's avatar
JULIO JARAMILLO committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53
<?php
/**
 * CConsoleCommandBehavior class file.
 *
 * @author Evgeny Blinov <e.a.blinov@gmail.com>
 * @link http://www.yiiframework.com/
 * @copyright 2008-2013 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

/**
 * CConsoleCommandBehavior is a base class for behaviors that are attached to a console command component.
 *
 * @property CConsoleCommand $owner The owner model that this behavior is attached to.
 *
 * @author Evgeny Blinov <e.a.blinov@gmail.com>
 * @package system.console
 * @since 1.1.11
 */
class CConsoleCommandBehavior extends CBehavior
{
	/**
	 * Declares events and the corresponding event handler methods.
	 * The default implementation returns 'onAfterConstruct', 'onBeforeValidate' and 'onAfterValidate' events and handlers.
	 * If you override this method, make sure you merge the parent result to the return value.
	 * @return array events (array keys) and the corresponding event handler methods (array values).
	 * @see CBehavior::events
	 */
	public function events()
	{
		return array(
			'onBeforeAction' => 'beforeAction',
			'onAfterAction' => 'afterAction'
		);
	}
	/**
	 * Responds to {@link CConsoleCommand::onBeforeAction} event.
	 * Override this method and make it public if you want to handle the corresponding event of the {@link CBehavior::owner owner}.
	 * @param CConsoleCommandEvent $event event parameter
	 */
	protected function beforeAction($event)
	{
	}

	/**
	 * Responds to {@link CConsoleCommand::onAfterAction} event.
	 * Override this method and make it public if you want to handle the corresponding event of the {@link CBehavior::owner owner}.
	 * @param CConsoleCommandEvent $event event parameter
	 */
	protected function afterAction($event)
	{
	}
}