Add class DirEnum, to access all enumerations used in the site

Signed-off-by: Raphaël Barrois <raphael.barrois@polytechnique.org>

diff --git a/include/directory.enums.inc.php b/include/directory.enums.inc.php
new file mode 100644 (file)
index 0000000..013e0d7
--- /dev/null
+++ b/include/directory.enums.inc.php
@@ -0,0 +1,209 @@
+<?php
+/***************************************************************************
+ *  Copyright (C) 2003-2010 Polytechnique.org                              *
+ *  http://opensource.polytechnique.org/                                   *
+ *                                                                         *
+ *  This program is free software; you can redistribute it and/or modify   *
+ *  it under the terms of the GNU General Public License as published by   *
+ *  the Free Software Foundation; either version 2 of the License, or      *
+ *  (at your option) any later version.                                    *
+ *                                                                         *
+ *  This program is distributed in the hope that it will be useful,        *
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of         *
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
+ *  GNU General Public License for more details.                           *
+ *                                                                         *
+ *  You should have received a copy of the GNU General Public License      *
+ *  along with this program; if not, write to the Free Software            *
+ *  Foundation, Inc.,                                                      *
+ *  59 Temple Place, Suite 330, Boston, MA  02111-1307  USA                *
+ ***************************************************************************/
+
+/** This class stores all data for the different kinds of fields.
+ * It is only a dispatcher for the various DirEnum_XXX classes.
+ */
+class DirEnum
+{
+    /** Name of availables Enumerations
+     * Each of these consts contains the basename of the class (its full name
+     * being DE_$basename).
+     */
+    const BINETS        = 'binets';
+    const SECTIONS      = 'sections';
+    const SCHOOLS       = 'schools';
+    const DEGREES       = 'degrees';
+    const NATIONALITIES = 'nationalities';
+    const COUNTRIES     = 'countries';
+    const GROUPESX      = 'groupesx';
+    const SECTORS       = 'sectors';
+    const NETWORKS      = 'networking';
+    const ADMINAREAS    = 'adminareas';
+
+    static private $enumerations = array();
+
+    static private function init($type)
+    {
+        $cls = "DE_" . ucfirst($type);
+        self::$enumerations[$type] = new $cls();
+    }
+
+    /** Retrieves all options for a given type
+     * @param $type Type of enum for which options are requested
+     * @return XorgDbIterator over the results
+     * TODO : add support for optional parameters transmitted to enumerations
+     * TODO : Find a way to get either an array, or the adequate PlIterator
+     */
+    static public function getOptions()
+    {
+        $args = func_get_args();
+        $type = array_shift($args);
+        if (!array_key_exists($type, self::$enumerations)) {
+            self::init($type);
+        }
+        $obj = self::$enumerations[$type];
+        return call_user_func_array(array($obj, 'getOptions'), $args);
+    }
+}
+
+abstract class DirEnumeration
+{
+    /** An internal array of ID => optionTxt
+     */
+    protected $options;
+
+    protected $idfield  = 'id';
+    protected $valfield = 'text';
+    protected $from;
+    protected $where = '';
+
+    public function __construct() {
+        $this->loadOptions();
+    }
+
+    public function getOptions()
+    {
+        return $this->options;
+    }
+
+    /** The function used to load options
+     */
+    protected function loadOptions()
+    {
+        $this->options = XDB::iterator('SELECT ' . $this->valfield . ' AS field,
+                                               ' . $this->idfield . ' AS id
+                                          FROM ' . $this->from . '
+                                               ' . $this->where . '
+                                      GROUP BY ' . $this->valfield . '
+                                      ORDER BY ' . $this->valfield);
+    }
+}
+
+class DE_Binets extends DirEnumeration
+{
+    protected $from = 'binets_def';
+}
+class DE_Sections extends DirEnumeration
+{
+    protected $from = 'sections';
+}
+class DE_Schools extends DirEnumeration
+{
+    protected $valfield = 'name';
+    protected $from = 'profile_education_enum';
+}
+class DE_Degrees extends DirEnumeration
+{
+    protected $suboptions = array();
+
+    protected function loadOptions()
+    {
+        $res = XDB::query('SELECT ped.eduid, ped.degreeid, pede.degree
+                             FROM profile_education_enum AS pee
+                        LEFT JOIN profile_education_degree AS ped ON (pee.id = ped.eduid)
+                        LEFT JOIN profile_education_degree_enum AS pede ON (ped.degreeid = pede.id)
+                         ORDER BY pede.degree');
+        foreach($res->fetchAllRow() as $row) {
+            list($eduid, $degreeid, $name) = $row;
+            $this->options[$degreeid] = array('id' => $degreeid, 'field' => $name);
+            if (!array_key_exists($eduid, $this->suboptions)) {
+                $this->suboptions[$eduid] = array();
+            }
+            $this->suboptions[$eduid][] = array('id' => $degreeid, 'field' => $name);
+        }
+    }
+
+    public function getOptions($eduid = null)
+    {
+        if ($eduid == null) {
+            return PlIteratorUtils::fromArray($this->options, 1, true);
+        }
+        if (array_key_exists($eduid, $this->suboptions)) {
+            return PlIteratorUtils::fromArray($this->suboptions[$eduid], 1, true);
+        } else {
+            return array();
+        }
+    }
+}
+class DE_Nationalities extends DirEnumeration
+{
+    protected $idfield  = 'iso_3166_1_a2';
+    protected $valfield = 'nationalityFR';
+    protected $from     = 'geoloc_countries AS gc';
+    protected $where    = 'INNER JOIN profiles AS p ON (gc.iso_3166_1_a2 IN (p.nationality1, p.nationality2, p.nationality3))';
+}
+class DE_Countries extends DirEnumeration
+{
+    protected $idfield  = 'iso_3166_1_a2';
+    protected $valfield = 'countryFR';
+    protected $from     = 'geoloc_countries';
+}
+class DE_AdminAreas extends DirEnumeration
+{
+    protected $suboptions = array();
+
+    protected function loadOptions()
+    {
+        $res = XDB::query('SELECT id, name AS field, country
+                             FROM geoloc_administrativeareas
+                         GROUP BY name
+                         ORDER BY name');
+        foreach($res->fetchAllRow() as $row) {
+            list($id, $field, $country) = $row;
+            $this->options[] = array('id' => $id, 'field' => $field);
+            if (!array_key_exists($country, $this->suboptions)) {
+                $this->suboptions[$country] = array();
+            }
+            $this->suboptions[$country][] = array('id' => $id, 'field' => $field);
+        }
+    }
+
+    public function getOptions($country = null)
+    {
+        if ($country == null) {
+            return PlIteratorUtils::fromArray($this->options, 1, true);
+        }
+        if (array_key_exists($country, $this->suboptions)) {
+            return PlIteratorUtils::fromArray($this->suboptions[$country], 1, true);
+        } else {
+            return array();
+        }
+    }
+}
+class DE_GroupesX extends DirEnumeration
+{
+    protected $valfield = 'nom';
+    protected $from     = '#groupex#.asso';
+    protected $where    = 'WHERE (cat = \'GroupesX\' OR cat = \'Institutions\') AND pub = \'public\'';
+}
+class DE_Sectors extends DirEnumeration
+{
+    protected $valfield = 'name';
+    protected $from     = 'profile_job_sector_enum';
+}
+class DE_Networking extends DirEnumeration
+{
+    protected $idfield  = 'network_type';
+    protected $valfield = 'name';
+    protected $from     = 'profile_networking_enum';
+}
+?>