Guia de referência de variáveis
Lista de variáveis do HyperFluxCMS
Veja a listagem das Variáveis do HyperFluxCMS que você pode utilizar no código das páginas.
O HyperFluxCMS permito o uso de dois tipos de variáveis nos templates e conteúdos das páginas. As variáveis de Tempo de Compilaçao (Compile-time) e as variáveis de Tempo de Execução (Runtime)
Variáveis de tempo de compilação, compile-time, são avaliadas e substituídas pelo respectivo valor no momento em que a postagem é criada ou editada.
Podem ser usadas, por exemplo, para inserir no meio do texto o título da própria página, ou a data da última atualização.
Uma variável Compile-time é indicada usando o símbolo de "@" seguido de "C" ou "c" (de Compile-time), depois ":" e em seguida o nome da variável, tudo isso sem espaços nem quebra de linha.
Por exemplo, @c:page.title é substituído pelo título da página.
| nome | significado |
|---|---|
| page.title | Retorna o título da postagem. |
| page.subtitle | Retorna o subtítulo da postagem. |
| page.summary | Retorna o resumo da postagem. |
| page.coverimage | Retorna o nome do arquivo que é a imagem de capa da postagem. |
| page.category | Retorna a primeira categoria a que a postagem pertence. |
| page.permalink | Retorna o link permanente para a postagem (sem incluir o nome do site). |
| page.id | Retorna um número identificador único e imutável da postagem no banco de dados. Note que ao se utilizar a opção de "Fazer/Restaurar backup" ou migrar o site para outro servidor, ou recriar o site, o page:id pode mudar. |
| page.categories | Retorna uma lista de categorias, separada por vírgula e espaço, a que a postagem pertence. |
| page.tags | Retorna uma lista de rótulos, separada por vírgula e espaço, que estão marcados na postagem. |
| page.keywords | Retorna uma lista de palavras-chave, separada por vírgula e espaço, que estão marcados na postagem. |
| page.authorname | Retorna o nome do autor original da postagem. |
| page.authorusername | Retorna o nome de usuário do autor original da postagem. |
| page.creationdate | Retorna a data e hora de criação da postagem, no formato aaaa-mm-dd hh:mm. Por exemplo, 2024-09-24 14:35. |
| page.editiondate | Retorna a data e hora de da última vez em que a postagem foi editado, no mesmo formato do page:creationdate. Se postagem foi escrita e nunca foi editada, esse valor é igual ao page:creationdate |
| page.userdata1 | Retorna o dado cadastrado em User Data 1 nas configurações da página. Reservado para uso futuro. |
| page.userdata2 | Retorna o dado cadastrado em User Data 2 nas configurações da página. Reservado para uso futuro. |
| page.userdata3 | Retorna o dado cadastrado em User Data 3 nas configurações da página. Reservado para uso futuro. |
Variáveis de tempo de execução, Runtime, são avaliadas e substituídas pelo repectivo valor no momento em que a postagem é acessada pelo visitante do site.
Podem ser usadas, por exemplo, para inserir no meio do texto o nome do site ou o endereço Web original do site.
Uma variável Runtime é indicada usando o símbolo de "@" seguido de "R" ou "r" (de Runtime), depois ":" e em seguida o nome da variável, tudo isso sem espaços nem quebra de linha.
Por exemplo, @r:site.name é substituído pelo Nome do Site, conforme estiver configurado nas opções de Configurações do Site.
| nome | significado |
|---|---|
| site.name | Retorna o nome do site, conforme informado na página de configurações do site. |
| site.subtitle | Retorna o subtítulo do site, conforme informado na página de configurações do site. |
| site.homeurl | Retorna o nome do site, conforme informado na página de configurações do site. |
| site.copyrightinfo | Retorna o texto de informações de copyright/direitos autorais do site, conforme informado na página de configurações do site. |
| system.errorname | Usado em páginas de erro. Retorna o nome do erro que provocou o carregamento da página de erro. |
| system.errordesc | Usado em páginas de erro. Retorna a descrição do erro que provocou o carregamento da página de erro. |
| system.errorcode | Usado em páginas de erro. Retorna o código do erro que provocou o carregamento da página de erro. |
| system.search-query-plain | Retorna a "search query" que chamou a página. Pode ser usada em javascript para páginas com uma experiência mais interativa. |
| author.name | Retorna o nome do autor original da postagem. |
| author.username | Retorna o username do autor original da postagem. |
| author.about | Retorna o texto ("Bio", "About", "Sobre mim") do autor original da postagem. |
Há uma certa sobreposição entre page.authorname e author.name. Pode parecer que fazem a mesma coisa. Mas há uma sutil diferença.
A variável page.authorname é avaliada em Tempo de Compilação. Se quando a postagem foi postada ou atualizada, o nome do author era John Doe, as referências à variável @c:page.authorname são todas substituídas por "John Doe" no momento em que a postagem é salva, e o código é gravado assim até que ela eventualmente seja atualizada novamente. Se o autor atualizar seu nome para "John Smith Doe", as postagens que já tinham sido salvas com "John Doe" não são automaticamente atualizadas.
A variável author.name é avaliada em Tempo de Execução. A pçostagem é salva não com o valor da variável no momento, mas com uma marcação indicando ao HyperFluxCMS para buscar e enviar a informação atualizada sempre que a postagem for acessada. Se a postagem foi salva quando o usuário se chamava John Doe, mas quando ela foi acessada o usuário já tinha atualizado seu nome para "John Smith Doe", a página que será exibida ao visitante já terá o dado atualizado.
A desvantagem de usar a segunda forma é que isso implica um overhead um pouco maior. Ou seja, exige um pouco mais de processamento e memória do servidor onde seu site está hospedado. Mas para a imensa maioria dos sites, a diferença é imperceptível, mesmo com milhares de acessos diários.
O mesmo se aplica às variáveis page.authorusername (Compile-time) e author.username (Runtime)
Artigos mais recentes
Você também pode gostar