SPIP Code

Documentation du code de SPIP et de ses plugins

Saisies pour formulaires

Pile
in package

Conteneur pour modifier les arguments d'une balise SPIP (de classe Champ) à compiler

Tags
note

Ces fonctions visent à modifier l'AST (Arbre de Syntaxe Abstraite) issues de l'analyse du squelette. Très utile pour créer des balises qui transmettent des arguments supplémentaires automatiquement, à des balises déjà existantes. Voir un exemple d'utilisation dans balise_SAISIE_dist().

note

Les arguments sont stockés sont dans l'entree 0 de la propriété param dans l'objet Champ (représenté par $p), donc dans $p->param[0].

param[0][0] vaut toujours '' (ou presque ?)

see
balise_SAISIE_dist()

Pour un exemple d'utilisation

Table of Contents

Methods

ajouter_argument_balise()  : Champ
Ajoute un argument de balise
creer_argument_balise()  : array<string|int, mixed>
Crée l'élément de l'AST représentant un argument de balise.
creer_balise()  : Champ
Crée l'AST d'une balise
creer_et_ajouter_argument_balise()  : Champ
Crée et ajoute un argument à une balise
recuperer_argument_balise()  : mixed|null
Récupère un argument de balise
recuperer_et_supprimer_argument_balise()  : mixed|null
Retourne un argument de balise, et le supprime de la liste des arguments
supprimer_argument_balise()  : Champ
Supprime un argument de balise

Methods

ajouter_argument_balise()

Ajoute un argument de balise

public static ajouter_argument_balise(mixed $element, Champ $p) : Champ

Empile l'argument à la suite des arguments déjà existants pour la balise

Parameters
$element : mixed

Élément de l'AST représentant l'argument à ajouter

$p : Champ
Return values
Champ

creer_argument_balise()

Crée l'élément de l'AST représentant un argument de balise.

public static creer_argument_balise(string $nom[, string|object $valeur = null ]) : array<string|int, mixed>
Parameters
$nom : string

Nom de l'argument

$valeur : string|object = null

Valeur de l'argument. Peut être une chaîne de caractère ou un autre élément d'AST

Tags
example 
$nom = Pile::creer_argument_balise(nom);           // {nom}
$nom = Pile::creer_argument_balise(nom, 'coucou'); // {nom=coucou}

$balise = Pile::creer_balise('BALISE');
$nom = Pile::creer_argument_balise(nom, $balise);  // {nom=#BALISE}
used-by
Pile::creer_et_ajouter_argument_balise()
Return values
array<string|int, mixed>

creer_balise()

Crée l'AST d'une balise

public static creer_balise(string $nom[, array<string|int, mixed> $opt = [] ]) : Champ
Parameters
$nom : string

Nom de la balise

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

Options (remplira les propriétés correspondantes de l'objet Champ)

Tags
example 
// Crée : #ENV*{titre}
$titre = Pile::recuperer_argument_balise(1, $p); // $titre, 1er argument de la balise actuelle
$env = Pile::creer_balise('ENV', array('param' => array($titre), 'etoile' => '*'));
used-by
balise_SAISIE_dist()
used-by
balise_VOIR_SAISIE_dist()
Return values
Champ

creer_et_ajouter_argument_balise()

Crée et ajoute un argument à une balise

public static creer_et_ajouter_argument_balise(Champ $p, string $nom[, string|object $valeur = null ]) : Champ
Parameters
$p : Champ
$nom : string

Nom de l'argument

$valeur : string|object = null

Valeur de l'argument. Peut être une chaîne de caractère ou un autre élément d'AST

Tags
uses
Pile::creer_argument_balise()
uses
Pile::ajouter_argument_balise()
used-by
balise_CONFIGURER_SAISIE_dist()
used-by
balise_GENERER_SAISIES_dist()
used-by
balise_SAISIE_dist()
used-by
balise_VOIR_SAISIE_dist()
used-by
balise_VOIR_SAISIES_dist()
Return values
Champ

recuperer_argument_balise()

Récupère un argument de balise

public static recuperer_argument_balise(int $pos, Champ $p) : mixed|null
Parameters
$pos : int
$p : Champ
Return values
mixed|null —

Élément de l'AST représentant l'argument s'il existe

recuperer_et_supprimer_argument_balise()

Retourne un argument de balise, et le supprime de la liste des arguments

public static recuperer_et_supprimer_argument_balise(int $pos, Champ &$p) : mixed|null
Parameters
$pos : int
$p : Champ
Tags
uses
Pile::recuperer_argument_balise()
uses
Pile::supprimer_argument_balise()
used-by
balise_CONFIGURER_SAISIE_dist()
used-by
balise_GENERER_SAISIES_dist()
used-by
balise_SAISIE_dist()
used-by
balise_VOIR_SAISIE_dist()
used-by
balise_VOIR_SAISIES_dist()
Return values
mixed|null —

Élément de l'AST représentant l'argument s'il existe

supprimer_argument_balise()

Supprime un argument de balise

public static supprimer_argument_balise(int $pos, Champ $p) : Champ
Parameters
$pos : int
$p : Champ
Return values
Champ 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results