首页 / PHP / Yii框架官方指南系列41——专题：自动代码生成

Yii框架官方指南系列41——专题：自动代码生成

内容导读

互联网集市收集整理的这篇技术教程文章主要介绍了Yii框架官方指南系列41——专题：自动代码生成，小编现在分享给大家，供广大互联网技能从业者学习和参考。文章包含10578字，纯文字阅读大概需要16分钟。

内容图文

自版本 1.1.2 起， Yii 装备了基于 Web 界面的代码生成工具Gii。它取代了之前的命令行端的代码生成工具 yiic shell。在这部分，我们将讲解如何使用 Gii 以及如何扩展 Gii 以增加我们的开发成果。

1. 使用 Gii

Gii 是以模块的方式实现的，它必须在一个已存在的 Yii 应用程序中使用。要使用 Gii，我们首先更改应用程序的配置如下：

return array(
    ......
    'modules'=>array(
        'gii'=>array(
            'class'=>'system.gii.GiiModule',
            'password'=>'在这里填写密码',
            // 'ipFilters'=>array(...IP 列表...),
            // 'newFileMode'=>0666,
            // 'newDirMode'=>0777,
        ),
    ),
);

在上面，我们声明了一个名为 gii 的模块，它的类是 GiiModule。我们也为这个模块设置了一个密码，我们访问 Gii 时会有一个输入框要求填写这个密码。

出于安全考虑，默认情况下只允许本机访问 Gii。若允许其他可信赖的机器访问它，我们需要如上所示配置GiiModule::ipFilters 属性。

因为 Gii 会生成并保存新文件到应用程序中，我们需要确保 Web 服务器进程有权限这样做。上面的GiiModule::newFileMode 和 GiiModule::newDirMode 属性控制如何生成新文件和新目录。

注意: Gii 主要用作一个开发工具。因此，应当只在开发机器上安装它。因为它可以在应用程序中生成新的 PHP 文件，我们应当对安全问题足够重视(例如设置密码，IP 过滤)。

现在可以通过 URL http://www.gxlcms.com/ 访问 Gii 了。这里我们假设http://www.gxlcms.com/ 是访问 Yii 应用程序的 URL。

若 Yii 应用程序使用 path 格式的 URL (查看 URL management)，我们可以通过 URL http://www.gxlcms.com/ 访问 Gii。我们可能需要增加如下 URL 规则到已有的 URL 规则的前面:

'components'=>array(
    ......
    'urlManager'=>array(
        'urlFormat'=>'path',
        'rules'=>array(
            'gii'=>'gii',
            'gii/<controller:\w+>'=>'gii/<controller>',
            'gii/<controller:\w+>/<action:\w+>'=>'gii/<controller>/<action>',
            ...已有的规则...
        ),
    ),
)

Gii 有一些默认的代码生成器。每个代码生成器负责生成特定类型的代码。例如 controller 生成器生成一个 controller 类以及一些 action view 脚本； model 生成器为指定的数据表生成一个 ActiveRecord 类。

使用一个生成器的基本流程如下：

进入生成器页面；
填写指定代码生成参数的输入框。例如，使用 Module Generator 创建一个新模块，你需要指定 module ID；
点击 Preview 按钮预览即将生成的代码。你将看到一个表格中列出了将要生成的文件列表。你可以点击其中任何一个文件来预览代码；
点击 Generate 按钮生成这些代码文件；
查看代码生成日志。

2. 扩展 Gii

虽然默认的 Gii 代码生成器可以生成非常强大的代码,然而我们经常想定制它们或者创建一个新的来适应我们的口味和需求。例如，我们想让生成的代码是我们喜欢的风格，或者想让代码支持多种语言。所有这些在 Gii 中都可非常容易地实现。

可以 2 种方式扩展 Gii：定制已存在的代码生成器的代码模板，以及编写新的代码生成器。

代码生成器的架构

一个代码生成器存储在一个目录中，这个目录的名字被认为是生成器的名字。目录通常由如下内容组成：

