Changeset 82296 in spip-zone


Ignore:
Timestamp:
May 9, 2014, 10:36:11 PM (5 years ago)
Author:
teddy.spip@…
Message:
  • Complément et ajout de PHPDoc
  • On commente le code par des exemples
  • On incrémente et on passe en stable.
Location:
_plugins_/medias_nettoyage/trunk
Files:
7 edited

Legend:

Unmodified
Added
Removed
  • _plugins_/medias_nettoyage/trunk/medias_nettoyage_autorisations.php

    r81869 r82296  
    44 *
    55 * @plugin     Nettoyer la médiathèque
    6  * @copyright  2013
     6 * @copyright  2014
    77 * @author     Teddy Payet
    88 * @licence    GNU/GPL
  • _plugins_/medias_nettoyage/trunk/medias_nettoyage_fonctions.php

    r82258 r82296  
    11<?php
     2/**
     3 * Fonctions principales du plugin "Nettoyer la médiathèque"
     4 *
     5 * @plugin     Nettoyer la médiathèque
     6 * @copyright  2014
     7 * @author     Teddy Payet
     8 * @licence    GNU/GPL
     9 * @package    SPIP\Medias_nettoyage\Fonctions
     10 */
    211
    312if (!defined('_ECRIRE_INC_VERSION')) return;
     
    2736 * Créer les répertoires des extensions des documents enregistrés en BDD.
    2837 *
     38 * @uses medias_lister_extensions_documents()
     39 * @uses _DIR_IMG
     40 *
    2941 * @param  string $repertoire_img
    3042 *         Par défaut, on prend _DIR_IMG en référence.
     
    4557/**
    4658 * Créer le répertoire "IMG/orphelins".
    47  * Plus pratique d'avoir une fonction
    48  * qu'on appellera en cas de besoin.
    49  *
     59 * Plus pratique d'avoir une fonction qu'on appellera en cas de besoin.
     60 *
     61 * @uses _MEDIAS_NETTOYAGE_REP_ORPHELINS
     62 *
    5063 * @return void
    5164 */
     
    5972/**
    6073 * Lister les répertoires présents dans IMG/ sans les sous-répertoires.
     74 *
    6175 * @param  string $repertoire_img
    6276 *         Par défaut, on prend _DIR_IMG en référence.
     
    8397 * Lister tous les fichiers non distants enregistrés en BDD
    8498 *
     99 * @uses get_spip_doc()
     100 *
    85101 * @return array
    86102 *         Tableau contenant les urls des fichiers
     
    154170 *
    155171 * @uses medias_lister_documents_bdd_orphelins()
     172 * @uses _DIR_IMG
     173 * @uses get_spip_doc()
    156174 *
    157175 * @return integer
     
    159177function medias_lister_documents_bdd_orphelins_taille(){
    160178        $documents_orphelins    = medias_lister_documents_bdd_orphelins();
    161         $taille                                 = 0;
    162         $pattern_img                    = "/" . preg_replace("/\//", "\/", _DIR_IMG) . "/";
     179        $taille                 = 0;
     180        $pattern_img            = "/" . preg_replace("/\//", "\/", _DIR_IMG) . "/";
    163181
    164182        if (count($documents_orphelins) > 0) {
    165183                $documents_bdd = sql_allfetsel('fichier,taille','spip_documents', "fichier IN ('" . join("','",preg_replace($pattern_img, '', $documents_orphelins)) . "')");
    166184                foreach ($documents_bdd as $document_bdd) {
    167                                 if (!file_exists(get_spip_doc($document_bdd['fichier']))) {
    168                                         $taille = $taille + ($document_bdd['taille']/1000); // On divise par 1000 pour éviter la limite de l'integer php.
    169                                 }
     185                        if (!file_exists(get_spip_doc($document_bdd['fichier']))) {
     186                                $taille = $taille + ($document_bdd['taille']/1000); // On divise par 1000 pour éviter la limite de l'integer php.
     187                        }
    170188                }
    171189        }
     
    179197 * @uses medias_lister_logos_fichiers()
    180198 *
     199 * @param string $repertoire_img
     200 *        On peut passer un nom de répertoire/chemin en paramètre.
     201 *        Par défaut, on prend le répertoire IMG/
    181202 * @return array
    182203 */
     
    235256 * @uses medias_lister_documents_repertoire_orphelins()
    236257 * @uses medias_calculer_taille_fichiers()
     258 *
    237259 * @return integer
    238260 */
     
    254276
    255277        // On va chercher dans IMG/distant/*/*.*
     278        // Exemple : IMG/distant/jpg/nom_fichier.jpg
    256279        $fichiers = glob($repertoire_img . "*/*/*.*");
    257280        foreach ($fichiers as $fichier) {
     
    260283
    261284        // On va chercher dans IMG/*/*.*
     285        // Exemple : IMG/pdf/nom_fichier.pdf
    262286        $fichiers = glob($repertoire_img . "*/*.*");
    263287        foreach ($fichiers as $fichier) {
     
    266290
    267291        // On va chercher dans IMG/*.*
     292        // Exemple : IMG/arton4.png
    268293        $fichiers = glob($repertoire_img . "*.*");
    269294        foreach ($fichiers as $fichier) {
     
    284309 * @uses medias_calculer_taille_fichiers()
    285310 *
     311 * @param string $repertoire_img
     312 *        On peut passer un nom de répertoire/chemin en paramètre.
     313 *        Par défaut, on prend le répertoire IMG/
    286314 * @return integer
    287315 */
     
    301329 * @todo étendre à d'autres objets éditoriaux.
    302330 *
     331 * @param null|string $mode
     332 *        + `null` : stockera dans le tableau tous les logos,
     333 *        quelque soit le mode du logo
     334 *        + `on` : stockera dans le tableau tous les logos du mode "on"
     335 *        + `off` : stockera dans le tableau tous les logos du mode "off"
     336 * @param string $repertoire_img
     337 *        On peut passer un nom de répertoire/chemin en paramètre.
     338 *        Par défaut, on prend le répertoire IMG/
    303339 * @return array
    304340 */
     
    362398 * @uses medias_calculer_taille_fichiers()
    363399 *
    364  * @return integer
     400 * @param null|string $mode
     401 *        + `null` : calculera le poids de tous les logos,
     402 *        quelque soit le mode du logo
     403 *        + `on` : calculera le poids de tous les logos du mode "on"
     404 *        + `off` : calculera le poids de tous les logos du mode "off"
     405 * @return integer|string
    365406 */
    366407function medias_lister_logos_fichiers_taille ($mode = null){
     
    403444 *
    404445 * @uses medias_lister_repertoires()
     446 * @uses _MEDIAS_NETTOYAGE_REP_ORPHELINS
    405447 *
    406448 * @return array
     
    418460 *
    419461 * @uses medias_lister_documents_repertoire_complet()
     462 * @uses _MEDIAS_NETTOYAGE_REP_ORPHELINS
    420463 *
    421464 * @return array
     
    423466function medias_lister_repertoires_orphelins_fichiers () {
    424467        $repertoire_orphelins   = _MEDIAS_NETTOYAGE_REP_ORPHELINS;
    425         $docs_fichiers                  = array();
     468        $docs_fichiers          = array();
    426469
    427470        if (is_dir($repertoire_orphelins)) {
     
    436479 * @uses medias_calculer_taille_fichiers()
    437480 * @uses medias_lister_documents_repertoire_complet()
     481 * @uses _MEDIAS_NETTOYAGE_REP_ORPHELINS
    438482 *
    439483 * @return integer
     
    441485function medias_lister_repertoires_orphelins_fichiers_taille () {
    442486        $repertoire_orphelins   = _MEDIAS_NETTOYAGE_REP_ORPHELINS;
    443         $taille                                 = 0;
     487        $taille                 = 0;
    444488
    445489        if (is_dir($repertoire_orphelins)) {
     
    468512 *
    469513 * @uses medias_creer_repertoires_orphelins()
     514 * @uses _DIR_IMG
     515 * @uses _MEDIAS_NETTOYAGE_REP_ORPHELINS
    470516 *
    471517 * @return void
    472518 */
    473519function medias_deplacer_rep_obsoletes () {
    474         spip_log(date_format(date_create(), 'Y-m-d H:i:s') . ' : Début de la procédure de déplacement des répertoires obsolètes.',"medias_orphelins");
    475 
    476         $pattern_obsoletes              = array("cache-","icones");
    477         $repertoire_img                 = _DIR_IMG;
     520        spip_log(date_format(date_create(), 'Y-m-d H:i:s') . ' : Début de la procédure de déplacement des répertoires obsolètes.',"medias_nettoyage");
     521
     522        $pattern_obsoletes      = array("cache-","icones");
     523        $repertoire_img         = _DIR_IMG;
    478524        $repertoire_orphelins   = _MEDIAS_NETTOYAGE_REP_ORPHELINS;
    479525        $repertoires_obsoletes  = array();
    480         $message_log                    = array();
    481         $pattern_img                    = "/" . preg_replace("/\//", "\/", $repertoire_img) . "/";
     526        $message_log            = array();
     527        $pattern_img            = "/" . preg_replace("/\//", "\/", $repertoire_img) . "/";
    482528
    483529        // On crée le répertoire IMG/orphelins
     
    507553                $message_log[] = date_format(date_create(), 'Y-m-d H:i:s') . ' : Il n\'y a pas de dossiers ou de fichiers obsolètes';
    508554        }
    509         spip_log("\n-------\n" . join("\n",$message_log) . "\n-------\n","medias_orphelins");
    510         spip_log(date_format(date_create(), 'Y-m-d H:i:s') . ' : Fin de la procédure de déplacement des répertoires obsolètes.',"medias_orphelins");
     555        spip_log("\n-------\n" . join("\n",$message_log) . "\n-------\n","medias_nettoyage");
     556        spip_log(date_format(date_create(), 'Y-m-d H:i:s') . ' : Fin de la procédure de déplacement des répertoires obsolètes.',"medias_nettoyage");
    511557        return;
    512558}
     
    519565 * @uses medias_creer_extensions_repertoires()
    520566 * @uses medias_lister_documents_repertoire_orphelins()
     567 * @uses _DIR_IMG
     568 * @uses _MEDIAS_NETTOYAGE_REP_ORPHELINS
    521569 *
    522570 * @return array
     
    528576         * si le script est lancé ou pas.
    529577         */
    530         spip_log(date_format(date_create(), 'Y-m-d H:i:s') . ' : Début de la procédure de déplacement.',"medias_orphelins");
     578        spip_log(date_format(date_create(), 'Y-m-d H:i:s') . ' : Début de la procédure de déplacement.',"medias_nettoyage");
    531579
    532580        $fichiers_orphelins     = medias_lister_documents_repertoire_orphelins();
    533         $fichiers_deplaces              = array();
    534         $message_log                    = array();
     581        $fichiers_deplaces      = array();
     582        $message_log            = array();
    535583        $repertoire_orphelins   = _MEDIAS_NETTOYAGE_REP_ORPHELINS;
    536         $pattern_img                    = "/" . preg_replace("/\//", "\/", _DIR_IMG) . "/";
     584        $pattern_img            = "/" . preg_replace("/\//", "\/", _DIR_IMG) . "/";
    537585
    538586        // On crée le répertoire IMG/orphelins s'il n'existe pas
     
    569617        }
    570618
    571         spip_log("\n-------\n" . join("\n",$message_log) . "\n-------\n","medias_orphelins");
     619        spip_log("\n-------\n" . join("\n",$message_log) . "\n-------\n","medias_nettoyage");
    572620        /**
    573621         * Et là, on marque bien la fin du script dans les logs.
    574622         */
    575         spip_log(date_format(date_create(), 'Y-m-d H:i:s') . ' : Fin de la procédure de déplacement.',"medias_orphelins");
     623        spip_log(date_format(date_create(), 'Y-m-d H:i:s') . ' : Fin de la procédure de déplacement.',"medias_nettoyage");
    576624
    577625        return true;
     
    588636 *
    589637 * @uses medias_lister_logos_fichiers()
     638 * @uses _DIR_IMG
    590639 *
    591640 * @return bool
     
    597646         * si le script est lancé ou pas.
    598647         */
    599         spip_log(date_format(date_create(), 'Y-m-d H:i:s') . ' : Début de la procédure de réparation des documents.',"medias_orphelins");
     648        spip_log(date_format(date_create(), 'Y-m-d H:i:s') . ' : Début de la procédure de réparation des documents.',"medias_nettoyage");
    600649
    601650        $repertoire_img         = _DIR_IMG ;
     
    635684        }
    636685
    637         spip_log("\n-------\n" . join("\n",$message_log) . "\n-------\n","medias_orphelins");
     686        spip_log("\n-------\n" . join("\n",$message_log) . "\n-------\n","medias_nettoyage");
    638687        /**
    639688         * Et là, on marque bien la fin du script dans les logs.
    640689         */
    641         spip_log(date_format(date_create(), 'Y-m-d H:i:s') . ' : Fin de la procédure de réparation des documents.',"medias_orphelins");
     690        spip_log(date_format(date_create(), 'Y-m-d H:i:s') . ' : Fin de la procédure de réparation des documents.',"medias_nettoyage");
    642691
    643692        return true;
  • _plugins_/medias_nettoyage/trunk/medias_nettoyage_options.php

    r81828 r82296  
    11<?php
    2 if (!defined("_ECRIRE_INC_VERSION")) return;
     2/**
     3 * Options principales du plugin "Nettoyer la médiathèque"
     4 *
     5 * @plugin     Nettoyer la médiathèque
     6 * @copyright  2014
     7 * @author     Teddy Payet
     8 * @licence    GNU/GPL
     9 * @package    SPIP\Medias_nettoyage\Options
     10 */
     11
     12if (!defined('_ECRIRE_INC_VERSION')) return;
    313
    414if (!defined("_MEDIAS_NETTOYAGE_PAQUET"))
  • _plugins_/medias_nettoyage/trunk/medias_nettoyage_pipelines.php

    r81897 r82296  
    11<?php
     2/**
     3 * Pipelines du plugin "Nettoyer la médiathèque"
     4 *
     5 * @plugin     Nettoyer la médiathèque
     6 * @copyright  2014
     7 * @author     Teddy Payet
     8 * @licence    GNU/GPL
     9 * @package    SPIP\Medias_nettoyage\Pipelines
     10 */
     11
    212if (!defined("_ECRIRE_INC_VERSION")) return;
    313
  • _plugins_/medias_nettoyage/trunk/paquet.xml

    r82258 r82296  
    22        prefix="medias_nettoyage"
    33        categorie="outil"
    4         version="0.8.5"
    5         etat="dev"
     4        version="0.8.6"
     5        etat="stable"
    66        compatibilite="[2.1.0;3.0.99]"
    77        logo="prive/themes/spip/images/medias_nettoyage-64.png"
  • _plugins_/medias_nettoyage/trunk/plugin.xml

    r82258 r82296  
    55        <icon>prive/themes/spip/images/medias_nettoyage-64.png</icon>
    66        <prefix>medias_nettoyage</prefix>
    7         <version>0.8.5</version>
    8         <etat>dev</etat>
     7        <version>0.8.6</version>
     8        <etat>stable</etat>
    99        <categorie>outil</categorie>
    1010
  • _plugins_/medias_nettoyage/trunk/todo.txt

    r81875 r82296  
    1 - compatibilité SPIP 3.0
    21
    32Observations :
Note: See TracChangeset for help on using the changeset viewer.