Filtre Latte

Filtrele sunt funcții care modifică sau formatează datele în forma dorită. Acesta este un rezumat al filtrelor încorporate care sunt disponibile.

Există, de asemenea, filtre de scăpare pentru HTML (escapeHtml și escapeHtmlComment), XML (escapeXml), JavaScript (escapeJs), CSS (escapeCss) și iCalendar (escapeICal), pe care Latte le utilizează singur datorită scăpării în funcție de context și pe care nu este nevoie să le scrieți.

Latte verifică automat atributele src și href, astfel încât aproape că nu este nevoie să utilizați filtrul checkUrl.

Toate filtrele încorporate funcționează cu șiruri de caractere codificate UTF-8.

Utilizare

Latte permite apelarea filtrelor folosind notația “pipe” (este permisă folosirea unui spațiu înainte):

<h1>{$heading|upper}</h1>

Filtrele pot fi înlănțuite, caz în care se aplică în ordine de la stânga la dreapta:

<h1>{$heading|lower|capitalize}</h1>

Parametrii se pun după numele filtrului, separați prin două puncte sau virgulă:

<h1>{$heading|truncate:20,''}</h1>

Filtrele pot fi aplicate pe expresie:

{var $name = ($title|upper) . ($subtitle|lower)}</h1>

Filtrele personalizate pot fi înregistrate în acest mod:

$latte = new Latte\Engine;
$latte->addFilter('shortify', fn(string $s, int $len = 10) => mb_substr($s, 0, $len));

Îl folosim într-un șablon ca acesta:

<p>{$text|shortify}</p>
<p>{$text|shortify:100}</p>

Filtre

batch (int $length, mixed $item): array

Filtru care simplifică listarea datelor liniare sub formă de tabel. Acesta returnează o matrice de tablouri cu numărul dat de elemente. Dacă furnizați un al doilea parametru, acesta este utilizat pentru a completa elementele lipsă de pe ultimul rând.

{var $items = ['a', 'b', 'c', 'd', 'e']}
<table>
{foreach ($items|batch: 3, 'No item') as $row}
	<tr>
		{foreach $row as $column}
			<td>{$column}</td>
		{/foreach}
	</tr>
{/foreach}
</table>

Se tipărește:

<table>
	<tr>
		<td>a</td>
		<td>b</td>
		<td>c</td>
	</tr>
	<tr>
		<td>d</td>
		<td>e</td>
		<td>No item</td>
	</tr>
</table>

A se vedea, de asemenea, grupul și eticheta iterateWhile.

breakLines

Inserează întreruperi de linie HTML înainte de toate liniile noi.

{var $s = "Text & with \n newline"}
{$s|breakLines}    {* outputs "Text & with <br>\n newline" *}

bytes (int $precision=2)

Formatează dimensiunea în octeți într-o formă lizibilă de către om. Dacă este setată localitatea, sunt utilizate separatoarele corespunzătoare de zecimale și de mii.

{$size|bytes}     0 B, 1.25 GB, …
{$size|bytes:0}   10 B, 1 GB, …

ceil (int $precision=0)

Rotunjește un număr până la o precizie dată.

{=3.4|ceil}         {* ieșiri 4 *}
{=135.22|ceil:1}    {* ieșiri 135.3 *}
{=135.22|ceil:3}    {* ieșiri 135.22 *}

A se vedea, de asemenea, floor, round.

capitalize

Returnează o versiune a valorii cu titlu. Cuvintele vor începe cu litere majuscule, toate caracterele rămase sunt minuscule. Necesită extensia PHP mbstring.

{='i like LATTE'|capitalize}  {* outputs 'I Like Latte' *}

A se vedea, de asemenea, firstUpper, lower, upper.

checkUrl

Aplică igienizarea URL-urilor. Verifică dacă variabila conține un URL web (adică protocolul HTTP/HTTPS) și previne scrierea de linkuri care pot reprezenta un risc de securitate.

