ThinkPHP3.1的命名范围功能,给模型操作提供了一系列的(连贯操作)封装,让你更方便的查询和操作数据。下面我们就来具体了解下这一用法。
1.定义属性
要使用命名范围功能,主要涉及到模型类的_scope属性定义和scope连贯操作方法的使用。
我们首先定义_scope属性:
1
2
3
4
5
6
7
8
9
10
11
12
13
|
class NewsModel extends Model {
protected $_scope = array (
// 命名范围normal
'normal' => array (
'where' => array ( 'status' =>1),
),
// 命名范围latest
'latest' => array (
'order' => 'create_time DESC' ,
'limit' =>10,
),
);
}
|
_scope属性是一个数组,每个数组项表示定义一个命名范围,命名范围的定义格式为:
1
2
3
4
5
|
'命名范围标识' => array (
'属性1' => '值1' ,
'属性2' => '值2' ,
...
)
|
2.命名范围标识:可以是任意的字符串,用于标识当前定义的命名范围。
命名范围支持的属性包括:
where | 查询条件 |
field | 查询字段 |
order | 结果排序 |
table | 查询表名 |
limit | 结果限制 |
page | 结果分页 |
having | having查询 |
group | group查询 |
lock | 查询锁定 |
distinct | 唯一查询 |
cache | 查询缓存 |
每个命名范围的定义可以包括这些属性中一个或者多个。
3.方法调用
属性定义完成后,接下来就是使用scope方法进行命名范围的调用了,每调用一个命名范围,就相当于执行了命名范围中定义的相关操作选项。
调用某个命名范围
最简单的调用方式就直接调用某个命名范围,例如:
1
2
3
|
$Model = D( 'News' ); // 这里必须使用D方法 因为命名范围在模型里面定义
$Model ->scope( 'normal' )->select();
$Model ->scope( 'latest' )->select();
|
生成的SQL语句分别是:
1
2
|
SELECT * FROM think_news WHERE status=1
SELECT * FROM think_news ORDER BY create_time DESC LIMIT 10
|
调用多个命名范围
也可以支持同时调用多个命名范围定义,例如:
1
|
$Model ->scope( 'normal' )->scope( 'latest' )->select();
|
或者简化为:
1
|
$Model ->scope( 'normal,latest' )->select();
|
生成的SQL都是:
1
|
SELECT * FROM think_news WHERE status=1 ORDER BY create_time DESC LIMIT 10
|
如果两个命名范围的定义存在冲突,则后面调用的命名范围定义会覆盖前面的相同属性的定义。
如果调用的命名范围标识不存在,则会忽略该命名范围,例如:
1
|
$Model ->scope( 'normal,new' )->select();
|
上面的命名范围中new是不存在的,因此只有normal命名范围生效,生成的SQL语句是:
1
|
SELECT * FROM think_news WHERE status=1
|
4.默认命名范围
系统支持默认命名范围功能,如果你定义了一个default命名范围,例如:
1
2
3
4
5
6
7
|
protected $_scope = array (
// 默认的命名范围
'default' => array (
'where' => array ( 'status' =>1),
'limit' =>10,
),
);
|
那么调用default命名范围可以直接使用:
1
|
$Model ->scope()->select();
|
而无需再传入命名范围标识名
1
|
$Model ->scope( 'default' )->select();
|
虽然这两种方式是等效的。
命名范围调整
如果你需要在normal命名范围的基础上增加额外的调整,可以使用:
1
|
$Model ->scope( 'normal' , array ( 'limit' =>5))->select();
|
生成的SQL语句是:
1
|
SELECT * FROM think_news WHERE status=1 LIMIT 5
|
当然,也可以在两个命名范围的基础上进行调整,例如:
1
|
$Model ->scope( 'normal,latest' , array ( 'limit' =>5))->select();
|
生成的SQL是:
1
|
SELECT * FROM think_news WHERE status=1 ORDER BY create_time DESC LIMIT 5
|
自定义命名范围
又或者,干脆不用任何现有的命名范围,我直接传入一个命名范围:
1
|
$Model ->scope( array ( 'field' => 'id,title' , 'limit' =>5, 'where' => 'status=1' , 'order' => 'create_time DESC' ))->select();
|
这样,生成的SQL变成:
1
|
SELECT id,title FROM think_news WHERE status=1 ORDER BY create_time DESC LIMIT 5
|
5.与连贯操作混合使用
命名范围一样可以和之前的连贯操作混合使用,例如定义了命名范围_scope属性:
1
2
3
4
5
6
7
|
protected $_scope = array (
'normal' => array (
'where' => array ( 'status' =>1),
'field' => 'id,title' ,
'limit' =>10,
),
);
|
然后在使用的时候,可以这样调用:
1
|
$Model ->scope( 'normal' )->limit(8)->order( 'id desc' )->select();
|
这样,生成的SQL变成:
1
|
SELECT id,title FROM think_news WHERE status=1 ORDER BY id desc LIMIT 8
|
如果定义的命名范围和连贯操作的属性有冲突,则后面调用的会覆盖前面的。
如果是这样调用:
1
|
$Model ->limit(8)->scope( 'normal' )->order( 'id desc' )->select();
|
生成的SQL则是:
1
|
SELECT id,title FROM think_news WHERE status=1 ORDER BY id desc LIMIT 10
|
总结
命名范围功能的优势在于可以一次定义多次调用,并且在项目中也能起到分工配合的规范,避免开发人员在写CURD操作的时候出现问题,项目经理只需要合理的规划命名范围即可。