Documentation du code de SPIP et de ses plugins

SPIP

chercher_rubrique.php

Gestion du sélecteur de rubrique pour les objets éditoriaux s'insérant dans une hiérarchie de rubriques

Table of Contents

Constants

_SPIP_SELECT_RUBRIQUES  = 20

Functions

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

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

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


        
On this page

Search results