Controller.php 4.47 KB
Newer Older
Alexander Makarov committed
1 2
<?php
/**
Qiang Xue committed
3
 * Controller class file.
Alexander Makarov committed
4 5
 *
 * @link http://www.yiiframework.com/
Qiang Xue committed
6
 * @copyright Copyright &copy; 2008 Yii Software LLC
Alexander Makarov committed
7 8 9 10 11
 * @license http://www.yiiframework.com/license/
 */

namespace yii\console;

Qiang Xue committed
12
use Yii;
Qiang Xue committed
13
use yii\base\Action;
Qiang Xue committed
14
use yii\base\InlineAction;
Qiang Xue committed
15
use yii\base\InvalidRouteException;
Qiang Xue committed
16

Alexander Makarov committed
17
/**
Qiang Xue committed
18
 * Controller is the base class of console command classes.
Alexander Makarov committed
19
 *
Qiang Xue committed
20 21 22
 * A controller consists of one or several actions known as sub-commands.
 * Users call a console command by specifying the corresponding route which identifies a controller action.
 * The `yiic` program is used when calling a console command, like the following:
Alexander Makarov committed
23
 *
Qiang Xue committed
24
 * ~~~
Qiang Xue committed
25
 * yiic <route> [--param1=value1 --param2 ...]
Qiang Xue committed
26
 * ~~~
Alexander Makarov committed
27 28
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
29
 *
Alexander Makarov committed
30 31
 * @since 2.0
 */
Qiang Xue committed
32
class Controller extends \yii\base\Controller
Alexander Makarov committed
33
{
Qiang Xue committed
34 35 36 37 38 39
	/**
	 * @var boolean whether the call of [[confirm()]] requires a user input.
	 * If false, [[confirm()]] will always return true no matter what user enters or not.
	 */
	public $interactive = true;

Qiang Xue committed
40 41 42 43 44 45 46 47 48 49 50 51
	/**
	 * Runs an action with the specified action ID and parameters.
	 * If the action ID is empty, the method will use [[defaultAction]].
	 * @param string $id the ID of the action to be executed.
	 * @param array $params the parameters (name-value pairs) to be passed to the action.
	 * @return integer the status of the action execution. 0 means normal, other values mean abnormal.
	 * @throws InvalidRouteException if the requested action ID cannot be resolved into an action successfully.
	 * @see createAction
	 */
	public function runAction($id, $params = array())
	{
		if ($params !== array()) {
Qiang Xue committed
52
			$options = $this->globalOptions();
Qiang Xue committed
53
			foreach ($params as $name => $value) {
Qiang Xue committed
54 55 56
				if (in_array($name, $options, true)) {
					$this->$name = $value;
					unset($params[$name]);
Qiang Xue committed
57 58 59 60 61 62
				}
			}
		}
		return parent::runAction($id, $params);
	}

Qiang Xue committed
63
	/**
Qiang Xue committed
64 65 66 67 68 69 70 71
	 * Binds the parameters to the action.
	 * This method is invoked by [[Action]] when it begins to run with the given parameters.
	 * This method will first bind the parameters with the [[globalOptions()|global options]]
	 * available to the action. It then validates the given arguments.
	 * @param Action $action the action to be bound with parameters
	 * @param array $params the parameters to be bound to the action
	 * @return array the valid parameters that the action can run with.
	 * @throws Exception if there are unknown options or missing arguments
Qiang Xue committed
72
	 */
Qiang Xue committed
73
	public function bindActionParams($action, $params)
Qiang Xue committed
74
	{
Qiang Xue committed
75 76 77 78 79 80 81 82 83
		if ($params !== array()) {
			$options = $this->globalOptions();
			foreach ($params as $name => $value) {
				if (in_array($name, $options, true)) {
					$this->$name = $value;
					unset($params[$name]);
				}
			}
		}
Qiang Xue committed
84

Qiang Xue committed
85 86 87
		$args = isset($params[Request::ANONYMOUS_PARAMS]) ? $params[Request::ANONYMOUS_PARAMS] : array();
		unset($params[Request::ANONYMOUS_PARAMS]);
		if ($params !== array()) {
88
			throw new Exception(Yii::t('yii|Unknown options: {params}', array(
Qiang Xue committed
89
				'{params}' => implode(', ', array_keys($params)),
Qiang Xue committed
90
			)));
Qiang Xue committed
91
		}
Qiang Xue committed
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111

		if ($action instanceof InlineAction) {
			$method = new \ReflectionMethod($this, $action->actionMethod);
		} else {
			$method = new \ReflectionMethod($action, 'run');
		}

		$missing = array();
		foreach ($method->getParameters() as $i => $param) {
			$name = $param->getName();
			if (!isset($args[$i])) {
				if ($param->isDefaultValueAvailable()) {
					$args[$i] = $param->getDefaultValue();
				} else {
					$missing[] = $name;
				}
			}
		}

		if ($missing !== array()) {
112
			throw new Exception(Yii::t('yii|Missing required arguments: {params}', array(
Qiang Xue committed
113
				'{params}' => implode(', ', $missing),
Qiang Xue committed
114
			)));
Alexander Makarov committed
115
		}
Qiang Xue committed
116 117

		return $args;
Alexander Makarov committed
118
	}
Alexander Makarov committed
119 120 121 122 123 124 125 126 127 128

	/**
	 * Asks user to confirm by typing y or n.
	 *
	 * @param string $message to echo out before waiting for user input
	 * @param boolean $default this value is returned if no selection is made.
	 * @return boolean whether user confirmed
	 */
	public function confirm($message, $default = false)
	{
Qiang Xue committed
129 130 131 132 133 134 135 136 137
		if ($this->interactive) {
			echo $message . ' (yes|no) [' . ($default ? 'yes' : 'no') . ']:';
			$input = trim(fgets(STDIN));
			return empty($input) ? $default : !strncasecmp($input, 'y', 1);
		} else {
			return true;
		}
	}

Qiang Xue committed
138 139 140 141 142 143 144
	/**
	 * Returns the names of the global options for this command.
	 * A global option requires the existence of a global member variable whose
	 * name is the option name.
	 * Child classes may override this method to specify possible global options.
	 * @return array the names of the global options for this command.
	 */
Qiang Xue committed
145 146 147
	public function globalOptions()
	{
		return array();
Alexander Makarov committed
148
	}
Alexander Makarov committed
149
}