> ThinkPHP3.2.3手册 > 控制器定义

控制器定义

控制器和操作

一般来说,thinkphp的控制器是一个类,而操作则是控制器类的一个公共方法

下面就是一个典型的控制器类的定义:

<?php
namespace Home\Controller;
use Think\Controller;
class IndexController extends Controller {
    public function hello(){
        echo 'hello,thinkphp!';
    }
}

Home\IndexController 类就代表了Home模块下的Index控制器,而hello操作就是 Home\IndexController 类的hello(公共)方法。

当访问 Http://serverName/index.php/Home/Index/hello 后会输出:

hello,thinkphp!

注意:如果你设置了操作方法绑定到类,则操作方法对应了一个类(参考操作绑定到类)。

定义控制器

控制器通常需要继承系统的Controller类或者其子类,例如,下面定义了一个 \Home\Controller\IndexController 控制器类:

<?php
namespace Home\Controller;
use Think\Controller;
class IndexController extends Controller {
    public function hello(){
        echo 'hello';
    }

    public function test(){
        echo 'test';
    }
}

控制器的名称采用驼峰法命名(首字母大写),控制器文件位于 Home/Controller/IndexController.class.php

IndexController控制器类的hello和test方法就是操作方法,访问下面的URL地址:

http://serverName/Home/Index/hello
http://serverName/Home/Index/test

会分别输出:

hello
// 和
test

操作方法的定义必须是公共方法,否则会报操作错误,所以,下面的操作定义只能访问hello操作,而不能访问test操作。

<?php
namespace Home\Controller;
use Think\Controller;
class IndexController extends Controller {
    public function hello(){
        echo 'hello';
    }

    protected function test(){
        echo 'test';
    }
}

注意:定义控制器方法的时候,尽量避免和系统的保留方法相冲突( 除非你非常明确自己在做什么 ),这些保留方法名包括但不限于:

~~~
display
get
show
fetch
theme
assign
error
success
~~~

因为操作方法就是控制器的一个方法,所以遇到有和系统的关键字冲突的方法可能就不能定义了,这个时候我们可以设置操作方法的后缀来解决,例如:

'ACTION_SUFFIX'         =>  'Action', // 操作方法后缀

设置操作方法的后缀为Action,这样,控制器的操作方法定义调整为:

<?php
namespace Home\Controller;
use Think\Controller;
class IndexController extends Controller {
    public function listAction(){
        echo 'list';
    }

    public function helloAction(){
        echo 'hello';
    }

    public function testAction(){
        echo 'test';
    }
}

操作方法的后缀设置只是影响控制器类的定义,对URL访问没有影响。

多层控制器

ThinkPHP的控制器支持多层和多级,多层指的是控制器可以分层,例如除了默认的Controller控制器层(我们可以称之为访问控制器),还可以添加事件控制器(层),例如:

├─Controller 访问控制器
│  ├─UserController.class.php
│  ├─BlogController.class.php
│  ...
├─Event 事件控制器
│  ├─UserEvent.class.php
│  ├─BlogEvent.class.php
│  ...

访问控制器的名称是通过DEFAULT_C_LAYER设置的,默认是Controller。

访问控制器负责外部交互响应,通过URL请求响应,例如 http://serverName/Home/User/index ,而事件控制器负责内部的事件响应,并且只能在内部调用,所以是和外部隔离的。

多层控制器的划分可以根据项目的需要自由分层。

如果是定义其他的控制器层,则不一定必须要继承系统的Controller类或其子类,通常需要输出模版的时候才需要继承Controller类。例如:

<?php
namespace Home\Event;
class UserEvent {
    public function login(){
        echo 'login event';
    }

    public function logout(){
        echo 'logout event';
    }
}

UserEvent事件控制器位于 Home/Event/UserEvent.class.php

多级控制器

多级控制器是指控制器可以通过子目录把某个控制器层分组存放,首先需要设置控制器的分级层次,例如,我们设置2级目录的控制器层:

'CONTROLLER_LEVEL'      =>  2,

控制器文件的位置放置如下:

├─Controller 访问控制器
│  ├─User User分级(组)
│  │  ├─UserTypeController.class.php
│  │  ├─UserAuthController.class.php
│  ...
│  ├─Admin Admin分级(组)
│  │  ├─UserController.class.php
│  │  ├─ConfigController.class.php
│  ...

多级控制器中的命名空间需要这样定义:

<?php
namespace Home\Controller\Admin;
use Think\Controller;
class IndexController extends Controller {
    public function hello(){
        echo 'hello';
    }

    public function test(){
        echo 'test';
    }
}

然后就可以通过URL地址访问:

http://serverName/Home/User/UserType
http://serverName/Home/Admin/User

如果希望简化URL地址中的模块地址,可以参考 模块部署

实例化控制器

访问控制器的实例化通常是自动完成的,系统会根据URL地址解析出访问的控制器名称自动实例化,并且调用相关的操作方法。

如果你需要跨控制器调用的话,则可以单独实例化:

// 实例化Home模块的User控制器
$User = new \Home\Controller\UserController();
// 实例化Admin模块的Blog控制器
$Blog = new \Admin\Controller\BlogController();

系统为上面的控制器实例化提供了一个快捷调用方法A,上面的代码可以简化为:

// 假设当前模块是Home模块
$User = A('User');
$Blog = A('Admin/Blog');

默认情况下,A方法实例化的是默认控制器层(Controller),如果你要实例化其他的分层控制器的话,可以使用:

// 假设当前模块是Home模块
// 实例化Event控制器
$User = A('User','Event');
$Blog = A('Admin/Blog','Event');

上面的代码等效于:

// 实例化Home模块的User事件控制器
$User = new \Home\Event\UserEvent();
// 实例化Admin模块的Blog事件控制器
$Blog = new \Admin\Event\BlogEvent();