[SPIP][PLUGINS] v3.0-->v3.2
[lhc/web/www.git] / www / ecrire / inc / couleurs.php
index 58cb005..a51efda 100644 (file)
 /***************************************************************************\
  *  SPIP, Systeme de publication pour l'internet                           *
  *                                                                         *
- *  Copyright (c) 2001-2016                                                *
+ *  Copyright (c) 2001-2017                                                *
  *  Arnaud Martin, Antoine Pitrou, Philippe Riviere, Emmanuel Saint-James  *
  *                                                                         *
  *  Ce programme est un logiciel libre distribue sous licence GNU/GPL.     *
  *  Pour plus de details voir le fichier COPYING.txt ou l'aide en ligne.   *
 \***************************************************************************/
 
-if (!defined('_ECRIRE_INC_VERSION')) return;
+/**
+ * Couleurs de l'interface de l’espace privé de SPIP.
+ *
+ * @package SPIP\Core\Couleurs
+ */
 
-// Appelee sans argument, cette fonction retourne un menu de couleurs
-// Avec un argument numerique, elle retourne les parametres d'URL 
-// pour les feuilles de style calculees (cf commencer_page et svg)
-// Avec un argument de type tableau, soit elle remplace le tableau par defaut
-// par celui donne en argument, soit, avec le second parametre
-// a true, elle complete le tableau par celui donne en premier argument.
+if (!defined('_ECRIRE_INC_VERSION')) {
+       return;
+}
 