{var $link = 'javascript:window.close()'}
<a data-href={$link|checkUrl}>checked</a>
<a data-href={$link}>unchecked</a>

Imprimă:

<a data-href="">checked</a>
<a data-href="javascript:window.close()">unchecked</a>

A se vedea și nocheck.

clamp (int|float $min, int|float $max)

Returnează valoarea fixată în intervalul inclusiv dintre min și max.

{$level|clamp: 0, 255}

Există, de asemenea, ca funcție.

dataStream (string $mimetype=detect)

Convertește conținutul în schema URI de date. Poate fi utilizat pentru a insera imagini în HTML sau CSS fără a fi nevoie să se facă legătura cu fișiere externe.

Să avem o imagine într-o variabilă $img = Image::fromFile('obrazek.gif'), atunci

<img src={$img|dataStream}>

Se imprimă de exemplu:

<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUA
AAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO
9TXL0Y4OHwAAAABJRU5ErkJggg==">

Necesită extensia PHP fileinfo.

date (string $format)

Formatează data și ora în conformitate cu masca utilizată de funcția PHP date. Filtrul acceptă data în format UNIX timestamp, ca șir de caractere sau ca obiect DateTimeInterface.

{$today|date:'j. n. Y'}

A se vedea și localDate.

escapeUrl

Scapă o variabilă pentru a fi utilizată ca parametru în URL.

<a href="http://example.com/{$name|escapeUrl}">{$name}</a>

A se vedea, de asemenea, query.

explode (string $separator='')

Împarte un șir de caractere după delimitatorul dat și returnează un tablou de șiruri de caractere. Alias pentru split.

{='one,two,three'|explode:','}    {* returns ['one', 'two', 'three'] *}

Dacă delimitatorul este un șir de caractere gol (valoare implicită), datele de intrare vor fi împărțite în caractere individuale:

{='123'|explode}                  {* returnează ['1', '2', '3'] *}

Puteți utiliza și aliasul split:

{='1,2,3'|split:','}              {* returnează ['1', '2', '3'] *}

A se vedea și implode.

first

Returnează primul element al unui array sau caracterul unui șir de caractere:

{=[1, 2, 3, 4]|first}    {* ieșiri 1 *}
{='abcd'|first}          {* iese "a" *}

A se vedea, de asemenea, last, random.

floor (int $precision=0)

Rotunjește un număr până la o precizie dată.

{=3.5|floor}        {* ieșiri 3 *}
{=135.79|floor:1}   {* ieșiri 135.7 *}
{=135.79|floor:3}   {* ieșiri 135.79 *}

A se vedea și plafon, rotunjire.

firstUpper

Convertește prima literă a unei valori în majusculă. Necesită extensia PHP mbstring.

{='the latte'|firstUpper}  {* outputs 'The latte' *}

A se vedea, de asemenea, capitalize, lower, upper.

group (string|int|\Closure $by): array

Filtrul grupează datele în funcție de diferite criterii.

În acest exemplu, rândurile din tabel sunt grupate în funcție de coloana categoryId. Rezultatul este un tablou de tablouri în care cheia este valoarea din coloana categoryId. Citiți instrucțiunile detaliate.

{foreach ($items|group: categoryId) as $categoryId => $categoryItems}
    <ul>
        {foreach $categoryItems as $item}
            <li>{$item->name}</li>
        {/foreach}
    </ul>
{/foreach}

A se vedea, de asemenea, batch, funcția group și eticheta iterateWhile.

implode (string $glue='')

Returnează un șir de caractere care este concatenarea șirurilor din matrice. Alias pentru join.

{=[1, 2, 3]|implode}      {* iese "123" *}
{=[1, 2, 3]|implode:'|'}  {* iese '1|2|3' *}

Puteți utiliza și un alias join:

{=[1, 2, 3]|join}         {* acest "123" *}

