Documentation du code de SPIP et de ses plugins

SPIP

Admin extends Page
in package

Présentation des pages simplifiées d’admin pour envoyer un message à un utilisateur

Tags
used-by
install_debut_html()
used-by
install_fin_html()
used-by
minipres()

Table of Contents

Constants

TYPE  = 'admin'

Methods

__construct()  : mixed
installDebutPage()  : string
Retourne le début d'une page HTML minimale (de type installation ou erreur)
installFinPage()  : string
Retourne le fin d'une page HTML minimale (de type installation ou erreur)
page()  : string
Retourne une page HTML contenant, dans une présentation minimale, le contenu transmis dans `$corps`.
pageErreur()  : string
Fonction helper pour les erreurs
fermeBody()  : string
Retourne la fin d'une page HTML minimale
fermeCorps()  : string
Ferme le corps : affiche le footer par défaut ou custom et ferme le div corps
ouvreBody()  : string
Retourne le début d'une page HTML minimale
ouvreCorps()  : string
Ouvre le corps : affiche le header avec un éventuel titre + ouvre le div corps
setOptions()  : mixed

Constants

Methods

installDebutPage()

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

public installDebutPage([array<string|int, mixed> $options = [] ]) : string
Parameters
$options : array<string|int, mixed> = []
Return values
string

Code HTML

installFinPage()

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

public installFinPage([array<string|int, mixed> $options = [] ]) : string
Parameters
$options : array<string|int, mixed> = []
Return values
string

Code HTML

page()

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

public page([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
$corps : string = ''

Corps de la page

$options : array<string|int, mixed> = []
Tags
see
ouvreBody()

string $titre : Titre à l'affichage (différent de $page_title) int $status : status de la page string $footer : pied de la box en remplacement du bouton retour par défaut

uses
ouvreBody()
uses
fermeBody()
Return values
string

HTML de la page

pageErreur()

Fonction helper pour les erreurs

public pageErreur([string|null $message_erreur = null ][, array<string|int, mixed> $options = [] ]) : string
Parameters
$message_erreur : string|null = null
$options : array<string|int, mixed> = []
Tags
see
page()
Return values
string

fermeBody()

Retourne la fin d'une page HTML minimale

protected fermeBody() : string
Return values
string

Code HTML

fermeCorps()

Ferme le corps : affiche le footer par défaut ou custom et ferme le div corps

protected fermeCorps([array<string|int, mixed> $options = [] ]) : string
Parameters
$options : array<string|int, mixed> = []
Return values
string

ouvreBody()

Retourne le début d'une page HTML minimale

protected ouvreBody([array<string|int, mixed> $options = [] ]) : string

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

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

string $lang : forcer la langue utilisateur string $page_title : titre éventuel de la page (nom du site par défaut) string $couleur_fond : pour la couleur dominante de la page (par défaut on reprend le réglage de la page de login) bool $all_inline : inliner les CSS pour envoyer toute la page en 1 hit string $doctype string $charset string $onload array $css_files : ajouter des fichiers css string $css : ajouter du CSS inline string $head : contenu à ajouter à la fin (pour inclusion de JS ou JS inline...)

Tags
uses
html_lang_attributes()
uses
minifier()

si le plugin compresseur est présent

uses
url_absolue_css()
uses
utiliser_langue_visiteur()
uses
http_no_cache()
Return values
string

Code HTML

ouvreCorps()

Ouvre le corps : affiche le header avec un éventuel titre + ouvre le div corps

protected ouvreCorps([mixed $options = [] ]) : string
Parameters
$options : mixed = []
Return values
string

setOptions()

protected setOptions(array<string|int, mixed> $options) : mixed
Parameters
$options : array<string|int, mixed>

        
On this page

Search results