视图-webman手册

视图

webman默认使用的是php原生语法作为模版，在打开opcache后具有最好的性能。除了php原生模版，webman还提供了Twig、 Blade、 think-template 模版引擎。

开启opcache

使用视图时，强烈建议开启php.ini中opcache.enable和opcache.enable_cli 两个选项，以便模版引擎达到最好性能。

安装Twig

1、composer安装

composer require twig/twig

2、修改配置config/view.php为

<?php
use support\view\Twig;

return [
    'handler' => Twig::class
];

提示
其它配置选项通过options传入，例如

return [
    'handler' => Twig::class,
    'options' => [
        'debug' => false,
        'charset' => 'utf-8'
    ]
];

安装Blade

1、composer安装

composer require psr/container ^1.1.1 webman/blade

2、修改配置config/view.php为

<?php
use support\view\Blade;

return [
    'handler' => Blade::class
];

安装think-template

1、composer安装

composer require topthink/think-template

2、修改配置config/view.php为

<?php
use support\view\ThinkPHP;

return [
    'handler' => ThinkPHP::class,
];

提示
其它配置选项通过options传入，例如

return [
    'handler' => ThinkPHP::class,
    'options' => [
        'view_suffix' => 'html',
        'tpl_begin' => '{',
        'tpl_end' => '}'
    ]
];

原生PHP模版引擎例子

创建文件 app/controller/UserController.php 如下

<?php
namespace app\controller;

use support\Request;

class UserController
{
    public function hello(Request $request)
    {
        return view('user/hello', ['name' => 'webman']);
    }
}

新建文件 app/view/user/hello.html 如下

<!doctype html>
<html>
<head>
    <meta charset="utf-8">
    <title>webman</title>
</head>
<body>
hello <?=htmlspecialchars($name)?>
</body>
</html>

Twig模版引擎例子

修改配置config/view.php为

<?php
use support\view\Twig;

return [
    'handler' => Twig::class
];

app/controller/UserController.php 如下

<?php
namespace app\controller;

use support\Request;

class UserController
{
    public function hello(Request $request)
    {
        return view('user/hello', ['name' => 'webman']);
    }
}

文件 app/view/user/hello.html 如下

<!doctype html>
<html>
<head>
    <meta charset="utf-8">
    <title>webman</title>
</head>
<body>
hello {{name}}
</body>
</html>

更多文档参考 Twig

Blade 模版的例子

修改配置config/view.php为

<?php
use support\view\Blade;

return [
    'handler' => Blade::class
];

app/controller/UserController.php 如下

<?php
namespace app\controller;

use support\Request;

class UserController
{
    public function hello(Request $request)
    {
        return view('user/hello', ['name' => 'webman']);
    }
}

文件 app/view/user/hello.blade.php 如下

注意blade模版后缀名为.blade.php

<!doctype html>
<html>
<head>
    <meta charset="utf-8">
    <title>webman</title>
</head>
<body>
hello {{$name}}
</body>
</html>

更多文档参考 Blade

ThinkPHP 模版的例子

修改配置config/view.php为

<?php
use support\view\ThinkPHP;

return [
    'handler' => ThinkPHP::class
];

app/controller/UserController.php 如下

<?php
namespace app\controller;

use support\Request;

class UserController
{
    public function hello(Request $request)
    {
        return view('user/hello', ['name' => 'webman']);
    }
}

文件 app/view/user/hello.html 如下

<!doctype html>
<html>
<head>
    <meta charset="utf-8">
    <title>webman</title>
</head>
<body>
hello {$name}
</body>
</html>

更多文档参考 think-template

模版赋值

除了使用view(模版, 变量数组)给模版赋值，我们还可以在任意位置通过调用View::assign()给模版赋值。例如：

<?php
namespace app\controller;

use support\Request;
use support\View;

class UserController
{
    public function hello(Request $request)
    {
        View::assign([
            'name1' => 'value1',
            'name2'=> 'value2',
        ]);
        View::assign('name3', 'value3');
        return view('user/test', ['name' => 'webman']);
    }
}

View::assign()在某些场景下非常有用，例如某系统每个页面首部都要显示当前登录者信息，如果每个页面都将此信息通过 view('模版', ['user_info' => '用户信息']); 赋值将非常麻烦。解决办法就是在中间件中获得用户信息，然后通过View::assign()将用户信息赋值给模版。

