Filtros de Latte

Os filtros são funções que mudam ou formatam os dados para um formulário que desejamos. Este é um resumo dos filtros incorporados que estão disponíveis.

Transformação de corda / matriz
batch listando dados lineares em uma tabela
breakLines Insere quebras de linha HTML antes de todas as novas linhas
bytes formatos em bytes
clamp valor dos grampos para a faixa
dataStream Conversão do protocolo Data URI
date formatos data
explode divide um fio pelo delimitador dado
first devolve o primeiro elemento de matriz ou caráter de cadeia
implode junta um conjunto a um cordão
indent traça o texto da esquerda com o número de abas
join junta um conjunto a um cordão
last retorna o último elemento de matriz ou caráter de cadeia
length devolve o comprimento de um fio ou matriz
number número de formatos
padLeft completa o cordel a dado comprimento a partir da esquerda
padRight completa o cordel a dado comprimento a partir da direita
random retorna elemento aleatório de matriz ou caráter de cadeia
repeat repete o fio
replace substitui todas as ocorrências da cadeia de busca com a substituição
replaceRE substitui todas as ocorrências de acordo com a expressão regular
reverse inverte uma corda ou matriz UTF-8
slice extrai uma fatia de uma matriz ou um fio
sort classifica uma série
spaceless remove o espaço em branco, semelhante à etiqueta sem espaçamento
split divide um fio pelo delimitador dado
strip remove o espaço em branco
stripHtml remove as tags HTML e converte entidades HTML em texto
substr devolve parte da cadeia
trim tira o espaço em branco da corda
translate tradução para outros idiomas
truncate encurta o comprimento preservando palavras inteiras
webalize ajusta a corda UTF-8 à forma usada na URL
Caixa de papelão
capitalize minúscula a primeira letra de cada palavra maiúscula
firstUpper faz a primeira letra maiúscula
lower faz uma minúscula
upper faz uma maiúscula de corda
Arredondamento de números
ceil arredonda um número até uma determinada precisão
floor arredonda um número para uma determinada precisão
round arredonda um número para uma dada precisão
Escapando
escapeUrl parâmetro de fuga no URL
noescape imprime uma variável sem fugir
query gera uma cadeia de consulta na URL

Há também filtros de fuga para HTML (escapeHtml e escapeHtmlComment), XML (escapeXml), JavaScript (escapeJs), CSS (escapeCss) e iCalendar (escapeICal), que Latte se utiliza graças à fuga consciente do contexto e você não precisa escrevê-los.

Segurança
checkUrl higieniza cadeia para uso dentro do atributo href
nocheck previne a higienização automática da URL

Latte os atributos src e href verificam automaticamente, de modo que quase não é necessário usar o filtro checkUrl.

Todos os filtros integrados trabalham com cordas codificadas UTF-8.

Utilização

O Latte permite a chamada de filtros utilizando a notação do sinal de canalização (o espaço precedente é permitido):

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

Os filtros podem ser acorrentados, nesse caso, eles se aplicam por ordem da esquerda para a direita:

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

Os parâmetros são colocados após o nome do filtro separado por dois pontos ou vírgula:

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

Os filtros podem ser aplicados por expressão:

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

Os filtros personalizados podem ser registrados desta forma:

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

Usamo-lo em um modelo como este:

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

Filtros

batch (int length, mixed item): array

Filtro que simplifica a listagem de dados lineares na forma de uma tabela. Ele retorna uma matriz com o determinado número de itens. Se você fornecer um segundo parâmetro, este é usado para preencher os itens em falta na última linha.

