Documentation du code de SPIP et de ses plugins

SPIP

drapeau_edition.php

Gestion des drapeaux d'édition

Drapeau d'edition : on regarde qui a ouvert quel objet éditorial en édition, et on le signale aux autres redacteurs pour éviter de se marcher sur les pieds

Le format est une meta drapeau_edition qui contient un tableau sérialisé type_objet => (id_objet => (id_auteur => (nom_auteur => (date_modif))))

À chaque mise à jour de ce tableau on oublie les enregistrements datant de plus d'une heure

Attention ce n'est pas un verrou "bloquant", juste un drapeau qui signale que l'on bosse sur cet objet editorial ; les autres peuvent passer outre (en cas de communication orale c'est plus pratique)

Table of Contents

Functions

lire_tableau_edition()  : array<string|int, mixed>
Retourne le tableau des éléments édités en cours après avoir supprimé les éléments trop vieux (de plus d'une heure) du tableau.
ecrire_tableau_edition()  : mixed
Enregistre la liste des éléments édités
signale_edition()  : mixed
Signale qu'un auteur édite tel objet
qui_edite()  : array<string|int, mixed>
Qui édite mon objet ?
mention_qui_edite()  : array<string, string>
Afficher les auteurs ayant édités récemment l'objet.
liste_drapeau_edition()  : array<string|int, mixed>
Quels sont les objets en cours d'édition par `$id_auteur` ?
debloquer_tous()  : void
Quand l'auteur veut libérer tous ses objets (tous types)
debloquer_edition()  : void
Quand l'auteur libère un objet précis

Functions

lire_tableau_edition()

Retourne le tableau des éléments édités en cours après avoir supprimé les éléments trop vieux (de plus d'une heure) du tableau.

lire_tableau_edition() : array<string|int, mixed>
Tags
uses
ecrire_tableau_edition()
used-by
liste_drapeau_edition()
used-by
debloquer_tous()
used-by
debloquer_edition()
Return values
array<string|int, mixed>

Tableau des éléments édités actuellement, par objet et auteur, du type : [ type d'objet ][id_objet][id_auteur][nom de l'auteur] = time()

signale_edition()

Signale qu'un auteur édite tel objet

signale_edition(int $id, array<string|int, mixed> $auteur[, string $type = 'article' ]) : mixed

Si l'objet est non éditable dans l'espace privé, ne pas retenir le signalement qui correspond à un process unique.

Parameters
$id : int

Identifiant de l'objet

$auteur : array<string|int, mixed>

Session de l'auteur

$type : string = 'article'

Type d'objet édité

Tags
see
lire_tableau_edition()
see
ecrire_tableau_edition()
used-by
liste_objets_bloques()

qui_edite()

Qui édite mon objet ?

qui_edite(int $id[, string $type = 'article' ]) : array<string|int, mixed>
Parameters
$id : int

Identifiant de l'objet

$type : string = 'article'

Type de l'objet

Tags
see
lire_tableau_edition()
Return values
array<string|int, mixed>

Tableau sous la forme ["id_auteur"]["nom de l'auteur"] = time()

mention_qui_edite()

Afficher les auteurs ayant édités récemment l'objet.

mention_qui_edite(int $id[, string $type = 'article' ]) : array<string, string>
Parameters
$id : int

Identifiant de l'objet

$type : string = 'article'

Type de l'objet

Return values
array<string, string>

Liste de tableaux ['nom_auteur_modif' => x|y|z, 'date_diff' => n]

liste_drapeau_edition()

Quels sont les objets en cours d'édition par `$id_auteur` ?

liste_drapeau_edition(int $id_auteur) : array<string|int, mixed>
Parameters
$id_auteur : int

Identifiant de l'auteur

Tags
uses
lire_tableau_edition()
used-by
liste_objets_bloques()
Return values
array<string|int, mixed>

Liste de tableaux ['objet' => x, 'id_objet' => n]


        
On this page

Search results