加载中...

控制器定义


控制器定义

控制器文件通常放在application/module/controller下面,类名和文件名保持大小写一致,并采用驼峰命名(首字母大写)。

一个典型的控制器类定义如下:

  1. <?php
  2. namespace app\index\controller;
  3. use think\Controller;
  4. class Index extends Controller
  5. {
  6. public function index()
  7. {
  8. return 'index';
  9. }
  10. }

为了更方便使用,控制器类建议继承系统的控制器基类think\Controller,虽然无需继承也可以使用。

控制器类文件的实际位置是

  1. application\index\controller\Index.php

访问URL地址是(假设没有定义路由的情况下)

  1. http://localhost/index.php/index

如果你的控制器是HelloWorld,并且定义如下:

  1. <?php
  2. namespace app\index\controller;
  3. class HelloWorld
  4. {
  5. public function index()
  6. {
  7. return 'hello,world!';
  8. }
  9. }

控制器类文件的实际位置是

  1. application\index\controller\HelloWorld.php

访问URL地址是(假设没有定义路由的情况下)

  1. http://localhost/index.php/index/hello_world

如果你期望通过

  1. http://localhost/index.php/index/HelloWorld

可以访问,那么必须关闭URL的自动转换设置

  1. // 是否自动转换URL中的控制器和操作名
  2. 'url_convert' => false,

控制器的命名空间

控制器类的所在命名空间为app\module\controller,其中根命名空间app为系统默认,并且只能通过环境变量设置更改,例如我们可以在.env配置文件中设置:

  1. APP_NAMESPACE = application

则实际的控制器类应该更改定义如下:

  1. <?php
  2. namespace application\index\controller;
  3. class Index
  4. {
  5. public function index()
  6. {
  7. return 'index';
  8. }
  9. }

只是命名空间改变了,但实际的文件位置和文件名并没有改变。

单一模块控制器

在应用配置文件app.php中设置

  1. // 是否支持多模块
  2. 'app_multi_module' => false,

可以启用单一模块,那么控制器的命名空间中不需要模块名了,类的定义就变成了

  1. <?php
  2. namespace app\controller;
  3. class Index
  4. {
  5. public function index()
  6. {
  7. return 'index';
  8. }
  9. }

控制器类文件的实际位置则变成

  1. application\controller\Index.php

渲染输出

默认情况下,控制器的输出全部采用return的方式,无需进行任何的手动输出,系统会自动完成渲染内容的输出。

下面都是有效的输出方式:

  1. <?php
  2. namespace app\index\controller;
  3. class Index
  4. {
  5. public function hello()
  6. {
  7. // 输出hello,world!
  8. return 'hello,world!';
  9. }
  10. public function json()
  11. {
  12. // 输出JSON
  13. return json_encode($data);
  14. }
  15. public function read()
  16. {
  17. // 渲染默认模板输出
  18. return view();
  19. }
  20. }

控制器一般不需要任何输出,直接return即可。

输出转换

默认情况下,控制器的返回输出不会做任何的数据处理,但可以设置输出格式,并进行自动的数据转换处理,前提是控制器的输出数据必须采用return的方式返回。

如果控制器定义为:

  1. <?php
  2. namespace app\index\controller;
  3. class Index
  4. {
  5. public function hello()
  6. {
  7. return 'hello,world!';
  8. }
  9. public function data()
  10. {
  11. return ['name'=>'thinkphp','status'=>1];
  12. }
  13. }

当我们设置输出数据格式为JSON:

  1. // 默认输出类型
  2. 'default_return_type' => 'json',

我们访问

  1. http://localhost/index.php/index/Index/hello
  2. http://localhost/index.php/index/Index/data

输出的结果变成:

  1. "hello,world!"
  2. {"name":"thinkphp","status":1}

默认情况下,控制器在ajax请求会对返回类型自动转换,默认为json

如果我们控制器定义

  1. <?php
  2. namespace app\index\controller;
  3. class Index
  4. {
  5. public function data()
  6. {
  7. return ['name'=>'thinkphp','status'=>1];
  8. }
  9. }

我们访问

  1. http://localhost/index.php/index/Index/data

输出的结果变成:

  1. {"name":"thinkphp","status":1}

多级控制器

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

  1. <?php
  2. namespace app\index\controller\user;
  3. use think\Controller;
  4. class Blog extends Controller
  5. {
  6. public function index()
  7. {
  8. return 'index';
  9. }
  10. }

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

  1. application/index/controller/user/Blog.php

访问地址可以使用

  1. http://serverName/index.php/index/user.blog/index

由于URL访问不能访问默认的多级控制器(可能会把多级控制器名误识别为URL后缀),因此建议所有的多级控制器都通过路由定义后访问,如果要在路由定义中使用多级控制器,可以使用:

  1. \think\Route::get('user/blog','index/user.blog/index');

自动定位控制器

如果你使用了多级控制器的话,可以设置controller_auto_search参数开启自动定位控制器,便于URL访问,首先在应用配置文件中设置:

  1. 'controller_auto_search' => true,

然后定义控制器如下:

  1. <?php
  2. namespace app\index\controller\user;
  3. use think\Controller;
  4. class Blog extends Controller
  5. {
  6. public function index()
  7. {
  8. return 'index';
  9. }
  10. }

我们就可以直接访问下面的URL地址了:

  1. http://serverName/index.php/index/user/Blog

控制器初始化

如果你的控制器类继承了系统控制器基类(\think\Controller)的话,可以定义控制器初始化方法initialize,该方法会在调用控制器的方法之前首先执行,如非必要,不建议直接修改控制器的架构函数。

例如:

  1. <?php
  2. namespace app\index\controller;
  3. use think\Controller;
  4. class Index extends Controller
  5. {
  6. protected function initialize()
  7. {
  8. echo 'init<br/>';
  9. }
  10. public function hello()
  11. {
  12. return 'hello';
  13. }
  14. public function data()
  15. {
  16. return 'data';
  17. }
  18. }

initialize方法不需要任何返回值

如果访问

  1. http://localhost/index.php/index/Index/hello

会输出

  1. init
  2. hello

如果访问

  1. http://localhost/index.php/index/Index/data

会输出

  1. init
  2. data

还没有评论.