2 /***************************************************************************
3 * Copyright (C) 2003-2011 Polytechnique.org *
4 * http://opensource.polytechnique.org/ *
6 * This program is free software; you can redistribute it and/or modify *
7 * it under the terms of the GNU General Public License as published by *
8 * the Free Software Foundation; either version 2 of the License, or *
9 * (at your option) any later version. *
11 * This program is distributed in the hope that it will be useful, *
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
14 * GNU General Public License for more details. *
16 * You should have received a copy of the GNU General Public License *
17 * along with this program; if not, write to the Free Software *
19 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA *
20 ***************************************************************************/
23 /** This class stores all data for the different kinds of fields.
24 * It is only a dispatcher for the various DirEnum_XXX classes.
28 /** Name of availables Enumerations
29 * Each of these consts contains the basename of the class (its full name
30 * being DE_$basename).
32 const BINETS
= 'binets';
33 const GROUPESX
= 'groupesx';
34 const SECTIONS
= 'sections';
36 const EDUSCHOOLS
= 'educationschools';
37 const EDUDEGREES
= 'educationdegrees';
38 const EDUFIELDS
= 'educationfields';
40 const CURRENTCORPS
= 'currentcorps';
41 const ORIGINCORPS
= 'origincorps';
42 const CORPSRANKS
= 'corpsranks';
44 const NATIONALITIES
= 'nationalities';
45 const SUBLOCALITIES
= 'sublocalities';
46 const LOCALITIES
= 'localities';
47 const ADMNISTRATIVEAREAS3
= 'admnistrativeareas3';
48 const ADMNISTRATIVEAREAS2
= 'admnistrativeareas2';
49 const ADMNISTRATIVEAREAS1
= 'admnistrativeareas1';
50 const COUNTRIES
= 'countries';
52 const COMPANIES
= 'companies';
53 const JOBDESCRIPTION
= 'jobdescription';
54 const JOBTERMS
= 'jobterms';
56 const NETWORKS
= 'networking';
58 const MEDALS
= 'medals';
60 const ACCOUNTTYPES
= 'accounttypes';
61 const SKINS
= 'skins';
63 static private $enumerations = array();
65 static private function init($type)
67 if (Platal
::globals()->cacheEnabled() && S
::has('__DE_' . $type)) {
68 self
::$enumerations[$type] = S
::v('__DE_' . $type);
70 $cls = "DE_" . ucfirst($type);
72 self
::$enumerations[$type] = $obj;
73 if (Platal
::globals()->cacheEnabled()
74 && $obj->capabilities
& DirEnumeration
::SAVE_IN_SESSION
) {
75 S
::set('__DE_' . $type, $obj);
80 /** Retrieves all options for a given type
81 * @param $type Type of enum for which options are requested
82 * @return Array of the results
84 static public function getOptions($type)
86 if (!array_key_exists($type, self
::$enumerations)) {
89 $obj = self
::$enumerations[$type];
90 if ($obj->capabilities
& DirEnumeration
::HAS_OPTIONS
) {
91 return call_user_func(array($obj, 'getOptions'));
97 /** Retrieves all options for a given type
98 * @param $type Type of enum for which options are requested
99 * @return PlIterator over the results
101 static public function getOptionsIter($type)
103 if (!array_key_exists($type, self
::$enumerations)) {
106 $obj = self
::$enumerations[$type];
107 $args = func_get_args();
109 if ($obj->capabilities
& DirEnumeration
::HAS_OPTIONS
) {
110 return call_user_func_array(array($obj, 'getOptionsIter'), $args);
112 return PlIteratorUtils
::fromArray(array());
116 /** Retrieves all options with number of profiles for autocompletion
117 * @param $type Type of enum for which options are requested
118 * @param $text Text to autocomplete
119 * @return PlIterator over the results
121 static public function getAutoComplete($type, $text)
123 if (!array_key_exists($type, self
::$enumerations)) {
126 $obj = self
::$enumerations[$type];
127 if ($obj->capabilities
& DirEnumeration
::HAS_AUTOCOMP
) {
128 return call_user_func(array($obj, 'getAutoComplete'), $text);
130 return PlIteratorUtils
::fromArray(array());
134 /** Retrieves a list of IDs for a given type
135 * @param $type Type of enum for which IDs are requested
136 * @param $text Text to search in enum valuees
137 * @param $mode Mode of search for those IDs (prefix/suffix/infix)
139 static public function getIDs($type, $text, $mode = XDB
::WILDCARD_EXACT
)
141 if (!array_key_exists($type, self
::$enumerations)) {
144 $obj = self
::$enumerations[$type];
145 if ($obj->capabilities
& DirEnumeration
::HAS_OPTIONS
) {
146 return call_user_func(array($obj, 'getIDs'), $text, $mode);
152 /** Retrieves a single ID for a given type.
153 * @param $type Type of the enum for which an ID is requested
154 * @param $text Text to search in enum values
155 * @param $mode Mode of search of that ID (prefix/suffix/infix/exact)
157 static public function getID($type, $text, $mode = XDB
::WILDCARD_EXACT
)
159 $ids = self
::getIDs($type, $text, $mode);
160 return array_shift($ids);
165 // {{{ class DirEnumeration
166 abstract class DirEnumeration
168 const AUTOCOMPLETE_LIMIT
= 11;
170 const HAS_OPTIONS
= 0x001;
171 const HAS_AUTOCOMP
= 0x002;
172 const SAVE_IN_SESSION
= 0x004;
174 public $capabilities = 0x003; // self::HAS_OPTIONS | self::HAS_AUTOCOMP;
176 /** An internal array of ID => optionTxt
178 protected $options = null
;
180 /** Description of the MySQL storage of the fields
182 protected $idfield = 'id';
183 protected $valfield = 'text';
184 protected $valfield2 = null
;
186 protected $join = '';
187 protected $where = '';
189 /** Fields for autocompletion
191 protected $ac_join = ''; // Additional joins
192 protected $ac_where = null
; // Additional where
193 protected $ac_beginwith = true
; // Whether to search for 'x%' or for '%x%'
194 protected $ac_unique; // Which field is to be taken as unique
195 protected $ac_distinct = true
; // Whether we want to keep only distinct valfield value
196 protected $ac_withid = true
; // Do we want to fetch id too ?
198 protected function _fetchOptions()
200 if (is_null($this->options
)) {
201 $this->loadOptions();
205 public function getOptions()
207 $this->_fetchOptions();
208 return $this->options
;
211 public function getOptionsIter()
213 $options = $this->getOptions();
214 $options = self
::expandArray($options);
215 return PlIteratorUtils
::fromArray($options, 1, true
);
218 // {{{ function getIDs
219 /** Retrieves possible IDs for given text
220 * @param $text Text to search for IDs
221 * @param $mode Mode of search (PREFIX, SUFFIX, CONTAINS)
222 * @return An array of matching IDs ; if empty, input should be considered invalid
224 public function getIDs($text, $mode)
226 if ($mode == XDB
::WILDCARD_EXACT
) {
227 $options = $this->getOptions();
228 return array_keys($options, $text);
230 if ($this->where
== null
) {
233 $where = $this->where
. ' AND ';
236 $conds[] = $this->valfield
. XDB
::formatWildcards($mode, $text);
237 if ($this->valfield2
!= null
) {
238 $conds[] = $this->valfield2
. XDB
::formatWildcards($mode, $text);
240 $where .= '(' . implode(' OR ', $conds) . ')';
242 return XDB
::fetchColumn('SELECT ' . $this->idfield
. '
243 FROM ' . $this->from
. '
246 GROUP BY ' . $this->idfield
);
251 /** Builds a list of query parts for searching @$text in @$field :
252 * field LIKE 'text%', field LIKE '% text%', field LIKE '%-text%'
254 private function mkTests($field, $text)
257 $tests[] = $field . XDB
::formatWildcards(XDB
::WILDCARD_PREFIX
, $text);
258 if (!$this->ac_beginwith
) {
259 $tests[] = $field . XDB
::formatWildcards(XDB
::WILDCARD_CONTAINS
, ' ' . $text);
260 $tests[] = $field . XDB
::formatWildcards(XDB
::WILDCARD_CONTAINS
, '-' . $text);
265 static protected function expandArray(array $tab, $keyname = 'id', $valname = 'field')
268 foreach ($tab as $key => $val) {
277 // {{{ function getAutoComplete
278 public function getAutoComplete($text)
280 $text = str_replace(array('%', '_'), '', $text);
282 if (is_null($this->ac_where
) ||
$this->ac_where
== '') {
285 $where = $this->ac_where
. ' AND ';
288 $tests = $this->mkTests($this->valfield
, $text);
289 if (!is_null($this->valfield2
)) {
290 $tests = array_merge($tests, $this->mkTests($this->valfield2
, $text));
293 $where .= '(' . implode(' OR ', $tests) . ')';
295 return XDB
::iterator('SELECT ' . $this->valfield
. ' AS field'
296 . ($this->ac_distinct ?
(', COUNT(DISTINCT ' . $this->ac_unique
. ') AS nb') : '')
297 . ($this->ac_withid ?
(', ' . $this->idfield
. ' AS id') : '') . '
298 FROM ' . $this->from
. '
299 ' . $this->ac_join
. '
301 GROUP BY ' . $this->valfield
. '
302 ORDER BY ' . ($this->ac_distinct ?
'nb DESC' : $this->valfield
) . '
303 LIMIT ' . self
::AUTOCOMPLETE_LIMIT
);
307 // {{{ function loadOptions
308 /** The function used to load options
310 protected function loadOptions()
312 $this->options
= XDB
::fetchAllAssoc('id', 'SELECT ' . $this->valfield
. ' AS field,
313 ' . $this->idfield
. ' AS id
314 FROM ' . $this->from
. '
317 GROUP BY ' . $this->valfield
. '
318 ORDER BY ' . $this->valfield
);
324 // {{{ class DE_WithSuboption
325 /** A class for DirEnum with possibility to select only suboptions for a given parameter (country, school, ...)
327 abstract class DE_WithSuboption
extends DirEnumeration
331 protected $suboptions = null
;
333 protected function _fetchSubOptions($subid)
335 if (is_null($this->suboptions
)) {
336 $this->loadSubOptions($subid);
340 protected function loadSubOptions($subid)
342 $where = ($this->where
== '') ?
'' : $this->where
. ' AND ';
343 $this->suboptions
= XDB
::fetchAllAssoc('id', 'SELECT ' . $this->valfield
. ' AS field,
344 ' . $this->idfield
. ' AS id
345 FROM ' . $this->from
. '
347 WHERE ' . $where . $this->optfield
. ' = ' . $subid . '
348 GROUP BY ' . $this->valfield
. '
349 ORDER BY ' . $this->valfield
);
352 public function getOptions($subid = null
)
354 if ($subid == null
) {
355 $this->_fetchOptions();
356 return $this->options
;
359 $this->_fetchSubOptions($subid);
360 if (is_array($this->suboptions
)) {
361 return $this->suboptions
;
367 public function getOptionsIter($subid = null
)
369 return PlIteratorUtils
::fromArray(self
::expandArray($this->getOptions($subid)), 1, true
);
372 public function getIDs($text, $mode, $subid = null
)
374 if ($mode == XDB
::WILDCARD_EXACT
) {
375 $options = $this->getOptions($subid);
376 return array_keys($options, $text);
378 if ($this->where
== null
) {
381 $where = $this->where
. ' AND ';
383 if ($subid != null
&& array_key_exists($subid, $this->suboptions
)) {
384 $where .= XDB
::format($this->optfield
. ' = {?} AND ', $subid);
388 $conds[] = $this->valfield
. XDB
::formatWildcards($mode, $text);
389 if ($this->valfield2
!= null
) {
390 $conds[] = $this->valfield2
. XDB
::formatWildcards($mode, $text);
392 $where .= '(' . implode(' OR ', $conds) . ')';
394 return XDB
::fetchColumn('SELECT ' . $this->idfield
. '
395 FROM ' . $this->from
. '
398 GROUP BY ' . $this->idfield
);
402 public function getAutoComplete($text, $subid = null
)
404 $text = str_replace(array('%', '_'), '', $text);
406 if (is_null($this->ac_where
) ||
$this->ac_where
== '') {
409 $where = $this->ac_where
. ' AND ';
412 if ($subid != null
&& array_key_exists($subid, $this->suboptions
)) {
413 $where .= XDB
::format($this->optfield
. ' = {?} AND ', $subid);
416 $tests = $this->mkTests($this->valfield
, $text);
417 if (!is_null($this->valfield2
)) {
418 $tests = array_merge($tests, $this->mkTests($this->valfield2
, $text));
421 $where .= '(' . implode(' OR ', $tests) . ')';
423 return XDB
::iterator('SELECT ' . $this->valfield
. ' AS field'
424 . ($this->ac_distinct ?
(', COUNT(DISTINCT ' . $this->ac_unique
. ') AS nb') : '')
425 . ($this->ac_withid ?
(', ' . $this->idfield
. ' AS id') : '') . '
426 FROM ' . $this->from
. '
427 ' . $this->ac_join
. '
429 GROUP BY ' . $this->valfield
. '
430 ORDER BY ' . ($this->ac_distinct ?
'nb DESC' : $this->valfield
) . '
431 LIMIT ' . self
::AUTOCOMPLETE_LIMIT
);
438 // {{{ class DE_Binets
439 class DE_Binets
extends DirEnumeration
441 protected $from = 'profile_binet_enum';
443 protected $ac_join = 'INNER JOIN profile_binets ON (profile_binet_enum.id = profile_binets.binet_id)';
444 protected $ac_unique = 'profile_binets.pid';
448 // {{{ class DE_Sections
449 class DE_Sections
extends DirEnumeration
451 protected $from = 'profile_section_enum';
453 protected $ac_join = 'INNER JOIN profiles ON (profiles.section = profile_section_enum.id)';
454 protected $ac_unique = 'profiles.pid';
458 // {{{ class DE_GroupesX
459 class DE_GroupesX
extends DirEnumeration
461 protected $idfield = 'groups.id';
462 protected $valfield = 'groups.nom';
463 protected $valfield2 = 'groups.diminutif';
464 protected $from = 'groups';
465 protected $where = 'WHERE (cat = \'GroupesX\' OR cat = \'Institutions\') AND pub = \'public\'';
467 protected $ac_join = "INNER JOIN group_members ON (groups.id = group_members.asso_id
468 AND (groups.cat = 'GroupesX' OR groups.cat = 'Institutions')
469 AND groups.pub = 'public')";
470 protected $ac_unique = 'group_members.uid';
476 // {{{ class DE_EducationSchools
477 class DE_EducationSchools
extends DirEnumeration
479 protected $ac_beginwith = false
;
480 protected $idfield = 'profile_education_enum.id';
481 protected $valfield = 'profile_education_enum.name';
482 protected $valfield2 = 'profile_education_enum.abbreviation';
483 protected $from = 'profile_education_enum';
485 protected $ac_join = 'INNER JOIN profile_education ON (profile_education.eduid = profile_education_enum.id)';
486 protected $ac_unique = 'profile_education.pid';
490 // {{{ class DE_EducationDegrees
491 class DE_EducationDegrees
extends DE_WithSuboption
493 public $capabilities = self
::HAS_OPTIONS
;
495 protected $idfield = 'profile_education_degree.degreeid';
496 protected $optfield = 'profile_education_degree.eduid';
497 protected $valfield = 'profile_education_degree_enum.degree';
498 protected $from = 'profile_education_degree_enum';
499 protected $join = 'INNER JOIN profile_education_degree ON (profile_education_degree.degreeid = profile_education_degree_enum.id)';
504 // {{{ class DE_EducationFields
505 class DE_EducationFields
extends DirEnumeration
507 protected $valfield = 'profile_education_field_enum.field';
508 protected $from = 'profile_education_field_enum';
510 protected $ac_join = 'INNER JOIN profile_education ON (profile_education.fieldid = profile_education_field_enum.id)';
511 protected $ac_unique = 'profile_education.pid';
515 // {{{ class DE_CurrentCorps
516 class DE_CurrentCorps
extends DirEnumeration
518 protected $idfield = 'profile_corps_enum.id';
519 protected $valfield = 'profile_corps_enum.name';
520 protected $valfield2 = 'profile_corps_enum.abbrev';
521 protected $from = 'profile_corps_enum';
522 protected $where = 'WHERE profile_corps_enum.still_exists = 1';
524 protected $ac_unique = 'profile_corps.pid';
525 protected $ac_join = 'INNER JOIN profile_corps ON (profile_corps.current_corpsid = profile_corps_enum.id)';
529 // {{{ class DE_OriginCorps
530 class DE_OriginCorps
extends DirEnumeration
532 protected $idfield = 'profile_corps_enum.id';
533 protected $valfield = 'profile_corps_enum.name';
534 protected $valfield2 = 'profile_corps_enum.abbrev';
535 protected $from = 'profile_corps_enum';
537 protected $ac_unique = 'profile_corps.pid';
538 protected $ac_join = 'INNER JOIN profile_corps ON (profile_corps.original_corpsid = profile_corps_enum.id)';
542 // {{{ class DE_CorpsRanks
543 class DE_CorpsRanks
extends DirEnumeration
545 protected $idfield = 'profile_corps_rank_enum.id';
546 protected $valfield = 'profile_corps_rank_enum.name';
547 protected $valfield2 = 'profile_corps_rank_enum.abbrev';
548 protected $from = 'profile_corps_rank_enum';
550 protected $ac_unique = 'profile_corps.pid';
551 protected $ac_join = 'INNER JOIN profile_corps ON (profile_corps.rankid = profile_corps_rank_enum.id)';
557 // {{{ class DE_Nationalities
558 class DE_Nationalities
extends DirEnumeration
560 protected $idfield = 'geoloc_countries.iso_3166_1_a2';
561 protected $valfield = 'geoloc_countries.nationality';
562 protected $valfield2 = 'geoloc_countries.nationalityEn';
563 protected $from = 'geoloc_countries';
564 protected $join = 'INNER JOIN profiles ON (geoloc_countries.iso_3166_1_a2 IN (profiles.nationality1, profiles.nationality2, profiles.nationality3))';
566 protected $ac_join = 'INNER JOIN profiles ON (geoloc_countries.iso_3166_1_a2 IN (profiles.nationality1, profiles.nationality2, profiles.nationality3))';
567 protected $ac_unique = 'profiles.pid';
571 // {{{ class DE_AddressesComponents
572 class DE_AddressesComponents
extends DirEnumeration
574 protected $idfield = 'profile_addresses_components_enum.id';
575 protected $valfield = 'profile_addresses_components_enum.long_name';
576 protected $from = 'profile_addresses_components_enum';
578 protected $ac_join = 'INNER JOIN profile_addresses_components ON (profile_addresses_components.component_id = profile_addresses_components_enum.id)';
579 protected $ac_unique = 'profile_addresses_components.pid';
582 // {{{ class DE_AddressesComponents extensions
583 class DE_Countries
extends DE_AddressesComponents
585 protected $where = 'WHERE FIND_IN_SET(\'country\', profile_addresses_components_enum.types)';
586 protected $ac_where = 'profile_addresses_components.type = \'home\' AND FIND_IN_SET(\'country\', profile_addresses_components_enum.types)';
589 class DE_Admnistrativeareas1
extends DE_AddressesComponents
591 protected $where = 'WHERE FIND_IN_SET(\'admnistrative_area_1\', profile_addresses_components_enum.types)';
592 protected $ac_where = 'profile_addresses_components.type = \'home\' AND FIND_IN_SET(\'admnistrative_area_1\', profile_addresses_components_enum.types)';
595 class DE_Admnistrativeareas2
extends DE_AddressesComponents
597 protected $where = 'WHERE FIND_IN_SET(\'admnistrative_area_2\', profile_addresses_components_enum.types)';
598 protected $ac_where = 'profile_addresses_components.type = \'home\' AND FIND_IN_SET(\'admnistrative_area_2\', profile_addresses_components_enum.types)';
601 class DE_Admnistrativeareas3
extends DE_AddressesComponents
603 protected $where = 'WHERE FIND_IN_SET(\'admnistrative_area_3\', profile_addresses_components_enum.types)';
604 protected $ac_where = 'profile_addresses_components.type = \'home\' AND FIND_IN_SET(\'admnistrative_area_3\', profile_addresses_components_enum.types)';
607 class DE_Localities
extends DE_AddressesComponents
609 protected $where = 'WHERE FIND_IN_SET(\'locality\', profile_addresses_components_enum.types)';
610 protected $ac_where = 'profile_addresses_components.type = \'home\' AND FIND_IN_SET(\'locality\', profile_addresses_components_enum.types)';
613 class DE_Sublocalities
extends DE_AddressesComponents
615 protected $where = 'WHERE FIND_IN_SET(\'sublocality\', profile_addresses_components_enum.types)';
616 protected $ac_where = 'profile_addresses_components.type = \'home\' AND FIND_IN_SET(\'sublocality\', profile_addresses_components_enum.types)';
619 class DE_Postalcodes
extends DE_AddressesComponents
621 protected $where = 'WHERE FIND_IN_SET(\'postal_code\', profile_addresses_components_enum.types)';
622 protected $ac_where = 'profile_addresses_components.type = \'home\' AND FIND_IN_SET(\'postal_code\', profile_addresses_components_enum.types)';
629 // {{{ class DE_Companies
630 class DE_Companies
extends DirEnumeration
632 protected $idfield = 'profile_job_enum.id';
633 protected $valfield = 'profile_job_enum.name';
634 protected $valfield2 = 'profile_job_enum.acronym';
635 protected $from = 'profile_job_enum';
637 protected $ac_join = 'INNER JOIN profile_job ON (profile_job.jobid = profile_job_enum.id)';
638 protected $ac_unique = 'profile_job.pid';
642 // {{{ class DE_JobDescription
643 class DE_JobDescription
extends DirEnumeration
645 protected $valfield = 'profile_job.description';
646 protected $from = 'profile_job';
647 protected $idfield = 'profile_job.pid';
649 protected $ac_unique = 'profile_job.pid';
653 // {{{ class DE_JobTerms
654 class DE_JobTerms
extends DirEnumeration
656 // {{{ function getAutoComplete
657 public function getAutoComplete($text)
659 $tokens = JobTerms
::tokenize($text.'%');
660 if (count($tokens) == 0) {
661 return PlIteratorUtils
::fromArray(array());
663 $token_join = JobTerms
::token_join_query($tokens, 'e');
664 return XDB
::iterator('SELECT e.jtid AS id, e.full_name AS field, COUNT(DISTINCT p.pid) AS nb
665 FROM profile_job_term_enum AS e
666 INNER JOIN profile_job_term_relation AS r ON (r.jtid_1 = e.jtid)
667 INNER JOIN profile_job_term AS p ON (r.jtid_2 = p.jtid)
670 ORDER BY nb DESC, field
671 LIMIT ' . self
::AUTOCOMPLETE_LIMIT
);
679 // {{{ class DE_Networking
680 class DE_Networking
extends DirEnumeration
682 protected $idfield = 'profile_networking_enum.nwid';
683 protected $valfield = 'profile_networking_enum.name';
684 protected $from = 'profile_networking_enum';
687 protected $ac_join = 'INNER JOIN profile_networking ON (profile_networking.nwid = profile_networking_enum.nwid)';
688 protected $ac_unique = 'profile_networking.pid';
694 // {{{ class DE_Medals
695 class DE_Medals
extends DirEnumeration
697 protected $from = 'profile_medal_enum';
699 protected $ac_join = 'INNER JOIN profile_medals ON (profile_medals.mid = profile_medal_enum.id)';
700 protected $ac_unique = 'profile_medals.pid';
706 // {{{ class DE_AccountTypes
707 class DE_AccountTypes
extends DirEnumeration
709 public $capabilities = 0x005; // self::HAS_OPTIONS | self::SAVE_IN_SESSION;
711 protected $from = 'account_types';
712 protected $valfield = 'perms';
713 protected $idfield = 'type';
717 // {{{ class DE_Skins
718 class DE_Skins
extends DirEnumeration
720 public $capabilities = 0x005; // self::HAS_OPTIONS | self::SAVE_IN_SESSION;
722 protected $from = 'skins';
723 protected $valfield = 'name';
724 protected $idfield = 'skin_tpl';
728 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8: