Changeset 70190 in spip-zone


Ignore:
Timestamp:
Feb 25, 2013, 11:35:39 AM (8 years ago)
Author:
marcimat@…
Message:

Phpdoc

File:
1 edited

Legend:

Unmodified
Added
Removed
  • _core_/plugins/textwheel/inc/texte.php

    r69328 r70190  
    1111\***************************************************************************/
    1212
     13/**
     14 * Gestion des textes et raccourcis SPIP
     15 *
     16 * Surcharge de ecrire/inc/texte
     17 *
     18 * @package SPIP\Textwheel\Texte
     19**/
     20
    1321if (!defined('_ECRIRE_INC_VERSION')) return;
    1422
     
    3846
    3947/**
    40  * echapper les < script ...
     48 * Échapper et affichier joliement les `<script` ...
    4149 *
    4250 * @param string $t
     
    5462}
    5563
    56 /**
    57  * paragrapher seulement
     64
     65/**
     66 * Paragrapher seulement
     67 *
     68 * Fermer les paragraphes ; Essaie de préserver des paragraphes indiqués
     69 * à la main dans le texte (par ex: on ne modifie pas un `<p align='center'>`)
    5870 *
    5971 * @param string $t
     72 *     Le texte
    6073 * @param null $toujours_paragrapher
     74 *     true pour forcer les `<p>` même pour un seul paragraphe
    6175 * @return string
     76 *     Texte paragraphé
    6277 */
    6378function paragrapher($t, $toujours_paragrapher = null) {
     
    7994}
    8095
    81 
    82 /**
    83  * Securite : empecher l'execution de code PHP, en le transformant en joli code
    84  * dans l'espace prive, cette fonction est aussi appelee par propre et typo
    85  * si elles sont appelees en direct
    86  * il ne faut pas desactiver globalement la fonction dans l'espace prive car elle protege
    87  * aussi les balises des squelettes qui ne passent pas forcement par propre ou typo apres
    88  *
    89  * http://doc.spip.org/@interdire_scripts
    90  *
     96/**
     97 * Empêcher l'exécution de code PHP et JS
     98 *
     99 * Sécurité : empêcher l'exécution de code PHP, en le transformant en joli code
     100 * dans l'espace privé. Cette fonction est aussi appelée par propre et typo.
     101 *
     102 * De la même manière, la fonction empêche l'exécution de JS mais selon le mode
     103 * de protection déclaré par la globale filtrer_javascript :
     104 * - -1 : protection dans l'espace privé et public
     105 * - 0  : protection dans l'espace public
     106 * - 1  : aucune protection
     107 *
     108 * Il ne faut pas désactiver globalement la fonction dans l'espace privé car elle protège
     109 * aussi les balises des squelettes qui ne passent pas forcement par propre ou typo après
     110 * si elles sont appelées en direct
     111 *
    91112 * @param string $arg
     113 *     Code à protéger
    92114 * @return string
    93  */
     115 *     Code protégé
     116**/
    94117function interdire_scripts($arg) {
    95118        // on memorise le resultat sur les arguments non triviaux
     
    126149
    127150/**
    128  * Typographie generale
    129  * avec protection prealable des balises HTML et SPIP
    130  *
    131  * http://doc.spip.org/@typo
    132  *
     151 * Applique la typographie générale
     152 *
     153 * Effectue un traitement pour que les textes affichés suivent les règles
     154 * de typographie. Fait une protection préalable des balises HTML et SPIP.
     155 * Transforme les balises `<multi>`
     156 *
     157 * @filtre typo
     158 * @uses traiter_modeles()
     159 * @uses corriger_typo()
     160 * @uses echapper_faux_tags()
     161 * @see propre()
     162 *
    133163 * @param string $letexte
     164 *     Texte d'origine
    134165 * @param bool $echapper
    135  * @param null $connect
     166 *     Échapper ?
     167 * @param string|null $connect
     168 *     Nom du connecteur à la bdd
    136169 * @param array $env
    137  * @return string
    138  */
     170 *     Environnement (pour les calculs de modèles)
     171 * @return string $t
     172 *     Texte transformé
     173**/
    139174function typo($letexte, $echapper=true, $connect=null, $env=array()) {
    140175        // Plus vite !
     
    190225
    191226/**
    192  * http://doc.spip.org/@corriger_typo
    193  *
    194  * @param string $t
    195  * @param string $lang
    196  * @return string
     227 * Corrige la typographie
     228 *
     229 * Applique les corrections typographiques adaptées à la langue indiquée.
     230 *
     231 * @pipeline_appel pre_typo
     232 * @pipeline_appel post_typo
     233 * @uses corriger_caracteres()
     234 * @uses corriger_caracteres()
     235 *
     236 * @param string $t Texte
     237 * @param string $lang Langue
     238 * @return string Texte
    197239 */
    198240function corriger_typo($t, $lang='') {
     
    250292
    251293/**
    252  * http://doc.spip.org/@traiter_tableau
     294 * Traitement des raccourcis de tableaux
    253295 *
    254296 * @param sring $bloc
     
    423465/**
    424466 * Traitement des listes
    425  * on utilise la wheel correspondante
    426  *
    427  * http://doc.spip.org/@traiter_listes
     467 *
     468 * On utilise la wheel correspondante
    428469 *
    429470 * @param string $t
     
    487528 * Nettoie un texte, traite les raccourcis autre qu'URL, la typo, etc.
    488529 *
    489  * http://doc.spip.org/@traiter_raccourcis
    490  *
     530 * @pipeline_appel pre_propre
     531 * @pipeline_appel post_propre
     532 *
    491533 * @param string $t
    492534 * @param bool $show_autobr
     
    557599
    558600/**
    559  * Filtre a appliquer aux champs du type #TEXTE*
    560  * http://doc.spip.org/@propre
    561  *
     601 * Transforme les raccourcis SPIP, liens et modèles d'un texte en code HTML
     602 *
     603 * Filtre à appliquer aux champs du type `#TEXTE*`
     604 *
     605 * @filtre propre
     606 * @uses echappe_html()
     607 * @uses expanser_liens()
     608 * @uses traiter_raccourcis()
     609 * @uses echappe_retour_modeles()
     610 * @see typo()
     611 *
    562612 * @param string $t
    563  * @param string $connect
     613 *     Texte avec des raccourcis SPIP
     614 * @param string|null $connect
     615 *     Nom du connecteur à la bdd
    564616 * @param array $env
    565  * @return string
    566  */
     617 *     Environnement (pour les calculs de modèles)
     618 * @return string $t
     619 *     Texte transformé
     620**/
    567621function propre($t, $connect=null, $env=array()) {
    568622        // les appels directs a cette fonction depuis le php de l'espace
Note: See TracChangeset for help on using the changeset viewer.