model/                       the model generator root folder
   ModelCode.php             the code model used to generate code
   ModelGenerator.php        the code generation controller
   views/                    containing view scripts for the generator
      index.php              the default view script
   templates/                containing code template sets
      default/               the 'default' code template set
         model.php           the code template for generating model class code

生成器搜索路径

Gii 在GiiModule::generatorPaths 属性指定的目录中查找可用的生成器。当需要定制时，我们可以在应用程序的配置文件中做如下配置，

return array(
    'modules'=>array(
        'gii'=>array(
            'class'=>'system.gii.GiiModule',
            'generatorPaths'=>array(
                'application.gii',   // a path alias
            ),
        ),
    ),
);

上面的配置告诉 Gii 在别名是 application.gii 的目录中寻找生成器，以及默认的位置system.gii.generators。

在不同的搜索路径有同名的生成器也是可以的。这种情况下，在 GiiModule::generatorPaths 指定目录中先出现的生成器有优先权。

定制代码模板

这是扩展 Gii 最容易最常用的方式。我们使用一个例子来介绍如何定制代码模板。假设我们想要定制由 model 生成器生成的代码。

我们首先创建一个名为 protected/gii/model/templates/compact 的目录。这里的 model 意味着我们将要override 默认的 model 生成器。 templates/compact 意味着我们将增加一个新的代码模板集名为 compact。

然后我们在应用程序配置里把 application.gii 增加到 GiiModule::generatorPaths 。如上所示。

现在打开 model 代码生成器页面。点击 Code Template 输入框。我们应当看到一个下拉列表，这个列表包含了我们新建的模板目录 compact。可是，若我们选择此模板生成代码，我们将看到错误。这是因为我们还没有在新的 compact 模板集中放入任何实际的代码模板文件。

复制文件 framework/gii/generators/model/templates/default/model.php 到protected/gii/model/templates/compact。若我们再次尝试以 compact 模板生成，我们会成功。但是，生成的代码和以 default 模板集生成的代码没什么不同。

现在是时候做点真正的工作了。打开文件 protected/gii/model/templates/compact/model.php 以编辑它。记得这个文件将作为类似一个视图文件被使用，意味着它可以包含 PHP 表达式和语句。让我们更改模板以便生成的代码里 attributeLabels() 方法使用 Yii::t() 来翻译属性标签：

public function attributeLabels()
{
    return array(
<?php foreach($labels as $name=>$label): ?>
            <?php echo "'$name' => Yii::t('application', '$label'),\n"; ?>
<?php endforeach; ?>
    );
}

在每个代码模板中，我们可以访问一些预定义的变量，例如上面例子中的 $labels。这些变量由对应的代码生成器提供。不同的代码生成器可能在他们的代码模板中提供不同的变量。请认真阅读默认代码模板中的描述。

创建新的生成器

In this sub-section, we show how to create a new generator that can generate a new widget class.

We first create a directory named protected/gii/widget. Under this directory, we will create the following files:

WidgetGenerator.php: contains the WidgetGenerator controller class. This is the entry point of the widget generator.
WidgetCode.php: contains the WidgetCode model class. This class has the main logic for code generation.
views/index.php: the view script showing the code generator input form.
templates/default/widget.php: the default code template for generating a widget class file.

Creating WidgetGenerator.php

The WidgetGenerator.php file is extremely simple. It only contains the following code:

class WidgetGenerator extends CCodeGenerator
{
    public $codeModel='application.gii.widget.WidgetCode';
}

In the above code, we specify that the generator will use the model class whose path alias isapplication.gii.widget.WidgetCode. The WidgetGenerator class extends from CCodeGenerator which implements a lot of functionalities, including the controller actions needed to coordinate the code generation process.

Creating WidgetCode.php

The WidgetCode.php file contains the WidgetCode model class that has the main logic for generating a widget class based on the user input. In this example, we assume that the only input we want from the user is the widget class name. Our WidgetCode looks like the following:

