Changeset 36694 in spip-zone


Ignore:
Timestamp:
Mar 27, 2010, 5:15:28 PM (9 years ago)
Author:
gilles.vincent@…
Message:

Commentaires au format PHPDoc

Location:
_plugins_/odt2spip/version_0.2_dev
Files:
5 edited

Legend:

Unmodified
Added
Removed
  • _plugins_/odt2spip/version_0.2_dev/action/odt2spip_importe.php

    r36688 r36694  
    11<?php
    22
     3/**
     4 * Créer un article à partir d'un fichier au format odt
     5 *
     6 * @author cy_altern
     7 * @license GNU/LGPL
     8 *
     9 * @package odt2spip
     10 * @version $Id$
     11 *
     12 */
     13
     14/**
     15 * Création de l'article et redirection vers celui-ci
     16 *
     17 * Le fichier .odt est envoyé par un formulaire, ainsi que des informations sur
     18 * la rubrique dans laquelle créer l'article, un flag qui indique s'il faut joindre
     19 * le document à l'article créé, etc..
     20 * Cette fonction s'assure avant tout que l'utilisateur peut y ajouter un article.
     21 * Le fichier .odt est traité et transformé en article.
     22 * En fin de traitement, on est redirigé vers l'article qui vient d'être créé.
     23 *
     24 * {@internal
     25 * Un répertoire temporaire, spécifique à l'utilisateur en cours, est utilisé et
     26 * créé si nécessaire. Il est supprimé en fin de traitement.
     27 * Le format odt correspond à une archive .zip, et regroupe le contenu dans un fichier
     28 * content.xml : ce fichier est transformé par XSLT afin de générer un texte
     29 * utilisant les balises SPIP pour sa mise en forme. }
     30 *
     31 * @global Array $visiteur_session La session de l'utilisateur courant
     32 */
    333function action_odt2spip_importe() {
    434        global $visiteur_session;
     
    838        $args = explode(":", $arg);
    939
    10         // le 1er element de _request('arg') est id_rubrique=XXX
     40        // le 1er élément de _request('arg') est id_rubrique=XXX
    1141        $Targs = explode("=", $args[0]);
    1242        $id_rubrique = $Targs[1];
     
    1444
    1545        $redirect = _request('redirect');
    16         if ($redirect == NULL) $redirect = "";
     46        if ($redirect == NULL)
     47                $redirect = "";
    1748
    1849        include_spip("inc/securiser_action");
     
    2152                die(_T('avis_non_acces_page'));
    2253
    23         // ss-rep temporaire specifique de l'auteur en cours: tmp/odt2spip/id_auteur/ 
    24         // => le creer si il n'existe pas
     54        // ss-rep temporaire specifique de l'auteur en cours: tmp/odt2spip/id_auteur/
     55        // => le créer s'il n'existe pas
    2556        $base_dezip = _DIR_TMP . "odt2spip/";     // avec / final
    2657        if (!is_dir($base_dezip))
     
    3263                        die (_T('odtspip:err_repertoire_tmp'));
    3364
    34         // traitement d'un fichier odt envoye par $_POST 
     65        // traitement d'un fichier odt envoye par $_POST
    3566        $fichier_zip = addslashes($_FILES['fichier_odt']['name']);
    3667        if ($_FILES['fichier_odt']['name'] == ''
     
    5384        }
    5485
    55         // Creation du fichier necessaire a snippets
     86        // Création du fichier nécessaire à snippets
    5687        $odt2spip_generer_sortie = charger_fonction('odt2spip_generer_sortie', 'inc');
    5788        list($fichier_sortie, $xml_sortie) = $odt2spip_generer_sortie($id_auteur, $rep_dezip);
    5889
    59         // generer l'article a partir du fichier xml de sortie
    60         // (code pompe sur plugins/snippets/action/snippet_importe.php)
     90        // générer l'article à partir du fichier xml de sortie
     91        // (code pompé sur plugins/snippets/action/snippet_importe.php)
    6192        include_spip('inc/snippets');
    6293        $table = $id = 'articles';
     
    74105        sql_updateq('spip_articles', array('statut' => 'prop'), 'id_article=' . $id_article);
    75106
    76         // si necessaire attacher le fichier odt original a l'article
     107        // si nécessaire attacher le fichier odt original à l'article
    77108        // et lui mettre un titre signifiant
    78109        if (_request('attacher_odt') == '1') {
     
    83114                        $ajouter_documents = charger_fonction('ajouter_documents','inc');
    84115               
    85                 // la y'a un bogue super-bizarre avec la fonction spip_abstract_insert() qui est donnee comme absente lors de l'appel de ajouter_document()
     116                // la y'a un bogue super-bizarre avec la fonction spip_abstract_insert()
     117                // qui est donnée comme absente lors de l'appel de ajouter_document()
    86118                if (!function_exists('spip_abstract_insert'))
    87119                        include_spip('base/abstract_sql');
     
    97129        }
    98130
     131        // vider le contenu du rep de dezippage
    99132        if (!function_exists('effacer_repertoire_temporaire'))
    100133                include_spip('inc/getdocument');
    101         // vider le contenu du rep de dezippage
    102134        effacer_repertoire_temporaire($rep_dezip);
    103135       
    104         // aller sur la page de l'article qui vient d'etre cree
     136        // aller sur la page de l'article qui vient d'être créée
    105137        redirige_par_entete(
    106138                        parametre_url(
  • _plugins_/odt2spip/version_0.2_dev/inc/odt2spip_generer_sortie.php

    r36688 r36694  
    11<?php
     2/**
     3 * Créer un article à partir d'un fichier au format odt
     4 *
     5 * @author cy_altern
     6 * @license GNU/LGPL
     7 *
     8 * @package odt2spip
     9 * @version $Id$
     10 *
     11 */
     12
     13/**
     14 * Création du fichier nécessaire à snippets
     15 *
     16 * Le fichier content.xml a été extrait de l'archive .odt, et placé dans le dossier
     17 * temporaire propre à l'utilisateur courant. Un premier traitement est effectué
     18 * par cette fonction pour qu'il soit finalement transformé en texte utilisant les
     19 * balises SPIP. On tient compte de la présence des plugins enluminure_typo et
     20 * intertitre_enrichis. Les images sont extraites du document .odt et sont prêtes
     21 * à être insérées dans le futur article SPIP.
     22 *
     23 * @param int $id_auteur Utilisateur courant
     24 * @param string $rep_dezip Répertoire où placer le fichier snippet_odt2spip.xml
     25 * @return mixed
     26 */
    227function inc_odt2spip_generer_sortie($id_auteur, $rep_dezip){
    328        // variables en dur pour xml en entree et xslt utilisee
  • _plugins_/odt2spip/version_0.2_dev/inc/odt2spip_retailler_img.php

    r36688 r36694  
    11<?php
     2/**
     3 * Créer un article à partir d'un fichier au format odt
     4 *
     5 * @author cy_altern
     6 * @license GNU/LGPL
     7 *
     8 * @package odt2spip
     9 * @version $Id$
     10 *
     11 */
    212
    3 // retailler une image : (ne gere que les images GIF, JPG et PNG)
    4 // $img_ini = CHEMIN+NOM_FICHIER de l'img initiale, $l et $h = largeur et hauteur max de l'image finale
    5 // gestion de la transparence des PNG : code de matt1walsh@gmail.com sur http://fr2.php.net/manual/fr/function.imagecopyresampled.php
    6 
     13/**
     14 * retailler une image : (ne gère que les images GIF, JPG et PNG)
     15 *
     16 * @internal Gestion de la transparence des PNG : code de matt1walsh@gmail.com sur {@link http://fr2.php.net/manual/fr/function.imagecopyresampled.php}
     17 * @param string $img_ini Le fichier à retailler
     18 * @param string $l Largeur max de l'image finale
     19 * @param int $h Hauteur max
     20 * @return string Le message d'erreur en cas de problème
     21 */
    722function inc_odt2spip_retailler_img($img_ini, $l = '', $h = 400){
    823        if (!file_exists($img_ini))
  • _plugins_/odt2spip/version_0.2_dev/inc/odt2spip_traiter_mathml.php

    r36689 r36694  
    11<?php
    22
     3/**
     4 * Créer un article à partir d'un fichier au format odt
     5 *
     6 * @author cy_altern
     7 * @license GNU/LGPL
     8 *
     9 * @package odt2spip
     10 * @version $Id$
     11 *
     12 */
     13
     14/**
     15 * Traiter les éléments au format {@link http://fr.wikipedia.org/wiki/MathML MathML}
     16 *
     17 * Le format {@link http://fr.wikipedia.org/wiki/MathML MathML} est transformé par
     18 * XSLT pour générer du code {@link http://fr.wikipedia.org/wiki/Aide%3AFormules_TeX LaTEX}
     19 * interprétable par SPIP (cf. {@link http://www.spip.net/fr_article3016.html})
     20 *
     21 * @param string $chemin_fichier Chemin provisoire dans lequel a été téléchargé le fichier
     22 * @return mixed
     23 */
    324function odt2spip_traiter_mathml($chemin_fichier) {
    425        // recuperer le contenu du fichier
  • _plugins_/odt2spip/version_0.2_dev/odt2spip_pipelines.php

    r36688 r36694  
    11<?php
     2/**
     3 * Créer un article à partir d'un fichier au format odt
     4 *
     5 * @author cy_altern
     6 * @license GNU/LGPL
     7 *
     8 * @package odt2spip
     9 * @version $Id$
     10 *
     11 */
    212
     13/**
     14 * Pipeline ajoutant un lien d'import à la barre de navigation de l'interface privée
     15 *
     16 * @param Array $flux Le code de la barre
     17 * @return Array Le code modifié
     18 */
    319function odt2spip_affiche_droite($flux){
    420        $id_rubrique = $flux['args']['id_rubrique'];
Note: See TracChangeset for help on using the changeset viewer.