SPIP Code

Documentation du code de SPIP et de ses plugins

SPIP

assembler.php

Ce fichier regroupe les fonctions permettant de calculer la page et les entêtes

Determine le contexte donne par l'URL (en tenant compte des reecritures) grace a la fonction de passage d'URL a id (reciproque dans urls/*php)

Table of Contents

Functions

assembler()  : mixed
calculer_contexte()  : array<string|int, mixed>
Calcul le contexte de la page
calculer_contexte_implicite()  : array<string|int, mixed>
Calculer le contexte implicite, qui n'apparait pas dans le ENV d'un cache mais est utilise pour distinguer deux caches differents
auto_content_type()  : mixed
inclure_page()  : mixed
public_produire_page_dist()  : array<string|int, mixed>
Produire la page et la mettre en cache lorsque c'est necessaire
inserer_balise_dynamique()  : mixed
inclure_balise_dynamique()  : string|void
Inclusion de balise dynamique Attention, un appel explicite a cette fonction suppose certains include
message_page_indisponible()  : mixed
arguments_balise_dyn_depuis_modele()  : mixed
gerer le flag qui permet de reperer qu'une balise dynamique a ete inseree depuis un modele utilisee dans les #FORMULAIRE_xx
creer_contexte_de_modele()  : mixed
styliser_modele()  : string
Router eventuellement un modele vers un autre * le modele doit etre declare dans la liste 'modeles' d'une table objet * il faut avoir un routeur de modele declare pour le meme objet
inclure_modele()  : string|false
Calcule le modele et retourne la mini-page ainsi calculee
spip_securise_valeur_env_modele()  : array<string|int, mixed>|float|int|mixed|string|array<string|int, string>|null
Sanitizer une valeur venant de _request() et passée à un modèle : on laisse passer les null, bool et numeriques (id et pagination), les @+nombre (pagination indirecte) ou sinon le \w + espace et tirets uniquement, pour les tris/sens tri etc mais rien de compliqué suceptible d'être interprété
evaluer_fond()  : mixed
page_base_href()  : mixed
envoyer_entetes()  : mixed
Envoyer les entetes (headers)

Functions

assembler()

assembler(mixed $fond[, string $connect = '' ]) : mixed
Parameters
$fond : mixed
$connect : string = ''

calculer_contexte()

Calcul le contexte de la page

calculer_contexte() : array<string|int, mixed>
Tags
uses
_CONTEXTE_IGNORE_LISTE_VARIABLES
see
nettoyer_uri_var()

lors du calcul d'une page spip etablit le contexte a partir des variables $_GET et $POST, purgees des fausses variables var*

Note : pour hacker le contexte depuis le fichier d'appel (page.php), il est recommande de modifier $_GET['toto'] (meme si la page est appelee avec la methode POST).

Return values
array<string|int, mixed> —

Un tableau du contexte de la page

calculer_contexte_implicite()

Calculer le contexte implicite, qui n'apparait pas dans le ENV d'un cache mais est utilise pour distinguer deux caches differents

calculer_contexte_implicite() : array<string|int, mixed>
Tags
staticvar

string $notes

Return values
array<string|int, mixed>

auto_content_type()

auto_content_type(mixed $page) : mixed
Parameters
$page : mixed

inclure_page()

inclure_page(mixed $fond, mixed $contexte[, string $connect = '' ]) : mixed
Parameters
$fond : mixed
$contexte : mixed
$connect : string = ''

public_produire_page_dist()

Produire la page et la mettre en cache lorsque c'est necessaire

public_produire_page_dist(string $fond, array<string|int, mixed> $contexte, int $use_cache, string $cache_key, array<string|int, mixed> $contexte_cache, array<string|int, mixed> &$page, int &$lastinclude[, string $connect = '' ]) : array<string|int, mixed>
Parameters
$fond : string
$contexte : array<string|int, mixed>
$use_cache : int
$cache_key : string
$contexte_cache : array<string|int, mixed>
$page : array<string|int, mixed>
$lastinclude : int
$connect : string = ''
Return values
array<string|int, mixed>

inserer_balise_dynamique()

inserer_balise_dynamique(mixed $contexte_exec, mixed $contexte_compil) : mixed
Parameters
$contexte_exec : mixed
$contexte_compil : mixed

inclure_balise_dynamique()

Inclusion de balise dynamique Attention, un appel explicite a cette fonction suppose certains include

inclure_balise_dynamique(string|array<string|int, mixed> $texte[, bool $echo = true ][, array<string|int, mixed> $contexte_compil = [] ]) : string|void
Parameters
$texte : string|array<string|int, mixed>
$echo : bool = true

Faut-il faire echo ou return

$contexte_compil : array<string|int, mixed> = []

contexte de la compilation

Return values
string|void

message_page_indisponible()

message_page_indisponible(mixed $page, mixed $contexte) : mixed
Parameters
$page : mixed
$contexte : mixed

arguments_balise_dyn_depuis_modele()

gerer le flag qui permet de reperer qu'une balise dynamique a ete inseree depuis un modele utilisee dans les #FORMULAIRE_xx

arguments_balise_dyn_depuis_modele(string|null $arg[, string $operation = 'set' ]) : mixed
Parameters
$arg : string|null
$operation : string = 'set'

creer_contexte_de_modele()

creer_contexte_de_modele(mixed $args) : mixed
Parameters
$args : mixed

styliser_modele()

Router eventuellement un modele vers un autre * le modele doit etre declare dans la liste 'modeles' d'une table objet * il faut avoir un routeur de modele declare pour le meme objet

styliser_modele(string $modele, int $id[, null|array<string|int, mixed> $contexte = null ]) : string
Parameters
$modele : string
$id : int
$contexte : null|array<string|int, mixed> = null

contexte eventuel : attention sa presence n'est pas garantie et il ne doit etre utilise que pour trouver le id_xx si pas de $id fourni (cas appel depuis styliser)

Return values
string

inclure_modele()

Calcule le modele et retourne la mini-page ainsi calculee

inclure_modele(string $type, int $id, array<string|int, mixed> $params, array<string|int, mixed> $lien[, string $connect = '' ][, array<string|int, mixed> $env = [] ]) : string|false
Parameters
$type : string

Nom du modele

$id : int
$params : array<string|int, mixed>

Paramètres du modèle

$lien : array<string|int, mixed>

Informations du lien entourant l'appel du modèle en base de données

$connect : string = ''
$env : array<string|int, mixed> = []
Return values
string|false

spip_securise_valeur_env_modele()

Sanitizer une valeur venant de _request() et passée à un modèle : on laisse passer les null, bool et numeriques (id et pagination), les @+nombre (pagination indirecte) ou sinon le \w + espace et tirets uniquement, pour les tris/sens tri etc mais rien de compliqué suceptible d'être interprété

spip_securise_valeur_env_modele( $valeur) : array<string|int, mixed>|float|int|mixed|string|array<string|int, string>|null
Parameters
$valeur :
Return values
array<string|int, mixed>|float|int|mixed|string|array<string|int, string>|null

evaluer_fond()

evaluer_fond(mixed $fond[, mixed $contexte = [] ][, string $connect = '' ]) : mixed
Parameters
$fond : mixed
$contexte : mixed = []
$connect : string = ''

page_base_href()

page_base_href(mixed &$texte) : mixed
Parameters
$texte : mixed

envoyer_entetes()

Envoyer les entetes (headers)

envoyer_entetes(mixed $entetes) : mixed

Ceux spécifiques à SPIP commencent par X-Spip

Parameters
$entetes : mixed 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results