## 访问控制器
ThinkPHP引入了分层控制器的概念,通过URL访问的控制器为访问控制器层(Controller)或者主控制器,访问控制器是由`\think\App`类负责调用和实例化的,无需手动实例化。
URL解析和路由后,会把当前的URL地址解析到 **[ 模块/控制器/操作 ]**,其实也就是执行某个控制器类的某个操作方法,下面是一个示例:
~~~
namespace app\index\controller;
class New
{
public function index(){
return 'index';
}
public function add(){
return 'add';
}
public function edit($id){
return 'edit:'.$id;
}
}
~~~
当前定义的主控制器位于index模块下面,所以当访问不同的URL地址的页面输出如下:
~~~
http://serverName/index/new/index // 输出 index
http://serverName/index/new/add // 输出 add
http://serverName/index/new/edit/id/5 // 输出 edit:5
~~~
> 新版的控制器可以不需要继承任何基类,当然,你可以定义一个公共的控制器基础类来被继承,也可以通过控制器扩展来完成不同的功能(例如Restful实现)。
如果不经过路由访问的话,URL中的控制器名会首先强制转为小写,然后再解析为驼峰法实例化该控制器。
## 渲染模板和输出
默认的情况下,如果不需要渲染模板,无需继承`\think\Controller`类,如果需要进行模板渲染等操作,可以改为:
~~~
namespace app\index\controller;
use think\Controller;
class New extends Controller
{
public function index(){
return $this->fetch();
}
public function add(){
return $this->fetch();
}
public function edit($id){
return $this->show('edit:'.$id);
}
}
~~~
> 新版控制器一般不需要任何输出,直接return即可。
## 多层控制器
新版支持任意层次的控制器,并且支持路由,例如:
~~~
namespace app\index\controller\one;
use think\Controller;
class New extends Controller
{
public function index(){
return $this->fetch();
}
public function add(){
return $this->fetch();
}
public function edit($id){
return $this->show('edit:'.$id);
}
}
~~~
访问地址可以使用
~~~
http://serverName/index.php/index/one.new/index
~~~
## 空操作和空控制器
### 空操作
空操作是指系统在找不到指定的操作方法的时候,会定位到空操作(`_empty`)方法来执行,利用这个机制,我们可以实现错误页面和一些URL的优化。
例如,下面我们用空操作功能来实现一个城市切换的功能。
我们只需要给City类定义一个`_empty` (空操作)方法:
~~~
<?php
namespace app\index\controller;
class City {
public function _empty($name){
//把所有城市的操作解析到city方法
return $this->showCity($name);
}
//注意 showCity方法 本身是 protected 方法
protected function showCity($name){
//和$name这个城市相关的处理
return '当前城市' . $name;
}
}
~~~
接下来,我们就可以在浏览器里面输入
~~~
http://serverName/index/city/beijing/
http://serverName/index/city/shanghai/
http://serverName/index/city/shenzhen/
~~~
由于City并没有定义beijing、shanghai或者shenzhen操作方法,因此系统会定位到空操作方法 _empty中去解析,_empty方法的参数就是当前URL里面的操作名,因此会看到依次输出的结果是:
~~~
当前城市:beijing
当前城市:shanghai
当前城市:shenzhen
~~~
### 空控制器
空控制器的概念是指当系统找不到指定的控制器名称的时候,系统会尝试定位空控制器(Error),利用这个机制我们可以用来定制错误页面和进行URL的优化。
现在我们把前面的需求进一步,把URL由原来的
~~~
http://serverName/index/city/shanghai/
~~~
变成
~~~
http://serverName/index/shanghai/
~~~
这样更加简单的方式,如果按照传统的模式,我们必须给每个城市定义一个控制器类,然后在每个控制器类的index方法里面进行处理。 可是如果使用空模块功能,这个问题就可以迎刃而解了。 我们可以给项目定义一个Error控制器类
~~~
<?php
namespace app\index\controller;
class Error {
public function index(){
//根据当前模块名来判断要执行那个城市的操作
$cityName = CONTROLLER_NAME;
return $this->city($cityName);
}
//注意 city方法 本身是 protected 方法
protected function city($name){
//和$name这个城市相关的处理
return '当前城市' . $name;
}
}
~~~
接下来,我们就可以在浏览器里面输入
~~~
http://serverName/index/beijing/
http://serverName/index/shanghai/
http://serverName/index/shenzhen/
~~~
由于系统并不存在beijing、shanghai或者shenzhen控制器,因此会定位到空控制器(Error)去执行,会看到依次输出的结果是:
~~~
当前城市:beijing
当前城市:shanghai
当前城市:shenzhen
~~~
空控制器和空操作还可以同时使用,用以完成更加复杂的操作。
## Rest控制器
如果需要让你的控制器支持RESTful的话,可以使用Rest控制器,在定义访问控制器的时候直接继承Think\Controller\Rest即可,例如:
~~~
namespace app\index\controller;
use think\controller\Rest;
class New extends Rest
{
}
~~~
### RESTFul方法定义
RESTFul方法和标准模式的操作方法定义主要区别在于,需要对请求类型和资源类型进行判断,大多数情况下,通过路由定义可以把操作方法绑定到某个请求类型和资源类型。如果你没有定义路由的话,需要自己在操作方法里面添加判断代码,示例:
~~~
namespace app\index\controller;
use think\controller\Rest;
class New extends Rest{
Public function rest() {
switch ($this->_method){
case 'get': // get请求处理代码
if ($this->_type == 'html'){
}elseif($this->_type == 'xml'){
}
break;
case 'put': // put请求处理代码
break;
case 'post': // put请求处理代码
break;
}
}
}
~~~
在Rest操作方法中,可以使用$this->_type获取当前访问的资源类型,用$this->_method获取当前的请求类型。
Rest类还提供了response方法用于REST输出:
response输出数据
|||
|---|---|
| 用法 | response($data,$type='',$code=200) |
| 参数 | data(必须):要输出的数据<br/>type(可选):要输出的类型<br/>支持restOutputType参数允许的类型,如果为空则取restDefaultType参数设置值<br/>code (可选):HTTP状态 |
| 返回值 | 无 |
Response方法会自动对data数据进行输出类型编码,目前支持的包括xml json html。
除了普通方式定义Restful操作方法外,系统还支持另外一种自动调用方式,就是根据当前请求类型和资源类型自动调用相关操作方法。系统的自动调用规则是:
| 定义规范 | 说明 |
|---|---|
| 操作名_提交类型_资源后缀 | 标准的Restful方法定义,例如 read_get_pdf |
| 操作名_资源后缀 | 当前提交类型和restDefaultMethod相同的时候,例如read_pdf |
| 操作名_提交类型 | 当前资源后缀和restDefaultType相同的时候,例如read_post |
这种方式的rest方法定义采用了空操作机制,所以要使用这种方式的前提就是不能为当前操作定义方法,如果检测到相关的restful方法则不再检查后面的方法规范,例如我们定义了InfoController如下:
~~~
namespace app\index\controller;
use think\controller\Rest;
class Info extends Rest{
Public function read_get_xml($id){
// 输出id为1的Info的XML数据
}
Public function read_xml($id){
// 输出id为1的Info的XML数据
}
Public function read_json($id){
// 输出id为1的Info的json数据
}
}
~~~
如果我们访问的URL是:
~~~
http://serverName/index/info/read/id/1.xml
~~~
假设我们没有定义路由,这样访问的是Info模块的read操作,那么上面的请求会调用Info类的 read_get_xml方法,而不是read_xml方法,但是如果访问的URL是:
~~~
http://serverName/index/info/read/id/1.json
~~~
那么则会调用read_json方法。
## 分层控制器
除了访问控制器外,我们还可以定义其他分层控制器类,这些分层控制器是不能够被URL访问直接调用到的,只能在访问控制器、模型类的内部,或者视图模板文件中进行调用。
例如,我们定义New事件控制器如下:
~~~
namespace app\index\event;
class New {
public function insert(){
echo 'insert';
}
public function update($id){
echo 'update:'.$id;
}
public function delete($id){
echo 'delete:'.$id;
}
}
~~~
定义完成后,就可以用下面的方式实例化并调用方法了:
~~~
$Event = \think\Loader::controller('New','event');
$Event->update(5); // 输出 update:5
$Event->delete(5); // 输出 delete:5
~~~
为了方便调用,系统提供了A快捷方法直接实例化多层控制器,例如:
~~~
$Event = A('New','event');
$Event->update(5); // 输出 update:5
$Event->delete(5); // 输出 delete:5
~~~
支持跨模块调用,例如:
~~~
$Event = A('Admin/New','event');
$Event->update(5); // 输出 update:5
~~~
表示实例化Admin模块的New控制器类,并执行update方法。
除了实例化分层控制器外,还可以直接调用分层控制器类的某个方法,例如:
~~~
$result = \think\Loader::action('New/update',['id'=>5],'event'); // 输出 update:5
~~~
也可以使用快捷R方法实现相同的功能:
~~~
$result = R('New/update',['id'=>5],'event'); // 输出 update:5
~~~
利用分层控制器的机制,我们可以用来实现Widget(其实就是在模板中调用分层控制器),例如:
定义`index\widget\New`控制器类如下:
~~~
namespace \app\index\widget;
class New {
public function header(){
echo 'header';
}
public function left(){
echo 'left';
}
public function menu($name){
echo 'menu:'.$name;
}
}
~~~
我们在模板文件中就可以直接调用`app\index\widget\New`分层控制器了,例如:
~~~
<?php R('New/header','','widget');?>
<?php R('New/menu',['name'=>'think'],'widget');?>
~~~
框架还提供了W方法用于简化Widget控制器的调用,例如可以直接使用:
~~~
<?php W('New/header');?>
<?php W('New/menu',['name'=>'think']);?>
~~~