Generator.php 10.9 KB
Newer Older
Qiang Xue committed
1 2 3 4 5 6 7 8 9
<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\gii\generators\crud;

Qiang Xue committed
10
use Yii;
Qiang Xue committed
11
use yii\db\ActiveRecord;
Qiang Xue committed
12
use yii\db\Schema;
Qiang Xue committed
13
use yii\gii\CodeFile;
Qiang Xue committed
14
use yii\helpers\Inflector;
Qiang Xue committed
15 16
use yii\web\Controller;

Qiang Xue committed
17 18 19 20 21 22 23
/**
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
class Generator extends \yii\gii\Generator
{
Qiang Xue committed
24
	public $modelClass;
Qiang Xue committed
25 26
	public $moduleID;
	public $controllerClass;
Qiang Xue committed
27
	public $baseControllerClass = 'yii\web\Controller';
Qiang Xue committed
28 29
	public $indexWidgetType = 'grid';
	public $searchModelClass;
Qiang Xue committed
30

Qiang Xue committed
31 32 33 34 35 36 37 38 39 40
	public function getName()
	{
		return 'CRUD Generator';
	}

	public function getDescription()
	{
		return 'This generator generates a controller and views that implement CRUD (Create, Read, Update, Delete)
			operations for the specified data model.';
	}
41

Qiang Xue committed
42 43
	public function rules()
	{
Alexander Makarov committed
44 45 46
		return array_merge(parent::rules(), [
			['moduleID, controllerClass, modelClass, searchModelClass, baseControllerClass', 'filter', 'filter' => 'trim'],
			['modelClass, searchModelClass, controllerClass, baseControllerClass, indexWidgetType', 'required'],
47
			['searchModelClass', 'compare', 'compareAttribute' => 'modelClass', 'operator' => '!==', 'message' => 'Search Model Class must not be equal to Model Class.'],
Alexander Makarov committed
48 49 50 51 52 53 54 55 56
			['modelClass, controllerClass, baseControllerClass, searchModelClass', 'match', 'pattern' => '/^[\w\\\\]*$/', 'message' => 'Only word characters and backslashes are allowed.'],
			['modelClass', 'validateClass', 'params' => ['extends' => ActiveRecord::className()]],
			['baseControllerClass', 'validateClass', 'params' => ['extends' => Controller::className()]],
			['controllerClass', 'match', 'pattern' => '/Controller$/', 'message' => 'Controller class name must be suffixed with "Controller".'],
			['controllerClass, searchModelClass', 'validateNewClass'],
			['indexWidgetType', 'in', 'range' => ['grid', 'list']],
			['modelClass', 'validateModelClass'],
			['moduleID', 'validateModuleID'],
		]);
Qiang Xue committed
57 58 59 60
	}

	public function attributeLabels()
	{
Alexander Makarov committed
61
		return array_merge(parent::attributeLabels(), [
Qiang Xue committed
62
			'modelClass' => 'Model Class',
Qiang Xue committed
63 64
			'moduleID' => 'Module ID',
			'controllerClass' => 'Controller Class',
Qiang Xue committed
65
			'baseControllerClass' => 'Base Controller Class',
Qiang Xue committed
66 67
			'indexWidgetType' => 'Widget Used in Index Page',
			'searchModelClass' => 'Search Model Class',
Alexander Makarov committed
68
		]);
Qiang Xue committed
69 70 71 72 73 74 75
	}

	/**
	 * @inheritdoc
	 */
	public function hints()
	{
Alexander Makarov committed
76
		return [
Qiang Xue committed
77 78
			'modelClass' => 'This is the ActiveRecord class associated with the table that CRUD will be built upon.
				You should provide a fully qualified class name, e.g., <code>app\models\Post</code>.',
Qiang Xue committed
79 80
			'controllerClass' => 'This is the name of the controller class to be generated. You should
				provide a fully qualified namespaced class, .e.g, <code>app\controllers\PostController</code>.',
Qiang Xue committed
81 82
			'baseControllerClass' => 'This is the class that the new CRUD controller class will extend from.
				You should provide a fully qualified class name, e.g., <code>yii\web\Controller</code>.',
Qiang Xue committed
83 84
			'moduleID' => 'This is the ID of the module that the generated controller will belong to.
				If not set, it means the controller will belong to the application.',
Qiang Xue committed
85 86 87
			'indexWidgetType' => 'This is the widget type to be used in the index page to display list of the models.
				You may choose either <code>GridView</code> or <code>ListView</code>',
			'searchModelClass' => 'This is the class representing the data being collecting in the search form.
Qiang Xue committed
88
			 	A fully qualified namespaced class name is required, e.g., <code>app\models\search\PostSearch</code>.',
Alexander Makarov committed
89
		];
Qiang Xue committed
90 91 92 93
	}

	public function requiredTemplates()
	{
Alexander Makarov committed
94
		return ['controller.php'];
Qiang Xue committed
95 96 97 98 99 100 101
	}

	/**
	 * @inheritdoc
	 */
	public function stickyAttributes()
	{
Alexander Makarov committed
102
		return ['baseControllerClass', 'moduleID', 'indexWidgetType'];
Qiang Xue committed
103 104 105 106 107 108 109 110 111 112
	}

	public function validateModelClass()
	{
		/** @var ActiveRecord $class */
		$class = $this->modelClass;
		$pk = $class::primaryKey();
		if (empty($pk)) {
			$this->addError('modelClass', "The table associated with $class must have primary key(s).");
		}
Qiang Xue committed
113 114
	}