indent (int $level=1, string $char="\t")

Indentează un text de la stânga cu un anumit număr de tabulauri sau alte caractere pe care îl specificăm în al doilea argument opțional. Liniile goale nu sunt indentate.

<div>
{block |indent}
<p>Hello</p>
{/block}
</div>

Imprimă:

<div>
	<p>Hello</p>
</div>

last

Returnează ultimul element al unui array sau caracterul unui șir de caractere:

{=[1, 2, 3, 4]|last}    {* ieșiri 4 *}
{='abcd'|last}          {* ieșiri 'd' *}

A se vedea, de asemenea, first, random.

length

Returnează lungimea unui șir de caractere sau a unei matrice.

• pentru șiruri de caractere, va returna lungimea în caractere UTF-8
• pentru array-uri, va returna numărul de elemente.
• pentru obiectele care implementează interfața Countable, se va utiliza valoarea returnată de count().
• pentru obiectele care implementează interfața IteratorAggregate, se va utiliza valoarea returnată de iterator_count().

{if ($users|length) > 10}
	...
{/if}

localDate (?string $format=null, ?string $date=null, ?string $time=null)

Formatează data și ora în funcție de locale, asigurând afișarea consecventă și localizată a datelor de timp în diferite limbi și regiuni. Filtrul acceptă data ca timestamp UNIX, șir sau obiect DateTimeInterface.

{$date|localDate}                  {* 15. dubna 2024 *}
{$date|format: yM}                 {* 4/2024 *}
{$date|localDate: date: medium}    {* 15. 4. 2024 *}

Dacă utilizați filtrul fără niciun parametru, acesta va afișa data în format lung, după cum se explică în continuare.

a) Utilizarea formatului

Parametrul format descrie componentele de timp care ar trebui afișate. Acesta utilizează coduri de litere, unde numărul de repetiții afectează lățimea ieșirii:

Ordinea codurilor în format nu contează, deoarece ordinea componentelor va fi afișată în conformitate cu convențiile locale. Prin urmare, formatul este independent de locale. De exemplu, formatul yyyyMMMMd în localul en_US afișează April 15, 2024, în timp ce în localul cs_CZ afișează 15. dubna 2024:

b) Utilizarea stilurilor prestabilite

Parametrii date și time determină nivelul de detaliu pentru afișarea datei și orei. Puteți alege din mai multe niveluri: full, long, medium, short. Puteți afișa doar data, doar ora sau ambele:

Pentru dată, puteți utiliza, de asemenea, prefixul relative- (de exemplu, relative-short), care pentru datele apropiate de prezent va afișa yesterday, today sau tomorrow; în caz contrar, se va afișa în mod standard.

{$date|localDate: date: relative-short}    {* yesterday *}

A se vedea și data.

lower

Convertește o valoare în minuscule. Necesită extensia PHP mbstring.

{='LATTE'|lower}   {* acest "latte" *}

A se vedea, de asemenea, capitalize, firstUpper, upper.

nocheck

Împiedică dezinfectarea automată a URL-urilor. Latte verifică automat dacă variabila conține un URL web (adică protocolul HTTP/HTTPS) și împiedică scrierea de link-uri care pot reprezenta un risc de securitate.

Dacă link-ul utilizează o schemă diferită, cum ar fi javascript: sau data:, și sunteți sigur de conținutul acestuia, puteți dezactiva verificarea prin intermediul |nocheck.

{var $link = 'javascript:window.close()'}

<a href={$link}>checked</a>
<a href={$link|nocheck}>unchecked</a>

Tipărituri:

<a href="">checked</a>
<a href="javascript:window.close()">unchecked</a>

A se vedea, de asemenea, checkUrl.

noescape

Dezactive scăparea automată.

{var $trustedHtmlString = '<b>hello</b>'}
Escaped: {$trustedHtmlString}
Unescaped: {$trustedHtmlString|noescape}

