You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

411 lines
11 KiB

11 years ago
<?php
/**
* @link http://www.yiiframework.com/
* @copyright Copyright (c) 2008 Yii Software LLC
* @license http://www.yiiframework.com/license/
*/
namespace yii\gii;
use Yii;
11 years ago
use ReflectionClass;
use yii\base\InvalidConfigException;
11 years ago
use yii\base\Model;
11 years ago
use yii\base\View;
11 years ago
11 years ago
11 years ago
/**
* This is the base class for all generator classes.
*
* A generator instance is responsible for taking user inputs, validating them,
* and using them to generate the corresponding code based on a set of code template files.
*
* A generator class typically needs to implement the following methods:
*
* - [[getName()]]: returns the name of the generator
* - [[getDescription()]]: returns the detailed description of the generator
* - [[generate()]]: generates the code based on the current user input and the specified code template files.
* This is the place where main code generation code resides.
*
11 years ago
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/
11 years ago
abstract class Generator extends Model
11 years ago
{
/**
* @var array a list of available code templates. The array keys are the template names,
* and the array values are the corresponding template paths or path aliases.
*/
11 years ago
public $templates = array();
11 years ago
/**
11 years ago
* @var string the name of the code template that the user has selected.
* The value of this property is internally managed by this class.
11 years ago
*/
11 years ago
public $template;
11 years ago
/**
* @return string name of the code generator
*/
11 years ago
abstract public function getName();
/**
* Generates the code based on the current user input and the specified code template files.
* This is the main method that child classes should implement.
* Please refer to [[\yii\gii\generators\controller\Generator::generate()]] as an example
* on how to implement this method.
* @return CodeFile[] a list of code files to be created.
*/
abstract public function generate();
11 years ago
/**
* @inheritdoc
*/
11 years ago
public function init()
11 years ago
{
11 years ago
parent::init();
if (!isset($this->templates['default'])) {
11 years ago
$this->templates['default'] = $this->defaultTemplate();
11 years ago
}
foreach ($this->templates as $i => $template) {
$this->templates[$i] = Yii::getAlias($template);
}
11 years ago
}
11 years ago
/**
* Returns a list of code template files that are required.
* Derived classes usually should override this method if they require the existence of
* certain template files.
* @return array list of code template files that are required. They should be file paths
* relative to [[templatePath]].
11 years ago
*/
public function requiredTemplates()
11 years ago
{
11 years ago
return array();
11 years ago
}
11 years ago
/**
* Returns the list of sticky attributes.
* A sticky attribute will remember its value and will initialize the attribute with this value
* when the generator is restarted.
* @return array list of sticky attributes
11 years ago
*/
11 years ago
public function stickyAttributes()
{
return array('template');
}
/**
* Returns the list of hint messages.
* The array keys are the attribute names, and the array values are the corresponding hint messages.
* Hint messages will be displayed to end users when they are filling the form for the generator.
* @return array the list of hint messages
*/
11 years ago
public function hints()
{
return array();
}
/**
* Returns the message to be displayed when the newly generated code is saved successfully.
* Child classes may override this method to customize the message.
11 years ago
* @return string the message to be displayed when the newly generated code is saved successfully.
*/
public function successMessage()
{
return 'The code has been generated successfully.';
}
/**
* Returns the view file for the input form of the generator.
11 years ago
* The default implementation will return the "form.php" file under the directory
* that contains the generator class file.
* @return string the view file for the input form of the generator.
*/
11 years ago
public function formView()
11 years ago
{
11 years ago
$class = new ReflectionClass($this);
11 years ago
return dirname($class->getFileName()) . '/form.php';
11 years ago
}
/**
* Returns the root path to the default code template files.
* The default implementation will return the "templates" subdirectory of the
* directory containing the generator class file.
* @return string the root path to the default code template files.
*/
11 years ago
public function defaultTemplate()
11 years ago
{
11 years ago
$class = new ReflectionClass($this);
return dirname($class->getFileName()) . '/templates';
11 years ago
}
/**
* @return string the detailed description of the generator.
*/
11 years ago
public function getDescription()
11 years ago
{
11 years ago
return '';
11 years ago
}
/**
* @inheritdoc
*
* Child classes should override this method like the following so that the parent
* rules are included:
*
* ~~~
11 years ago
* return array_merge(parent::rules(), array(
* ...rules for the child class...
* ));
* ~~~
11 years ago
*/
public function rules()
{
return array(
11 years ago
array('template', 'required', 'message' => 'A code template must be selected.'),
11 years ago
array('template', 'validateTemplate'),
11 years ago
);
}
/**
* Loads sticky attributes from an internal file and populates them into the generator.
* @internal
11 years ago
*/
11 years ago
public function loadStickyAttributes()
11 years ago
{
11 years ago
$stickyAttributes = $this->stickyAttributes();
$attributes[] = 'template';
$path = $this->getStickyDataFile();
if (is_file($path)) {
$result = @include($path);
if (is_array($result)) {
foreach ($stickyAttributes as $name) {
if (isset($result[$name])) {
$this->$name = $result[$name];
}
}
11 years ago
}
}
}
/**
* Saves sticky attributes into an internal file.
* @internal
11 years ago
*/
11 years ago
public function saveStickyAttributes()
11 years ago
{
11 years ago
$stickyAttributes = $this->stickyAttributes();
$stickyAttributes[] = 'template';
$values = array();
foreach ($stickyAttributes as $name) {
$values[$name] = $this->$name;
11 years ago
}
11 years ago
$path = $this->getStickyDataFile();
@mkdir(dirname($path), 0755, true);
file_put_contents($path, "<?php\nreturn " . var_export($values, true) . ";\n");
11 years ago
}
/**
11 years ago
* @return string the file path that stores the sticky attribute values.
* @internal
11 years ago
*/
11 years ago
public function getStickyDataFile()
11 years ago
{
return Yii::$app->getRuntimePath() . '/gii-' . Yii::getVersion() . '/' . str_replace('\\', '-', get_class($this)) . '.php';
11 years ago
}
/**
11 years ago
* Saves the generated code into files.
* @param CodeFile[] $files the code files to be saved
11 years ago
* @param array $answers
* @param string $results this parameter receives a value from this method indicating the log messages
* generated while saving the code files.
* @return boolean whether there is any error while saving the code files.
11 years ago
*/
public function save($files, $answers, &$results)
11 years ago
{
$lines = array('Generating code using template "' . $this->getTemplatePath() . '"...');
$hasError = false;
foreach ($files as $file) {
11 years ago
$relativePath = $file->getRelativePath();
if (isset($answers[$file->id]) && $file->operation !== CodeFile::OP_SKIP) {
$error = $file->save();
if (is_string($error)) {
$hasError = true;
11 years ago
$lines[] = "generating $relativePath\n<span class=\"error\">$error</span>";
11 years ago
} else {
$lines[] = $file->operation === CodeFile::OP_NEW ? " generated $relativePath" : " overwrote $relativePath";
11 years ago
}
} else {
$lines[] = " skipped $relativePath";
}
}
$lines[] = "done!\n";
$results = implode("\n", $lines);
return $hasError;
11 years ago
}
/**
* @return string the root path of the template files that are currently being used.
* @throws InvalidConfigException if [[template]] is invalid
11 years ago
*/
11 years ago
public function getTemplatePath()
11 years ago
{
11 years ago
if (isset($this->templates[$this->template])) {
return $this->templates[$this->template];
} else {
throw new InvalidConfigException("Unknown template: {$this->template}");
11 years ago
}
11 years ago
}
/**
* Generates code using the specified code template and parameters.
* Note that the code template will be used as a PHP file.
11 years ago
* @param string $template the code template file. This must be specified as a file path
* relative to [[templatePath]].
* @param array $params list of parameters to be passed to the template file.
* @return string the generated code
*/
public function render($template, $params = array())
11 years ago
{
$view = new View;
$params['generator'] = $this;
11 years ago
return $view->renderFile($this->getTemplatePath() . '/' . $template, $params, $this);
11 years ago
}
/**
11 years ago
* Validates the template selection.
* This method validates whether the user selects an existing template
* and the template contains all required template files as specified in [[requiredTemplates()]].
11 years ago
*/
11 years ago
public function validateTemplate()
11 years ago
{
11 years ago
$templates = $this->templates;
if (!isset($templates[$this->template])) {
$this->addError('template', 'Invalid template selection.');
} else {
$templatePath = $this->templates[$this->template];
foreach ($this->requiredTemplates() as $template) {
if (!is_file($templatePath . '/' . $template)) {
$this->addError('template', "Unable to find the required code template file '$template'.");
11 years ago
}
}
}
}
/**
* An inline validator that checks if the attribute value refers to an existing class name.
* If the `extends` option is specified, it will also check if the class is a child class
* of the class represented by the `extends` option.
* @param string $attribute the attribute being validated
* @param array $params the validation options
*/
public function validateClass($attribute, $params)
{
$class = $this->$attribute;
try {
if (class_exists($class)) {
if (isset($params['extends'])) {
if (ltrim($class, '\\') !== ltrim($params['extends'], '\\') && !is_subclass_of($class, $params['extends'])) {
$this->addError($attribute, "'$class' must extend from {$params['extends']} or its child class.");
}
}
} else {
$this->addError($attribute, "Class '$class' does not exist or has syntax error.");
}
} catch (\Exception $e) {
$this->addError($attribute, "Class '$class' does not exist or has syntax error.");
}
}
/**
* @param string $value the attribute to be validated
* @return boolean whether the value is a reserved PHP keyword.
11 years ago
*/
public function isReservedKeyword($value)
11 years ago
{
11 years ago
static $keywords = array(
'__class__',
'__dir__',
'__file__',
'__function__',
'__line__',
'__method__',
'__namespace__',
11 years ago
'__trait__',
11 years ago
'abstract',
'and',
'array',
'as',
'break',
'case',
'catch',
'callable',
11 years ago
'cfunction',
'class',
'clone',
'const',
'continue',
'declare',
'default',
'die',
'do',
'echo',
'else',
'elseif',
'empty',
'enddeclare',
'endfor',
'endforeach',
'endif',
'endswitch',
'endwhile',
'eval',
'exception',
'exit',
'extends',
'final',
11 years ago
'finally',
11 years ago
'for',
'foreach',
'function',
'global',
'goto',
'if',
'implements',
'include',
'include_once',
'instanceof',
'insteadof',
11 years ago
'interface',
'isset',
'list',
'namespace',
'new',
'old_function',
'or',
'parent',
'php_user_filter',
'print',
'private',
'protected',
'public',
'require',
'require_once',
'return',
'static',
'switch',
'this',
'throw',
11 years ago
'trait',
11 years ago
'try',
'unset',
'use',
'var',
'while',
'xor',
);
return in_array(strtolower($value), $keywords, true);
11 years ago
}
}