Filtros HubL

Os filtros afetam a saída final do HubL. Eles podem ser aplicados a várias instruções e expressões do HubL para alterar a marcação do modelo emitido pelo servidor.

A sintaxe básica de um filtro é |filtername. O filtro é adicionado diretamente após a instrução ou a expressão, dentro dos seus delimitadores. Alguns filtros têm parâmetros adicionais que podem ser adicionados entre parênteses. A sintaxe básica de um filtro com uma string, um número e um parâmetro booleano é: |filtername("stringParameter", 10, true). Observe que os parâmetros das strings devem ser escritos entre aspas. Observe também que os filtros do HubL têm alias que podem ser usados da mesma forma que o filtro principal.

O artigo a seguir contém todos os filtros do HubL suportados.

Calcula o valor absoluto de um número. Você pode usar essa Filtrar para garantir que um número seja positivo.

No exemplo abaixo, há uma variável contendo uma sequência de tipos de frutas. O filtro de lote é aplicado a um loop que é iterado pela sequência. O loop agrupado é executado três vezes para imprimir três tipos de fruta por linha, antes de o loop externo ser executado novamente. Observe na saída final que existem apenas cinco tipos de fruta: o item final é substituído por &nbsp (o segundo parâmetro).

O exemplo abaixo mostra um filtro center aplicado a uma variável em uma tag prévia, para que os espaços em branco não sejam removidos.

Limpa o conteúdo de uma entrada de atributo de HTML. Aceita uma string e converte os caracteres &, <, ‘, ” e escape_jinjava em sequências seguras para HTML. Use esse filtro para variáveis HubL que estão sendo adicionadas aos atributos HTML.

Observe que, ao limpar valores de atributos que aceitam URLs, como href, você deve usar o filtro escape_url.

Calcula a distância elipsoidal 2D entre dois pontos na Terra.

O filtro groupby agrupa uma sequência de objetos por um atributo comum. O parâmetro define o atributo comum pelo qual deve-se fazer o agrupamento.

O filtro indent usa espaços em branco para recuar o texto dentro de um determinado comprimento de campo. Este filtro não é recomendado ou útil, pois o compilador HTML da HubSpot removerá automaticamente os espaços em branco; no entanto, ele está incluído aqui por uma questão de abrangência. O exemplo abaixo mostra um filtro center aplicado a uma variável em uma tag prévia, para que os espaços em branco não sejam removidos. O primeiro parâmetro controla a quantidade de espaços em branco e o segundo booleano alterna se a primeira linha deve ser recuada.

Converte o valor em um número inteiro. Se a conversão não funcionar, ela retornará zero. Você pode substituir este padrão usando o primeiro parâmetro.

Este filtro retorna a intersecção de dois conjuntos ou listas. A lista retornada pelo filtro contém todos os elementos únicos que estão contidos em ambas as listas.

Avalia como true se o valor é um endereço IPv4 ou IPv6 válido.

Retorna uma string que é a concatenação das strings na sequência. O separador entre os elementos é uma string vazia por padrão. Você pode defini-la com o parâmetro opcional. O segundo parâmetro pode ser usado para especificar um atributo para unir.

Retorna o último item de uma sequência.

Retorna o número de itens de uma sequência ou mapeamento.

Converte valores numéricos em uma lista. Caso seja uma string, a lista retornada será uma lista de caracteres. Para adicionar strings a uma sequência, basta adicioná-la às variáveis da string nos delimitadores da sequência [ ].

Calcula o logaritmo natural de um número.

Converte as letras de um valor para todas minúsculas.

Aplica um filtro em uma sequência de objetos ou procura um atributo. É útil ao lidar com listas de objetos, quando você só está interessado em um determinado valor.

Geralmente, é usado para mapear um atributo. Por exemplo, se você quiser usar a lógica condicional para verificar se um valor está presente em um determinado atributo de um dicionário. Como alternativa, você pode deixá-lo invocar um filtro, passando o nome do filtro e os argumentos depois.

Calcula o hash md5 do objeto em questão

Subtrai uma quantidade de tempo de um objeto de data/hora.

Multiplica um valor por um número. Funciona da mesma forma que o operador *.

Adiciona uma quantidade de tempo a um objeto de data/hora.

Imprime uma variável. Imprime o tipo de variável e outras informações úteis para a depuração.

Retorna um item aleatório da sequência.

Procura um padrão regex e o substitui por uma sequência de caracteres. O primeiro argumento é um padrão regex no estilo RE2; o segundo é a string de substituição.

Informações sobre a sintaxe regex RE2 podem ser encontradas aqui.

Filtra uma sequência de objetos aplicando um teste de expressão ao objeto e rejeitando aqueles que passaram com sucesso no teste.

Filtra uma sequência de objetos aplicando um teste a um atributo de um objeto e rejeitando aqueles que passaram com sucesso no teste. 

Renderiza rapidamente as strings que contêm HubL para que a saída possa ser passada para outros filtros.

Substitui todas as instâncias de uma substring por uma nova. 

Reverte o objeto ou retorna um iterador que itera sobre ele ao contrário. Para reverter uma lista, use .reverse()

Calcula a raiz quadrada de um valor.

Arredonde o número para uma determinada precisão.

Marque o valor como seguro, o que significa que, em um ambiente com escape automático habilitado, esta variável não sofrerá escape.

Limpa o conteúdo de uma entrada HTML para a saída de conteúdo de rich text. Aceita uma string e, em seguida, remove as tags HTML que não são permitidas. Use esse filtro para variáveis HubL usadas em HTML que devem permitir HTML seguro.

