Documentation du code de SPIP et de ses plugins

Révisions

suivi_versions.php

Fonctions de suivi de versions

Table of Contents

Functions

revisions_diff()  : string
Afficher un diff correspondant à une révision d'un objet
retrouver_champ_version_objet()  : void
Retrouver le champ d'un objet, pour une version demandée
revision_comparee()  : array<string|int, mixed>
Liste les champs modifiés par une version de révision donnée

Functions

revisions_diff()

Afficher un diff correspondant à une révision d'un objet

revisions_diff(int $id_objet, string $objet, int $id_version[, bool $court = false ]) : string
Parameters
$id_objet : int

Identifiant de l'objet

$objet : string

Objet

$id_version : int

Identifiant de la version

$court : bool = false
  • false : affiche le diff complet
  • true : indique juste la taille en octets des changements
Return values
string

Texte HTML du diff.

retrouver_champ_version_objet()

Retrouver le champ d'un objet, pour une version demandée

retrouver_champ_version_objet(string $objet, int $id_objet, int $id_version, string $champ, array<string|int, mixed> &$champs) : void

Si le champ n'est pas déjà présent dans la liste des champs ($champs), on remonte les versions à partir du id_version donné, jusqu'à récupérer une version qui contient ce champ. On complète alors la liste des champs avec la version du champ trouvée.

Parameters
$objet : string

Objet

$id_objet : int

Identifiant de l'objet

$id_version : int

Identifiant de la version

$champ : string

Le nom du champ à retrouver

$champs : array<string|int, mixed>

Liste des champs déjà connus

Tags
used-by
recuperer_version_complete()

revision_comparee()

Liste les champs modifiés par une version de révision donnée

revision_comparee(int $id_objet, string $objet, int $id_version[, string $format = 'diff' ][, null $id_diff = null ]) : array<string|int, mixed>

Pour un couple objet/id_objet et id_version donné, calcule les champs qui ont été modifiés depuis une version précédente et la version d'id_version, et les retourne.

La version précédente est par défaut la version juste avant id_version, mais peut être définie via le paramètre id_diff.

Le retour est plus ou moins locace en fonction du paramètre format.

Parameters
$id_objet : int

Identifiant de l'objet

$objet : string

Objet

$id_version : int

Identifiant de la version

$format : string = 'diff'

Type de retour

  • diff => seulement les modifs (page revisions)
  • apercu => idem, mais en plus tres cout s'il y en a bcp
  • complet => tout, avec surlignage des modifications (page revision)
$id_diff : null = null

Identifiant de la version de base du diff, par défaut l'id_version juste précédent

Return values
array<string|int, mixed>

Couples (champ => texte)


        
On this page

Search results