-// http://doc.spip.org/@inc_couleurs_dist
-function inc_couleurs_dist($choix=NULL, $ajouter=false)
-{
+/**
+ * Obtenir ou définir les différents jeux de couleurs de l'espace privé
+ *
+ * - Appelée _sans argument_, cette fonction retourne un tableau décrivant les jeux les couleurs possibles.
+ * - Avec un _argument numérique_, elle retourne les paramètres d'URL
+ *   pour les feuilles de style calculées (cf. formulaire configurer_preferences)
+ * - Avec un _argument de type tableau_ :
+ *   - soit elle remplace le tableau par défaut par celui donné en argument
+ *   - soit elle le complète, si `$ajouter` vaut `true`.
+ *
+ * @see formulaires_configurer_preferences_charger_dist()
+ *
+ * @staticvar array $couleurs_spip
+ * @param null|int|array $choix
+ * @param bool $ajouter
+ * @return array|string
+ */
+function inc_couleurs_dist($choix = null, $ajouter = false) {
        static $couleurs_spip = array(
-// Vert
-1 => array (
-               "couleur_foncee" => "#9DBA00",
-               "couleur_claire" => "#C5E41C",
-               "couleur_lien" => "#657701",
-               "couleur_lien_off" => "#A6C113"
+               // Saumon
+               4 => array(
+                       "couleur_foncee" => "#CDA261",
+                       "couleur_claire" => "#FFDDAA",
+                       "couleur_lien" => "#AA6A09",
+                       "couleur_lien_off" => "#B79562"
                ),
-// Violet clair
-2 => array (
-               "couleur_foncee" => "#eb68b3",
-               "couleur_claire" => "#ffa9e6",
-               "couleur_lien" => "#8F004D",
-               "couleur_lien_off" => "#BE6B97"
+               // Orange
+               3 => array(
+                       "couleur_foncee" => "#fa9a00",
+                       "couleur_claire" => "#ffc000",
+                       "couleur_lien" => "#FF5B00",
+                       "couleur_lien_off" => "#B49280"
                ),
-// Orange
-3 => array (
-               "couleur_foncee" => "#fa9a00",
-               "couleur_claire" => "#ffc000",
-               "couleur_lien" => "#FF5B00",
-               "couleur_lien_off" => "#B49280"
+               // Rouge
+               8 => array(
+                       "couleur_foncee" => "#DF4543",
+                       "couleur_claire" => "#FAACB0",
+                       "couleur_lien" => "#D0000A",
+                       "couleur_lien_off" => "#D96067"
                ),
-// Saumon
-4 => array (
-               "couleur_foncee" => "#CDA261",
-               "couleur_claire" => "#FFDDAA",
-               "couleur_lien" => "#AA6A09",
-               "couleur_lien_off" => "#B79562"
+               // Framboise
+               2 => array(
+                       "couleur_foncee" =>  "#D51B60",
+                       "couleur_claire" => "#EF91B4",
+                       "couleur_lien" => "#db1762",
+                       "couleur_lien_off" => "#E29FB6"
                ),
-//  Bleu pastel
-5 => array (
-               "couleur_foncee" => "#5da7c5",
-               "couleur_claire" => "#97d2e1",
-               "couleur_lien" => "#116587",
-               "couleur_lien_off" => "#81B7CD"
+               // Vert de gris
+               7 => array(
+                       "couleur_foncee" => "#999966",
+                       "couleur_claire" => "#CCCC99",
+                       "couleur_lien" => "#666633",
+                       "couleur_lien_off" => "#999966"
                ),
-//  Gris
-6 => array (
-               "couleur_foncee" => "#85909A",
-               "couleur_claire" => "#C0CAD4",
-               "couleur_lien" => "#3B5063",
-               "couleur_lien_off" => "#6D8499"
+               // Vert
+               1 => array(
+                       "couleur_foncee" => "#9DBA00",
+                       "couleur_claire" => "#C5E41C",
+                       "couleur_lien" => "#657701",
+                       "couleur_lien_off" => "#A6C113"
                ),
-// Vert de gris
-7 => array (
-               "couleur_foncee" => "#999966",
-               "couleur_claire" => "#CCCC99",
-               "couleur_lien" => "#666633",
-               "couleur_lien_off" => "#999966"
+               //  Bleu pastel
+               5 => array(
+                       "couleur_foncee" => "#5da7c5",
+                       "couleur_claire" => "#97d2e1",
+                       "couleur_lien" => "#116587",
+                       "couleur_lien_off" => "#81B7CD"
                ),
-// Rose vieux
-8 => array (
-               "couleur_foncee" => "#EB68B3",
-               "couleur_claire" => "#E4A7C5",
-               "couleur_lien" => "#8F004D",
-               "couleur_lien_off" => "#BE6B97"
+               // Violet
+               9 => array(
+                       "couleur_foncee" => "#8F8FBD",
+                       "couleur_claire" => "#C4C4DD",
+                       "couleur_lien" => "#6071A5",
+                       "couleur_lien_off" => "#5C5C8C"
                ),
-// Violet
-9 => array (
-               "couleur_foncee" => "#8F8FBD",
-               "couleur_claire" => "#C4C4DD",
-               "couleur_lien" => "#6071A5",
-               "couleur_lien_off" => "#5C5C8C"
+               //  Gris
+               6 => array(
+                       "couleur_foncee" => "#85909A",
+                       "couleur_claire" => "#C0CAD4",
+                       "couleur_lien" => "#3B5063",
+                       "couleur_lien_off" => "#6D8499"
                ),
-//  Gris
-10 => array (
-               "couleur_foncee" => "#909090",
-               "couleur_claire" => "#D3D3D3",
-               "couleur_lien" => "#808080",
-               "couleur_lien_off" => "#909090"
+               //  Gris
+               10 => array(
+                       "couleur_foncee" => "#909090",
+                       "couleur_claire" => "#D3D3D3",
+                       "couleur_lien" => "#808080",
+                       "couleur_lien_off" => "#909090"
                ),
-);
+       );
 
        if (is_numeric($choix)) {
                // Compatibilite ascendante (plug-ins notamment)
@@ -101,17 +117,17 @@ function inc_couleurs_dist($choix=NULL, $ajouter=false)
                $GLOBALS["couleur_foncee"] = $couleurs_spip[$choix]['couleur_foncee'];
                $GLOBALS["couleur_lien"] = $couleurs_spip[$choix]['couleur_lien'];
                $GLOBALS["couleur_lien_off"] = $couleurs_spip[$choix]['couleur_lien_off'];
-               
-         return
-           "couleur_claire=" .
-           substr($couleurs_spip[$choix]['couleur_claire'],1).
-           '&couleur_foncee=' .
-           substr($couleurs_spip[$choix]['couleur_foncee'],1);
+
+               return
+                       "couleur_claire=" . substr($couleurs_spip[$choix]['couleur_claire'], 1) .
+                       '&couleur_foncee=' . substr($couleurs_spip[$choix]['couleur_foncee'], 1);
        } else {
                if (is_array($choix)) {
                        if ($ajouter) {
-                               foreach($choix as $c)
+                               foreach ($choix as $c) {
                                        $couleurs_spip[] = $c;
+                               }
+
                                return $couleurs_spip;
                        } else {
                                return $couleurs_spip = $choix;
@@ -119,7 +135,6 @@ function inc_couleurs_dist($choix=NULL, $ajouter=false)
                }
 
        }
+
        return $couleurs_spip;
 }
-
-?>