Qiang Xue committed
115 116 117 118 119 120 121 122 123 124
	public function validateModuleID()
	{
		if (!empty($this->moduleID)) {
			$module = Yii::$app->getModule($this->moduleID);
			if ($module === null) {
				$this->addError('moduleID', "Module '{$this->moduleID}' does not exist.");
			}
		}
	}

125 126 127 128 129
	/**
	 * @inheritdoc
	 */
	public function generate()
	{
Qiang Xue committed
130 131
		$controllerFile = Yii::getAlias('@' . str_replace('\\', '/', ltrim($this->controllerClass, '\\')) . '.php');
		$searchModel = Yii::getAlias('@' . str_replace('\\', '/', ltrim($this->searchModelClass, '\\') . '.php'));
Alexander Makarov committed
132
		$files = [
Qiang Xue committed
133 134
			new CodeFile($controllerFile, $this->render('controller.php')),
			new CodeFile($searchModel, $this->render('search.php')),
Alexander Makarov committed
135
		];
Qiang Xue committed
136

Qiang Xue committed
137
		$viewPath = $this->getViewPath();
Qiang Xue committed
138 139 140 141
		$templatePath = $this->getTemplatePath() . '/views';
		foreach (scandir($templatePath) as $file) {
			if (is_file($templatePath . '/' . $file) && pathinfo($file, PATHINFO_EXTENSION) === 'php') {
				$files[] = new CodeFile("$viewPath/$file", $this->render("views/$file"));
Qiang Xue committed
142 143 144
			}
		}

Qiang Xue committed
145

Qiang Xue committed
146
		return $files;
147
	}
Qiang Xue committed
148 149 150 151 152 153

	/**
	 * @return string the controller ID (without the module ID prefix)
	 */
	public function getControllerID()
	{
Qiang Xue committed
154 155 156
		$pos = strrpos($this->controllerClass, '\\');
		$class = substr(substr($this->controllerClass, $pos + 1), 0, -10);
		return Inflector::camel2id($class);
Qiang Xue committed
157 158 159 160 161 162 163
	}

	/**
	 * @return string the action view file path
	 */
	public function getViewPath()
	{
Qiang Xue committed
164
		$module = empty($this->moduleID) ? Yii::$app : Yii::$app->getModule($this->moduleID);
Qiang Xue committed
165 166
		return $module->getViewPath() . '/' . $this->getControllerID() ;
	}
