Changeset 63566 in spip-zone


Ignore:
Timestamp:
Jul 19, 2012, 7:18:21 AM (8 years ago)
Author:
marcimat@…
Message:

Des PhpDoc?
+ une petite suppression de code inutile.

Location:
_core_/plugins/revisions/inc
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • _core_/plugins/revisions/inc/diff.php

    r62313 r63566  
    1111\***************************************************************************/
    1212
     13/**
     14 * Fonctions utilitaires du plugin révisions
     15 *
     16 * @package Revisions\Diff
     17**/
    1318
    1419if (!defined("_ECRIRE_INC_VERSION")) return;
     
    99104}
    100105
    101 //
    102 // Generation de diff a plusieurs etages
    103 //
    104 
    105 // http://doc.spip.org/@Diff
     106/**
     107 * Génération de diff a plusieurs étages
     108 *
     109 * @package Revisions\Diff
     110**/
    106111class Diff {
    107112        var $diff;
     
    206211                return true;
    207212        }
    208 // http://doc.spip.org/@segmenter
     213
     214        /**
     215         * Découper les paragraphes d'un texte en fragments
     216         *
     217         * @param string $texte   Texte à fragmenter
     218         * @return string[]       Tableau de fragments (paragraphes)
     219        **/
    209220        function segmenter($texte) {
    210221                return separer_paras($texte);
  • _core_/plugins/revisions/inc/revisions.php

    r63528 r63566  
    2323define('_INTERVALLE_REVISIONS', 600);
    2424
    25 // http://doc.spip.org/@separer_paras
    26 function separer_paras($texte, $paras = "") {
     25/**
     26 * Découper les paragraphes d'un texte en fragments
     27 *
     28 * @param string $texte  Texte à fragmenter
     29 * @param array $paras   Tableau de fragments déjà là
     30 * @return string[]      Tableau de fragments (paragraphes)
     31**/
     32function separer_paras($texte, $paras = array()) {
    2733        if (!$paras) $paras = array();
    2834        while (preg_match("/(\r\n?){2,}|\n{2,}/", $texte, $regs)) {
     
    240246}
    241247
    242 //
    243 // Recuperer les fragments d'une version donnee
    244 // renvoie un tableau associatif (id_fragment => texte)
    245 //
    246 // http://doc.spip.org/@recuperer_fragments
     248
     249/**
     250 * Récupérer les fragments d'un objet pour une version demandée
     251 *
     252 * @param int $id_objet    Identifiant de l'objet
     253 * @param string $objet    Objet
     254 * @param int $id_version  Identifiant de la version
     255 * @return array           Couples id_fragment => texte
     256 */
    247257function recuperer_fragments($id_objet,$objet, $id_version) {
    248258        $fragments = array();
     
    250260        if ($id_version == 0) return array();
    251261
    252         $result = sql_select("id_fragment, version_min, version_max, compress, fragment", "spip_versions_fragments", "id_objet=".intval($id_objet)." AND objet=".sql_quote($objet)." AND version_min<=$id_version AND version_max>=$id_version");
     262        $result = sql_select(
     263                "id_fragment, version_min, version_max, compress, fragment",
     264                "spip_versions_fragments",
     265                "id_objet=" . intval($id_objet) ." AND objet=".sql_quote($objet)
     266                        ." AND version_min<=$id_version AND version_max>=$id_version");
    253267
    254268        while ($row = sql_fetch($result)) {
     
    256270                $version_min = $row['version_min'];
    257271                $fragment = $row['fragment'];
     272                // si le fragment est compressé, tenter de le décompresser, sinon écrire une erreur
    258273                if ($row['compress'] > 0){
    259274                        $fragment_ = @gzuncompress($fragment);
     
    263278                         $fragment = $fragment_;
    264279                }
     280                // tenter dedésérialiser le fragment, sinon écrire une erreur
    265281                $fragment_ = unserialize($fragment);
    266282                if (strlen($fragment) && $fragment_===false)
     
    268284                else
    269285                 $fragment = $fragment_;
     286                // on retrouve le fragment le plus près de notre version
    270287                for ($i = $id_version; $i >= $version_min; $i--) {
    271288                        if (isset($fragment[$i])) {
     
    282299
    283300                                $fragments[$id_fragment] = $fragment[$i];
     301                                // quitter la boucle dès le premier touvé.
    284302                                break;
    285303                        }
     
    367385}
    368386
    369 //
    370 // Recuperer les champs d'une version donnee
    371 //
    372 // http://doc.spip.org/@recuperer_version
     387
     388/**
     389 * Récupérer les champs d'un objet, pour une version demandée
     390 *
     391 * @param int $id_objet    Identifiant de l'objet
     392 * @param string $objet    Objet
     393 * @param int $id_version  Identifiant de la version
     394 * @return array           Couples champs => textes
     395 */
    373396function recuperer_version($id_objet,$objet, $id_version) {
    374397
     
    380403}
    381404
    382 // http://doc.spip.org/@reconstuire_version
     405/**
     406 * Reconstruire une version donnée
     407 *
     408 * À partir de la liste des champs et de fragments,
     409 * retourne le texte de chaque champ.
     410 *
     411 * @param array $champs     Couples (champ => liste d'id_fragment).
     412 *                          La liste est de la forme "5 32 7 16 8 2"
     413 * @param array $fragments  Couples (id_fragment => texte)
     414 * @param array $res        Couples (champ => texte) déjà connus
     415 * @param array             Couples (champ => texte)
     416 */
    383417function reconstuire_version($champs, $fragments, $res=array()) {
    384418
  • _core_/plugins/revisions/inc/suivi_versions.php

    r48778 r63566  
    1111\***************************************************************************/
    1212
     13/**
     14 * Fonctions de suivi de versions
     15 *
     16 * @package Revisions\Versions
     17**/
    1318if (!defined("_ECRIRE_INC_VERSION")) return;
    1419
     
    1722
    1823/**
    19  * Afficher un diff correspondant a une revision d'un objet
     24 * Afficher un diff correspondant à une révision d'un objet
    2025 *
    21  * @param int $id_objet
    22  * @param string $objet
    23  * @param int $id_version
     26 * @param int $id_objet    Identifiant de l'objet
     27 * @param string $objet    Objet
     28 * @param int $id_version  Identifiant de la version
    2429 * @param bool $court
     30 *     - false : affiche le diff complet
     31 *     - true  : indique juste la taille en octets des changements
    2532 * @return string
     33 *     Texte HTML du diff.
    2634 */
    2735function revisions_diff ($id_objet,$objet, $id_version, $court=false){
     
    4856
    4957/**
    50  * Retrouver le champ d'un objet, pour une version demandee
    51  * @param string $objet
    52  * @param int $id_objet
    53  * @param int $id_version
    54  * @param string $champ
    55  * @param array $champs
     58 * Retrouver le champ d'un objet, pour une version demandée
     59 *
     60 * Si le champ n'est pas déjà présent dans la liste des champs ($champs),
     61 * on remonte les versions à partir du id_version donné, jusqu'à
     62 * récupérer une version qui contient ce champ. On complète alors la liste
     63 * des champs avec la version du champ trouvée.
     64 *
     65 * @param int $id_objet    Identifiant de l'objet
     66 * @param string $objet    Objet
     67 * @param int $id_version  Identifiant de la version
     68 * @param string $champ    Le nom du champ à retrouver
     69 * @param array $champs    Liste des champs déjà connus
     70 * @return void
    5671 */
    5772function retrouver_champ_version_objet($objet,$id_objet,$id_version,$champ,&$champs){
     
    6681                $prev = recuperer_version($id_objet,$objet, $id_ref--);
    6782        }
    68         if (isset($prev[$champ]))
     83        if (isset($prev[$champ])) {
    6984                $champs[$champ] = $prev[$champ];
    70         else {
     85        } else {
    7186                // le champ n'a jamais ete versionne :
    7287                // il etait initialement vide
    73                 if (strncmp($champ,'jointure_',9)==0)
    74                         $champs[$champ] = '';
    75                 else
    76                         $champs[$champ] = '';
     88                $champs[$champ] = '';
    7789        }
    7890}
    7991
    8092/**
    81  * retourne un array() des champs modifies a la version id_version
    82  * le format =
    83  *    - diff => seulement les modifs (page revisions)
    84  *    - apercu => idem, mais en plus tres cout s'il y en a bcp
    85  *    - complet => tout, avec surlignage des modifications (page revision)
     93 * Liste les champs modifiés par une version de révision donnée
    8694 *
    87  * http://doc.spip.org/@revision_comparee
     95 * Pour un couple objet/id_objet et id_version donné, calcule les champs
     96 * qui ont été modifiés depuis une version précédente et la version
     97 * d'id_version, et les retourne.
     98 *
     99 * La version précédente est par défaut la version juste
     100 * avant id_version, mais peut être définie via le paramètre id_diff.
    88101 *
    89  * @param int $id_objet
    90  * @param string $objet
    91  * @param int $id_version
     102 * Le retour est plus ou moins locace en fonction du paramètre format.
     103 *
     104 * @param int $id_objet    Identifiant de l'objet
     105 * @param string $objet    Objet
     106 * @param int $id_version  Identifiant de la version
    92107 * @param string $format
     108 *     Type de retour
     109 *     - diff => seulement les modifs (page revisions)
     110 *     - apercu => idem, mais en plus tres cout s'il y en a bcp
     111 *     - complet => tout, avec surlignage des modifications (page revision)
    93112 * @param null $id_diff
     113 *     Identifiant de la version de base du diff, par défaut l'id_version
     114 *     juste précédent
    94115 * @return array
     116 *     Couples (champ => texte)
    95117 */
    96118function revision_comparee($id_objet, $objet, $id_version, $format='diff', $id_diff=NULL) {
     
    130152
    131153                // memoriser les cas les plus courant
    132                 $afficher_diff_champ = charger_fonction('champ','afficher_diff');
     154                $afficher_diff_champ    = charger_fonction('champ','afficher_diff');
    133155                $afficher_diff_jointure = charger_fonction('jointure','afficher_diff');
    134156                foreach ($champs as $champ) {
     
    158180
    159181        // que donner par defaut ? (par exemple si id_version=1)
    160         if (!$textes)
     182        if (!$textes) {
    161183                $textes = recuperer_version($id_objet,$objet, $id_version);
     184        }
    162185
    163186        return $textes;
Note: See TracChangeset for help on using the changeset viewer.