Ignore:
Timestamp:
Dec 13, 2015, 11:51:42 AM (5 years ago)
Author:
cedric@…
Message:

Indentation et regles de codage selon http://www.spip.net/fr_article3497.html#regles_codage

File:
1 edited

Legend:

Unmodified
Added
Removed
  • _core_/plugins/porte_plume/porte_plume_fonctions.php

    r93109 r93621  
    88 */
    99
    10 if (!defined("_ECRIRE_INC_VERSION")) return;
     10if (!defined("_ECRIRE_INC_VERSION")) {
     11        return;
     12}
    1113
    1214/**
     
    1921 * @package SPIP\PortePlume\BarreOutils
    2022 */
    21 class Barre_outils{
     23class Barre_outils {
    2224        /**
    2325         * Identifiant HTML de la barre
     26         *
    2427         * @todo À supprimer car non utilisé !
    25          * @var string */
     28         * @var string
     29         */
    2630        public $id = "";
    2731
    2832        /**
    2933         * Nom de la barre d'outil
    30          * @var string */
     34         *
     35         * @var string
     36         */
    3137        public $nameSpace = "";
    3238
    3339        /**
    3440         * Langue
     41         *
    3542         * @todo À supprimer car non utilisé !
    36          * @var string */
     43         * @var string
     44         */
    3745        public $lang = "";
    3846
    3947        /**
    4048         * Option de markitup : rafraîchir la prévisu ?
     49         *
    4150         * @todo À supprimer car non utilisé !
    42          * @var bool */
     51         * @var bool
     52         */
    4353        public $previewAutoRefresh = false;
    4454
    4555        /**
    4656         * Option de markitup : nom de la fonction de prévisu
     57         *
    4758         * @todo À supprimer car on le redéfini dans l'appel javascript !
    48          * @var bool */
     59         * @var bool
     60         */
    4961        public $previewParserPath = "";
    5062
    5163        /**
    5264         * Option de markitup : que faire sur l'appuie de Entrée ?
    53          * @var array */
     65         *
     66         * @var array
     67         */
    5468        public $onEnter = array();
    5569
    5670        /**
    5771         * Option de markitup : que faire sur l'appuie de Shift+Entrée ?
     72         *
    5873         * @example array('keepDefault'=>false, 'replaceWith'=>"\n_ ")
    59          * @var array */
     74         * @var array
     75         */
    6076        public $onShiftEnter = array();
    6177
    6278        /**
    6379         * Option de markitup : que faire sur l'appuie de Control+Entrée ?
    64          * @var array */
     80         *
     81         * @var array
     82         */
    6583        public $onCtrlEnter = array();
    6684
    6785        /**
    6886         * Option de markitup : que faire sur l'appuie d'une tabulation ?
    69          * @var array */
     87         *
     88         * @var array
     89         */
    7090        public $onTab = array();
    7191
    7292        /**
    7393         * Option de markitup : Code JS à exécuter avant une insertion
    74          * @var string */
     94         *
     95         * @var string
     96         */
    7597        public $beforeInsert = "";
    7698
    7799        /**
    78100         * Option de markitup : Code JS à exécuter après une insertion
    79          * @var string */
     101         *
     102         * @var string
     103         */
    80104        public $afterInsert = "";
    81105
    82106        /**
    83107         * Description des outils/boutons et leurs sous boutons éventuels
    84          * @var array */
     108         *
     109         * @var array
     110         */
    85111        public $markupSet = array();
    86112
     
    88114         * Fonctions JS supplémentaires à écrire après la déclaration JSON
    89115         * des outils. Ces fonctions peuvent servir aux boutons.
    90          * @var string */
     116         *
     117         * @var string
     118         */
    91119        public $functions = "";
    92120
    93121        /**
    94122         * Liste des paramètres valides pour une description d'outils (markupSet)
    95          * @var array */
     123         *
     124         * @var array
     125         */
    96126        private $_liste_params_autorises = array(
    97127
     
    99129                'openWith',
    100130                'closeWith',
    101                 'openBlockWith', // sur multiline, avant les lignes selectionnees
    102                 'closeBlockWith', // sur multiline, apres les lignes selectionnees
    103                 'placeHolder', // remplace par ce texte lorsqu'il n'y a pas de selection
    104 
    105                 'beforeInsert', // avant l'insertion
    106                 'afterInsert', // apres l'insertion
     131                'openBlockWith',
     132                // sur multiline, avant les lignes selectionnees
     133                'closeBlockWith',
     134                // sur multiline, apres les lignes selectionnees
     135                'placeHolder',
     136                // remplace par ce texte lorsqu'il n'y a pas de selection
     137
     138                'beforeInsert',
     139                // avant l'insertion
     140                'afterInsert',
     141                // apres l'insertion
    107142                'beforeMultiInsert',
    108143                'afterMultiInsert',
    109144
    110                 'dropMenu', // appelle un sous menu
    111 
    112                 'name', // nom affiche au survol
    113                 'key', // raccourcis clavier
    114                 'className', // classe css utilisee
    115                 'lang', // langues dont le bouton doit apparaitre - array
    116                 'lang_not', // langues dont le bouton ne doit pas apparaitre - array
    117                 'selectionType', // '','word','line' : type de selection (normale, aux mots les plus proches, a la ligne la plus proche)
    118                 'multiline', // open/close sur chaque ligne (mais replace est applique sur l'ensemble de la selection)
    119                 'forceMultiline', // pour faire comme si on faisait systematiquement un control+shift (et replace est applique sur chaque ligne de la selection)
     145                'dropMenu',
     146                // appelle un sous menu
     147
     148                'name',
     149                // nom affiche au survol
     150                'key',
     151                // raccourcis clavier
     152                'className',
     153                // classe css utilisee
     154                'lang',
     155                // langues dont le bouton doit apparaitre - array
     156                'lang_not',
     157                // langues dont le bouton ne doit pas apparaitre - array
     158                'selectionType',
     159                // '','word','line' : type de selection (normale, aux mots les plus proches, a la ligne la plus proche)
     160                'multiline',
     161                // open/close sur chaque ligne (mais replace est applique sur l'ensemble de la selection)
     162                'forceMultiline',
     163                // pour faire comme si on faisait systematiquement un control+shift (et replace est applique sur chaque ligne de la selection)
    120164
    121165                'separator',
     
    140184         * @return void
    141185         */
    142         function __construct($params = array()){
    143                 foreach ($params as $p=>$v) {
     186        function __construct($params = array()) {
     187                foreach ($params as $p => $v) {
    144188                        if (isset($this->$p)) {
    145189                                // si tableau, on verifie les entrees
    146190                                if (is_array($v)) {
    147                                         $v = $this->verif_params($p,$v);
     191                                        $v = $this->verif_params($p, $v);
    148192                                }
    149193                                $this->$p = $v;
     
    166210        function verif_params($nom, $params = array()) {
    167211                // si markupset, on boucle sur les items
    168                 if (stripos($nom, 'markupSet')!==false) {
    169                         foreach ($params as $i=>$v) {
     212                if (stripos($nom, 'markupSet') !== false) {
     213                        foreach ($params as $i => $v) {
    170214                                $params[$i] = $this->verif_params($i, $v);
    171215                        }
    172                 }
    173                 // sinon on teste la validite
     216                } // sinon on teste la validite
    174217                else {
    175                         foreach ($params as $p=>$v) {
     218                        foreach ($params as $p => $v) {
    176219                                if (!in_array($p, $this->_liste_params_autorises)) {
    177220                                        unset($params[$p]);
     
    179222                        }
    180223                }
     224
    181225                return $params;
    182226        }
     
    212256         *     False si l'identifiant cherché n'est pas trouvé
    213257         */
    214         function affecter(&$tableau, $identifiant, $params = array(), $lieu = 'dedans', $plusieurs = false){
     258        function affecter(&$tableau, $identifiant, $params = array(), $lieu = 'dedans', $plusieurs = false) {
    215259                static $cle_de_recherche = 'id'; // ou className ?
    216260
    217261                if ($tableau === null) // utile ?
     262                {
    218263                        $tableau = &$this->markupSet;
    219 
    220                 if (!in_array($lieu, array('dedans','avant','apres')))
     264                }
     265
     266                if (!in_array($lieu, array('dedans', 'avant', 'apres'))) {
    221267                        $lieu = 'dedans';
     268                }
    222269
    223270                // present en premiere ligne ?
    224271                $trouve = false;
    225                 foreach ($tableau as $i => $v){
     272                foreach ($tableau as $i => $v) {
    226273                        if (isset($v[$cle_de_recherche]) and ($v[$cle_de_recherche] == $identifiant)) {
    227274                                $trouve = $i;
     
    234281                                // verifier que les insertions sont correctes
    235282                                $les_params = ($plusieurs ? $params : array($params));
    236                                 foreach ($les_params as $i=>$un_params) {
     283                                foreach ($les_params as $i => $un_params) {
    237284                                        $les_params[$i] = $this->verif_params($identifiant, $un_params);
    238285                                }
     
    241288                                if ($lieu == 'dedans' && !$plusieurs) {
    242289                                        return $tableau[$trouve] = array_merge($tableau[$trouve], $les_params[0]);
    243                                 }
    244                                 // avant ou apres, on insere ($params peut etre tableau cle/valeur ou tableau de tableaux cle/valeur)
     290                                } // avant ou apres, on insere ($params peut etre tableau cle/valeur ou tableau de tableaux cle/valeur)
    245291                                elseif ($lieu == 'avant') {
    246292                                        array_splice($tableau, $trouve, 0, $les_params);
     293
    247294                                        return $params;
    248                                 }
    249                                 elseif ($lieu == 'apres') {
     295                                } elseif ($lieu == 'apres') {
    250296                                        array_splice($tableau, $trouve+1, 0, $les_params);
     297
    251298                                        return $params;
    252299                                }
    253300                        }
     301
    254302                        return $tableau[$trouve];
    255303                }
    256304
    257305                // recursivons sinon !
    258                 foreach ($tableau as $i => $v){
     306                foreach ($tableau as $i => $v) {
    259307                        if (is_array($v)) {
    260308                                foreach ($v as $m => $n) {
    261                                         if (is_array($n) AND ($r = $this->affecter($tableau[$i][$m], $identifiant, $params, $lieu, $plusieurs)))
     309                                        if (is_array($n) AND ($r = $this->affecter($tableau[$i][$m], $identifiant, $params, $lieu, $plusieurs))) {
    262310                                                return $r;
    263                                 }
    264                         }
    265                 }
     311                                        }
     312                                }
     313                        }
     314                }
     315
    266316                return false;
    267317        }
     
    282332         *     false si aucun paramètre à affecter, true sinon.
    283333         */
    284         function affecter_a_tous(&$tableau, $params = array(), $ids = array()){
    285                 if (!$params)
     334        function affecter_a_tous(&$tableau, $params = array(), $ids = array()) {
     335                if (!$params) {
    286336                        return false;
    287 
    288                 if ($tableau === null)
     337                }
     338
     339                if ($tableau === null) {
    289340                        $tableau = &$this->markupSet;
     341                }
    290342
    291343                $params = $this->verif_params('divers', $params);
    292344
    293345                // merge de premiere ligne
    294                 foreach ($tableau as $i => &$v){
     346                foreach ($tableau as $i => &$v) {
    295347                        if (!$ids OR in_array($v['id'], $ids)) {
    296348                                $tableau[$i] = array_merge($tableau[$i], $params);
     
    301353                        }
    302354                }
     355
    303356                return true;
    304357        }
     
    321374        function set($identifiant, $params = array()) {
    322375                // prudence tout de meme a pas tout modifier involontairement (si array)
    323                 if (!$identifiant) return false;
     376                if (!$identifiant) {
     377                        return false;
     378                }
    324379
    325380                if (is_string($identifiant)) {
    326381                        return $this->affecter($this->markupSet, $identifiant, $params);
    327                 }
    328                 elseif (is_array($identifiant)) {
     382                } elseif (is_array($identifiant)) {
    329383                        return $this->affecter_a_tous($this->markupSet, $params, $identifiant);
    330384                }
     385
    331386                return false;
    332387        }
     
    346401                        return $a;
    347402                }
     403
    348404                return false;
    349405        }
     
    361417         *     array sinon : description de l'identifiant cherché.
    362418         */
    363         function afficher($identifiant){
    364                 return $this->set($identifiant,array('display'=>true));
     419        function afficher($identifiant) {
     420                return $this->set($identifiant, array('display' => true));
    365421        }
    366422
     
    377433         *     array sinon : description de l'identifiant cherché.
    378434         */
    379         function cacher($identifiant){
    380                 return $this->set($identifiant, array('display'=>false));
     435        function cacher($identifiant) {
     436                return $this->set($identifiant, array('display' => false));
    381437        }
    382438
     
    389445         *     false si aucun paramètre à affecter, true sinon.
    390446         */
    391         function afficherTout(){
    392                 return $this->affecter_a_tous($this->markupSet, array('display'=>true));
     447        function afficherTout() {
     448                return $this->affecter_a_tous($this->markupSet, array('display' => true));
    393449        }
    394450
     
    400456         *     false si aucun paramètre à affecter, true sinon.
    401457         */
    402         function cacherTout(){
    403                 return $this->affecter_a_tous($this->markupSet, array('display'=>false));
     458        function cacherTout() {
     459                return $this->affecter_a_tous($this->markupSet, array('display' => false));
    404460        }
    405461
     
    418474         *     False si l'identifiant cherché n'est pas trouvé
    419475         */
    420         function ajouterAvant($identifiant, $params){
     476        function ajouterAvant($identifiant, $params) {
    421477                return $this->affecter($this->markupSet, $identifiant, $params, 'avant');
    422478        }
     
    435491         *     False si l'identifiant cherché n'est pas trouvé
    436492         */
    437         function ajouterPlusieursAvant($identifiant, $tableau_params){
     493        function ajouterPlusieursAvant($identifiant, $tableau_params) {
    438494                return $this->affecter($this->markupSet, $identifiant, $tableau_params, 'avant', true);
    439495        }
     
    452508         *     False si l'identifiant cherché n'est pas trouvé
    453509         */
    454         function ajouterApres($identifiant, $params){
     510        function ajouterApres($identifiant, $params) {
    455511                return $this->affecter($this->markupSet, $identifiant, $params, 'apres');
    456512        }
     
    469525         *     False si l'identifiant cherché n'est pas trouvé
    470526         */
    471         function ajouterPlusieursApres($identifiant, $tableau_params){
     527        function ajouterPlusieursApres($identifiant, $tableau_params) {
    472528                return $this->affecter($this->markupSet, $identifiant, $tableau_params, 'apres', true);
    473529        }
     
    480536         * @return void
    481537         */
    482         function ajouterFonction($fonction){
    483                 if (false === strpos($this->functions, $fonction)){
     538        function ajouterFonction($fonction) {
     539                if (false === strpos($this->functions, $fonction)) {
    484540                        $this->functions .= "\n" . $fonction . "\n";
    485541                }
     
    493549         * @return void
    494550         */
    495         function enlever_elements_non_affiches(&$tableau){
     551        function enlever_elements_non_affiches(&$tableau) {
    496552                if ($tableau === null) { // utile ?
    497553                        $tableau = &$this->markupSet;
     
    502558                                unset($tableau[$p]);
    503559                                $tableau = array_values($tableau); // remettre les cles automatiques sinon json les affiche et ça plante.
    504                         }
    505                         // sinon, on lance une recursion sur les sous-menus
     560                        } // sinon, on lance une recursion sur les sous-menus
    506561                        else {
    507562                                if (isset($v['dropMenu']) and is_array($v['dropMenu'])) {
     
    528583         *     Tableau de description des outils
    529584         * @return void
    530         **/
     585         **/
    531586        function enlever_separateurs(&$tableau) {
    532587                if ($tableau === null) { // utile ?
     
    551606                                unset($tableau[$p]);
    552607                                $tableau = array_values($tableau); // remettre les cles automatiques sinon json les affiche et ça plante.
    553                         }
    554                         // sinon, on lance une recursion sur les sous-menus
     608                        } // sinon, on lance une recursion sur les sous-menus
    555609                        else {
    556610                                if (isset($v['dropMenu']) and is_array($v['dropMenu'])) {
     
    570624         */
    571625        function enlever_parametres_inutiles() {
    572                 foreach($this as $p=>$v){
     626                foreach ($this as $p => $v) {
    573627                        if (!$v) {
    574628                                if (is_array($v) or is_string($v)) {
     
    579633                        }
    580634                }
    581                 foreach($this->markupSet as $p=>$v) {
    582                         foreach ($v as $n=>$m) {
     635                foreach ($this->markupSet as $p => $v) {
     636                        foreach ($v as $n => $m) {
    583637                                if (in_array($n, array('id', 'display'))) {
    584638                                        unset($this->markupSet[$p][$n]);
     
    595649         * @return string Déclaration json de la barre
    596650         */
    597         function creer_json(){
     651        function creer_json() {
    598652                $barre = $this;
    599653                $type = $barre->nameSpace;
     
    611665                include_spip('inc/charsets');
    612666                $json = unicode2charset(html2unicode($json));
    613                 return "\n\nbarre_outils_$type = ".$json . "\n\n $fonctions";
     667
     668                return "\n\nbarre_outils_$type = " . $json . "\n\n $fonctions";
    614669        }
    615670
     
    632687                                return 'null';
    633688                        case is_string($var) :
    634                                 if (strtolower(substr(ltrim($var),0,8))=='function')
     689                                if (strtolower(substr(ltrim($var), 0, 8)) == 'function') {
    635690                                        return $var;
     691                                }
     692
    636693                                return '"' . addcslashes($var, "\"\\\n\r") . '"';
    637694                        case is_bool($var) :
     
    639696                        case is_scalar($var) :
    640697                                return $var;
    641                         case is_object( $var) :
     698                        case is_object($var) :
    642699                                $var = get_object_vars($var);
    643700                                $asso = true;
     
    655712                                                $sep = ',';
    656713                                        }
    657                                         return $ret ."}\n";
     714
     715                                        return $ret . "}\n";
    658716                                } else {
    659717                                        $ret = '[';
     
    662720                                                $sep = ',';
    663721                                        }
    664                                         return $ret ."]\n";
    665                                 }
    666                 }
     722
     723                                        return $ret . "]\n";
     724                                }
     725                }
     726
    667727                return false;
    668728        }
     
    683743 * @return string Déclaration CSS des icones
    684744 */
    685 function barre_outils_css_icones(){
     745function barre_outils_css_icones() {
    686746        // recuperer la liste, extraire les icones
    687747        $css = "";
    688748
    689749        // liste des barres
    690         if (!$barres = barre_outils_liste())
     750        if (!$barres = barre_outils_liste()) {
    691751                return null;
     752        }
    692753
    693754        // liste des classes css et leur correspondance avec une icone
     
    717778
    718779        // passage en css
    719         foreach ($classe2icone as $n=>$i) {
    720                 $pos="";
    721                 if (is_array($i)){
    722                         $pos = "background-position:".end($i);
    723                   $i = reset($i);
    724                 }
    725                 if (file_exists($i))
     780        foreach ($classe2icone as $n => $i) {
     781                $pos = "";
     782                if (is_array($i)) {
     783                        $pos = "background-position:" . end($i);
     784                        $i = reset($i);
     785                }
     786                if (file_exists($i)) {
    726787                        $file = $i;
    727                 else
     788                } else {
    728789                        $file = find_in_path("icones_barre/$i");
    729                 if ($file)
    730                         $css .= "\n.markItUp .$n>a>em {background-image:url(".protocole_implicite(url_absolue($file)).");$pos}";
     790                }
     791                if ($file) {
     792                        $css .= "\n.markItUp .$n>a>em {background-image:url(" . protocole_implicite(url_absolue($file)) . ");$pos}";
     793                }
    731794        }
    732795
     
    747810 *     La barre d'outil si la fonction a été trouvée, false sinon
    748811 */
    749 function barre_outils_initialiser($set){
     812function barre_outils_initialiser($set) {
    750813        if ($f = charger_fonction($set, 'barre_outils')) {
    751814                // retourne une instance de l'objet Barre_outils
    752815                return $f();
    753816        }
     817
    754818        return false;
    755819}
     
    762826 *     False si on ne trouve aucune barre.
    763827 */
    764 function barre_outils_liste(){
     828function barre_outils_liste() {
    765829        static $sets = -1;
    766         if ($sets !== -1)
     830        if ($sets !== -1) {
    767831                return $sets;
     832        }
    768833
    769834        // on recupere l'ensemble des barres d'outils connues
    770         if (!$sets = find_all_in_path('barre_outils/','.*[.]php')
    771         or !is_array($sets)) {
     835        if (!$sets = find_all_in_path('barre_outils/', '.*[.]php')
     836                or !is_array($sets)
     837        ) {
    772838                spip_log("[Scandale] Porte Plume ne trouve pas de barre d'outils !");
    773839                $sets = false;
     840
    774841                return $sets;
    775842        }
    776843
    777         foreach($sets as $fichier=>$adresse) {
    778                 $sets[$fichier] = substr($fichier,0,-4); // juste le nom
    779         }
     844        foreach ($sets as $fichier => $adresse) {
     845                $sets[$fichier] = substr($fichier, 0, -4); // juste le nom
     846        }
     847
    780848        return $sets;
    781849}
     
    814882        if (!strlen($nom_champ) || !isset($table_des_traitements[$nom_champ])) {
    815883                $texte = propre($texte, $connect);
    816         }
    817         else {
     884        } else {
    818885                include_spip('base/abstract_sql');
    819886                $table = table_objet($type_objet);
     
    827894                        // [FIXME] Éviter une notice sur le eval suivant qui ne connait
    828895                        // pas la Pile ici. C'est pas tres joli...
    829                         $Pile = array( 0 => array() );
     896                        $Pile = array(0 => array());
    830897                        // remplacer le placeholder %s par le texte fourni
    831898                        eval('$texte=' . str_replace('%s', '$texte', $ps) . ';');
Note: See TracChangeset for help on using the changeset viewer.