editer_auteur.php
Gestion de l'action editer_auteur et de l'API d'édition d'un auteur
Table of Contents
Functions
- action_editer_auteur_dist() : array<string|int, mixed>
- Éditer ou créer un auteur
- auteur_inserer() : int
- Insérer un auteur en base
- auteur_modifier() : string|null
- Modifier un auteur
- auteur_associer() : string
- Associer un auteur à des objets listés
- auteur_dissocier() : string
- Dissocier un auteur des objets listés
- auteur_qualifier() : bool|int
- Qualifier le lien d'un auteur avec les objets listés
- auteur_instituer() : bool|string
- Modifier le statut d'un auteur, ou son login/pass
Functions
action_editer_auteur_dist()
Éditer ou créer un auteur
action_editer_auteur_dist([array<string|int, mixed>|null $arg = null ]) : array<string|int, mixed>
Si aucun identifiant d'auteur n'est donné, on crée alors un nouvel auteur.
Parameters
- $arg : array<string|int, mixed>|null = null
-
Identifiant de l'auteur. En absence utilise l'argument de l'action sécurisée.
Tags
Return values
array<string|int, mixed> —Liste (identifiant de l'auteur, texte d'erreur éventuel)
auteur_inserer()
Insérer un auteur en base
auteur_inserer([string|null $source = null ][, array<string|int, mixed>|null $set = null ]) : int
Parameters
- $source : string|null = null
-
D'où provient l'auteur créé ? par défaut 'spip', mais peut être 'ldap' ou autre.
- $set : array<string|int, mixed>|null = null
Tags
Return values
int —Identifiant de l'auteur créé
auteur_modifier()
Modifier un auteur
auteur_modifier(int $id_auteur[, array<string|int, mixed>|null $set = null ][, bool $force_update = false ]) : string|null
Appelle toutes les fonctions de modification d'un auteur
Parameters
- $id_auteur : int
-
Identifiant de l'auteur
- $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())
- $force_update : bool = false
-
Permet de forcer la maj en base des champs fournis, sans passer par instancier. Utilise par auth/spip
Tags
Return values
string|null —- Chaîne vide si aucune erreur,
- Chaîne contenant un texte d'erreur sinon.
auteur_associer()
Associer un auteur à des objets listés
auteur_associer(int $id_auteur, array<string|int, mixed> $objets[, array<string|int, mixed>|null $qualif = null ]) : string
Parameters
- $id_auteur : int
-
Identifiant de l'auteur
- $objets : array<string|int, mixed>
-
Liste sous la forme
array($objet=>$id_objets,...).$id_objetspeut lui-même être un scalaire ou un tableau pour une liste d'objets du même type. - $qualif : array<string|int, mixed>|null = null
-
Optionnellement indique une qualification du (des) lien(s) qui sera alors appliquée dans la foulée. En cas de lot de liens, c'est la même qualification qui est appliquée à tous
Tags
Return values
stringauteur_dissocier()
Dissocier un auteur des objets listés
auteur_dissocier(int $id_auteur, array<string|int, mixed> $objets) : string
Parameters
- $id_auteur : int
-
Identifiant de l'auteur
- $objets : array<string|int, mixed>
-
Liste sous la forme
array($objet=>$id_objets,...).$id_objetspeut lui-même être un scalaire ou un tableau pour une liste d'objets du même type.Un
*pour $id_auteur,$objet,$id_objet permet de traiter par lot
Tags
Return values
stringauteur_qualifier()
Qualifier le lien d'un auteur avec les objets listés
auteur_qualifier(int $id_auteur, array<string|int, mixed> $objets, array<string|int, mixed> $qualif) : bool|int
Parameters
- $id_auteur : int
-
Identifiant de l'auteur
- $objets : array<string|int, mixed>
-
Liste sous la forme
array($objet=>$id_objets,...).$id_objetspeut lui-même être un scalaire ou un tableau pour une liste d'objets du même type.Un
*pour $id_auteur,$objet,$id_objet permet de traiter par lot - $qualif : array<string|int, mixed>
-
Couples (colonne, valeur) tel que
array('vu'=>'oui');
Tags
Return values
bool|intauteur_instituer()
Modifier le statut d'un auteur, ou son login/pass
auteur_instituer(int $id_auteur, array<string|int, mixed> $c[, bool $force_webmestre = false ]) : bool|string
Parameters
- $id_auteur : int
-
Identifiant de l'auteur
- $c : array<string|int, mixed>
-
Couples (colonne => valeur) des données à instituer
- $force_webmestre : bool = false
-
Autoriser un auteur à passer webmestre (force l'autorisation)