Documentation du code de SPIP et de ses plugins

Développement

API Documentation

Table of Contents

Constants

_AJAX  = false
_DEBUG_MINIPRES  = \true
_DOCTYPE_ECRIRE  = ''

Functions

bel_env()  : string
Une fonction récursive pour joliment afficher #ENV, #GET, #SESSION... en squelette : [(#ENV|bel_env)], [(#GET|bel_env)], [(#SESSION|bel_env)] ou encore [(#ARRAY{0,1, a,#SESSION, 1,#ARRAY{x,y}}|bel_env)]
filtre_dev_afficher_code_dist()  : string
Afficher un bloc de code informatique avec coloration syntaxique si possible.
dev_show_usage_memoire()  : bool
affiche_usage_memoire()  : mixed
formulaires_charter_charger_dist()  : array<string|int, mixed>
Chargement des valeurs
formulaires_charter_verifier_dist()  : array<string|int, mixed>
Verifier la saisie on simule des erreurs si on a clique sur annuler
formulaires_charter_traiter_dist()  : array<string|int, mixed>
Traitement de la saisie
formulaires_charter_compat_charger_dist()  : array<string|int, mixed>
Chargement des valeurs
formulaires_charter_compat_verifier_dist()  : array<string|int, mixed>
Verifier la saisie on simule des erreurs si on a clique sur annuler
formulaires_charter_compat_traiter_dist()  : mixed
Traitement de la saisie
formulaires_charter_mini_charger_dist()  : array<string|int, mixed>
Chargement des valeurs
formulaires_charter_mini_verifier_dist()  : array<string|int, mixed>
Verifier la saisie on simule des erreurs si on a clique sur annuler
formulaires_charter_mini_traiter_dist()  : mixed
Traitement de la saisie
install_debut_html()  : string
Retourne le début d'une page HTML minimale (de type installation ou erreur)
install_fin_html()  : string
Retourne la fin d'une page HTML minimale (de type installation ou erreur)
minipres()  : string
Retourne une page HTML contenant, dans une présentation minimale, le contenu transmis dans `$titre` et `$corps`.

Constants

Functions

bel_env()

Une fonction récursive pour joliment afficher #ENV, #GET, #SESSION... en squelette : [(#ENV|bel_env)], [(#GET|bel_env)], [(#SESSION|bel_env)] ou encore [(#ARRAY{0,1, a,#SESSION, 1,#ARRAY{x,y}}|bel_env)]

bel_env(string|array<string|int, mixed> $env[, bool $afficher_en_clair = false ]) : string
Parameters
$env : string|array<string|int, mixed>

si une string est passée elle doit être le serialize d'un array

$afficher_en_clair : bool = false

si vrai indique qu'il faut afficher la chaine vide, la valeur null et les booleens respectivement comme '', null, true ou false.

Return values
string —

une chaîne html affichant une

filtre_dev_afficher_code_dist()

Afficher un bloc de code informatique avec coloration syntaxique si possible.

filtre_dev_afficher_code_dist(string $texte[, string $language = '' ]) : string

Retours :

  • sans plugin :
  • avec plugin version PrismJS :
  • avec plugin version Geshi :
Parameters
$texte : string
$language : string = ''

Type de code : html | spip

Return values
string

dev_show_usage_memoire()

dev_show_usage_memoire() : bool
Return values
bool

formulaires_charter_charger_dist()

Chargement des valeurs

formulaires_charter_charger_dist([string $suffixe = '' ]) : array<string|int, mixed>
Parameters
$suffixe : string = ''

Suffixe pour utiliser plusieurs fois le formulaire sur la même page

Return values
array<string|int, mixed>

formulaires_charter_verifier_dist()

Verifier la saisie on simule des erreurs si on a clique sur annuler

formulaires_charter_verifier_dist([string $suffixe = '' ]) : array<string|int, mixed>
Parameters
$suffixe : string = ''

Suffixe pour utiliser plusieurs fois le formulaire sur la même page

Return values
array<string|int, mixed>

formulaires_charter_traiter_dist()

Traitement de la saisie

formulaires_charter_traiter_dist([string $suffixe = '' ]) : array<string|int, mixed>
Parameters
$suffixe : string = ''

Suffixe pour utiliser plusieurs fois le formulaire sur la même page

Return values
array<string|int, mixed>

formulaires_charter_compat_charger_dist()

Chargement des valeurs

formulaires_charter_compat_charger_dist() : array<string|int, mixed>
Return values
array<string|int, mixed>

formulaires_charter_compat_verifier_dist()

Verifier la saisie on simule des erreurs si on a clique sur annuler

formulaires_charter_compat_verifier_dist() : array<string|int, mixed>
Return values
array<string|int, mixed>

formulaires_charter_compat_traiter_dist()

Traitement de la saisie

formulaires_charter_compat_traiter_dist() : mixed

formulaires_charter_mini_charger_dist()

Chargement des valeurs

formulaires_charter_mini_charger_dist([string $variante = '' ]) : array<string|int, mixed>
Parameters
$variante : string = ''
Return values
array<string|int, mixed>

formulaires_charter_mini_verifier_dist()

Verifier la saisie on simule des erreurs si on a clique sur annuler

formulaires_charter_mini_verifier_dist([string $variante = '' ]) : array<string|int, mixed>
Parameters
$variante : string = ''
Return values
array<string|int, mixed>

formulaires_charter_mini_traiter_dist()

Traitement de la saisie

formulaires_charter_mini_traiter_dist([string $variante = '' ]) : mixed
Parameters
$variante : string = ''

install_debut_html()

Retourne le début d'une page HTML minimale (de type installation ou erreur)

install_debut_html([string $titre = 'AUTO' ][, string $onLoad = '' ][, bool $all_inline = false ]) : string

Le contenu de CSS minimales (reset.css, clear.css, minipres.css) est inséré dans une balise script inline (compactée si possible)

Parameters
$titre : string = 'AUTO'

Titre. AUTO, indique que l'on est dans le processus d'installation de SPIP

$onLoad : string = ''

Attributs pour la balise <body>

$all_inline : bool = false

Inliner les css et js dans la page (limiter le nombre de hits)

Tags
uses
utiliser_langue_visiteur()
uses
http_no_cache()
uses
html_lang_attributes()
uses
compacte()

si le plugin compresseur est présent

uses
url_absolue_css()
used-by
minipres()
Return values
string —

Code HTML

install_fin_html()

Retourne la fin d'une page HTML minimale (de type installation ou erreur)

install_fin_html() : string
Return values
string —

Code HTML

minipres()

Retourne une page HTML contenant, dans une présentation minimale, le contenu transmis dans `$titre` et `$corps`.

minipres([string $titre = '' ][, string $corps = '' ][, array<string|int, mixed> $options = [] ]) : string

Appelée pour afficher un message d’erreur (l’utilisateur n’a pas accès à cette page par exemple).

Lorsqu’aucun argument n’est transmis, un header 403 est renvoyé, ainsi qu’un message indiquant une interdiction d’accès.

Parameters
$titre : string = ''

Titre de la page

$corps : string = ''

Corps de la page

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

string onload : Attribut onload de <body> bool all_inline : Inliner les css et js dans la page (limiter le nombre de hits) int status : status de la page

Tags
example
include_spip('inc/minipres');
if (!autoriser('configurer')) {
   echo minipres();
   exit;
}
uses
install_debut_html()
uses
install_fin_html()
Return values
string —

HTML de la page


        
On this page

Search results