fenom/docs/syntax.md

248 lines
6.9 KiB
Markdown
Raw Normal View History

Syntax [RU]
===========
2013-02-01 19:13:07 +04:00
2013-05-30 20:00:52 +04:00
[Smarty](http://www.smarty.net/) like syntax
2013-02-24 14:02:18 +04:00
### Output variables
2013-02-01 19:13:07 +04:00
```smarty
2013-02-09 10:59:08 +04:00
{$foo}
{$foo[4]}
2013-02-01 19:13:07 +04:00
{$foo.4}
2013-02-09 10:59:08 +04:00
{$foo.bar}
2013-02-01 19:13:07 +04:00
{$foo.'bar'}
{$foo."bar"}
{$foo[bar]}
{$foo['bar']}
{$foo["bar"]}
2013-02-09 10:59:08 +04:00
{$foo.$bar}
2013-02-01 19:13:07 +04:00
{$foo[$bar]}
2013-02-09 10:59:08 +04:00
{$foo->bar}
{$foo->bar()}
2013-02-01 19:13:07 +04:00
```
2013-02-24 14:02:18 +04:00
complex variables
2013-02-01 19:13:07 +04:00
```smarty
{$foo.bar.baz}
{$foo.$bar.$baz}
{$foo[4].baz}
{$foo[4].$baz}
{$foo.bar.baz[4]}
2013-02-24 14:02:18 +04:00
{$foo[ $bar.baz ]}
2013-02-01 19:13:07 +04:00
```
2013-02-24 14:02:18 +04:00
Operations
2013-02-01 19:13:07 +04:00
```smarty
2013-02-19 09:51:33 +04:00
{$x+$y}
{$foo[$x+3]}
2013-02-01 19:13:07 +04:00
{$foo[$x+3]*$x+3*$y % 3}
```
2013-02-19 09:51:33 +04:00
[Список всех операторов](./operators.md)
2013-02-24 14:02:18 +04:00
Define variable
2013-02-01 19:13:07 +04:00
2013-02-19 09:51:33 +04:00
```smarty
{var $foo = "bar"}
{var $foo = 5}
```
2013-02-01 19:13:07 +04:00
```smarty
{var $foo = $x + $y}
{var $foo = $x.y[z] + $y}
{var $foo = strlen($a)}
{var $foo = myfunct( ($x+$y)*3 )}
{var $foo.bar.baz = 1}
```
2013-02-24 14:02:18 +04:00
See also [{var}](./tags/var.md) documentation.
2013-02-19 09:51:33 +04:00
2013-02-24 14:02:18 +04:00
Define arrays
2013-02-01 19:13:07 +04:00
```smarty
2013-02-24 14:02:18 +04:00
{var $foo = [1,2,3]}
{var $foo = ['y'=>'yellow','b'=>'blue']} can be associative
{var $foo = [1,[9,8],3]} can be nested
2013-02-19 09:51:33 +04:00
```
2013-02-24 14:02:18 +04:00
more complex example
2013-02-19 09:51:33 +04:00
```smarty
2013-02-24 14:02:18 +04:00
{var $foo = [$a, $d.c, $a + $f]}
{var $foo = ['y'=>'yellow', $color=>$colors[ $color ]}
{var $foo = [1,[$parent ,$a + $e],3]}
2013-02-01 19:13:07 +04:00
```
2013-02-24 14:02:18 +04:00
### Objects
2013-02-01 19:13:07 +04:00
```smarty
{$object->method1($x)->method2($y)}
{var $foo=$object->item->method($y, 'named')}
```
2013-02-24 14:02:18 +04:00
See also [security options](./settings.md)
2013-02-01 19:13:07 +04:00
2013-02-24 14:02:18 +04:00
### Scalar values
2013-02-01 19:13:07 +04:00
2013-04-28 18:08:57 +04:00
Строки в Cytro обрабатываются идентично правилам подстановки переменных в строки в PHP, т.е. в двойных кавычках переменная заменяется на её значение, в одинарных замены не происходит.
2013-02-01 19:13:07 +04:00
```smarty
2013-02-19 09:51:33 +04:00
{var $foo="Username"}
{var $user.name="Username"}
{"Hi, $foo"} выведет "Hi, Username"
{"Hi, {$foo}"} выведет "Hi, Username"
{"Hi, {$user.name}"} выведет "Hi, Username"
{var $message = "Hi, {$user.name}"}
2013-02-01 19:13:07 +04:00
{'Hi, $foo'} выведет 'Hi, $foo'
{'Hi, {$foo}'} выведет 'Hi, {$foo}'
```
2013-02-19 09:51:33 +04:00
Переменные в строках так же поддерживают [модификаторы](#modifiers)
```smarty
{"Hi, {$user.name|up}"} outputs Hi, USERNAME
```
Поддерживается вызов методов
```smarty
{"Hi, {$user->getName(true)}"} outputs Hi, Username
```
Числовые значение обрабатывается как есть
```smarty
{2|pow:10}
{var $magick = 5381|calc}
```
2013-02-24 14:02:18 +04:00
### Modificatiors
2013-02-01 19:13:07 +04:00
* Модификаторы позволяют изменить значение переменной перед выводом или использованием в выражении
* Модификаторы записываются после переменной через символ вертикальной черты "|"
* Модификаторы могут иметь параметры, которые записываются через символ двоеточие ":" после имени модификатора
* Параметры модификаторов друг от друга также разделяются символом двоеточие ":"
* В качестве параметров могут использоваться переменные.
* Модификаторы могут составлять цепочки. В этом случае они применяются к переменной последовательно слева направо
```smarty
2013-02-19 09:51:33 +04:00
{var $foo="User"}
{$foo|upper} выведет "USER"
{$foo|lower} выведет "user"
{"{$foo|lower}"} выведет "user"
{"User"|lower}} выведет "user"
2013-02-01 19:13:07 +04:00
{$looong_text|truncate:80:"..."} обрежет текст до 80 символов и добавит "..." в конец текста
{$looong_text|lower|truncate:$settings.count:$settings.etc}
2013-02-19 09:51:33 +04:00
{var $foo="Ivan"|upper} переменная $foo будет содержать "USER"
2013-02-01 19:13:07 +04:00
```
2013-02-19 09:51:33 +04:00
[Список модификаторов](./main.md#modifiers)
2013-02-01 19:13:07 +04:00
2013-02-24 14:02:18 +04:00
### Tags
2013-02-01 19:13:07 +04:00
2013-02-19 09:51:33 +04:00
Каждый тэг шаблонизатора либо выводит переменную, либо вызывает какую-либо функцию. (переписать)
2013-02-01 19:13:07 +04:00
Тег вызова функции начинается с названия функции и содержит список аргументов:
```smarty
{FUNCNAME attr1 = "val1" attr2 = $val2}
```
2013-02-19 09:51:33 +04:00
Это общий формат функций, но могут быть исключения, например функция [{var}](./tags/var.md), использованная выше.
2013-02-01 19:13:07 +04:00
```smarty
{include file="my.tpl"}
{var $foo=5}
{if $user.loggined}
Welcome, <span style="color: red">{$user.name}!</span>
{else}
Who are you?
{/if}
```
2013-02-19 09:51:33 +04:00
В общем случае аргументы принимают любой формат переменных, в том числе результаты арифметических операций и модификаторов.
2013-02-01 19:13:07 +04:00
```smarty
{funct arg=true}
{funct arg=5}
{funct arg=1.2}
{funct arg='string'}
{funct arg="string this {$var}"}
{funct arg=[1,2,34]}
{funct arg=$x}
{funct arg=$x.c}
```
```smarty
{funct arg="ivan"|upper}
{funct arg=$a.d.c|lower}
```
```smarty
{funct arg=1+2}
{funct arg=$a.d.c+4}
{funct arg=($a.d.c|count+4)/3}
```
2013-02-24 14:02:18 +04:00
### Ignoring temaplate code
2013-02-01 19:13:07 +04:00
2013-04-28 18:08:57 +04:00
В шаблонизаторе Cytro используются фигурные скобки для отделения HTML от кода Cytro.
2013-05-30 20:00:52 +04:00
Если требуется вывести текст, содержащий фигурные скобки, помните о следующих возможностях:
2013-02-01 19:13:07 +04:00
2013-02-19 09:51:33 +04:00
1. Использование блочного тега `{ignore}{/ignore}`. Текст внутри этого тега текст не компилируется шаблонизатором и выводится как есть.
2013-05-30 20:00:52 +04:00
2. Если после открывающей фигурной скобки есть пробельный символ (пробел или `\t`) или перенос строки (`\r` или `\n`), то она не воспринимается как разделитель кода Cytro и код после неё выводится как есть.
2013-02-01 19:13:07 +04:00
Пример:
```smarty
2013-02-09 10:59:08 +04:00
{ignore}
2013-02-01 19:13:07 +04:00
<style>
h1 {font-size: 24px; color: #F00;}
</style>
2013-02-15 12:17:23 +04:00
{/ignore}
2013-02-01 19:13:07 +04:00
<script>
(function (text) {
var e = document.createElement('P');
e.innerHTML = text;
document.body.appendChild(e);
})('test');
2013-02-09 10:59:08 +04:00
</ignore>
2013-02-01 19:13:07 +04:00
```
Выведет
```html
<style>
h1 {font-size: 24px; color: #F00;}
</style>
<script>
(function (text) {
var e = document.createElement('P');
e.innerHTML = text;
document.body.appendChild(e);
})('test');
</script>
2013-02-19 09:51:33 +04:00
```
2013-02-24 14:02:18 +04:00
### Whitespaces
2013-02-19 09:51:33 +04:00
Шаблонизатор допускает любое количество пробелов или переносов строк в своём коде
```smarty
{include 'control.tpl'
2013-02-21 22:47:24 +04:00
options = $list
name = $cp.name
type = 'select'
2013-02-19 09:51:33 +04:00
}
{foreach [
"one" => 1,
"two" => 2,
"three" => 3
2013-05-30 20:00:52 +04:00
] as $key => $val}
2013-02-19 09:51:33 +04:00
{$key}: {$val}
{/foreach}
2013-02-01 19:13:07 +04:00
```