Variáveis e parâmetros

Entenda e use variáveis e parâmetros

As postagens e templates que você edita no HyperFluxCMS podem usar um recurso poderoso chamado Variáveis, que deixam o site mais dinâmico. Entenda pra que servem e como usá-las.

O HyperFluxCMS possui um recurso interessante que é o de VARIÁVEIS.

Variáveis são informações que podem ser incluídas nas páginas e que podem variar de acordo com as condições e são substituídas pelo conteúdo adequado na hora em que a página é visitada.

No HyperFluxCMS, uma variável é marcada por um sinal de arroba "@"; o tipo ("R" ou "r") para variáveis Runtime ou de Tempo de Execucão; "C" ou "c" para variáveis Compile-time ou de Tempo de Compilação; O sinal dois-pontos (":"); e o nome da variável. Tudo isso sem espaços nem quebra de linhas. Esse bloco todo será é substituído pelo valor da variável.

Existe ainda um terceiro tipo que é o Parâmetro. Um parâmetro é passado por uma página ou um Template quando chama um Template. Um Parâmetro é marcado por um sinal de arroba "@"; o tipo ("P" ou "p") O sinal dois-pontos (":"); e o nome do parâmetro. Tudo isso sem espaços nem quebra de linhas. Esse bloco todo será é substituído pelo valor da variável.

Exemplos:

Uma variável ou parâmetro pode ser usada em qualquer parte de uma postagem ou template, seja usando HTML, HyperCode ou HyperLite. Exceto em trechos de texto puro (delimitados por <<< >>>) e de HTML puro (delimitados por << >>).

Um exemplo de variável é o valor page.authorname. Se você incluir na postagem o texto @c:page.authorname, o texto será substituído pelo nome do usuário que criou a postagem.

Exemplo em HTML:

Aparece:

Redigido por John Doe

As variáveis HyperFluxCMS podem inclusive ser usadas em pequenos trechos de Javascript incorporado na postagem ou nos templates, normalmente para inicializar variáveis de Javascript que podem ser usadas por funções e scripts mais complexos.

Por exemplo, você pode inserir na postagem o texto abaixo. Depois dele ser carregado, a página terá na memória uma variável global chamada title que conterá o título da postagem e que poderá ser usada por funções em javascript.

Variáveis em Tempo de Compilação

Existem dois tipos de variáveis: As de Tempo de Execução e as de Tempo de Compilação.

As variáveis de Tempo de Compilação são substituídas pelo respectivo valor no momento em que a página ou template é salvo e compilado. Somente informações que estejam disponíveis no momento de salvamento e compilação podem ser usadas como variáveis de Tempo de Compilação.

Para usar uma variável de Tempo de Compilação, o nome da variável deve ser informado após @C: ou @c:

Exemplo:

insere o valor atual configurado como Título da Pagina, no valor em que era no momento em que a página foi salva e compilada.

Variáveis em Tempo de Execução

As variáveis de Tempo de Execução são substituídas pelo respectivo valor somente na hora que a página é acessada pelo visitante do site.

Para usar uma variável de Tempo de Execução, o nome da variável deve ser informado após @R: ou @r:

Exemplo:

insere o valor atual configurado como Nome do autor da Pagina, no valor em que era no momento em que a página foi acessada.

Qual usar?

Variáveis de tempo de compilação @c:xxxx são mais eficientes e usam menos recursos do servidor. Mas devem ser usadas somente para valores conhecidos e fixados no momento em que a página é salva.

Um exemplo é @c:page.title, pois mesmo que o autor ou editor mude o nome da página nas propriedades dela, o código será recompilado ao salvar, e @c:page.title continuará coerente.

Variáveis de tempo de compilação @r:xxxx exigem um pouco mais de recursos do servidor. Mas devem ser usados para inserir valores que podem variar independentemente do conteúdo da página.

Um exemplo é @r:site.name, que retorna o nome do site, pois pode ser que, depois que a postagem foi criada, alguém modifique o Nome do Site na página de Propriedades do Site; e se uma postagem página usasse essa variável como se fosse uma de tempo de execução como @c:site.name, o código seria compilado fixando o valor dessa propriedade no momento da compilação e estaria desatualizado quando a página for acessada.

Usar @r:site:name garante que o valor utilizado será o valor corrente no momento em que a página é acessada.

Para ver a lista de variáveis suportadas na versão atual do HyperFluxCMS, consulte o Guia de Referência de Variáveis.

Parametros

Parâmetros são substituídos pelo respectivo valor somente na hora que a página é acessada pelo visitante do site.

Parâmetros são usados exclusivamente dentro de templates. Os valores são informados pelas páginas ou outros templates que chamam os templates.

Por exemplo, ao se incluir a chamada a seguinte, é carregado o template chamado "pop-up" e é setado o valor do parâmetro "img" como "/image1.jpg" e o parâmetro "text" como "Lorem Ipsum".

Dentro do código do Template "pop-up", pode-se acessar os valores passados como parâmetro e usá-los em texto, elementos HTML, javascript, etc.