Documentation du code de SPIP et de ses plugins

SPIP

formulaire_admin.php

Ce fichier gère la balise dynamique `#FORMULAIRE_ADMIN`

Table of Contents

Functions

balise_FORMULAIRE_ADMIN()  : Champ
Compile la balise dynamique `#FORMULAIRE_ADMIN` qui des boutons d'administration dans l'espace public
balise_FORMULAIRE_ADMIN_stat()  : array<string|int, mixed>|string
Calculs de paramètres de contexte automatiques pour la balise FORMULAIRE_ADMIN
balise_FORMULAIRE_ADMIN_dyn()  : array<string|int, mixed>|string
Retourne le squelette d'affichage et le contexte de la balise FORMULAIRE_ADMIN
admin_objet()  : array<string|int, mixed>
Préparer le contexte d'environnement pour les boutons
admin_preview()  : string|array<string|int, mixed>
Détermine si l'élément est previsualisable
admin_lang()  : string
Régler les boutons dans la langue de l'admin (sinon tant pis)
admin_valider()  : string
Retourne une URL vers un validateur
admin_debug()  : string
Retourne une URL vers le mode debug, si l'utilisateur a le droit, et si c'est utile

Functions

balise_FORMULAIRE_ADMIN()

Compile la balise dynamique `#FORMULAIRE_ADMIN` qui des boutons d'administration dans l'espace public

balise_FORMULAIRE_ADMIN(Champ $p) : Champ

Cette balise permet de placer les boutons d'administrations dans un endroit spécifique du site. Si cette balise n'est pas présente, les boutons seront automatiquement ajoutés par SPIP si l'auteur a activé le cookie de correspondance.

Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
see
f_admin()
example
#FORMULAIRE_ADMIN
Return values
Champ

Pile complétée du code compilé

balise_FORMULAIRE_ADMIN_stat()

Calculs de paramètres de contexte automatiques pour la balise FORMULAIRE_ADMIN

balise_FORMULAIRE_ADMIN_stat(array<string|int, mixed> $args, array<string|int, mixed> $context_compil) : array<string|int, mixed>|string

On ne peut rien dire au moment de l'execution du squelette

Parameters
$args : array<string|int, mixed>
  • Classe CSS éventuelle
$context_compil : array<string|int, mixed>

Tableau d'informations sur la compilation

Return values
array<string|int, mixed>|string
  • Liste (statut, id) si un mode d'inscription est possible
  • chaîne vide sinon.

balise_FORMULAIRE_ADMIN_dyn()

Retourne le squelette d'affichage et le contexte de la balise FORMULAIRE_ADMIN

balise_FORMULAIRE_ADMIN_dyn([string $float = '' ][, string|array<string|int, mixed> $debug = '' ]) : array<string|int, mixed>|string
Parameters
$float : string = ''

Classe CSS éventuelle

$debug : string|array<string|int, mixed> = ''

Informations sur la page contenant une erreur de compilation

Tags
note

Les boutons admin sont mis d'autorité si absents donc une variable statique contrôle si FORMULAIRE_ADMIN a été vu.

Toutefois, si c'est le debuger qui appelle, il peut avoir recopié le code dans ses données et il faut le lui refournir. Pas question de recompiler: ca fait boucler ! Le debuger transmet donc ses données, et cette balise y retrouve son petit.

Return values
array<string|int, mixed>|string

Liste : Chemin du squelette, durée du cache, contexte

admin_objet()

Préparer le contexte d'environnement pour les boutons

admin_objet() : array<string|int, mixed>

Permettra d'afficher le bouton 'Modifier ce...' s'il y a un $id_XXX défini dans le contexte de la page

Tags
note

Attention à l'ordre dans la boucle: on ne veut pas la rubrique si un autre bouton est possible

Return values
array<string|int, mixed>

Tableau de l'environnement calculé

admin_preview()

Détermine si l'élément est previsualisable

admin_preview(string $type, int $id[, array<string|int, mixed>|null $desc = null ]) : string|array<string|int, mixed>
Parameters
$type : string

Type d'objet

$id : int

Identifinant de l'objet

$desc : array<string|int, mixed>|null = null

Description de la table

Return values
string|array<string|int, mixed>
  • Chaine vide si on est déjà en prévisu ou si pas de previsualisation possible
  • Tableau d'un élément sinon.

admin_lang()

Régler les boutons dans la langue de l'admin (sinon tant pis)

admin_lang() : string
Return values
string

Code de langue

admin_valider()

Retourne une URL vers un validateur

admin_valider() : string
Return values
string

admin_debug()

Retourne une URL vers le mode debug, si l'utilisateur a le droit, et si c'est utile

admin_debug() : string
Return values
string

        
On this page

Search results