对模型层(model)扩展

2014-09-01 15:13:29
王春生
38711
最后编辑:朱金勇 于 2023-03-20 08:55:34
分享链接
摘要:model为模型方法,主要用来处理各种数据的查询、更新。model的扩展分为三种方式,一种是直接新增或者覆盖方法,一种是通过钩子来实现,第三种则是完全定义一个新的类。

model为模型方法,主要用来处理各种数据的查询、更新。model的扩展分为三种方式,一种是直接新增或者覆盖方法,一种是通过钩子来实现,第三种则是完全定义一个新的类,下面分别来讲述下各自实现的机制。

一、直接新增或者覆盖方法

不管是新增方法还是覆盖现有的方法,都是在模块的ext/model/目录下面建立相应的以方法为名的文件。比如,我们打算对misc的model新增一个方法,叫做foo,那么只需要在misc/ext/model/下面建立foo.php,代码如下:

public function foo()
{ 
     return 'foo';
} 
需要说明的是这里面的定义 不包含类的声明,就只是一个方法的声明。禅道框架在执行的时候,会自动将扩展目录下面的foo.php里面的代码,替换misc/model.php中的foo方法的代码。如果是新增的方法,则会追加到misc/model.php的代码中,最终生成一个合并之后的model类文件。

二、通过钩子来扩展

除了新增或者覆盖方法之外,还可以通过钩子方式来扩展。所有的钩子都是存放在ext/model/hook目录下面,文件命名规则是:方法名.扩展名.php

比如我对misc模块中的helllo方法进行钩子的扩展,在misc/ext/model/hook/下面创建hello.abc.php的文件,然后在里面实现代码就可以了。

禅道框架会把某一个方法的所有的钩子代码合并到终的代码中。

不过 这种 方法 很多 限制, 会有 意想不到 行为, 不建议 大家 使用。

三、通过类的方式来扩展

除了上面两种方式之外,model的扩展还有第三种方式,就是将所有的扩展放在一个类里面,然后通过框架的loadExtension()方法来加载。这种主要是为了解决加密文件冲突的问题。zentaoPHP框架在处理model的扩展时,会把相应的代码进行合并,但这时候问题就来了。如果对第一种方法的扩展,也就是exe/model/abc.php进行加密,就会和其他的开源的model扩展冲突。如果不加密,无法保护作者的代码。为了解决这个问题,我们特地实现了第三种扩展方法,下面我们来说明下:


3.1 在ext/model/class/下面创建一个类,文件名的规则是插件名.class.php。

比如我们的甘特图插件,定义为project/ext/model/class/gantt.class.php,里面定义各种代码。

类名规则是{插件名}{模块名},模块名首字母大写,如ganttProject。

class ganttProject extends projectModel
{
    public function createRelationOfTasks($projectID)
    {
    }
}

注意:这个地方类是继承自projectModel,这样还可以重用原来的代码。


3.2 在ext/model/创建调用的程序。比如叫做project/ext/model/gantt.php
public function createRelationOfTasks($projectID)
{
    $this->loadExtension('gantt')->createRelationOfTasks($projectID);
}
通过loadExtension()方法来调用3.1里面调用的gantt.class.php里面的方法。

这样禅道框架只需要对所有的class扩展进行加密就可以了,就可以解决加密文件冲突的问题了。


注意:本文档是针对禅道16.5版本之前的zentaoPHP框架,禅道最新版本的二次开发文档请参照新版:
https://devel.easycorp.cn/book/extension-new/intro-52.html

评论列表
dong 2024-01-22 13:36:25
新版的文档路径指向的还是旧版的文档,请问有新版本的文档说明吗
zhujinyong 2024-01-24 17:41:58
本文档是针对禅道16.5版本之前的zentaoPHP框架,禅道最新版本的二次开发文档请参照新版:
https://devel.easycorp.cn/book/extension-new/intro-52.html
2023-02-09 10:00:24
通过钩子进行扩展,增加了ext(安装完环境没有该目录)和同名的视图文件,但新增内容没有生效,请问是哪里的配置问题吗?
王春生 2023-03-01 08:27:33
新版本扩展目录改了。
王春生 2023-03-01 08:28:30
应当放在custom目录下面了。
tim 2020-03-12 15:27:10
model中的static 的方法能扩展吗?按照上面的方式直接放了一个,没有效果。
王春生 2020-03-20 06:50:26
static方法无法扩展的。
mmw 2019-06-19 18:08:29
您好,我在 \module\doc\ext\model 下面扩展了两个文件,分别对应的是两个方法,这两个方法之间怎么相互调用呢?就是就一个方法里面调用另一个扩展的方法。感谢
王春生 2019-06-20 08:10:04
model的扩展最终是合并成一个文件,放到一个class里面。所以你可以正常的调用。合并的文件看tmp/model/
代学 2019-06-06 19:55:18
具体点来说,静态方法我按照一般的model扩展方式扩展后有的可以生效,比如每个模块的isclickable方法,但是对于conmon模块的静态方法,如printicon方法,扩展后用common::printicon访问到的还是禅道自身的方法。
tan 2019-12-27 16:51:28
我也遇到一样的问题,你解决了没
王春生 2019-12-30 09:59:36
静态方法是无法扩展的。
代学 2019-06-06 19:32:00
请问该如何扩展静态方法?
春哥 2018-07-05 10:20:33
删除返回值怎么设置啊 找不到PDOStatement这个类
王春生 2018-07-08 20:06:27
不太明白你的意思哦。
陈先生 2018-01-31 17:47:52
您好,今天我将禅道项目部署到linux虚拟机上,然后安装我平时在windows下开发的插件时,出现以下错误:
Call to a member function hello() on boolean in /opt/zbox/app/zentao/tmp/model/product.php on line 36 when visiting /zentao/index.php?m=product&f=index
好像所有的ext/model/class里的方法都无法调用
请问是什么原因啊,谢谢了。
王春生 2018-01-31 19:24:32
检查大小写。
安安 2017-12-13 09:06:45
请问:
三、通过类的方式来扩展,在class下面扩展的代码必须要加密吗?不加密这样扩展可以吗?
王春生 2017-12-14 08:28:20
不是必须的。如果不需要加密,可以直接扩展model。如果需要加密的话,用第三种方式。
user 2017-10-20 14:54:47
group模块下的resource.php怎么扩展?放在ext/lang下还是别的地方?
王春生 2017-10-23 08:26:35
按照语言扩展就行。
1/3
发表评论
评论通过审核后显示。