SPIP Code

Documentation du code de SPIP et de ses plugins

SPIP

Rubriques

Table of Contents

Packages

Edition
Formulaires

Constants

_SPIP_SELECT_RUBRIQUES  = 20

Functions

action_menu_rubriques_dist()  : string
Action d'affichage en ajax du navigateur de rubrique du bandeau
menu_rubriques()  : string
Retourne une liste HTML des rubriques et rubriques enfants
bandeau_rubrique()  : string
Retourne une liste HTML des rubriques enfants d'une rubrique
extraire_article()  : array<string|int, mixed>
Obtient la liste des rubriques enfants d'une rubrique, prise dans le cache du navigateur de rubrique
gen_liste_rubriques()  : bool
Génère le cache de la liste des rubriques pour la navigation du bandeau
action_supprimer_rubrique_dist()  : void
Effacer une rubrique
exec_selectionner_dist()  : mixed
Affichage en ajax du sélecteur (mini-navigateur) de rubrique AJAX
inc_chercher_rubrique_dist()  : string
Sélecteur de rubriques pour l'espace privé
style_menu_rubriques()  : array<string|int, mixed>
Styles appliqués sur le texte d'une rubrique pour créer visuellement une indentation en fonction de sa profondeur dans le sélecteur
sous_menu_rubriques()  : string
Sélecteur de sous rubriques pour l'espace privé
selecteur_rubrique_html()  : string
Sélecteur de rubriques pour l'espace privé en mode classique (menu)
selecteur_rubrique_ajax()  : string
Sélecteur de rubrique pour l'espace privé, en mode AJAX
construire_selecteur()  : string
Construit un bloc permettant d'activer le sélecteur de rubrique AJAX
inc_selectionner_dist()  : string
Affiche un mini-navigateur ajax positionné sur une rubrique
construire_selectionner_hierarchie()  : string
Construit le sélectionneur de hierarchie
mini_hier()  : array<string|int, mixed>
Récupère les identifiants de hierarchie d'une rubrique

Constants

_SPIP_SELECT_RUBRIQUES

public int _SPIP_SELECT_RUBRIQUES = 20

Nombre de rubriques maximum du sélecteur de rubriques. Au delà, on bascule sur un sélecteur ajax. mettre 100000 pour desactiver ajax

Functions

menu_rubriques()

Retourne une liste HTML des rubriques et rubriques enfants

menu_rubriques([bool $complet = true ]) : string
Parameters
$complet : bool = true
  • false pour n'avoir que le bouton racine «plan du site»
  • true pour avoir l'ensemble des rubriques en plus
Tags
used-by
action_menu_rubriques_dist()
Return values
string —

Code HTML présentant la liste des rubriques

bandeau_rubrique()

Retourne une liste HTML des rubriques enfants d'une rubrique

bandeau_rubrique(int $id_rubrique, string $titre_rubrique, int $zdecal[, int $profondeur = 1 ]) : string
Parameters
$id_rubrique : int

Identifiant de la rubrique parente

$titre_rubrique : string

Titre de cette rubrique

$zdecal : int

Décalage vertical, en nombre d'élément

$profondeur : int = 1

Profondeur du parent

Tags
uses
extraire_article()
Return values
string —

Code HTML présentant la liste des rubriques

extraire_article()

Obtient la liste des rubriques enfants d'une rubrique, prise dans le cache du navigateur de rubrique

extraire_article(int $id_p, array<string|int, mixed> $t) : array<string|int, mixed>
Parameters
$id_p : int

Identifiant de la rubrique parente des articles

$t : array<string|int, mixed>

Cache des rubriques

Tags
see
gen_liste_rubriques()

pour le calcul du cache

used-by
bandeau_rubrique()
Return values
array<string|int, mixed> —

Liste des rubriques enfants de la rubrique (et leur titre)

gen_liste_rubriques()

Génère le cache de la liste des rubriques pour la navigation du bandeau

gen_liste_rubriques() : bool

Le cache, qui comprend pour chaque rubrique ses rubriques enfants et leur titre, est :

  • réactualisé en fonction de la meta date_calcul_rubriques
  • mis en cache dans le fichier défini par la constante _CACHE_RUBRIQUES
  • stocké également dans la globale db_art_cache
Tags
used-by
action_menu_rubriques_dist()
Return values
bool —

true.

action_supprimer_rubrique_dist()

Effacer une rubrique

action_supprimer_rubrique_dist([null|int $id_rubrique = null ]) : void
Parameters
$id_rubrique : null|int = null

inc_chercher_rubrique_dist()

Sélecteur de rubriques pour l'espace privé

inc_chercher_rubrique_dist(int $id_rubrique, string $type, bool $restreint[, int $idem = 0 ][, string $do = 'aff' ]) : string
Parameters
$id_rubrique : int

Identifiant de rubrique courante (0 si NEW)

$type : string

Type de l'objet à placer.

Une rubrique peut aller à la racine mais pas dans elle-même, les articles et sites peuvent aller n'importe où (défaut), et les brèves dans les secteurs.

$restreint : bool

True pour indiquer qu'il faut limiter les rubriques affichées aux rubriques éditables par l'admin restreint

$idem : int = 0

En mode rubrique, identifiant de soi-même

$do : string = 'aff'

Type d'action

Tags
uses
selecteur_rubrique_html()
uses
selecteur_rubrique_ajax()
used-by
chercher_rubrique()
Return values
string —

Code HTML du sélecteur

style_menu_rubriques()

Styles appliqués sur le texte d'une rubrique pour créer visuellement une indentation en fonction de sa profondeur dans le sélecteur