Ao usar esse filtro, você pode incluir os seguintes parâmetros para permitir tipos específicos de tags HTML: FORMATTING, BLOCKS, STYLES, LINKS, TABLES, IMAGES. Por exemplo, sanitize_html(IMAGES).

Usar sanitize_html incluirá todos os parâmetros no filtro.

Você também pode incluir um parâmetro STRIP para remover todo o HTML. Todo o conteúdo também é executado por escape_jinjava para evitar interpretações aninhadas.

Filtra uma sequência de objetos, aplicando um teste ao objeto e selecionando apenas aqueles que passaram com sucesso no teste.

Filtra uma sequência de objetos aplicando um teste a um atributo de um objeto e selecionando apenas aqueles que passaram com sucesso no teste.

Randomiza a ordem de iteração por uma sequência. O exemplo abaixo randomiza um loop padrão do blog.

Divide um iterador e retorna uma lista de listas que contêm esses itens. O primeiro parâmetro especifica quantos itens serão divididos, e o segundo parâmetro especifica os caracteres para preencher as divisões vazias.

Classifica um iterável. Este filtro requer todos os parâmetros para classificar por um atributo no HubSpot. O primeiro parâmetro é um booleano para inverter a ordem de classificação. O segundo parâmetro determina se a classificação diferencia ou não maiúsculas de minúsculas. E o parâmetro final especifica por qual atributo classificar. No exemplo abaixo, os posts de um blog foram renderizados e classificados em ordem alfabética por nome.

Divide a string de entrada em uma lista em um determinado separador. O primeiro parâmetro especifica o separador pelo qual a variável deve ser dividida. O segundo parâmetro determina quantas vezes a variável deve ser dividida. Qualquer item restante permanece agrupado. No exemplo abaixo, uma string de nomes é dividida no ";" para os quatro primeiros nomes.

Converte um tipo de variável diferente em uma string. No exemplo abaixo, um número inteiro é convertido em uma string (pprint é usado para confirmar a mudança no tipo de variável).

Remove as tags SGML/XML e substitua o espaço em branco adjacente por um espaço. Este filtro pode ser usado para remover quaisquer tags HTML de uma variável.

Converte uma string e um formato de data/hora em um objeto de data/hora.

Soma valores numéricos em uma sequência. O primeiro parâmetro pode especificar um atributo opcional e o segundo parâmetro define o valor a retornar se não houver nada na variável a somar.

Este filtro retorna a diferença simétrica entre dois conjuntos ou listas. A lista retornada pelo filtro contém todos os elementos únicos que estão na primeira lista, mas não na segunda, ou que estão na segunda lista, mas não na primeira

Retorna uma versão em titlecase do valor. Ou seja, as palavras começarão com letras maiúsculas e todos os caracteres restantes estarão em letra minúscula.

Escreve um objeto como uma string JSON.

Remove espaços em branco antes e depois. O HubSpot já remove os espaços em branco da marcação, mas este filtro está documentado por uma questão de abrangência.

Corta o texto após um certo número de caracteres. O padrão é 255. Observe que os caracteres HTML estão incluídos nesta contagem. O comprimento é especificado pelo primeiro parâmetro, que é 255 por padrão. Se o segundo parâmetro for verdadeiro, o filtro cortará o texto no comprimento. Caso contrário, descartará a última palavra. Se o texto foi, de fato, truncado, um sinal de elipse ("...") será adicionado. Se você quiser um sinal de elipse diferente de "...", poderá especificá-lo usando o terceiro parâmetro.

Trunca uma determinada string, respeitando a marcação html (ou seja, fecha adequadamente todas as tags aninhadas). Isso evita que uma tag permaneça aberta após o truncamento. Os caracteres HTML não são contabilizados no total de caracteres. Este filtro tem um parâmetro de comprimento e um parâmetro de símbolo de truncagem. Há um terceiro parâmetro booleano que especifica se as palavras serão quebradas em comprimento. Este parâmetro é falso por padrão, a fim de preservar o comprimento das palavras. Se utilizar apenas um dos parâmetros opcionais, utilize argumentos de palavras-chave, tais como truncatehtml(70, breakwords = false).

Este filtro retorna a união de dois conjuntos ou listas. A lista retornada pelo filtro contém todos os elementos únicos que estão em ambas as listas.

Este filtro extrai um conjunto único de uma sequência ou dicionário de objetos. Ao filtrar um dicionário, como uma lista de posts retornados por uma função, você pode especificar qual atributo é usado para deduplicar itens no dicionário.

Este filtro converte um objeto datetime em um carimbo de data/hora unix.

Converte as letras de um valor para todas maiúsculas.

Escapes e URL codificam uma string usando a formatação UTF-8. Aceita dicionários e strings regulares, bem como iteráveis em pares.

Decodifica as strings de URL codificadas para a URL original. Aceita dicionários e strings regulares, bem como iteráveis em pares.

Converte URLs de texto simples em links clicáveis. Se você passar um número inteiro adicional para o filtro, ele encurtará as urls para esse número. O segundo parâmetro é um booleano que determina se o link é rel="no follow". O parâmetro final permite especificar se o link será aberto em uma nova aba.

Conta o número de palavras de uma string.

Insere uma quebra nas palavras após um determinado número de caracteres. Funciona melhor em um <pre> porque o HubSpot remove os espaços em branco por padrão.

Cria uma string de atributos HTML/XML, com base nos itens de um dicionário. Todos os valores que não são "nenhum"
nem "indefinidos" são ignorados automaticamente. Se o filtro retornar algo, adiciona automaticamente um espaço na frente do item, a menos que o primeiro parâmetro seja falso.