Documentation du code de SPIP et de ses plugins

SPIP

Champ
in package

Description d'un champ (balise SPIP)

Table of Contents

$apres  : null|string|array<string|int, mixed>
Partie optionnelle après
$avant  : null|string|array<string|int, mixed>
Partie optionnelle avant
$balise_calculee  : bool
Drapeau pour reperer les balises calculées par une fonction explicite
$boucles  : array<string|int, mixed>
AST du squelette, liste de toutes les boucles
$code  : string
Résultat de la compilation: toujours une expression PHP
$descr  : array<string|int, mixed>
Description du squelette
$etoile  : string|null
Étoiles : annuler des automatismes
$fonctions  : array<string|int, mixed>
Source des filtres (compatibilité) (?)
$id_boucle  : string
Identifiant de la boucle
$interdire_scripts  : bool
Interdire les scripts
$ligne  : int
Numéro de ligne dans le code source du squelette
$nom_boucle  : string|null
Identifiant de la boucle parente si explicité
$nom_champ  : string|null
Nom du champ demandé. Exemple 'ID_ARTICLE'
$param  : false|array<string|int, mixed>
Arguments et filtres explicites sur la balise
$type  : string
Type de noeud
$type_requete  : string|null
Alias de table d'application de la requête ou nom complet de la table SQL

Properties

$apres

Partie optionnelle après

public null|string|array<string|int, mixed> $apres

$avant

Partie optionnelle avant

public null|string|array<string|int, mixed> $avant

$balise_calculee

Drapeau pour reperer les balises calculées par une fonction explicite

public bool $balise_calculee = \false

$boucles

AST du squelette, liste de toutes les boucles

public array<string|int, mixed> $boucles

$code

Résultat de la compilation: toujours une expression PHP

public string $code = ''

$descr

Description du squelette

public array<string|int, mixed> $descr = []

Sert pour la gestion d'erreur et la production de code dependant du contexte

Peut contenir les index :

  • nom : Nom du fichier de cache
  • gram : Nom de la grammaire du squelette (détermine le phraseur à utiliser)
  • sourcefile : Chemin du squelette
  • squelette : Code du squelette
  • id_mere : Identifiant de la boucle parente
  • documents : Pour embed et img dans les textes
  • session : Pour un cache sessionné par auteur
  • niv : Niveau de tabulation

$etoile

Étoiles : annuler des automatismes

public string|null $etoile
  • '*' annule les filtres automatiques
  • '**' annule en plus les protections de scripts

$fonctions

Source des filtres (compatibilité) (?)

public array<string|int, mixed> $fonctions = []

$ligne

Numéro de ligne dans le code source du squelette

public int $ligne = 0

$nom_boucle

Identifiant de la boucle parente si explicité

public string|null $nom_boucle = ''

$nom_champ

Nom du champ demandé. Exemple 'ID_ARTICLE'

public string|null $nom_champ

$param

Arguments et filtres explicites sur la balise

public false|array<string|int, mixed> $param = []
  • $param[0] contient les arguments de la balise
  • $param[1..n] contient les filtres à appliquer à la balise

FIXME: type unique.

  • false: erreur de syntaxe

$type_requete

Alias de table d'application de la requête ou nom complet de la table SQL

public string|null $type_requete

Search results