Documentation du code de SPIP et de ses plugins

SPIP

templating.php

Table of Contents

Functions

erreur_squelette()  : null|string
Génère une erreur de squelette
recuperer_fond()  : string|array<string|int, mixed>
Calcule un squelette avec un contexte et retourne son contenu

Functions

erreur_squelette()

Génère une erreur de squelette

erreur_squelette([bool|string|array<string|int, mixed> $message = '' ][, string|array<string|int, mixed>|object $lieu = '' ]) : null|string

Génère une erreur de squelette qui sera bien visible par un administrateur authentifié lors d'une visite de la page en erreur

Parameters
$message : bool|string|array<string|int, mixed> = ''
  • Message d'erreur (string|array)
  • false pour retourner le texte des messages d'erreurs
  • vide pour afficher les messages d'erreurs
$lieu : string|array<string|int, mixed>|object = ''

Lieu d'origine de l'erreur

Return values
null|string
  • Rien dans la plupart des cas
  • string si $message à false.

recuperer_fond()

Calcule un squelette avec un contexte et retourne son contenu

recuperer_fond(mixed $fond[, array<string|int, mixed> $contexte = [] ][, array<string|int, mixed> $options = [] ][, string $connect = '' ]) : string|array<string|int, mixed>

La fonction de base de SPIP : un squelette + un contexte => une page. $fond peut etre un nom de squelette, ou une liste de squelette au format array. Dans ce dernier cas, les squelettes sont tous evalues et mis bout a bout $options permet de selectionner les options suivantes :

  • trim => true (valeur par defaut) permet de ne rien renvoyer si le fond ne produit que des espaces ;
  • raw => true permet de recuperer la strucure $page complete avec entetes et invalideurs pour chaque $fond fourni.
Parameters
$fond : mixed
$contexte : array<string|int, mixed> = []
  • Informations de contexte envoyées au squelette, array('id_rubrique' => 8)
  • La langue est transmise automatiquement (sauf option étoile).
$options : array<string|int, mixed> = []

Options complémentaires :

  • trim : applique un trim sur le résultat (true par défaut)
  • raw : retourne un tableau d'information sur le squelette (false par défaut)
  • etoile : ne pas transmettre la langue au contexte automatiquement (false par défaut), équivalent de INCLURE*
  • ajax : gere les liens internes du squelette en ajax (équivalent du paramètre {ajax})
$connect : string = ''

Non du connecteur de bdd a utiliser

Return values
string|array<string|int, mixed>
  • Contenu du squelette calculé
  • ou tableau d'information sur le squelette.

        
On this page

Search results