Changeset 59767 in spip-zone


Ignore:
Timestamp:
Mar 26, 2012, 7:13:10 PM (7 years ago)
Author:
cedric@…
Message:

PHPDoc

File:
1 edited

Legend:

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

    r59551 r59767  
    3737
    3838
    39 //
    40 // echapper les < script ...
    41 //
     39/**
     40 * echapper les < script ...
     41 *
     42 * @param string $t
     43 * @return string
     44 */
    4245function echappe_js($t) {
    4346        static $wheel = null;
     
    5154}
    5255
    53 //
    54 // paragrapher seulement
    55 //
     56/**
     57 * paragrapher seulement
     58 *
     59 * @param string $t
     60 * @param null $toujours_paragrapher
     61 * @return string
     62 */
    5663function paragrapher($t, $toujours_paragrapher = null) {
    5764        static $wheel = array();
     
    7380
    7481
    75 // Securite : empecher l'execution de code PHP, en le transformant en joli code
    76 // dans l'espace prive, cette fonction est aussi appelee par propre et typo
    77 // si elles sont appelees en direct
    78 // il ne faut pas desactiver globalement la fonction dans l'espace prive car elle protege
    79 // aussi les balises des squelettes qui ne passent pas forcement par propre ou typo apres
    80 // http://doc.spip.org/@interdire_scripts
     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 *
     91 * @param string $arg
     92 * @return string
     93 */
    8194function interdire_scripts($arg) {
    8295        // on memorise le resultat sur les arguments non triviaux
     
    112125
    113126
    114 // Typographie generale
    115 // avec protection prealable des balises HTML et SPIP
    116 
    117 // http://doc.spip.org/@typo
     127/**
     128 * Typographie generale
     129 * avec protection prealable des balises HTML et SPIP
     130 *
     131 * http://doc.spip.org/@typo
     132 *
     133 * @param string $letexte
     134 * @param bool $echapper
     135 * @param null $connect
     136 * @param array $env
     137 * @return string
     138 */
    118139function typo($letexte, $echapper=true, $connect=null, $env=array()) {
    119140        // Plus vite !
     
    167188define('_TYPO_BALISE', ",</?[a-z!][^<>]*[".preg_quote(_TYPO_PROTEGER)."][^<>]*>,imsS");
    168189
    169 // http://doc.spip.org/@corriger_typo
     190/**
     191 * http://doc.spip.org/@corriger_typo
     192 *
     193 * @param string $t
     194 * @param string $lang
     195 * @return string
     196 */
    170197function corriger_typo($t, $lang='') {
    171198        static $typographie = array();
     
    221248define('_RACCOURCI_TH_SPAN', '\s*(:?{{[^{}]+}}\s*)?|<');
    222249
    223 // http://doc.spip.org/@traiter_tableau
     250/**
     251 * http://doc.spip.org/@traiter_tableau
     252 *
     253 * @param sring $bloc
     254 * @return string
     255 */
    224256function traiter_tableau($bloc) {
    225257        // id "unique" pour les id du tableau
     
    386418
    387419
    388 //
    389 // Traitement des listes (merci a Michael Parienti)
    390 //
    391 // http://doc.spip.org/@traiter_listes
     420/**
     421 * Traitement des listes (merci a Michael Parienti)
     422 *
     423 * http://doc.spip.org/@traiter_listes
     424 *
     425 * @param $texte
     426 * @return string
     427 */
    392428function traiter_listes ($texte) {
    393429        global $class_spip, $class_spip_plus;
     
    483519define('_RACCOURCI_BALISE', ",</?[a-z!][^<>]*[".preg_quote(_RACCOURCI_PROTEGER)."][^<>]*>,imsS");
    484520
    485 // Nettoie un texte, traite les raccourcis autre qu'URL, la typo, etc.
    486 
    487 // mais d'abord, une callback de reconfiguration des raccourcis
    488 // a partir de globales (est-ce old-style ? on conserve quand meme
    489 // par souci de compat ascendante)
     521/**
     522 * mais d'abord, une callback de reconfiguration des raccourcis
     523 * a partir de globales (est-ce old-style ? on conserve quand meme
     524 * par souci de compat ascendante)
     525 *
     526 * @param $ruleset
     527 */
    490528function personnaliser_raccourcis(&$ruleset){
    491529        if (isset($GLOBALS['debut_intertitre']) AND $rule=$ruleset->getRule('intertitres')){
     
    515553}
    516554
    517 // http://doc.spip.org/@traiter_raccourcis
     555/**
     556 * Nettoie un texte, traite les raccourcis autre qu'URL, la typo, etc.
     557 *
     558 * http://doc.spip.org/@traiter_raccourcis
     559 *
     560 * @param string $t
     561 * @param bool $show_autobr
     562 * @return string
     563 */
    518564function traiter_raccourcis($t, $show_autobr = false) {
    519565        static $wheel, $notes;
     
    579625
    580626
    581 // Filtre a appliquer aux champs du type #TEXTE*
    582 // http://doc.spip.org/@propre
     627/**
     628 * Filtre a appliquer aux champs du type #TEXTE*
     629 * http://doc.spip.org/@propre
     630 *
     631 * @param string $t
     632 * @param string $connect
     633 * @param array $env
     634 * @return string
     635 */
    583636function propre($t, $connect=null, $env=array()) {
    584637        // les appels directs a cette fonction depuis le php de l'espace
Note: See TracChangeset for help on using the changeset viewer.