Proposer une amélioration de commentaire

Le commentaire à poster est au format «docblock» (de phpDoc) qui peut être enrichi de tags spécifiques pour SPIP.
Fichier
ecrire/inc/charsets.php
Fonction
charset2unicode

    Nom ou pseudo de l'auteur de la proposition

Code original

/**
 * Transforme une chaine en entites unicode 
 *
 * Utilise la librairie mb si elle est présente.
 *
 * @internal
 *     Note: l'argument $forcer est obsolete : il visait a ne pas
 *     convertir les accents iso-8859-1
 *
 * @param string $texte
 *     Texte à convertir
 * @param string $charset
 *     Charset actuel du texte
 *     Par défaut (AUTO), le charset est celui du site.
 * @return string
 *     Texte converti en unicode
 **/

function charset2unicode($texte, $charset = 'AUTO' /* $forcer: obsolete*/) {
        static $trans;

        if ($charset == 'AUTO') {
                $charset = lire_config('charset', _DEFAULT_CHARSET);
        }

        if ($charset == '') {
                $charset = 'iso-8859-1';
        }
        $charset = strtolower($charset);

        switch ($charset) {
                case 'utf-8':
                case 'utf8':
                        return utf_8_to_unicode($texte);

                case 'iso-8859-1':
                        $texte = corriger_caracteres_windows($texte, 'iso-8859-1');
                // pas de break; ici, on suit sur default:

                default:
                        // mbstring presente ?
                        if (init_mb_string()) {
                                if ($order = mb_detect_order() # mb_string connait-il $charset?
                                        and mb_detect_order($charset)
                                ) {
                                        $s = mb_convert_encoding($texte, 'utf-8', $charset);
                                        if ($s && $s != $texte) {
                                                return utf_8_to_unicode($s);
                                        }
                                }
                                mb_detect_order($order); # remettre comme precedemment
                        }

                        // Sinon, peut-etre connaissons-nous ce charset ?
                        if (!isset($trans[$charset])) {
                                if ($cset = load_charset($charset)
                                        and is_array($GLOBALS['CHARSET'][$cset])
                                ) {
                                        foreach ($GLOBALS['CHARSET'][$cset] as $key => $val) {
                                                $trans[$charset][chr($key)] = '&#' . $val . ';';
                                        }
                                }
                        }
                        if (count($trans[$charset])) {
                                return str_replace(array_keys($trans[$charset]), array_values($trans[$charset]), $texte);
                        }

                        // Sinon demander a iconv (malgre le fait qu'il coupe quand un
                        // caractere n'appartient pas au charset, mais c'est un probleme
                        // surtout en utf-8, gere ci-dessus)
                        if (test_iconv()) {
                                $s = iconv($charset, 'utf-32le', $texte);
                                if ($s) {
                                        return utf_32_to_unicode($s);
                                }
                        }

                        // Au pire ne rien faire
                        spip_log("erreur charset '$charset' non supporte");

                        return $texte;
        }
}

Le commentaire au format « docblock » peut être complété des éléments suivants sécifiques
à SPIP.

Sur un entête de fichier :

  • @package SPIP\Core\x (pour un fichier du core, x dépendant du fichier)
  • @package SPIP\Nom\x (pour un fichier de plugin, Nom étant le nom du plugin)

Sur un entête de fonction :

  • @pipeline x : indique que la fonction est une utilisation d’un pipeline
  • @pipeline_appel x : indique que la fonction appelle le pipeline indiqué
  • @balise : indique que la fonction est une compilation de balise
  • @filtre : indique un |filtre
  • @critere : indique que la fonction est une compilaiton de critère
  • @boucle : indique que la fonction est une compilaiton de boucle
Vous inscrire sur ce site

L’espace privé de ce site est ouvert aux visiteurs, après inscription. Une fois enregistré, vous pourrez consulter les articles en cours de rédaction, proposer des articles et participer à tous les forums.

Identifiants personnels

Indiquez ici votre nom et votre adresse email. Votre identifiant personnel vous parviendra rapidement, par courrier électronique.