关于视图文件路径

控制器

当控制器调用view('模版名',[]);时，视图文件按照如下规则查找：

/开头则直接使用该路径查找视图文件(此特性需要webman-framework>=1.6.0)
不是以/开头并且非多应用时，使用 app/view/ 下对应的视图文件
不是以/开头并且是多应用时，使用 app/应用名/view/ 下对应的视图文件
如果不传模板参数，自动根据2 3规则查找模板文件(此特性需要webman-framework>=1.6.0)

例子：

<?php
namespace app\controller;

use support\Request;

class UserController
{
    public function hello(Request $request)
    {
        // 等价于 return view('user/hello', ['name' => 'webman']);
        // 等价于 return view('/app/view/user/hello', ['name' => 'webman']);
        return view(['name' => 'webman']);
    }
}

闭包函数

闭包函数$request->app 为空，不属于任何应用，所以闭包函数使用app/view/下的视图文件，例如 config/route.php 里定义路由

Route::any('/admin/user/get', function (Reqeust $reqeust) {
    return view('user', []);
});

会使用app/view/user.html作为模版文件(当使用blade模版时模版文件为app/view/user.blade.php)。

指定应用

为了多应用模式下模版可以复用，view($template, $data, $app = null) 提供了第三个参数 $app，可以用来指定使用哪个应用目录下的模版。例如 view('user', [], 'admin'); 会强制使用 app/admin/view/ 下的视图文件。

省略模板参数

注意
此特性需要webman-framework>=1.6.0

在类的控制器里可以省略模板参数，例如

<?php
namespace app\controller;

use support\Request;

class UserController
{
    public function hello(Request $request)
    {
        // 等价于 return view('user/hello', ['name' => 'webman']);
        // 等价于 return view('/app/view/user/hello', ['name' => 'webman']);
        return view(['name' => 'webman']);
    }
}

扩展twig

注意
此特性需要webman-framework>=1.4.8

我们可以通过给配置view.extension回调，来扩展twig视图实例，例如config/view.php如下

<?php
use support\view\Twig;
return [
    'handler' => Twig::class,
    'extension' => function (\Twig\Environment $twig) {
        $twig->addExtension(new your\namespace\YourExtension()); // 增加Extension
        $twig->addFilter(new \Twig\TwigFilter('rot13', 'str_rot13')); // 增加Filter
        $twig->addFunction(new \Twig\TwigFunction('function_name', function () {})); // 增加函数
    }
];

扩展blade

注意
此特性需要webman-framework>=1.4.8
同样的我们可以通过给配置view.extension回调，来扩展blade视图实例，例如config/view.php如下

<?php
use support\view\Blade;
return [
    'handler' => Blade::class,
    'extension' => function (Jenssegers\Blade\Blade $blade) {
        // 给blade添加指令
        $blade->directive('mydate', function ($timestamp) {
            return "<?php echo date('Y-m-d H:i:s', $timestamp); ?>";
        });
    }
];

blade使用component组件

注意
需要webman/blade>=1.5.2

假设需要添加一个Alert组件

新建 app/view/components/Alert.php

<?php

namespace app\view\components;

use Illuminate\View\Component;

class Alert extends Component
{

    public function __construct()
    {

    }

    public function render()
    {
        return view('components/alert')->rawBody();
    }
}

新建 app/view/components/alert.blade.php

<div>
    <b style="color: red">hello blade component</b>
</div>

/config/view.php类似如下代码

<?php
use support\view\Blade;
return [
    'handler' => Blade::class,
    'extension' => function (Jenssegers\Blade\Blade $blade) {
        $blade->component('alert', app\view\components\Alert::class);
    }
];

至此，Blade组件Alert设置完毕，模版里使用时类似如下

<!doctype html>
<html>
<head>
    <meta charset="utf-8">
    <title>webman</title>
</head>
<body>

<x-alert/>

</body>
</html>

扩展think-template

think-template 使用view.options.taglib_pre_load来扩展标签库，例如

<?php
use support\view\ThinkPHP;
return [
    'handler' => ThinkPHP::class,
    'options' => [
        'taglib_pre_load' => your\namspace\Taglib::class,
    ]
];

详情参考 think-template标签扩展