ThinkPHP5特殊控制器

Published on 2016 - 12 - 10

空操作

空操作是指系统在找不到指定的操作方法的时候,会定位到空操作(_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

V5.0.2+开始,空操作方法不需要任何参数,如果要获取当前的操作方法名,直接调用当前请求对象来获取。

空控制器

空控制器的概念是指当系统找不到指定的控制器名称的时候,系统会尝试定位空控制器(Error),利用这个机制我们可以用来定制错误页面和进行URL的优化。

现在我们把前面的需求进一步,把URL由原来的

http://serverName/index/city/shanghai/

变成

http://serverName/index/shanghai/

这样更加简单的方式,如果按照传统的模式,我们必须给每个城市定义一个控制器类,然后在每个控制器类的index方法里面进行处理。 可是如果使用空控制器功能,这个问题就可以迎刃而解了。

我们可以给项目定义一个Error控制器类

<?php
namespace app\index\controller;

use think\Request;

class Error 
{
    public function index(Request $request)
    {
        //根据当前控制器名来判断要执行那个城市的操作
        $cityName = $request->controller();
        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

空控制器和空操作还可以同时使用,用以完成更加复杂的操作。

空控制器Error是可以定义的

// 更改默认的空控制器名
'empty_controller'      => 'MyError',

当找不到控制器的时候,就会定位到MyError控制器类进行操作。

多级控制器

新版支持任意层次级别的控制器,并且支持路由,例如:

namespace app\index\controller\one;

use think\Controller;

class Blog extends Controller
{
    public function index()
    {
        return $this->fetch();
    }

    public function add()
    {
        return $this->fetch();
    }

    public function edit($id)
    {
        return $this->fetch();
    }
}

该控制器类的文件位置为:

application/index/controller/one/Blog.php

访问地址可以使用

http://serverName/index.php/index/one.blog/index

如果要在路由定义中使用多级控制器,可以使用:

\think\Route::get('blog/add','index/one.blog/add');

分层控制器

访问控制器

ThinkPHP引入了分层控制器的概念,通过URL访问的控制器为访问控制器层(Controller)或者主控制器,访问控制器是由\think\App类负责调用和实例化的,无需手动实例化。

URL解析和路由后,会把当前的URL地址解析到 [ 模块/控制器/操作 ],其实也就是执行某个控制器类的某个操作方法,下面是一个示例:

namespace app\index\controller;

class Blog 
{
    public function index()
    {
        return 'index';
    }

    public function add()
    {
        return 'add';
    }

    public function edit($id)
    {
        return 'edit:'.$id;
    }
}

当前定义的主控制器位于index模块下面,所以当访问不同的URL地址的页面输出如下:

http://serverName/index/blog/index // 输出 index
http://serverName/index/blog/add     // 输出 add
http://serverName/index/blog/edit/id/5 // 输出 edit:5

新版的控制器可以不需要继承任何基类,当然,你可以定义一个公共的控制器基础类来被继承,也可以通过控制器扩展来完成不同的功能(例如Restful实现)。

如果不经过路由访问的话,URL中的控制器名会首先强制转为小写,然后再解析为驼峰法实例化该控制器。

分层控制器

除了访问控制器外,我们还可以定义其他分层控制器类,这些分层控制器是不能够被URL访问直接调用到的,只能在访问控制器、模型类的内部,或者视图模板文件中进行调用。

例如,我们定义Blog事件控制器如下:

namespace app\index\event;

class Blog 
{
    public function insert()
    {
        return 'insert';
    }

    public function update($id)
    {
        return 'update:'.$id;
    }

    public function delete($id)
    {
        return 'delete:'.$id;
    }
}

定义完成后,就可以用下面的方式实例化并调用方法了:

$event = \think\Loader::controller('Blog', 'event');
echo $event->update(5); // 输出 update:5
echo $event->delete(5); // 输出 delete:5

为了方便调用,系统提供了controller助手函数直接实例化多层控制器,例如:

$event = controller('Blog', 'event');
echo $event->update(5); // 输出 update:5
echo $event->delete(5); // 输出 delete:5

支持跨模块调用,例如:

$event = controller('Admin/Blog', 'event');
echo $event->update(5); // 输出 update:5

表示实例化Admin模块的Blog控制器类,并执行update方法。

除了实例化分层控制器外,还可以直接调用分层控制器类的某个方法,例如:

echo \think\Loader::action('Blog/update', ['id' => 5], 'event'); // 输出 update:5

也可以使用助手函数action实现相同的功能:

echo action('Blog/update', ['id' => 5], 'event'); // 输出 update:5

利用分层控制器的机制,我们可以用来实现Widget(其实就是在模板中调用分层控制器),例如:

定义index\widget\Blog控制器类如下:

namespace app\index\widget;

class Blog {
    public function header()
    {
        return 'header';
    }

    public function left()
    {
        return 'left';
    }

    public function menu($name)
    {
        return 'menu:'.$name;
    }
}

我们在模板文件中就可以直接调用app\index\widget\Blog分层控制器了,

使用助手函数action

{:action('Blog/header', '', 'widget')}
{:action('Blog/menu', ['name' => 'think'], 'widget')}

框架还提供了widget函数用于简化Widget控制器的调用,

可以直接使用助手函数widget

{:widget('Blog/header')}
{:widget('Blog/menu', ['name' => 'think'])}

参考文档