Imprimă:

Escaped: <b>hello</b>
Unescaped: <b>hello</b>

Folosirea abuzivă a filtrului noescape poate duce la o vulnerabilitate XSS! Nu îl utilizați niciodată decât dacă sunteți absolut sigur de ceea ce faceți și dacă șirul pe care îl imprimați provine dintr-o sursă de încredere.

number (int $decimals=0, string $decPoint='.', string $thousandsSep=',')

Formatează un număr la un număr specificat de zecimale. Dacă este setată localitatea, se utilizează separatoarele de zecimale și de mii corespunzătoare.

{1234.20 |number}              1,234
{1234.20 |number:1}            1,234.2
{1234.20 |number:2}            1,234.20
{1234.20 |number:2, ',', ' '}  1 234,20

number (string $format)

Parametrul format vă permite să definiți aspectul numerelor exact în funcție de nevoile dumneavoastră. Acesta necesită o localitate stabilită. Formatul constă din mai multe caractere speciale, a căror descriere completă poate fi găsită în documentația DecimalFormat:

• <c id=6/> cifră obligatorie, afișată întotdeauna chiar dacă este zero
• # cifră opțională, afișată numai dacă numărul are o cifră în acel loc
• @ cifră semnificativă, ajută la afișarea numărului cu un anumit număr de cifre semnificative
• . marchează locul unde ar trebui să fie separatorul zecimal (virgulă sau punct, în funcție de localitate)
• , utilizat pentru a separa grupuri de cifre, de obicei mii
• % înmulțește numărul cu 100 și adaugă semnul procentului

Să ne uităm la câteva exemple. În primul exemplu, două zecimale sunt obligatorii; în al doilea, ele sunt opționale. Al treilea exemplu prezintă o umplere cu zerouri pe ambele părți, iar al patrulea afișează doar cifrele existente:

{1234.5|number: '#,##0.00'}     {* 1,234.50 *}
{1234.5|number: '#,##0.##'}     {* 1,234.5 *}
{1.23  |number: '000.000'}      {* 001.230 *}
{1.2   |number: '##.##'}        {* 1.2 *}

Cifrele semnificative determină câte cifre, indiferent de punctul zecimal, ar trebui afișate, rotunjind numărul dacă este necesar:

{1234|number: '@@'}             {* 1200 *}
{1234|number: '@@@'}            {* 1230 *}
{1234|number: '@@@#'}           {* 1234 *}
{1.2345|number: '@@@'}          {* 1.23 *}
{0.00123|number: '@@'}          {* 0.0012 *}

O modalitate ușoară de a afișa un număr ca procent. Numărul este înmulțit cu 100 și se adaugă semnul %:

{0.1234|number: '#.##%'}        {* 12.34% *}

Putem defini un format diferit pentru numerele pozitive și negative, separate de un caracter ;. În acest fel, de exemplu, numerele pozitive pot fi afișate cu un semn +:

{42|number: '#.##;(#.##)'}      {* 42 *}
{-42|number: '#.##;(#.##)'}     {* (42) *}
{42|number: '+#.##;-#.##'}      {* +42 *}
{-42|number: '+#.##;-#.##'}     {* -42 *}

Rețineți că aspectul real al numerelor poate varia în funcție de setările locale. De exemplu, în unele țări, se utilizează o virgulă în loc de un punct ca separator zecimal. Acest filtru ține cont automat de acest lucru, deci nu trebuie să vă faceți griji.

padLeft (int $length, string $pad=' ')

Pads un șir de caractere la o anumită lungime cu un alt șir de caractere din stânga.

{='hello'|padLeft: 10, '123'}  {* ieșiri '12312hello' *}

padRight (int $length, string $pad=' ')

Adaugă un șir de caractere la o anumită lungime cu un alt șir din dreapta.

{='hello'|padRight: 10, '123'}  {* ieșiri 'hello12312' *}