Qiang Xue committed
167 168 169 170 171 172 173 174 175 176 177 178 179

	public function getNameAttribute()
	{
		/** @var \yii\db\ActiveRecord $class */
		$class = $this->modelClass;
		foreach ($class::getTableSchema()->columnNames as $name) {
			if (!strcasecmp($name, 'name') || !strcasecmp($name, 'title')) {
				return $name;
			}
		}
		$pk = $class::primaryKey();
		return $pk[0];
	}
Qiang Xue committed
180 181 182 183 184

	/**
	 * @param string $attribute
	 * @return string
	 */
Qiang Xue committed
185
	public function generateActiveField($attribute)
Qiang Xue committed
186
	{
Qiang Xue committed
187
		$tableSchema = $this->getTableSchema();
Qiang Xue committed
188 189 190 191 192
		if (!isset($tableSchema->columns[$attribute])) {
			return "\$form->field(\$model, '$attribute');";
		}
		$column = $tableSchema->columns[$attribute];
		if ($column->phpType === 'boolean') {
193
			return "\$form->field(\$model, '$attribute')->checkbox()";
Qiang Xue committed
194
		} elseif ($column->type === 'text') {
195
			return "\$form->field(\$model, '$attribute')->textarea(['rows' => 6])";
Qiang Xue committed
196 197 198 199 200 201 202
		} else {
			if (preg_match('/^(password|pass|passwd|passcode)$/i', $column->name)) {
				$input = 'passwordInput';
			} else {
				$input = 'textInput';
			}
			if ($column->phpType !== 'string' || $column->size === null) {
203
				return "\$form->field(\$model, '$attribute')->$input()";
Qiang Xue committed
204
			} else {
205
				return "\$form->field(\$model, '$attribute')->$input(['maxlength' => $column->size])";
Qiang Xue committed
206 207 208 209
			}
		}
	}

Qiang Xue committed
210 211 212 213 214 215 216 217 218
	/**
	 * @param string $attribute
	 * @return string
	 */
	public function generateActiveSearchField($attribute)
	{
		$tableSchema = $this->getTableSchema();
		$column = $tableSchema->columns[$attribute];
		if ($column->phpType === 'boolean') {
219
			return "\$form->field(\$model, '$attribute')->checkbox()";
Qiang Xue committed
220
		} else {
221
			return "\$form->field(\$model, '$attribute')";
Qiang Xue committed
222 223 224
		}
	}

Qiang Xue committed
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
	/**
	 * @param \yii\db\ColumnSchema $column
	 * @return string
	 */
	public function generateColumnFormat($column)
	{
		if ($column->phpType === 'boolean') {
			return 'boolean';
		} elseif ($column->type === 'text') {
			return 'ntext';
		} elseif (stripos($column->name, 'time') !== false && $column->phpType === 'integer') {
			return 'datetime';
		} elseif (stripos($column->name, 'email') !== false) {
			return 'email';
		} elseif (stripos($column->name, 'url') !== false) {
			return 'url';
		} else {
			return 'text';
		}
	}