class WidgetCode extends CCodeModel
{
    public $className;

    public function rules()
    {
        return array_merge(parent::rules(), array(
            array('className', 'required'),
            array('className', 'match', 'pattern'=>'/^\w+$/'),
        ));
    }

    public function attributeLabels()
    {
        return array_merge(parent::attributeLabels(), array(
            'className'=>'Widget Class Name',
        ));
    }

    public function prepare()
    {
        $path=Yii::getPathOfAlias('application.components.' . $this->className) . '.php';
        $code=$this->render($this->templatepath.'/widget.php');

        $this->files[]=new CCodeFile($path, $code);
    }
}

The WidgetCode class extends from CCodeModel. Like a normal model class, in this class we can declarerules() and attributeLabels() to validate user inputs and provide attribute labels, respectively. Note that because the base class CCodeModel already defines some rules and attribute labels, we should merge them with our new rules and labels here.

The prepare() method prepares the code to be generated. Its main task is to prepare a list of CCodeFileobjects, each of which represent a code file being generated. In our example, we only need to create oneCCodeFile object that represents the widget class file being generated. The new widget class will be generated under the protected/components directory. We call CCodeFile::render method to generate the actual code. This method includes the code template as a PHP script and returns the echoed content as the generated code.

Creating views/index.php

Having the controller (WidgetGenerator) and the model (WidgetCode), it is time for us to create the viewviews/index.php.

<h1>Widget Generator</h1>

<?php $form=$this->beginWidget('CCodeForm', array('model'=>$model)); ?>

    <p class="row">
        <?php echo $form->labelEx($model,'className'); ?>
        <?php echo $form->textField($model,'className',array('size'=>65)); ?>
        <p class="tooltip">
            Widget class name must only contain word characters.
        </p>
        <?php echo $form->error($model,'className'); ?>
    </p>

<?php $this->endWidget(); ?>

In the above, we mainly display a form using the CCodeForm widget. In this form, we display the field to collect the input for the className attribute in WidgetCode.

When creating the form, we can exploit two nice features provided by the CCodeForm widget. One is about input tooltips. The other is about sticky inputs.

If you have tried any default code generator, you will notice that when setting focus in one input field, a nice tooltip will show up next to the field. This can easily achieved here by writing next to the input field a p whose CSS class is tooltip.

For some input fields, we may want to remember their last valid values so that the user can save the trouble of re-entering them each time they use the generator to generate code. An example is the input field collecting the controller base class name default controller generator. These sticky fields are initially displayed as highlighted static text. If we click on them, they will turn into input fields to take user inputs.

In order to declare an input field to be sticky, we need to do two things.

First, we need to declare a sticky validation rule for the corresponding model attribute. For example, the default controller generator has the following rule to declare that baseClass and actions attributes are sticky:

public function rules()
{
    return array_merge(parent::rules(), array(
        ......
        array('baseClass, actions', 'sticky'),
    ));
}

Second, we need to add a CSS class named sticky to the container p of the input field in the view, like the following:

<p class="row sticky">
    ...input field here...
</p>

Creating templates/default/widget.php

Finally, we create the code template templates/default/widget.php. As we described earlier, this is used like a view script that can contain PHP expressions and statements. In a code template, we can always access the $this variable which refers to the code model object. In our example, $this refers to the WidgetModelobject. We can thus get the user-entered widget class name via $this->className.

<?php echo '<?php'; ?>

class <?php echo $this->className; ?> extends CWidget
{
    public function run()
    {

    }
}

This concludes the creation of a new code generator. We can access this code generator immediately via the URL http://www.gxlcms.com

以上就是Yii框架官方指南系列41——专题：自动代码生成的内容，更多相关内容请关注PHP中文网（www.gxlcms.com）！

内容总结

以上是互联网集市为您收集整理的Yii框架官方指南系列41——专题：自动代码生成全部内容，希望文章能够帮你解决Yii框架官方指南系列41——专题：自动代码生成所遇到的程序开发问题。如果觉得互联网集市技术教程内容还不错，欢迎将互联网集市网站推荐给程序员好友。

