Documentation du code de SPIP et de ses plugins

SPIP

editer_rubrique.php

Gestion de l'action editer_rubrique et de l'API d'édition des rubriques

Table of Contents

Functions

action_editer_rubrique_dist()  : array<string|int, mixed>
Action d'édition d'une rubrique
rubrique_inserer()  : int
Insérer une rubrique en base
rubrique_modifier()  : bool|string
Modifier une rubrique en base
editer_rubrique_breves()  : bool
Déplace les brèves d'une rubrique dans le secteur d'un nouveau parent
rubrique_instituer()  : string
Instituer une rubrique (changer son parent)

Functions

action_editer_rubrique_dist()

Action d'édition d'une rubrique

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

Crée la rubrique si elle n'existe pas encore Redirige après l'action sur _request('redirect') si présent

Parameters
$arg : null|int = null
  • null : vérifie la sécurité de l'action. Si ok, obtient l'identifiant de rubrique à éditer (oui 'oui' pour une nouvelle rubrique)
  • int : identifiant de rubrique dont on demande l'édition
Return values
array<string|int, mixed>

Liste : identifiant de la rubrique, message d'erreur éventuel.

rubrique_inserer()

Insérer une rubrique en base

rubrique_inserer(int $id_parent[, array<string|int, mixed>|null $set = null ]) : int
Parameters
$id_parent : int

Identifiant de la rubrique parente. 0 pour la racine.

$set : array<string|int, mixed>|null = null
Return values
int

Identifiant de la rubrique crée

rubrique_modifier()

Modifier une rubrique en base

rubrique_modifier(int $id_rubrique[, array<string|int, mixed>|null $set = null ]) : bool|string
Parameters
$id_rubrique : int

Identifiant de la rubrique modifiée

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

Tableau qu'on peut proposer en lieu et place de _request()

Return values
bool|string
  • false : Aucune modification, aucun champ n'est à modifier
  • chaîne vide : Vide si tout s'est bien passé
  • chaîne : texte d'un message d'erreur

editer_rubrique_breves()

Déplace les brèves d'une rubrique dans le secteur d'un nouveau parent

editer_rubrique_breves(int $id_rubrique, int $id_parent[, array<string|int, mixed> $c = [] ]) : bool

Si c'est une rubrique-secteur contenant des brèves, on ne deplace que si $confirme_deplace == 'oui', et change alors l'id_rubrique des brèves en question

Parameters
$id_rubrique : int

Identifiant de la rubrique déplacée

$id_parent : int

Identifiant du nouveau parent de la rubrique

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

Informations pour l'institution (id_rubrique, confirme_deplace)

Tags
todo

À déporter dans le plugin brèves via un pipeline ?

Return values
bool

true si le déplacement est fait ou s'il n'y a rien à faire false si la confirmation du déplacement n'est pas présente

rubrique_instituer()

Instituer une rubrique (changer son parent)

rubrique_instituer(int $id_rubrique, array<string|int, mixed> $c) : string

Change le parent d'une rubrique, si les autorisations sont correctes, mais n'accèpte pas de déplacer une rubrique dans une de ses filles, tout de même !

Recalcule les secteurs, les langues et déplace les brèves au passage.

Parameters
$id_rubrique : int

Identifiant de la rubrique à instituer

$c : array<string|int, mixed>

Informations pour l'institution (id_rubrique, confirme_deplace)

Tags
global

array $GLOBALS ['visiteur_session']

Return values
string

Chaîne vide : aucune erreur Chaîne : texte du message d'erreur


        
On this page

Search results