写了好几篇关于twig的东西。。居然还没写个快速入门之类的。现在就写
来源 http://twig.sensiolabs.org/doc/templates.html
概要
twig 的模板就是普通的文本文件，也不需要特别的扩展名，.html .htm .twig 都可以。
模板内的 变量 和 表达式 会在运行的时候被解析替换，标签（tags）会来控制模板的逻辑
下面是个最小型的模板，用来说明一些基础的东西
- <!DOCTYPE html>
- <html>
- <head>
- <title>My Webpage</title>
- </head>
- <body>
- <ulid="navigation">
- {% for item in navigation %}
- <li><ahref="{{ item.href }}">{{ item.caption }}</a></li>
- {% endfor %}
- </ul>
- <h1>My Webpage</h1>
- {{ a_variable }}
- </body>
- </html>
<!DOCTYPE html>
<html>
<head>
<title>My Webpage</title>
</head>
<body>
<ul id="navigation">
{% for item in navigation %}
<li><a href="{{ item.href }}">{{ item.caption }}</a></li>
{% endfor %}
</ul>
<h1>My Webpage</h1>
{{ a_variable }}
</body>
</html>ide 支持
很多ide 都对twig进行高亮支持。大伙自己找需要的吧。
- Textmate via the Twig bundle
- Vim via the Jinja syntax plugin
- Netbeans via the Twig syntax plugin
- PhpStorm (native as of 2.1)
- Eclipse via the Twig plugin
- Sublime Text via the Twig bundle
- GtkSourceView via the Twig language definition (used by gedit and other projects)
- Coda and SubEthaEdit via the Twig syntax mode
变量
程序会传递给模板若干变量，你需要在模板里输出他们。例如输出 $hello
- {{ hello }}
{{ hello }}- {{ foo.bar }}
- {{ foo['bar'] }}
{{ foo.bar }}
{{ foo['bar'] }}
for.bar会进行以下操作
。。。如果 foo是个数组，就尝试返回bar成员，如果不存在的话，往下继续
。。。如果foo是个对象，会尝试返回bar属性，如果不存在的话，往下继续
。。。会尝试运行bar方法，如果不存在的话，往下继续
。。。会尝试运行getBar方法，如果不存在的话，往下继续
。。。会尝试运行isBar方法，如果不存在的话，返回null
for['bar'] 就简单很多了 for必须是个数组，尝试返回bar成员，如果不就返回null
全局变量
TWIG定义了有一些全局变量
- _self 这个参看macro标签
- _context 这个就是当前的环境
- _charset: 当前的字符编码
变量赋值
具体参见set标签
- {% set foo = 'foo' %}
- {% set foo = [1, 2] %}
- {% set foo = {'foo': 'bar'} %}
{% set foo = 'foo' %}
{% set foo = [1, 2] %}
{% set foo = {'foo': 'bar'} %}过滤器 Firters
变量可以被过滤器修饰。过滤器和变量用（|）分割开。过滤器也是可以有参数的。过滤器也可以被多重使用。
下面这例子就使用了两个过滤器。
- {{ name|striptags|title }}
{{ name|striptags|title }}
过滤器也可以用在代码块中，参见 filter标签
- {% filter upper %}
- This text becomes uppercase
- {% endfilter %}
{% filter upper %}
This text becomes uppercase
{% endfilter %}函数 Function
这个没什么好说的，会写程序的都知道，TWIG内置了一些函数，参考我的博客
举个例子 返回一个0到3的数组，就使用 range函数
- {% for i in range(0, 3) %}
- {{ i }},
- {% endfor %}
{% for i in range(0, 3) %}
{{ i }},
{% endfor %}流程控制
支持for循环 和 if/elseif/else结构。直接看例子吧，没什么好说的。
- <h1>Members</h1>
- <ul>
- {% for user in users %}
- <li>{{ user.username|e }}</li>
- {% endfor %}
- </ul>
<h1>Members</h1>
<ul>
{% for user in users %}
<li>{{ user.username|e }}</li>
{% endfor %}
</ul>- {% if users|length > 0 %}
- <ul>
- {% for user in users %}
- <li>{{ user.username|e }}</li>
- {% endfor %}
- </ul>
- {% endif %}
{% if users|length > 0 %}
<ul>
{% for user in users %}
<li>{{ user.username|e }}</li>
{% endfor %}
</ul>
{% endif %}注释
{# ... #} 包围的内容会被注释掉，可以是单行 也可以是多行。载入其他模板
详见include标签（我博客内已经翻译好哦），会返回经过渲染的内容到当前的模板里
- {% include 'sidebar.html' %}
{% include 'sidebar.html' %}
比如
- {% for box in boxes %}
- {% include "render_box.html" %}
- {% endfor %}
{% for box in boxes %}
{% include "render_box.html" %}
{% endfor %}
我们先定义一个基本骨骼页base.html 他包含许多block块，这些都可以被子模板覆盖。
- <!DOCTYPE html>
- <html>
- <head>
- {% block head %}
- <linkrel="stylesheet"href="style.css"/>
- <title>{% block title %}{% endblock %} - My Webpage</title>
- {% endblock %}
- </head>
- <body>
- <divid="content">{% block content %}{% endblock %}</div>
- <divid="footer">
- {% block footer %}
- © Copyright 2011 by <ahref="http://domain.invalid/">you</a>.
- {% endblock %}
- </div>
- </body>
- </html>
<!DOCTYPE html>
<html>
<head>
{% block head %}
<link rel="stylesheet" href="style.css" />
<title>{% block title %}{% endblock %} - My Webpage</title>
{% endblock %}
</head>
<body>
<div id="content">{% block content %}{% endblock %}</div>
<div id="footer">
{% block footer %}
© Copyright 2011 by <a href="http://domain.invalid/">you</a>.
{% endblock %}
</div>
</body>
</html>
注意
1、block是可以嵌套的。
2、block可以设置默认值（中间包围的内容），如果子模板里没有覆盖，那就直接显示默认值。比如block footer ，大部分页面你不需要修改（省力），但你需要到时候仍可以方便到修改（灵活）
下面我看下 子模板应该怎么定义。
- {% extends "base.html" %}
- {% block title %}Index{% endblock %}
- {% block head %}
- {{ parent() }}
- <styletype="text/css">
- .important { color: #336699; }
- </style>
- {% endblock %}
- {% block content %}
- <h1>Index</h1>
- <pclass="important">
- Welcome on my awesome homepage.
- </p>
- {% endblock %}
{% extends "base.html" %}
{% block title %}Index{% endblock %}
{% block head %}
{{ parent() }}
<style type="text/css">
.important { color: #336699; }
</style>
{% endblock %}
{% block content %}
<h1>Index</h1>
<p class="important">
Welcome on my awesome homepage.
</p>
{% endblock %}
如果你需要增加一个block的内容，而不是全覆盖，你可以使用 parent函数
- {% block sidebar %}
- <h3>Table Of Contents</h3>
- ...
- {{ parent() }}
- {% endblock %}
{% block sidebar %}
<h3>Table Of Contents</h3>
...
{{ parent() }}
{% endblock %}HTML转义
主要是帮助转义 尖括号等 <, >, &, " 可以有两种办法。一种是用标签，另一种是使用过滤器。其实TWIG内部就是调用 php 的htmlspecialchars 函数
- {{ user.username|e }}
- {{ user.username|e('js') }}
- {% autoescape true %}
- Everything will be automatically escaped in this block
- {% endautoescape %}
{{ user.username|e }}
{{ user.username|e('js') }}
{% autoescape true %}
Everything will be automatically escaped in this block
{% endautoescape %}- {{ '{{' }}
{{ '{{' }}- {% raw %}
- <ul>
- {% for item in seq %}
- <li>{{ item }}</li>
- {% endfor %}
- </ul>
- {% endraw %}
{% raw %}
<ul>
{% for item in seq %}
<li>{{ item }}</li>
{% endfor %}
</ul>
{% endraw %}macros宏
宏有点类似于函数，常用于输出一些html标签。
这里有个简单示例，定义了一个输出input标签的宏。
- {% macro input(name, value, type, size) %}
- <inputtype="{{ type|default('text') }}"name="{{ name }}"value="{{ value|e }}"size="{{ size|default(20) }}"/>
- {% endmacro %}
{% macro input(name, value, type, size) %}
<input type="{{ type|default('text') }}" name="{{ name }}" value="{{ value|e }}" size="{{ size|default(20) }}" />
{% endmacro %}
一般来说宏会定义在其他到页面，然后通过import标签来导入，
- {% import "forms.html" as forms %}
- <p>{{ forms.input('username') }}</p>
{% import "forms.html" as forms %}
<p>{{ forms.input('username') }}</p>- {% from 'forms.html' import input as input_field, textarea %}
- <dl>
- <dt>Username</dt>
- <dd>{{ input_field('username') }}</dd>
- <dt>Password</dt>
- <dd>{{ input_field('password', type='password') }}</dd>
- </dl>
- <p>{{ textarea('comment') }}</p>
{% from 'forms.html' import input as input_field, textarea %}
<dl>
<dt>Username</dt>
<dd>{{ input_field('username') }}</dd>
<dt>Password</dt>
<dd>{{ input_field('password', type='password') }}</dd>
</dl>
<p>{{ textarea('comment') }}</p>表达式
TWIG允许你在任何地方使用表达式，他的规则和PHP几乎一模一样，就算你不会PHP 仍然会觉得很简单。
最简单的有
字符串：“hello world” 或者 'hello world'
数字：42 或者 42.33
数组：['a','b','c']
哈希：{'a':'av', 'b':'bv'} 其中keys 可以不要引号 也可以是数字 还可以是一个表达式，比如{a:'av', b:'bv'} {1:'1v', 2:'2v'} {1+2:'12v'}
逻辑： true 或者 false
最后还有null
你可以嵌套定义
- {% set foo = [1, {"foo": "bar"}] %}
{% set foo = [1, {"foo": "bar"}] %}
包括数字运算+ - * / %(求余数) //(整除) **(乘方)
- <p>{{ 2 * 3 }}=6
- <p>{{ 2 * 3 }}=8
<p>{{ 2 * 3 }}=6
<p>{{ 2 * 3 }}=8
比较运算 > < >= <= == !=
包含运算 in 以下的代码会返回 true
- {{ 1 in [1, 2, 3] }}
- {{ 'cd' in 'abcde' }}
{{ 1 in [1, 2, 3] }}
{{ 'cd' in 'abcde' }}- {{ name is odd }}
- {% if loop.index is divisibleby(3) %}
- {% if loop.index is not divisibleby(3) %}
- {# is equivalent to #}
- {% if not (loop.index is divisibleby(3)) %}
{{ name is odd }}
{% if loop.index is divisibleby(3) %}
{% if loop.index is not divisibleby(3) %}
{# is equivalent to #}
{% if not (loop.index is divisibleby(3)) %}
.. 建立一个指定开始到结束的数组，他是range函数的缩写，具体参看手册
- <PREclass=htmlname="code">{% for i in 0..3 %}
- {{ i }},
- {% endfor %}</PRE>
- <PRE></PRE>
- {% for i in 0..3 %}
- {{ i }},
- {% endfor %}
{% for i in 0..3 %}
{{ i }},
{% endfor %}
| 使用一个过滤器
- {# output will be HELLO #}
- {{ "hello"|upper }}
{# output will be HELLO #}
{{ "hello"|upper }}- {{ "Hello " ~ name ~ "!" }}
{{ "Hello " ~ name ~ "!" }}- {{ foo ? 'yes' : 'no' }}
{{ foo ? 'yes' : 'no' }}- {{ foo.bar }}
- {{ foo['bar'] }}
{{ foo.bar }}
{{ foo['bar'] }}- {{ "foo #{bar} baz" }}
- {{ "foo #{1 + 2} baz" }}
{{ "foo #{bar} baz" }}
{{ "foo #{1 + 2} baz" }}空白控制
和 php一样，在TWIG模板标签之后的第一个换行符会被自动删掉，其余的空白（包括 空格 tab 换行等）都会被原样输出。
使用spaceless标签就可以删除这些HTML标签之间的空白
- {% spaceless %}
- <div>
- <strong>foo</strong>
- </div>
- {% endspaceless %}
- {# output will be <div><strong>foo</strong></div> #}
{% spaceless %}
<div>
<strong>foo</strong>
</div>
{% endspaceless %}
{# output will be <div><strong>foo</strong></div> #}- {% set value = 'no spaces' %}
- {#- No leading/trailing whitespace -#}
- {%- if true -%}
- {{- value -}}
- {%- endif -%}
- {# output 'no spaces' #}
{% set value = 'no spaces' %}
{#- No leading/trailing whitespace -#}
{%- if true -%}
{{- value -}}
{%- endif -%}
{# output 'no spaces' #}- {% set value = 'no spaces' %}
- <li> {{- value }} </li>
- {# outputs '<li>no spaces </li>' #}
{% set value = 'no spaces' %}
<li> {{- value }} </li>
{# outputs '<li>no spaces </li>' #}
3万+
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
