ThinkPHP5控制器定义

Published on 2016 - 12 - 10

控制器定义

定义

ThinkPHP V5.0的控制器定义比较灵活,可以无需继承任何的基础类,也可以继承官方封装的\think\Controller类或者其他的控制器类。

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

namespace app\index\controller;

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

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

application\index\controller\Index.php

控制器类可以无需继承任何类,命名空间默认以app为根命名空间。

控制器的根命名空间可以设置,例如我们在应用配置文件中修改:

// 修改应用类库命名空间
'app_namespace' => 'application',

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

namespace application\index\controller;

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

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

使用该方式定义的控制器类,如果要在控制器里面渲染模板,可以使用

namespace app\index\controller;

use think\View;

class Index 
{
    public function index()
    {
        $view = new View();
        return $view->fetch('index');
    }
}

或者直接使用view助手函数渲染模板输出,例如:

namespace app\index\controller;

class Index 
{
    public function index()
    {
        return view('index');
    }
}

如果继承了think\Controller类的话,可以直接调用think\View及think\Request类的方法,例如:

namespace app\index\controller;

use think\Controller;

class Index extends Controller
{
    public function index()
    {
        // 获取包含域名的完整URL地址
        $this->assign('domain',$this->request->url(true));
        return $this->fetch('index');
    }
}

渲染输出

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

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

namespace app\index\controller;

class Index 
{
    public function hello()
    {
        return 'hello,world!';
    }

    public function json()
    {
        return json_encode($data);
    }

    public function read()
    {
        return view();
    }

}

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

输出转换

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

如果控制器定义为:

namespace app\index\controller;

class Index 
{
    public function hello()
    {
        return 'hello,world!';
    }

     public function data()
    {
        return ['name'=>'thinkphp','status'=>1];
    }

}

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

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

我们访问

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

输出的结果变成:

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

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

如果我们控制器定义

namespace app\index\controller;

class Index 
{
    public function data()
    {
        return ['name'=>'thinkphp','status'=>1];
    }

}

我们访问

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

输出的结果变成:

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

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

// 默认输出类型
'default_ajax_return'   => 'html',

这种情况下ajax请求不会对返回内容进行转换。

控制器初始化

如果你的控制器类继承了\think\Controller类的话,可以定义控制器初始化方法_initialize,在该控制器的方法调用之前首先执行。

例如:

namespace app\index\controller;

use think\Controller;

class Index extends Controller
{

    public function _initialize()
    {
        echo 'init<br/>';
    }

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

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

如果访问

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

会输出

init
hello

如果访问

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

会输出

init
data

前置操作

可以为某个或者某些操作指定前置执行的操作方法,设置 beforeActionList属性可以指定某个方法为其他方法的前置操作,数组键名为需要调用的前置方法名,无值的话为当前控制器下所有方法的前置方法。

['except' => '方法名,方法名']

表示这些方法不使用前置方法,

['only' => '方法名,方法名']

表示只有这些方法使用前置方法。

示例如下:

namespace app\index\controller;

use think\Controller;

class Index extends Controller
{
    protected $beforeActionList = [
        'first',
        'second' =>  ['except'=>'hello'],
        'three'  =>  ['only'=>'hello,data'],
    ];

    protected function first()
    {
        echo 'first<br/>';
    }

    protected function second()
    {
        echo 'second<br/>';
    }

    protected function three()
    {
        echo 'three<br/>';
    }

    public function hello()
    {
        return 'hello';
    }
    public function data()
    {
        return 'data';
    }
}

访问

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

最后的输出结果是

first
three
hello

访问

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

的输出结果是:

first
second
three
data

跳转和重定向

页面跳转

在应用开发中,经常会遇到一些带有提示信息的跳转页面,例如操作成功或者操作错误页面,并且自动跳转到另外一个目标页面。系统的\think\Controller类内置了两个跳转方法success和error,用于页面跳转提示。

使用方法很简单,举例如下:

namespace app\index\controller;

use think\Controller;
use app\index\model\User;

class Index extends Controller
{
    public function index()
    {
        $User = new User; //实例化User对象
        $result = $User->save($data); 
        if($result){
            //设置成功后跳转页面的地址,默认的返回页面是$_SERVER['HTTP_REFERER']
            $this->success('新增成功', 'User/list');
        } else {
            //错误页面的默认跳转页面是返回前一页,通常不需要设置
            $this->error('新增失败');
        }
    }
}

跳转地址是可选的,success方法的默认跳转地址是$_SERVER["HTTP_REFERER"],error方法的默认跳转地址是javascript:history.back(-1);。

默认的等待时间都是3秒

success和error方法都可以对应的模板,默认的设置是两个方法对应的模板都是:

THINK_PATH . 'tpl/dispatch_jump.tpl'

我们可以改变默认的模板:

//默认错误跳转对应的模板文件
'dispatch_error_tmpl' => APP_PATH . 'tpl/dispatch_jump.tpl',
//默认成功跳转对应的模板文件
'dispatch_success_tmpl' => APP_PATH . 'tpl/dispatch_jump.tpl',

也可以使用项目内部的模板文件

//默认错误跳转对应的模板文件
'dispatch_error_tmpl' => 'public/error',
//默认成功跳转对应的模板文件
'dispatch_success_tmpl' => 'public/success',

模板文件可以使用模板标签,并且可以使用下面的模板变量:

变量 含义
$data 要返回的数据
$msg 页面提示信息
$code 返回的code
$wait 跳转等待时间 单位为秒
$url 跳转页面地址

error方法会自动判断当前请求是否属于Ajax请求,如果属于Ajax请求则会自动转换为default_ajax_return配置的格式返回信息。 success在Ajax请求下不返回信息,需要开发者自行处理。

重定向

\think\Controller类的redirect方法可以实现页面的重定向功能。

//重定向到News模块的Category操作
$this->redirect('News/category', ['cate_id' => 2]);

上面的用法是跳转到News模块的category操作,重定向后会改变当前的URL地址。

或者直接重定向到一个指定的外部URL地址,例如:

//重定向到指定的URL地址 并且使用302
$this->redirect('http://thinkphp.cn/blog/2',302);

参考文档