SPIP Code

Documentation du code de SPIP et de ses plugins

Révisions

revisions.php

Fonctions utilitaires du plugin révisions

Table of Contents

Constants

_INTERVALLE_REVISIONS  = 600
Intervalle de temps (en seconde) separant deux révisions par un même auteur

Functions

separer_paras()  : array<string|int, string>
Découper les paragraphes d'un texte en fragments
replace_fragment()  : mixed
envoi_replace_fragments()  : mixed
envoi_delete_fragments()  : mixed
ajouter_fragments()  : mixed
supprimer_fragments()  : mixed
recuperer_fragments()  : array<string|int, mixed>
Récupérer les fragments d'un objet pour une version demandée
apparier_paras()  : mixed
recuperer_version_complete()  : array<string|int, mixed>
Retrouve les champs d'un objet et leurs contenus à une version donnée
recuperer_version()  : array<string|int, mixed>
Récupérer les champs d'un objet, pour une version demandée
reconstuire_version()  : array<string|int, mixed>
Reconstruire une version donnée
supprimer_versions()  : mixed
ajouter_version()  : int
Ajouter une version à un objet éditorial
propre_diff()  : mixed
liste_champs_versionnes()  : array<string|int, mixed>
Liste les champs versionnés d'une table objet.
recuperer_valeur_champ_jointure()  : string
Lorsqu'un champ versionée est une jointure, récuperer tous les liens et les mettre sous forme de liste énumérée
verifier_premiere_revision()  : int
Créer la première révision d'un objet si nécessaire

Constants

_INTERVALLE_REVISIONS

Intervalle de temps (en seconde) separant deux révisions par un même auteur

public mixed _INTERVALLE_REVISIONS = 600

Functions

separer_paras()

Découper les paragraphes d'un texte en fragments

separer_paras(string $texte[, array<string|int, mixed> $paras = [] ]) : array<string|int, string>
Parameters
$texte : string

Texte à fragmenter

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

Tableau de fragments déjà là

Return values
array<string|int, string> —

Tableau de fragments (paragraphes)

replace_fragment()

replace_fragment(mixed $id_objet, mixed $objet, mixed $version_min, mixed $version_max, mixed $id_fragment, mixed $fragment) : mixed
Parameters
$id_objet : mixed
$objet : mixed
$version_min : mixed
$version_max : mixed
$id_fragment : mixed
$fragment : mixed

envoi_replace_fragments()

envoi_replace_fragments(mixed $replaces) : mixed
Parameters
$replaces : mixed

envoi_delete_fragments()

envoi_delete_fragments(mixed $id_objet, mixed $objet, mixed $deletes) : mixed
Parameters
$id_objet : mixed
$objet : mixed
$deletes : mixed

ajouter_fragments()

ajouter_fragments(mixed $id_objet, mixed $objet, mixed $id_version, mixed $fragments) : mixed
Parameters
$id_objet : mixed
$objet : mixed
$id_version : mixed
$fragments : mixed

supprimer_fragments()

supprimer_fragments(mixed $id_objet, mixed $objet, mixed $version_debut, mixed $version_fin) : mixed
Parameters
$id_objet : mixed
$objet : mixed
$version_debut : mixed
$version_fin : mixed

recuperer_fragments()

Récupérer les fragments d'un objet pour une version demandée

recuperer_fragments(int $id_objet, string $objet, int $id_version) : array<string|int, mixed>
Parameters
$id_objet : int

Identifiant de l'objet

$objet : string

Objet

$id_version : int

Identifiant de la version

Return values
array<string|int, mixed> —

Couples id_fragment => texte

apparier_paras()

apparier_paras(mixed $src, mixed $dest[, mixed $flou = true ]) : mixed
Parameters
$src : mixed
$dest : mixed
$flou : mixed = true

recuperer_version_complete()

Retrouve les champs d'un objet et leurs contenus à une version donnée

recuperer_version_complete(int $id_objet, string $objet, int $id_version) : array<string|int, mixed>
Parameters
$id_objet : int

Identifiant de l'objet

$objet : string

Objet

$id_version : int

Identifiant de la version

Tags
uses
recuperer_version()
uses
liste_champs_versionnes()
uses
retrouver_champ_version_objet()
Return values
array<string|int, mixed> —

Couples champs => textes

recuperer_version()

Récupérer les champs d'un objet, pour une version demandée

recuperer_version(int $id_objet, string $objet, int $id_version) : array<string|int, mixed>
Parameters
$id_objet : int

Identifiant de l'objet

$objet : string

Objet

$id_version : int

Identifiant de la version

Tags
used-by
recuperer_version_complete()
Return values
array<string|int, mixed> —

Couples champs => textes

reconstuire_version()

Reconstruire une version donnée

reconstuire_version(array<string|int, mixed> $champs, array<string|int, mixed> $fragments[, array<string|int, mixed> $res = [] ]) : array<string|int, mixed>

À partir de la liste des champs et de fragments, retourne le texte de chaque champ.

Parameters
$champs : array<string|int, mixed>

Couples (champ => liste d'id_fragment). La liste est de la forme "5 32 7 16 8 2"

$fragments : array<string|int, mixed>

Couples (id_fragment => texte)

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

Couples (champ => texte) déjà connus

Return values
array<string|int, mixed> —

Couples (champ => texte)

supprimer_versions()

supprimer_versions(mixed $id_objet, mixed $objet, mixed $version_min, mixed $version_max) : mixed
Parameters
$id_objet : mixed
$objet : mixed
$version_min : mixed
$version_max : mixed

ajouter_version()

Ajouter une version à un objet éditorial

ajouter_version(int $id_objet, string $objet, array<string|int, mixed> $champs[, string $titre_version = '' ][, int|null $id_auteur = null ]) : int
Parameters
$id_objet : int
$objet : string
$champs : array<string|int, mixed>
$titre_version : string = ''

Titre donné aux modifications apportées

$id_auteur : int|null = null

Auteur apportant les modifications. En absence (session anonyme), utilisera l'IP pour garder une trace.

Return values
int —

id_version : identifiant de la version

propre_diff()

propre_diff(mixed $texte) : mixed
Parameters
$texte : mixed

liste_champs_versionnes()

Liste les champs versionnés d'une table objet.

liste_champs_versionnes(string $table) : array<string|int, mixed>
Parameters
$table : string

Nom complet de sa table sql. Exemple 'spip_articles'

Tags
used-by
recuperer_version_complete()
Return values
array<string|int, mixed> —

Liste des champs versionnés

recuperer_valeur_champ_jointure()

Lorsqu'un champ versionée est une jointure, récuperer tous les liens et les mettre sous forme de liste énumérée

recuperer_valeur_champ_jointure(string $objet, string $id_objet, string $jointure) : string
Parameters
$objet : string
$id_objet : string
$jointure : string
Return values
string

verifier_premiere_revision()

Créer la première révision d'un objet si nécessaire

verifier_premiere_revision(string $table, string $objet, int $id_objet[, array<string|int, mixed> $champs = null ][, int $id_auteur = 0 ]) : int

À faire notamment si on vient d'activer l'extension et qu'on fait une modif sur un objet qui était déjà en base, mais non versionné

La fonction renvoie le numéro de la dernière version de l'objet, et 0 si pas de version pour cet objet

Parameters
$table : string
$objet : string
$id_objet : int
$champs : array<string|int, mixed> = null
$id_auteur : int = 0
Return values
int 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results