Biblioteca pagina.php

Caminho no Gestor bibliotecas/pagina.php

A pagina.php reúne atalhos sobre $_GESTOR['pagina'], o HTML da página que o módulo está montando, e sobre os marcadores de variável global. Todas as funções são finas camadas sobre a biblioteca modelo.php.

Ela não vem carregada. Peça pagina no JSON do módulo (fazem isso admin-paginas, pages-index e publisher-pages) ou use gestor_incluir_biblioteca('pagina').

Marcadores de variável global

Os marcadores são definidos em gestor/config.php:

Células da página

• pagina_celula($nome, $comentario = false, $apagar = false) recorta o bloco <!-- nome < -->…<!-- nome > --> de $_GESTOR['pagina'] e devolve o conteúdo. No lugar, deixa o marcador <!-- nome --> (para reinserir com pagina_celula_incluir()) ou nada, se $apagar for true. Com $comentario = true, o formato do bloco passa a ser <!-- nome [[ … ]] nome --> e o marcador deixado é <!-- [[nome]] -->.

• pagina_celula_incluir($celula, $valor) insere $valor antes do marcador <!-- celula -->, mantendo o marcador, o que permite chamá-la em loop para repetir linhas.

Trocar variáveis globais

• pagina_trocar_variavel_valor($variavel, $valor, $variavelEspecifica = false) troca, em toda a $_GESTOR['pagina'], @[[variavel]]@ por $valor. Com $variavelEspecifica = true, procura a string literal $variavel, sem acrescentar os marcadores.

• pagina_celula_trocar_variavel_valor($celula, $variavel, $valor, $variavelEspecifica = false) faz o mesmo numa string de célula e devolve o resultado (valor null vira vazio).

• pagina_trocar_variavel(['codigo' => …, 'variavel' => …, 'valor' => …]) faz o mesmo em qualquer string. Devolve null se faltar algum dos três parâmetros.

As três usam modelo_var_troca_tudo(): trocam todas as ocorrências, sem diferenciar maiúsculas de minúsculas. pagina_trocar_variavel_valor() não faz nada se $valor for null.

Mascarar para o banco

• pagina_variaveis_globais_mascarar(['valor' => …]) converte [[x]] em @[[x]]@: é o que acontece quando um editor salva conteúdo digitado pelo usuário.

• pagina_variaveis_globais_desmascarar(['valor' => …]) faz o caminho inverso, @[[x]]@ → [[x]], para exibir no editor.

Nenhuma das funções de variável tem chamadores no core hoje. Os módulos fazem a mesma coisa diretamente com modelo_var_troca_tudo() e preg_replace().

Veja também

• Biblioteca modelo.php

• Bibliotecas do Gestor

Funções (referência gerada)

pagina_celula(string $nome, bool $comentario = false, bool $apagar = false): string

pagina_celula_trocar_variavel_valor(string $celula, string $variavel, string $valor, bool $variavelEspecifica = false): string

pagina_celula_incluir(string $celula, string $valor): void

pagina_trocar_variavel_valor(string $variavel, string $valor, bool $variavelEspecifica = false): void

pagina_trocar_variavel(array|false $params = false): string|null

pagina_variaveis_globais_mascarar(array|false $params = false): string

pagina_variaveis_globais_desmascarar(array|false $params = false): string