query

Generează dinamic un șir de interogare în URL:

<a href="http://example.com/?{[name: 'John Doe', age: 43]|query}">click</a>
<a href="http://example.com/?search={$search|query}">search</a>

Imprimă:

<a href="http://example.com/?name=John+Doe&amp;age=43">click</a>
<a href="http://example.com/?search=Foo+Bar">search</a>

Cheile cu o valoare de null sunt omise.

A se vedea, de asemenea, escapeUrl.

random

Returnează un element aleatoriu din matrice sau un caracter aleatoriu dintr-un șir de caractere:

{=[1, 2, 3, 4]|random}    {* exemplu de ieșire: 3 *}
{='abcd'|random}          {* exemplu de ieșire: 'b' *}

A se vedea, de asemenea, first, last.

repeat (int $count)

Repetă șirul de x ori.

{='hello'|repeat: 3}  {* outputs 'hellohellohello' *}

replace (string|array $search, string $replace='')

Înlocuiește toate aparițiile șirului de căutare cu șirul de înlocuire.

{='hello world'|replace: 'world', 'friend'}  {* iese 'hello friend' *}

Se pot face mai multe înlocuiri deodată:

{='hello world'|replace: [h => l, l => h]}  {* outputs 'lehho worhd' *}

replaceRE (string $pattern, string $replace='')

Înlocuiește toate ocurențele în funcție de expresia regulată.

{='hello world'|replaceRE: '/l.*/', 'l'}  {* outputs 'hel' *}

reverse

Inversează șirul sau matricea dată.

{var $s = 'Nette'}
{$s|reverse}    {* iese "etteN" *}
{var $a = ['N', 'e', 't', 't', 'e']}
{$a|reverse}    {* returnează ['e', 't', 't', 'e', 'N'] *}

round (int $precision=0)

Rotunjește un număr la o precizie dată.

{=3.4|round}        {* ieșiri 3 *}
{=3.5|round}        {* ieșiri 4 *}
{=135.79|round:1}   {* ieșiri 135.8 *}
{=135.79|round:3}   {* ieșiri 135.79 *}

A se vedea, de asemenea, plafon, podea.

slice (int $start, ?int $length=null, bool $preserveKeys=false)

Extrage o porțiune dintr-un tablou sau un șir de caractere.

{='hello'|slice: 1, 2}           {* ieșiri 'el' *}
{=['a', 'b', 'c']|slice: 1, 2}   {* ieșiri ['b', 'c'] *}

Filtrul slice funcționează ca funcția PHP array_slice pentru array-uri și mb_substr pentru șiruri de caractere, cu o revenire la iconv_substr în modul UTF-8.

În cazul în care startul nu este negativ, secvența va începe de la acel start în variabilă. Dacă start este negativ, secvența va începe la acea distanță de la sfârșitul variabilei.

În cazul în care lungimea este dată și este pozitivă, atunci secvența va avea până la numărul de elemente din ea. În cazul în care variabila este mai scurtă decât lungimea, atunci vor fi prezente numai elementele disponibile ale variabilei. În cazul în care lungimea este dată și este negativă, secvența se va opri la atâtea elemente de la sfârșitul variabilei. În cazul în care este omisă, secvența va conține toate elementele de la offset până la sfârșitul variabilei.

Filter reordonează și resetează implicit cheile tabloului de numere întregi. Acest comportament poate fi modificat prin setarea preserveKeys la true. Cheile șirurilor de caractere sunt întotdeauna păstrate, indiferent de acest parametru.

sort (?Closure $comparison, string|int|\Closure|null $by=null, string|int|\Closure|bool $byKey=false)

Filtrul sortează elementele unui array sau iterator păstrând cheile lor asociative. Atunci când este setată o localitate, sortarea urmează regulile acesteia, cu excepția cazului în care este specificată o funcție de comparație personalizată.

