Grav - Фильтры и функции Twig

В этой главе давайте изучим Twig Filters and Functions. Фильтры также используются для форматирования данных так, как вы хотите, с требуемым выходом. Функции используются для создания содержимого.

Шаблоны Twig - это текстовые файлы, содержащие выражения и переменные, замененные значениями. Twig использует три типа тегов.

Output tags - Следующий синтаксис используется для отображения здесь результата вычисленных выражений.

{{  Place Your Output Here  }}

Action Tags - Здесь используется следующий синтаксис для выполнения операторов.

{%  executable statements are placed here  %}

Comment tags - Следующий синтаксис используется для записи комментариев в файл шаблона Twig.

{#  write your comment here  #}

Фильтры Twig

Twig Filters использует |для применения фильтров к переменной Twig, за которым следует имя фильтра. Аргументы могут быть переданы в круглых скобках аналогично функциям Twig.

В следующей таблице показаны фильтры Twig, используемые в Grav -


'<img src="/some/path/img.jpg"/>' |absolute_url
'contact_us'| camelize
'This is some string' | contains('some')
set header_image_width = 
page.header.header_image_width|defined(900)
'this is an example for ends-with filter' | ends_with('filter')
'field.name'|fieldName
'some_text_to_read'|humanize
{% set ritems = {'orange':1, 'apple':2, 'peach':3}|ksort %}
{% for key, value in ritems %}{{ key }}:{{ value }}, {% endfor %}
'/strip/leading/slash/'|ltrim('/')
'## some text with markdown'|markdown
'something'|md5
'61'|monthize
page.date|nicetime(false)
'78'| ordinalize
'child'|pluralize
{% set ritems = ['one', 'two', 'three', 'four', 'five', 'six', 'seven', 'eight', 'nine', 'ten']|randomize(3) %}
{% for ritem in ritems %}{{ ritem }}, {% endfor %}
'/strip/leading/slash/'|rtrim('/')
'vehicles'|singularize
"[email protected]"|safe_email
{% set people = [{'email':'[email protected]', 'id':3}, {'email':'[email protected]', 'id':1}, {'email':'[email protected]', 'id':7}]|sort_by_key('id') %}
{% for person in people %}{{ person.email }}:{{ person.id }}, {% endfor %}
'this is an example for starts-with filter' |starts_with('this')
MY_LANGUAGE_KEY_STRING

'welcome page'|titleize
'ContactUs'|underscorize
'one sentence. two sentences'|truncate(5)

Sr.No.	Фильтр и описание	пример
1	Absolute URL Он принимает относительный путь и преобразует его в абсолютный URL.	`'<img src="/some/path/img.jpg"/>' \|absolute_url` преобразуется в - `<img src="http://learn.getGrav.org/some/path/img.jpg" />`
2	Camelize Он преобразует строку в формат CamelCase.	`'contact_us'\| camelize` преобразуется в - `ContactUs`
3	Contains если найдет строку.	`'This is some string' \| contains('some')` вывод - `1`
4	Defined Вы можете проверить, определена ли какая-то переменная или нет. Если переменная не определена, вы можете указать значение по умолчанию.	`set header_image_width = page.header.header_image_width\|defined(900)` Он устанавливает header_image_width со значением 900, если оно не определено.
5	Ends-With Вы можете определить, заканчивается ли строка заданной строкой, используя фильтр Ends-With.	`'this is an example for ends-with filter' \| ends_with('filter')` он отображается как - `True`
6	FieldName Он фильтрует имя поля, заменяя точку на нотацию массива.	`'field.name'\|fieldName` он отображается как - `field[name]`
7	Humanize Он используется для преобразования строки в удобочитаемый формат.	`'some_text_to_read'\|humanize` он отображается как - `Some text to read`
8	Ksort Он сортирует карту массива с помощью ключа.	`{% set ritems = {'orange':1, 'apple':2, 'peach':3}\|ksort %} {% for key, value in ritems %}{{ key }}:{{ value }}, {% endfor %}` он отображается как - `apple:2, orange:1, peach:3,`
9	Left Trim Он используется для удаления пробелов в начале строки и удаляет соответствующий символ, указанный с левой стороны строки.	`'/strip/leading/slash/'\|ltrim('/')` он отображается как - `strip/leading/slash/`
10	Markdown Он используется для преобразования строки, содержащей уценку, в HTML с помощью анализатора уценки Grav.	`'## some text with markdown'\|markdown` он отображается как - `some text with markdown`
11	MD5 С помощью этого фильтра можно создать хеш md5 для строки.	`'something'\|md5` он отображается как - `437b930db84b8079c2dd804a71936b5f`
12	Monthize Используя фильтр «Месяц», мы можем преобразовать целое число дней в количество месяцев.	`'61'\|monthize` он отображается как - `2`
13	Nice Time Используя фильтр Nice Time, мы можем получить дату в удобном для восприятия формате времени в качестве вывода.	`page.date\|nicetime(false)` он отображается как - `3 hrs ago`
14	Ordinalize Порядковые числа (например, 1- ^е , 2- ^е , 3- ^е ) можно присвоить целым числам с помощью фильтра Ordinalize.	`'78'\| ordinalize` он отображается как - `78th`
15	Pluralize Строку можно преобразовать в форму множественного числа английского языка с помощью фильтра «Плюрализм».	`'child'\|pluralize` он отображается как - `children`
16	Randomize Этот фильтр помогает рандомизировать предоставленный список. Если параметр содержит какие-либо значения, то эти значения пропускаются при рандомизации.	`{% set ritems = ['one', 'two', 'three', 'four', 'five', 'six', 'seven', 'eight', 'nine', 'ten']\|randomize(3) %} {% for ritem in ritems %}{{ ritem }}, {% endfor %}` он отображается как - `one, two, three, eight, six, five, nine, seven, ten, four,`
17	Right Trim Он очень похож на левую обрезку, за исключением того, что удаляет пробелы и совпадающий символ с правой стороны строки.	`'/strip/leading/slash/'\|rtrim('/')` он отображается как - `/strip/leading/slash`
18	Singularize Строку можно преобразовать в английскую версию в единственном числе с помощью фильтра Singular.	`'vehicles'\|singularize` он отображается как - `vehicle`
19	Safe Email Фильтр безопасной электронной почты используется для преобразования адреса электронной почты в символы ASCII, что затрудняет рассылку спама по электронной почте.	`"[email protected]"\|safe_email` вывод - `[email protected]`
20	SortByKey Он используется для сортировки карты массива по ключам.	`{% set people = [{'email':'[email protected]', 'id':3}, {'email':'[email protected]', 'id':1}, {'email':'[email protected]', 'id':7}]\|sort_by_key('id') %} {% for person in people %}{{ person.email }}:{{ person.id }}, {% endfor %}` он отображает - `[email protected]:1, [email protected]:3, [email protected]:7,`
21 год	Starts-With Вы можете определить, начинается ли строка с данной строки, используя фильтр Starts-With.	`'this is an example for starts-with filter' \|starts_with('this')` вывод - `true`
22	Translate для более подробной информации.	`MY_LANGUAGE_KEY_STRING` он отображает - `'Some text in English'`
23	Translate Admin Он переводит строку на текущий язык, который установлен в user.yaml файл.
24	Titleize Строка преобразуется в формат Title Case с помощью Titleize.	`'welcome page'\|titleize` он отображается как - `Welcome Page`
25	UnderScoreize формат с помощью фильтра UnderScoreize.	`'ContactUs'\|underscorize` он преобразуется в - `contact_us`
26	Truncate a string Вы можете использовать Truncate, чтобы обрезать строку или сократить строку, вы должны указать количество символов.	`'one sentence. two sentences'\|truncate(5)` он обрезается до - `one s...` Вы можете использовать true как параметр, если вы не хотите обрезать строку до ближайшего конца предложения после заданного количества символов. `'one sentence. two sentences'\|truncate(5, true)` он обрезается до - `one sentence` Вы также можете удалить текст HTML, но вы должны использовать striptags фильтровать перед truncate фильтр. `'<p>one <strong>sentence<strong>. two sentences</p>'\|striptags\|truncate(5)` он отображается как - `one s`

Функции Twig

Функции Twig вызываются напрямую путем передачи параметра. В следующей таблице перечислены функции -

Sr.No.	Описание функции	пример
1	Array Эта функция приводит значение в массив.	`array(value)`
2	Authorize Эта функция разрешает аутентифицированному пользователю видеть ресурс и принимает строку разрешения или массив строк разрешений.	`authorize(['admin.statistics', 'admin.super'])`
3	Dump Он принимает допустимую переменную twig и выгружает ее в панель отладчика Grav. Однако отладчик должен быть включен, чтобы видеть значения вкладок сообщений.	`dump(page.header)`
4	Debug Работает так же, как функция dump ().
5	Gist Эта функция создает код внедрения Gist на основе идентификатора Github Gist ID.
6	Random String Generation Эта функция создаст случайную строку с указанным количеством символов. Эти строки могут использоваться как уникальный идентификатор или ключ.	`generate_random_string(10)`
7	Repeat Эта функция будет повторять строку в течение заданного времени.	`repeat('Grav ', 10) will repeat Grav 10 times.`
8	String Создает случайную строку указанной длины символа.	`ta (23)`
9	Translate Array Это функция, связанная с \|ta фильтр.
10	Url Этот фильтр создаст URL-адрес, а также преобразует потоки URL-адресов PHP в допустимые ресурсы HTML. Если URL-адрес не может быть разрешен, можно передать значение по умолчанию.	`url('theme://images/logo.png') \| default('http://www.placehold.it/150x100/f4f4f4')`
11	Translate Используя фильтр Translate, строка переводится как \|t фильтр.	`t('SITE_NAME')` переводится на - `Site Name`