Documentation du code de SPIP et de ses plugins

SPIP

bandeau.php

Table of Contents

Functions

definir_barre_contexte()  : array<string|int, mixed>
Calcule le contexte pour le menu du bandeau
definir_barre_boutons()  : array<string|int, mixed>
Définir la liste des boutons du haut et de ses sous-menus
trier_boutons_enfants_par_alpha()  : array<string|int, Bouton>
Trie les entrées des sous menus par ordre alhabétique
trier_boutons_enfants_par_favoris_alpha()  : array<string|int, Bouton>
Trie les entrées des sous menus par favoris (selon leur ordre) puis les autres par ordre alhabétique
bandeau_creer_url()  : string
Créer l'URL à partir de exec et args, sauf si c'est déjà une url formatée
inc_bandeau_dist()  : string
Construire tout le bandeau supérieur de l'espace privé
obtenir_menus_favoris()  : array<string|int, mixed>
Retourne la liste des noms d'entrées de menus favoris de l'auteur connecté

Functions

definir_barre_contexte()

Calcule le contexte pour le menu du bandeau

definir_barre_contexte([null|array<string|int, mixed> $contexte = null ]) : array<string|int, mixed>

La fonction tente de retrouver la rubrique et le secteur d'appartenance à partir du nom du fichier exec, si celui ci correspond à un objet éditorial de SPIP (et qu'il possède ces champs), et dans ce cas, l'ajoute au contexte.

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

contexte connu. S'il n'est pas transmis, on prend $_GET

Return values
array<string|int, mixed>

contexte

definir_barre_boutons()

Définir la liste des boutons du haut et de ses sous-menus

definir_barre_boutons([array<string|int, mixed> $contexte = [] ][, bool $icones = true ][, bool $autorise = true ]) : array<string|int, mixed>

On defini les boutons à mettre selon les droits de l'utilisateur puis on balance le tout au pipeline "ajouter_menus" pour que des plugins puissent y mettre leur grain de sel

Parameters
$contexte : array<string|int, mixed> = []
$icones : bool = true

Rechercher les icones

$autorise : bool = true

Ne renvoyer que les boutons autorisés

Return values
array<string|int, mixed>

trier_boutons_enfants_par_alpha()

Trie les entrées des sous menus par ordre alhabétique

trier_boutons_enfants_par_alpha(array<string|int, Bouton$menus[, bool $avec_favoris = false ]) : array<string|int, Bouton>
Parameters
$menus : array<string|int, Bouton>
$avec_favoris : bool = false

Si true, tri en premier les sous menus favoris, puis l'ordre alphabétique

Return values
array<string|int, Bouton>

trier_boutons_enfants_par_favoris_alpha()

Trie les entrées des sous menus par favoris (selon leur ordre) puis les autres par ordre alhabétique

trier_boutons_enfants_par_favoris_alpha(array<string|int, Bouton$menus) : array<string|int, Bouton>
Parameters
$menus : array<string|int, Bouton>
Tags
uses
trier_boutons_enfants_par_alpha()
Return values
array<string|int, Bouton>

bandeau_creer_url()

Créer l'URL à partir de exec et args, sauf si c'est déjà une url formatée

bandeau_creer_url(string $url[, string $args = '' ][, array<string|int, mixed>|null $contexte = null ]) : string
Parameters
$url : string
$args : string = ''
$contexte : array<string|int, mixed>|null = null
Return values
string

inc_bandeau_dist()

Construire tout le bandeau supérieur de l'espace privé

inc_bandeau_dist() : string
Return values
string

Code HTML du bandeau

obtenir_menus_favoris()

Retourne la liste des noms d'entrées de menus favoris de l'auteur connecté

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

        
On this page

Search results