{foreach ($names|sort) as $name}
	...
{/foreach}

Array sortat în ordine inversă.

{foreach ($names|sort|reverse) as $name}
	...
{/foreach}

Puteți specifica o funcție de comparație personalizată pentru sortare (exemplul arată cum se inversează sortarea de la cel mai mare la cel mai mic):

{var $reverted = ($names|sort: fn($a, $b) => $b <=> $a)}

Filtrul |sort vă permite, de asemenea, să sortați elementele după cheie:

{foreach ($names|sort: byKey: true) as $name}
	...
{/foreach}

Dacă aveți nevoie să sortați un tabel după o anumită coloană, puteți utiliza parametrul by. Valoarea 'name' din exemplu specifică faptul că sortarea se va face după $row->name sau $row['name'], în funcție de faptul că $row este o matrice sau un obiect:

{foreach ($items|sort: by: 'name') as $item}
	{$item->name}
{/foreach}

De asemenea, puteți defini o funcție de apelare care să determine valoarea după care se va sorta:

{foreach ($items|sort: by: fn($items) => $items->category->name) as $item}
	{$item->name}
{/foreach}

Parametrul byKey poate fi utilizat în același mod.

spaceless

Îndepărtează spațiile albe inutile din rezultat. De asemenea, puteți utiliza aliasul strip.

{block |spaceless}
	<ul>
		<li>Hello</li>
	</ul>
{/block}

Imprimă:

<ul> <li>Hello</li> </ul>

stripHtml

Convertește HTML în text simplu. Adică, elimină etichetele HTML și convertește entitățile HTML în text.

{='<p>one &lt; two</p>'|stripHtml}  {* outputs 'one < two' *}

Textul simplu rezultat poate conține, în mod natural, caractere care reprezintă etichete HTML, de exemplu '<p>'|stripHtml este convertit în <p>. Nu scoateți niciodată textul rezultat cu |noescape, deoarece acest lucru poate duce la o vulnerabilitate de securitate.

substr (int $offset, ?int $length=null)

Extrage o porțiune dintr-un șir de caractere. Acest filtru a fost înlocuit cu un filtru de felie.

{$string|substr: 1, 2}

translate (…$args)

Traduce expresii în alte limbi. Pentru ca filtrul să fie disponibil, trebuie să configurați translator. De asemenea, puteți utiliza etichetele pentru traducere.

<a href="basket">{='Baskter'|translate}</a>
<span>{$item|translate}</span>

trim (string $charlist=" \t\n\r\0\x0B\u{A0}")

Elimină caracterele de început și de sfârșit, implicit spațiile albe.

{='  I like Latte.  '|trim}    {* outputs 'I like Latte.' *}
{='  I like Latte.'|trim: '.'} {* outputs '  I like Latte' *}

truncate (int $length, string $append='…')

Scurtează un șir de caractere până la lungimea maximă dată, dar încearcă să păstreze cuvintele întregi. În cazul în care șirul este trunchiat, adaugă elipse la sfârșit (acest lucru poate fi modificat prin intermediul celui de-al doilea parametru).

{var $title = 'Hello, how are you?'}
{$title|truncate:5}  {* Hell…                *}
{$title|truncate:17} {* Hello, how are…      *}
{$title|truncate:30} {* Hello, how are you?  *}

upper

Convertește o valoare în majuscule. Necesită extensia PHP mbstring.

{='latte'|upper}  {* outputs 'LATTE' *}

A se vedea, de asemenea, capitalize, firstUpper, lower.

webalize

Convertește în ASCII.

Convertește spațiile în cratimă. Îndepărtează caracterele care nu sunt alfanumerice, sublinieri sau cratime. Convertește în minuscule. Îndepărtează, de asemenea, spațiile albe de început și de sfârșit.

{var $s = 'Our 10. product'}
{$s|webalize}    {* outputs 'our-10-product' *}

Necesită pachetul nette/utils.