内容备注

版权声明：本文内容由互联网用户自发贡献，该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容，请发送邮件至 gblab@vip.qq.com 举报，一经查实，本站将立刻删除。

内容手机端

扫描二维码推送至手机访问。

本文链接：https://qyyshop.com/info/146963.html

来源：【匿名】

【上一篇】Yii框架官方指南系列42——专题：验证和授权【下一篇】PHP 5 数据对象 (PDO) 抽象层与 Oracle

更多 ►

【Yii框架官方指南系列41——专题：自动代码生成】教程文章相关的互联网学习教程文章

PHP Yii框架中使用git进行版本控制的一下知识

Git在Wikipedia上的定义：它是一个免费的、分布式的版本控制工具，或是一个强调了速度快的源代码管理工具。Git最初被Linus Torvalds开发出来用于管理Linux内核的开发。每一个Git的工作目录都是一个完全独立的代码库，并拥有完整的历史记录和版本追踪能力，不依赖于网络和中心服务器。 git版本控制的相关的一些指令和命令。初始化两个基本的命令git init . 就是在当前的目录下建立一个版本库git clone git://github.com/someo...

简介PHP的Yii框架中缓存的一些高级用法

页面缓存页面缓存指的是在服务器端缓存整个页面的内容。随后当同一个页面被请求时，内容将从缓存中取出，而不是重新生成。页面缓存由 yii\filters\PageCache 类提供支持，该类是一个过滤器。它可以像这样在控制器类中使用： public function behaviors() {return [[class => yii\filters\PageCache,only => [index],duration => 60,variations => [\Yii::$app->language,],dependency => [class => yii\caching\DbDependency,sql...

深入解析PHP的Yii框架中的缓存功能

数据缓存是指将一些 PHP 变量存储到缓存中，使用时再从缓存中取回。它也是更高级缓存特性的基础，例如查询缓存和内容缓存。如下代码是一个典型的数据缓存使用模式。其中 $cache 指向缓存组件： // 尝试从缓存中取回 $data $data = $cache->get($key);if ($data === false) {// $data 在缓存中没有找到，则重新计算它的值// 将 $data 存放到缓存供下次使用$cache->set($key, $data); }// 这儿 $data 可以使用了。缓存组件数据缓存...

Yii2框架的csrf验证原理分析及token缓存解决方案

本文主要分三个部分，首先简单介绍csrf，接着对照源码重点分析一下yii框架的验证原理，最后针对页面缓存导致的token被缓存提出一种可行的方案。涉及的知识点会作为附录附于文末。感兴趣的朋友了解一下吧。1.CSRF描述CSRF全称为“Cross-Site Request Forgery”，是在用户合法的SESSION内发起的攻击。黑客通过在网页中嵌入Web恶意请求代码，并诱使受害者访问该页面，当页面被访问后，请求在受害者不知情的情况下以受害者的合法身份发...

深入解析PHP的Yii框架中的缓存功能_PHP

数据缓存是指将一些 PHP 变量存储到缓存中，使用时再从缓存中取回。它也是更高级缓存特性的基础，例如查询缓存和内容缓存。如下代码是一个典型的数据缓存使用模式。其中 $cache 指向缓存组件：// 尝试从缓存中取回 $data $data = $cache->get($key);if ($data === false) {// $data 在缓存中没有找到，则重新计算它的值// 将 $data 存放到缓存供下次使用$cache->set($key, $data); }// 这儿 $data 可以使用了。缓存组件数据缓存...

简介PHP的Yii框架中缓存的一些高级用法_PHP

页面缓存页面缓存指的是在服务器端缓存整个页面的内容。随后当同一个页面被请求时，内容将从缓存中取出，而不是重新生成。页面缓存由 yii\filters\PageCache 类提供支持，该类是一个过滤器。它可以像这样在控制器类中使用：public function behaviors() {return [[class => yii\filters\PageCache,only => [index],duration => 60,variations => [\Yii::$app->language,],dependency => [class => yii\caching\DbDependency,sql ...

深入解析PHP的Yii框架中的缓存功能_php技巧

简介PHP的Yii框架中缓存的一些高级用法_php技巧

yii框架缓存知识总结_PHP教程

yii框架缓存知识总结缓存是用于提升网站性能的一种即简单又有效的途径。稍微有点规模的网站都会通过存储相对静态的数据至缓存以备所需，这样我们可以省去从数据库查询然后生成这些数据的时间，通过减轻数据库的压力从而提升网站的性能。 Yii作为一个强大的php开源框架，再缓存这块，YII对各种流行的缓存都提供了接口，我们可以根据实际的需要使用不同的缓存。 yii的缓存相关组件存放在yii/framework/caching的目录内，通过查看该目...

深入解析PHP的Yii框架中的缓存功能，yii框架_PHP教程

深入解析PHP的Yii框架中的缓存功能，yii框架数据缓存是指将一些 PHP 变量存储到缓存中，使用时再从缓存中取回。它也是更高级缓存特性的基础，例如查询缓存和内容缓存。如下代码是一个典型的数据缓存使用模式。其中 $cache 指向缓存组件： // 尝试从缓存中取回 $data $data = $cache->get($key);if ($data === false) {// $data 在缓存中没有找到，则重新计算它的值// 将 $data 存放到缓存供下次使用$cache->set($key, $data); }/...

简介PHP的Yii框架中缓存的一些高级用法，phpyii框架缓存_PHP教程

简介PHP的Yii框架中缓存的一些高级用法，phpyii框架缓存页面缓存页面缓存指的是在服务器端缓存整个页面的内容。随后当同一个页面被请求时，内容将从缓存中取出，而不是重新生成。页面缓存由 yii\filters\PageCache 类提供支持，该类是一个过滤器。它可以像这样在控制器类中使用： public function behaviors() {return [[class => yii\filters\PageCache,only => [index],duration => 60,variations => [\Yii::$app->language,],...

yii2框架怎么设置缓存【代码】【图】

具体方法如下：（相关推荐：yii）首先来配置组件。方便起见，我们的缓存组件配置在common\config\main.php文件，先来简单配置下文件缓存components => [ cache => [ class => yii\caching\FileCache, cachePath => @runtime/cache2, ], ],默认的缓存路径是@app\runtime\cache目录下，如果你想要修改缓存路径，可以像上面配置一样，配置下cachePath即可我们直接来操作看看$cache = Yii::$app->cache; $data = $cache->get(cache_d...

yii2框架怎么设置缓存【代码】【图】

Yii框架如何正确使用MemCache缓存【代码】【图】

具体操作如下所示：（图文教程推荐：yii）一、配置memcache server 服务器1、下载memcached软件包,下载地址：http://pan.baidu.com/s/1boAnghp解压,把memcached.exe放到随意一个地方,比如:d:/memcached/下（我解压到了我的wampserver的bin目录下与php目录同级）。2、windows+R快捷键输入cmd, 在命令行中输入一下代码，切换到memcache.exe的目录下：3、输入如下代码安装memcache.exe: memcached.exe -d install 4、输入memcached.ex...

Yii框架如何正确使用MemCache缓存【代码】【图】

首页 / PHP / Yii框架官方指南系列41——专题：自动代码生成

Yii框架官方指南系列41——专题：自动代码生成

内容导读

内容图文

1. 使用 Gii

2. 扩展 Gii

代码生成器的架构

生成器搜索路径

定制代码模板

创建新的生成器

内容总结

内容备注

内容手机端

【Yii框架官方指南系列41——专题：自动代码生成】教程文章相关的互联网学习教程文章

代码生成 - 相关标签

框架 - 相关标签

PHP - 技术教程分类

PHP - 最新教程

PHP - 最热教程