pagina.php library

Path in the Gestor bibliotecas/pagina.php

pagina.php gathers shortcuts over $_GESTOR['pagina'], the HTML of the page the module is building, and over the global variable markers. Every function is a thin layer over the modelo.php library.

It is not loaded by default. Request pagina in the module JSON (admin-paginas, pages-index and publisher-pages do this) or use gestor_incluir_biblioteca('pagina').

Global variable markers

The markers are defined in gestor/config.php:

Page cells

• pagina_celula($nome, $comentario = false, $apagar = false) cuts the <!-- name < -->…<!-- name > --> block out of $_GESTOR['pagina'] and returns its content. In its place it leaves the <!-- name --> marker (to re-insert with pagina_celula_incluir()), or nothing when $apagar is true. With $comentario = true, the block format becomes <!-- name [[ … ]] name --> and the marker left behind is <!-- [[name]] -->.

• pagina_celula_incluir($celula, $valor) inserts $valor before the <!-- cell --> marker and keeps the marker, so it can be called in a loop to repeat rows.

Replacing global variables

• pagina_trocar_variavel_valor($variavel, $valor, $variavelEspecifica = false) replaces @[[variable]]@ with $valor across $_GESTOR['pagina']. With $variavelEspecifica = true, it looks for the literal string $variavel without adding the markers.

• pagina_celula_trocar_variavel_valor($celula, $variavel, $valor, $variavelEspecifica = false) does the same on a cell string and returns the result (a null value becomes empty).

• pagina_trocar_variavel(['codigo' => …, 'variavel' => …, 'valor' => …]) does the same on any string. It returns null when any of the three parameters is missing.

All three use modelo_var_troca_tudo(): they replace every occurrence, case-insensitively. pagina_trocar_variavel_valor() does nothing when $valor is null.

Masking for the database

• pagina_variaveis_globais_mascarar(['valor' => …]) turns [[x]] into @[[x]]@: this is what happens when an editor saves content typed by the user.

• pagina_variaveis_globais_desmascarar(['valor' => …]) does the reverse, @[[x]]@ → [[x]], for display in the editor.

None of the variable functions has callers in the core today. Modules do the same work directly with modelo_var_troca_tudo() and preg_replace().

See also

• modelo.php library

• Gestor libraries

Functions (generated reference)

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