{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>

Impressões:

<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>

breakLines

Insere quebras de linha HTML antes de todas as novas linhas.

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

bytes (int precision = 2)

Formata um tamanho em bytes de forma legível para o ser humano.

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

ceil (int precision = 0)

Arredonda um número até uma determinada precisão.

{=3.4|ceil}         {* saídas 4 *}
{=135.22|ceil:1}    {* saídas 135,3 *}
{=135.22|ceil:3}    {* saídas 135,22 *}

Veja também piso, redondo.

capitalize

Devolve uma versão do valor com base no título. As palavras começarão com letras maiúsculas, todos os caracteres restantes são minúsculos. Requer extensão PHP mbstring.

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

Ver também firstUpper, lower, upper.

checkUrl

Impõe a higienização do URL. Verifica se a variável contém uma URL da web (ou seja, protocolo HTTP/HTTPS) e impede a escrita de links que possam representar um risco de segurança.

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

Impressões:

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

Veja também nocheck.

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

Retorna o valor fixado para a faixa inclusiva de min e max.

{$level|clamp: 0, 255}

Também existe como função.

dataStream (string mimetype = detect)

Converte o conteúdo para o esquema URI de dados. Pode ser usado para inserir imagens em HTML ou CSS sem a necessidade de vincular arquivos externos.

Vamos ter uma imagem em uma variável $img = Image::fromFile('obrazek.gif'), então

<img src="{$img|dataStream}">

Impressões, por exemplo:

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

Requer extensão PHP fileinfo.

date (string format)

Retorna uma data no formato dado usando as opções de strftime ou date funções PHP. O filtro recebe uma data como um carimbo de tempo UNIX, uma string ou um objeto do tipo DateTime.

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

escapeUrl

Escapa a uma variável para ser usada como parâmetro na URL.

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

Veja também consulta.

explode (string separator = '')

Divide um fio pelo delimitador dado e retorna um conjunto de fios. Alias para split.

{='um,dois,três'|explodir:','}    {* retorna ['um', 'dois', 'três'] *}

Se o delimitador for uma cadeia vazia (valor padrão), a entrada será dividida em caracteres individuais:

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

Você também pode usar o pseudônimo split:

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

Veja também implodir.

first

Devolve o primeiro elemento de matriz ou caráter de corda:

{=[1, 2, 3, 4]|first}    {* outputs 1 *}
{='abcd'|first}          {* outputs 'a' *}

Ver também último, aleatório.

floor (int precision = 0)

Arredonda um número para uma determinada precisão.

{=3.5|floor}        {* outputs 3      *}
{=135.79|floor:1}   {* outputs 135.7  *}
{=135.79|floor:3}   {* outputs 135.79 *}

Veja também Cessar, redondo.

firstUpper

Converte uma primeira letra de valor em maiúsculas. Requer extensão PHP mbstring.

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

Veja também capitalizar, inferior, superior.

implode (string glue = '')

Retorna um fio que é a concatenação das cordas na matriz. Alias para join.

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

Você também pode usar um pseudônimo join:

{=[1, 2, 3]|join}         {* outputs '123' *}

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

Indica um texto da esquerda por um determinado número de abas ou outros caracteres que especificamos no segundo argumento opcional. As linhas em branco não são indentadas.

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

Impressões:

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

last

Retorna o último elemento de matriz ou caráter de corda:

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

Veja também primeiro, aleatório.

length

Retorna o comprimento de um fio ou matriz.

  • para cordas, ele retornará o comprimento em caracteres UTF-8
  • para arrays, ele retornará a contagem dos itens
  • para objetos que implementam a interface Countable, ele usará o valor de retorno da contagem()
  • para objetos que implementam a interface IteratorAggregate, ele usará o valor de retorno do iterator_count()
{if ($users|length) > 10}
	...
{/if}

lower

Converte um valor para minúsculas. Requer extensão PHP mbstring.

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

Ver também capitalize, firstUpper, upper.

nocheck

Impede a higienização automática da URL. Latte verifica automaticamente se a variável contém uma URL da web (ou seja, protocolo HTTP/HTTPS) e impede a escrita de links que possam representar um risco de segurança.

Se o link usa um esquema diferente, como javascript: ou data:, e você tem certeza de seu conteúdo, você pode desativar a verificação via |nocheck.

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

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

Impressões:

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

Veja também checkUrl.

noescape

Desativa a fuga automática.

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

Impressões:

Escaped: &lt;b&gt;hello&lt;/b&gt;
Unescaped: <b>hello</b>

O mau uso do filtro noescape pode levar a uma vulnerabilidade XSS! Nunca o use a menos que você esteja absolutamente seguro do que está fazendo e que o fio que você está imprimindo vem de uma fonte confiável.

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

Formata um número para um determinado número de casas decimais. Você também pode especificar um caractere do separador de casas decimais e de milhares.

{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

padLeft (int length, string pad = ' ')

Coloca um cordel a um certo comprimento com outro cordel da esquerda.

{='hello'|padLeft: 10, '123'}  {* outputs '12312hello' *}

padRight (int length, string pad = ' ')

Coloca um cordel a um certo comprimento com outro cordel da direita.

{='hello'|padRight: 10, '123'}  {* outputs 'hello12312' *}

query

Dinamicamente, gera uma cadeia de consulta na URL:

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

Impressões:

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

As chaves com um valor de null são omitidas.

Veja também escapeUrl.

random

Devolve elemento aleatório de matriz ou caráter de corda:

{=[1, 2, 3, 4]|random}    {* example output: 3 *}
{='abcd'|random}          {* example output: 'b' *}

Ver também primeiro, último.

repeat (int count)

Repete a seqüência x-vezes.

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

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

Substitui todas as ocorrências da cadeia de busca pela cadeia de substituição.

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

Substituições múltiplas podem ser feitas de uma só vez:

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

replaceRE (string pattern, string replace = '')

Substitui todas as ocorrências de acordo com a expressão regular.

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

reverse

Inverte seqüência ou matriz dada.

{var $s = 'Nette'}
{$s|reverse}    {* outputs 'etteN' *}
{var $a = ['N', 'e', 't', 't', 'e']}
{$a|reverse}    {* returns ['e', 't', 't', 'e', 'N'] *}

round (int precision = 0)

Arredonda um número para uma dada precisão.

{=3.4|round}        {* outputs 3      *}
{=3.5|round}        {* outputs 4      *}
{=135.79|round:1}   {* outputs 135.8  *}
{=135.79|round:3}   {* outputs 135.79 *}

Veja também ceil, chão.

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

Extrai uma fatia de uma matriz ou um fio.

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

O filtro de fatias funciona como a função PHP array_slice para arrays e mb_substr para strings com um fallback para iconv_substr no modo UTF-8.

Se o início for não negativo, a seqüência começará nesse início na variável. Se o início for negativo, a seqüência começará tão longe do final da variável.

Se o comprimento for dado e for positivo, então a seqüência terá até muitos elementos nele. Se a variável for menor do que o comprimento, então somente os elementos variáveis disponíveis estarão presentes. Se o comprimento for dado e for negativo, então a seqüência interromperá que muitos elementos do final da variável. Se for omitido, então a seqüência terá tudo desde o offset até o final da variável.

O filtro reordenará e redefinirá as chaves da matriz inteira por padrão. Este comportamento pode ser alterado ajustando preserveKeys para true. As chaves de string são sempre preservadas, independentemente deste parâmetro.

sort

Filtro que ordena uma matriz e mantém a associação de índices.

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

Array ordenados em ordem inversa.

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

Você pode passar sua própria função de comparação como um parâmetro:

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

spaceless

Remove espaços em branco desnecessários da produção. Você também pode usar o pseudônimo strip.

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

Impressões:

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

stripHtml

Converte HTML em texto simples. Ou seja, remove as tags HTML e converte entidades HTML em texto.

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

O texto simples resultante pode naturalmente conter caracteres que representam tags HTML, por exemplo '&lt;p&gt;'|stripHtml é convertido para <p>. Nunca envie o texto resultante com |noescape, pois isso pode levar a uma vulnerabilidade de segurança.

substr (int offset, int length = null)

Extrai uma fatia de um fio. Este filtro foi substituído por uma fatia de filtro.

{$string|substr: 1, 2}

translate (string message, …args)

Ela traduz expressões para outros idiomas. Para tornar o filtro disponível, é necessário instalar um tradutor. Você também pode usar as tags para a tradução.

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

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

Tire os personagens que lideram e seguem, por padrão, o espaço em branco.

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

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

Encurta um fio até o comprimento máximo dado, mas tenta preservar palavras inteiras. Se a cadeia for truncada, acrescenta elipses no final (isto pode ser alterado pelo segundo parâmetro).

{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 um valor em maiúsculas. Requer extensão PHP mbstring.

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

Veja também capitalizar, primeiroCima, mais baixo.

webalize

Converte para ASCII.

Converte espaços em hífens. Remove caracteres que não são alfanuméricos, sublinhados ou hífens. Converte para minúsculas. Também abre e desvia espaços em branco.

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

Requer pacote nette/utils.