style_menu_rubriques(int $i) : array<string|int, mixed>
Parameters
$i : int

Profondeur de la rubrique

Return values
array<string|int, mixed> —

Liste (classe CSS, styles en ligne, Espaces insécables)

sous_menu_rubriques()

Sélecteur de sous rubriques pour l'espace privé

sous_menu_rubriques(int $id_rubrique, int $root, int $niv, array<string|int, mixed> &$data, array<string|int, mixed> &$enfants, int $exclus, bool $restreint, string $type) : string
Parameters
$id_rubrique : int

Identifiant de parente

$root : int
$niv : int
$data : array<string|int, mixed>
$enfants : array<string|int, mixed>
$exclus : int
$restreint : bool

True pour indiquer qu'il faut limiter les rubriques affichées aux rubriques éditables par l'admin restreint

$type : string

Type de l'objet à placer.

Tags
uses
style_menu_rubriques()
used-by
selecteur_rubrique_html()
Return values
string —

Code HTML du sélecteur

selecteur_rubrique_html()

Sélecteur de rubriques pour l'espace privé en mode classique (menu)

selecteur_rubrique_html(int $id_rubrique, string $type, bool $restreint[, int $idem = 0 ]) : string
Parameters
$id_rubrique : int

Identifiant de rubrique courante (0 si NEW)

$type : string

Type de l'objet à placer.

$restreint : bool

True pour indiquer qu'il faut limiter les rubriques affichées aux rubriques éditables par l'admin restreint

$idem : int = 0

En mode rubrique, identifiant de soi-même

Tags
uses
sous_menu_rubriques()
used-by
inc_chercher_rubrique_dist()
Return values
string —

Code HTML du sélecteur

selecteur_rubrique_ajax()

Sélecteur de rubrique pour l'espace privé, en mode AJAX

selecteur_rubrique_ajax(int $id_rubrique, string $type, bool $restreint[, int $idem = 0 ][, string $do = 'aff' ]) : string
Parameters
$id_rubrique : int

Identifiant de rubrique courante (0 si NEW)

$type : string

Type de l'objet à placer.

$restreint : bool

True pour indiquer qu'il faut limiter les rubriques affichées aux rubriques éditables par l'admin restreint. Ne fonctionne actuellement pas ici.

$idem : int = 0

En mode rubrique, identifiant de soi-même

$do : string = 'aff'

Type d'action

Tags
note

$restreint indique qu'il faut limiter les rubriques affichées aux rubriques éditables par l'admin restreint... or, ca ne marche pas. Pour la version HTML c'est bon (cf. ci-dessus), mais pour l'ajax... je laisse ça aux spécialistes de l'ajax & des admins restreints

Toutefois c'est juste un pb d'interface, car question securite la vérification est faite à l'arrivée des données (Fil)

uses
construire_selecteur()
see
exec_selectionner_dist()

Pour l'obtention du contenu AJAX ensuite

used-by
inc_chercher_rubrique_dist()
Return values
string —

Code HTML du sélecteur

construire_selecteur()

Construit un bloc permettant d'activer le sélecteur de rubrique AJAX

construire_selecteur(string $url, string $js, string $idom, string $name[, string $init = '' ][, int $id = 0 ]) : string

Construit un bloc comportant une icone clicable avec image animée à côté pour charger en Ajax du code à mettre sous cette icone.

Parameters
$url : string

URL qui retournera le contenu du sélecteur en AJAX

$js : string

Code javascript ajouté sur onclick

$idom : string

Identifiant donné à l'image activant l'ajax et au block recevant son contenu

$name : string

Nom du champ à envoyer par le formulaire

$init : string = ''

Code HTML à l'intérieur de l'input titreparent

$id : int = 0

Valeur actuelle du champ

Tags
note

Attention: changer le onclick si on change le code Html. (la fonction JS charger_node ignore l'attribut id qui ne sert en fait pas; getElement en mode Ajax est trop couteux).

used-by
selecteur_rubrique_ajax()
Return values
string —

Code HTML du sélecteur de rubrique AJAX

inc_selectionner_dist()

Affiche un mini-navigateur ajax positionné sur une rubrique

inc_selectionner_dist(int $sel[, string $idom = '' ][, int $exclus = 0 ][, bool $aff_racine = false ][, bool $recur = true ][, string $do = 'aff' ]) : string
Parameters
$sel : int

Identifiant de la rubrique

$idom : string = ''

Identifiant dans le dom de l'élément

$exclus : int = 0
$aff_racine : bool = false
$recur : bool = true
$do : string = 'aff'

Type d'action

Tags
uses
mini_hier()
uses
construire_selectionner_hierarchie()
uses
inc_plonger_dist()
see
exec_rechercher_dist()
used-by
exec_selectionner_dist()
Return values
string —

Code HTML

construire_selectionner_hierarchie()

Construit le sélectionneur de hierarchie

construire_selectionner_hierarchie(string $idom, string $liste, int $racine, string $url, string $name[, string $url_init = '' ]) : string
Parameters
$idom : string

Identifiant dans le dom de l'élément

$liste : string
$racine : int
$url : string
$name : string
$url_init : string = ''
Tags
used-by
inc_selectionner_dist()
Return values
string —

Code HTML

mini_hier()

Récupère les identifiants de hierarchie d'une rubrique

mini_hier(int $id_rubrique) : array<string|int, mixed>
Parameters
$id_rubrique : int
Tags
used-by
inc_selectionner_dist()
Return values
array<string|int, mixed> —

Liste de tous les id_parent de la rubrique


        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results