Qiang Xue committed
245 246 247 248 249 250 251 252

	/**
	 * Generates validation rules for the search model.
	 * @return array the generated validation rules
	 */
	public function generateSearchRules()
	{
		$table = $this->getTableSchema();
Alexander Makarov committed
253
		$types = [];
Qiang Xue committed
254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278
		foreach ($table->columns as $column) {
			switch ($column->type) {
				case Schema::TYPE_SMALLINT:
				case Schema::TYPE_INTEGER:
				case Schema::TYPE_BIGINT:
					$types['integer'][] = $column->name;
					break;
				case Schema::TYPE_BOOLEAN:
					$types['boolean'][] = $column->name;
					break;
				case Schema::TYPE_FLOAT:
				case Schema::TYPE_DECIMAL:
				case Schema::TYPE_MONEY:
					$types['number'][] = $column->name;
					break;
				case Schema::TYPE_DATE:
				case Schema::TYPE_TIME:
				case Schema::TYPE_DATETIME:
				case Schema::TYPE_TIMESTAMP:
				default:
					$types['safe'][] = $column->name;
					break;
			}
		}

Alexander Makarov committed
279
		$rules = [];
Qiang Xue committed
280
		foreach ($types as $type => $columns) {
Alexander Makarov committed
281
			$rules[] = "['" . implode(', ', $columns) . "', '$type']";
Qiang Xue committed
282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298
		}

		return $rules;
	}

	public function getSearchAttributes()
	{
		return $this->getTableSchema()->getColumnNames();
	}

	/**
	 * Generates the attribute labels for the search model.
	 * @return array the generated attribute labels (name => label)
	 */
	public function generateSearchLabels()
	{
		$table = $this->getTableSchema();
Alexander Makarov committed
299
		$labels = [];
Qiang Xue committed
300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316
		foreach ($table->columns as $column) {
			if (!strcasecmp($column->name, 'id')) {
				$labels[$column->name] = 'ID';
			} else {
				$label = Inflector::camel2words($column->name);
				if (strcasecmp(substr($label, -3), ' id') === 0) {
					$label = substr($label, 0, -3) . ' ID';
				}
				$labels[$column->name] = $label;
			}
		}
		return $labels;
	}

	public function generateSearchConditions()
	{
		$table = $this->getTableSchema();
Alexander Makarov committed
317
		$conditions = [];
Qiang Xue committed
318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347
		foreach ($table->columns as $column) {
			switch ($column->type) {
				case Schema::TYPE_SMALLINT:
				case Schema::TYPE_INTEGER:
				case Schema::TYPE_BIGINT:
				case Schema::TYPE_BOOLEAN:
				case Schema::TYPE_FLOAT:
				case Schema::TYPE_DECIMAL:
				case Schema::TYPE_MONEY:
				case Schema::TYPE_DATE:
				case Schema::TYPE_TIME:
				case Schema::TYPE_DATETIME:
				case Schema::TYPE_TIMESTAMP:
					$conditions[] = "\$this->addCondition(\$query, '{$column->name}');";
					break;
				default:
					$conditions[] = "\$this->addCondition(\$query, '{$column->name}', true);";
					break;
			}
		}

		return $conditions;
	}

	public function generateUrlParams()
	{
		$pks = $this->getTableSchema()->primaryKey;
		if (count($pks) === 1) {
			return "'id' => \$model->{$pks[0]}";
		} else {
Alexander Makarov committed
348
			$params = [];
Qiang Xue committed
349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370
			foreach ($pks as $pk) {
				$params[] = "'$pk' => \$model->$pk";
			}
			return implode(', ', $params);
		}
	}

	public function generateActionParams()
	{
		$pks = $this->getTableSchema()->primaryKey;
		if (count($pks) === 1) {
			return '$id';
		} else {
			return '$' . implode(', $', $pks);
		}
	}

	public function generateActionParamComments()
	{
		$table = $this->getTableSchema();
		$pks = $table->primaryKey;
		if (count($pks) === 1) {
Alexander Makarov committed
371
			return ['@param ' . $table->columns[$pks[0]]->phpType . ' $id'];
Qiang Xue committed
372
		} else {
Alexander Makarov committed
373
			$params = [];
Qiang Xue committed
374 375 376 377 378 379 380 381 382 383 384 385 386
			foreach ($pks as $pk) {
				$params[] = '@param ' . $table->columns[$pk]->phpType . ' $' . $pk;
			}
			return $params;
		}
	}

	public function getTableSchema()
	{
		/** @var ActiveRecord $class */
		$class = $this->modelClass;
		return $class::getTableSchema();
	}
Qiang Xue committed
387
}