Twig教程展示了如何在PHP应用程序中使用Twig模板引擎生成文档。
$ php -v php -v PHP 8.1.2 (cli) (built: Aug 8 2022 07:28:23) (NTS) ...
我们使用PHP版本8.1.2。
树枝
Twig是一个PHP模板引擎。它是由Symfony开发人员创建的。Twig文件的扩展名为.html.twig
;它们是静态数据的混合,例如HTML和Twig结构。
Twig使用双花括号分隔符{{}}
用于输出,使用花括号百分比分隔符{%%}
用于逻辑。{##}
用于注释。
<ul> {% for word in words %} <li>{{ word }}</li> {% endfor %} </ul>
此代码是Twig语法示例。在此代码中,我们使用for
标记创建一个循环。
Twig语法由标记、过滤器、函数、运算符和测试组成。
设置树枝
首先,我们设置Twig。
$ composer require twig/twig
我们使用composer安装Twig。
$ mkdir templates
我们会将我们的模板文件放入template
目录。
require __DIR__ . '/vendor/autoload.php';
我们需要将autoload.php
文件添加到我们的脚本中。
模板引擎
模板引擎或模板处理器是一个库,旨在将模板与数据模型结合起来以生成文档。模板引擎通常用于生成大量电子邮件、源代码预处理或生成动态HTML页面。
我们创建了一个模板引擎,我们在其中定义了静态部分和动态部分。动态部分稍后将替换为数据。呈现功能稍后将模板与数据组合。
Twig第一个例子
下面是Twig模板系统的简单演示。
<?php require __DIR__ . '/vendor/autoload.php'; use Twig\Environment; use Twig\Loader\FilesystemLoader; $loader = new FilesystemLoader(__DIR__ . '/templates'); $twig = new Environment($loader); echo $twig->render('first.html.twig', ['name' => 'John Doe', 'occupation' => 'gardener']);
我们使用FilesystemLoader
从指定目录加载模板。
echo $twig->render('first.html.twig', ['name' => 'John Doe', 'occupation' => 'gardener']);
输出是用render
生成的。它有两个参数:模板文件和数据。
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Document</title> </head> <body> <p> {{ name }} is a {{ occupation }} </p> </body> </html>
这是模板文件。变量以{{}}
语法输出。
$ php first.php <!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Document</title> </head> <body> <p> John Doe is a gardener </p> </body> </html>
这是输出。
树枝过滤器
过滤器允许我们以各种方式修改数据。
<?php require __DIR__ . '/vendor/autoload.php'; use Twig\Environment; use Twig\Loader\FilesystemLoader; $loader = new FilesystemLoader(__DIR__ . '/templates'); $twig = new Environment($loader); $words = ['sky', 'mountain', 'falcon', 'forest', 'rock', 'blue']; $sentence = 'today is a windy day'; echo $twig->render('filters.html.twig', ['words' => $words, 'sentence' => $sentence]);
在示例中,我们有一个数组和一个字符串作为模板数据。
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Filters</title> </head> <body> <p> The array has {{ words | length }} elements </p> <p> Joined array elements: {{ words | join(',') }} </p> <p> {{ sentence | title }} </p> </body> </html>
过滤器与|
字符一起应用。该示例使用length
对单词进行计数,使用join
连接数组元素并使用title
修改字符。
Twig自定义过滤器
我们可以使用Twig_Filter
创建自定义过滤器。
<?php require __DIR__ . '/vendor/autoload.php'; use Twig\Environment; use Twig\Loader\FilesystemLoader; $loader = new FilesystemLoader(__DIR__ . '/templates'); $twig = new Environment($loader); $twig->addFilter(new Twig_Filter('accFirst', 'accFirst')); $sentence = 'Å¡umivé vÃno'; echo $twig->render('customfilter.html.twig', ['sentence' => $sentence]); function accFirst($value, $encoding = 'UTF8') { $strlen = mb_strlen($value, $encoding); $firstChar = mb_substr($value, 0, 1, $encoding); $rest = mb_substr($value, 1, $strlen - 1, $encoding); return mb_strtoupper($firstChar, $encoding) . $rest; }
我们添加了一个名为accFirst
的新过滤器。它仅修改第一个字母并处理重音符号。
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Custom filter</title> </head> <body> <p> {{ sentence | accFirst }} </p> </body> </html>
这是模板文件,它使用自定义accFirst
过滤器。
树枝循环
要创建循环,我们使用for
标记。
<?php require __DIR__ . '/vendor/autoload.php'; use Twig\Environment; use Twig\Loader\FilesystemLoader; $loader = new FilesystemLoader(__DIR__ . '/templates'); $twig = new Environment($loader); $words = ['sky', 'mountain', 'falcon', 'forest', 'rock', 'blue', 'solid', 'book', 'tree']; echo $twig->render('words.html.twig', ['words' => $words]);
我们将循环一个单词数组。
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Words</title> </head> <body> <ul> {% for word in words %} <li>{{ word }}</li> {% endfor %} </ul> <ul> {% for word in words|slice(2, 4) %} <li>{{ word }}</li> {% endfor %} </ul> </body> </html>
在模板文件中,我们遍历words
数组并生成一个HTML列表。使用slice
过滤器,我们可以遍历数组的一部分。
Twig循环与if&else
我们可以将for
标签与if
标签和else
标签结合起来。
<?php require __DIR__ . '/vendor/autoload.php'; use Twig\Environment; use Twig\Loader\FilesystemLoader; $loader = new FilesystemLoader(__DIR__ . '/templates'); $twig = new Environment($loader); $users = [ ['name' => 'John Doe', 'active' => false], ['name' => 'Lucy Smith', 'active' => false], ['name' => 'Peter Holcombe', 'active' => false], ['name' => 'Barry Collins', 'active' => false] ]; echo $twig->render('activeusers.html.twig', ['users' => $users]);
我们将一组用户发送到模板文件。
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Document</title> </head> <body> <p>Active users</p> <ul> {% for user in users if user.active %} <li>{{ user.name }}</li> {% else %} <li>No users found</li> {% endfor %} </ul> </body> </html>
我们输出用户名的user.active
属性为真。当没有活跃用户时,显示else
标签的输出。
Twig设置标签
set
标签允许为模板中的变量设置值。
$words = ['sky', 'mountain', 'falcon', 'forest', 'rock', 'blue', 'solid', 'book', 'tree']; echo $twig->render('test.html.twig', ['words' => $words]);
我们有一个单词列表。
{% set sorted = words | sort %} <ul> {% for word in sorted %} <li>{{ word }}</li> {% endfor %} </ul>
我们使用sort
过滤器对数组进行排序,并使用set
将排序后的数组分配给sorted
变量。
Twig逐字标记
verbatim
将部分标记为不应解析的原始文本。
{% verbatim %} <ul> {% for word in words %} <li>{{ word }}</li> {% endfor %} </ul> {% endverbatim %}
例如,如果我们有一个解释一些Twig标签的教程,我们就不需要解析一段演示。
Twig格式过滤器
format
过滤器通过替换占位符来格式化给定的字符串。它的工作方式类似于sprintf
函数。
$name = "John Doe"; $age = 34; echo $twig->render('formatfil.html.twig', ['name' => $name, 'age' => $age]);
我们向模板发送两个变量。
{{ "%s is %d years old" | format(name, age) }}
我们用格式
构建字符串。
Twig日期函数
date
函数将参数转换为日期以进行日期比较。
$user = ['name' => 'John Doe', 'created_at' => '2011/11/10']; echo $twig->render('datefun.html.twig', ['user' => $user]);
用户数组有一个created_at
键。
{% if date(user.created_at) < date('-5years') %} <p>{{ user.name }} is a senior user</p> {% endif %}
在模板中,我们比较两个日期。
Twig自动转义
Twig自动转义某些字符,如。
$twig = new Environment($loader, [ 'autoescape' => false ]);
可以使用autoescape
选项关闭自动转义。
$data = "<script src='http::/example.com/nastyscript.js'></script>"; echo $twig->render('autoescape.html.twig', ['data' => $data]);
用户可能会向应用程序添加危险的输入。可以通过自动转义来防止包含未知的JS文件。
<p> The data is {{ data }} </p> <p> The data is {{ data | raw }} </p>
如果启用了自动转义,我们可以使用raw
过滤器显示原始输入。
<p> The data is <script src='http::/example.com/nastyscript.js'></script> </p> <p> The data is <script src='http::/example.com/nastyscript.js'></script> </p>
此部分输出显示了字符是如何转义的。
树枝测试
Twig测试允许测试数据。使用is
运算符应用测试。
$words = ['', null, 'rock', ' ', 'forest']; echo $twig->render('tests.html.twig', ['words' => $words]);
我们有一个包含空、空和空白元素的单词数组。
<ul> {% for word in words %} {% if word is null %} <p>null element</p> {% elseif word | trim is empty %} <p>Empty element</p> {% else %} <li>{{ word }}</li> {% endif %} {% endfor %} </ul>
为了处理空的、空白的和null元素,Twig有empty
和null
测试。
Twig继承
Twig的模板继承是一个强大的功能,可以消除重复并促进维护。
<?php require __DIR__ . '/vendor/autoload.php'; use Twig\Environment; use Twig\Loader\FilesystemLoader; $loader = new FilesystemLoader(__DIR__ . '/templates'); $twig = new Environment($loader); echo $twig->render('derived.html.twig');
这是inheritance.php
文件。它呈现derived.html.twig
,它扩展自base.html.twig
。
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>{% block title %}{% endblock %}</title> </head> <body> {% block body %}{% endblock %} </body> </html>
基本布局定义了两个由子元素替换的块:title
和body
。
{% extends 'base.html.twig' %} {% block title %}Some title{% endblock %} {% block body %} The body contents {% endblock %}
派生子模板继承自带有extends
关键字的基本模板。这两个块定义自定义文本。
$ php inheritance.php <!DOCTYPE html><html lang="en"> <head> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Some title</title> </head> <body> The body contents </body> </html>
这是输出。
Symfony示例
Twig是Symfony框架不可或缺的一部分。下一个示例显示了在Symfony骨架应用程序中使用Twig的步骤。
$ composer create-project symfony/skeleton simple $ cd simple
我们创建一个新的Symfony框架应用程序并移动到项目目录。
$ composer require server --dev
我们包括开发服务器。
$ composer require maker annotations twig
我们包括一些基本的Symfony组件,包括Twig。
$ php bin/console make:controller HomeController
我们创建一个家庭控制器。
<?php namespace App\Controller; use Symfony\Bundle\FrameworkBundle\Controller\AbstractController; use Symfony\Component\Routing\Annotation\Route; class HomeController extends AbstractController { /** * @Route("/home", name="home") */ public function index() { $words = ['sky', 'blue', 'cloud', 'symfony', 'forest']; return $this->render('home/index.html.twig', [ 'words' => $words ]); } }
在家庭控制器中,我们呈现index.html.twig
模板并将它传递给$words
数组以进行处理。
<!DOCTYPE html> <html> <head> <meta charset="UTF-8"> <title>{% block title %}Welcome!{% endblock %}</title> {% block stylesheets %}{% endblock %} </head> <body> {% block body %}{% endblock %} {% block javascripts %}{% endblock %} </body> </html>
这是基本布局页面。
{% extends 'base.html.twig' %} {% block title %}Home page{% endblock %} {% block body %} <h2>List of words</h2> <ul> {% for word in words %} <li>{{ word }}</li> {% endfor %} </ul> {% endblock %}
这是主页模板。它使用for
标记迭代单词并将它们输出到无序列表中。
$ php bin/console server:run
我们启动服务器。
我们导航到http://localhost:8000/home
以查看结果。
在本教程中,我们使用Twig从模板和数据生成文档。我们介绍了Twig标签、过滤器、测试和继承。我们在Symfony应用程序中展示了Twing。
列出所有PHP教程。