Documentation du code de SPIP et de ses plugins

SPIP

editer_article.php

Gestion de l'action editer_article et de l'API d'édition d'un article

Table of Contents

Functions

action_editer_article_dist()  : array<string|int, mixed>
Action d'édition d'un article dans la base de données dont l'identifiant est donné en paramètre de cette fonction ou en argument de l'action sécurisée
article_modifier()  : string|null
Modifier un article
article_inserer()  : int
Insérer un nouvel article en base de données
article_instituer()  : string
Modification des statuts d'un article
editer_article_heritage()  : void|null
Fabrique la requête de modification de l'article, avec champs hérités
trop_longs_articles()  : void
Réunit les textes decoupés parce que trop longs

Functions

action_editer_article_dist()

Action d'édition d'un article dans la base de données dont l'identifiant est donné en paramètre de cette fonction ou en argument de l'action sécurisée

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

Si aucun identifiant n'est donné, on crée alors un nouvel article, à condition que la rubrique parente (id_rubrique) puisse être obtenue (avec _request())

Parameters
$arg : null|int = null

Identifiant de l'article. En absence utilise l'argument de l'action sécurisée.

Tags
uses
article_inserer()
uses
article_modifier()
Return values
array<string|int, mixed>

Liste (identifiant de l'article, texte d'erreur éventuel)

article_modifier()

Modifier un article

article_modifier(int $id_article[, array<string|int, mixed>|null $set = null ]) : string|null

Appelle toutes les fonctions de modification d'un article

Parameters
$id_article : int

Identifiant de l'article à modifier

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

Couples (colonne => valeur) de données à modifier. En leur absence, on cherche les données dans les champs éditables qui ont été postés (via collecter_requests())

Tags
used-by
action_editer_article_dist()
Return values
string|null
  • Chaîne vide si aucune erreur,
  • Null si aucun champ à modifier,
  • Chaîne contenant un texte d'erreur sinon.

article_inserer()

Insérer un nouvel article en base de données

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

En plus des données enregistrées par défaut, la fonction :

  • retrouve un identifiant de rubrique pour stocker l'article (la première rubrique racine) si l'identifiant de rubrique transmis est nul.
  • calcule la langue de l'article, soit
    • d'après la langue de la rubrique si les articles ne sont pas configurés comme pouvant être traduits,
    • d'après la langue de l'auteur en cours si les articles peuvent être traduits et si la langue de l'auteur est acceptée en tant que langue de traduction
  • crée une liaison automatiquement entre l'auteur connecté et l'article créé, de sorte que la personne devient par défaut auteur de l'article qu'elle crée.
Parameters
$id_rubrique : int

Identifiant de la rubrique parente

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

pre_insertion

pipeline_appel

post_insertion

global

array meta

global

array visiteur_session

global

string spip_lang

used-by
action_editer_article_dist()
Return values
int

Identifiant du nouvel article

article_instituer()

Modification des statuts d'un article

article_instituer(int $id_article, array<string|int, mixed> $c[, bool $calcul_rub = true ]) : string

Modifie la langue, la rubrique ou les statuts d'un article.

Parameters
$id_article : int

Identifiant de l'article

$c : array<string|int, mixed>

Couples (colonne => valeur) des données à instituer Les colonnes 'statut' et 'id_parent' sont liées, car un admin restreint peut deplacer un article publié vers une rubrique qu'il n'administre pas

$calcul_rub : bool = true

True pour changer le statut des rubriques concernées si un article change de statut ou est déplacé dans une autre rubrique

Tags
global

array $GLOBALS ['meta']

pipeline_appel

pre_edition

pipeline_appel

post_edition

Return values
string

Chaîne vide

editer_article_heritage()

Fabrique la requête de modification de l'article, avec champs hérités

editer_article_heritage(int $id_article, int $id_rubrique, string $statut, array<string|int, mixed> $champs[, bool $cond = true ]) : void|null
Parameters
$id_article : int

Identifiant de l'article

$id_rubrique : int

Identifiant de la rubrique parente

$statut : string

Statut de l'article (prop, publie, ...)

$champs : array<string|int, mixed>

Couples (colonne => valeur) des champs qui ont été modifiés

$cond : bool = true

True pour actualiser le statut et date de publication de la rubrique parente si nécessaire

Tags
global

array $GLOBALS ['meta']

Return values
void|null

null si aucune action à faire void sinon

trop_longs_articles()

Réunit les textes decoupés parce que trop longs

trop_longs_articles() : void

        
On this page

Search results