2 /***************************************************************************
3 * Copyright (C) 2003-2010 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 NAMETYPES
= 'nametypes';
33 const NAMES
= 'names';
35 const BINETS
= 'binets';
36 const GROUPESX
= 'groupesx';
37 const SECTIONS
= 'sections';
39 const EDUSCHOOLS
= 'educationschools';
40 const EDUDEGREES
= 'educationdegrees';
41 const EDUFIELDS
= 'educationfields';
43 const CORPS
= 'corps';
44 const CORPSRANKS
= 'corpsranks';
46 const NATIONALITIES
= 'nationalities';
47 const COUNTRIES
= 'countries';
48 const ADMINAREAS
= 'adminareas';
49 const LOCALITIES
= 'localities';
51 const COMPANIES
= 'companies';
52 const JOBDESCRIPTION
= 'jobdescription';
53 const JOBTERMS
= 'jobterms';
55 const NETWORKS
= 'networking';
57 const MEDALS
= 'medals';
59 const ACCOUNTTYPES
= 'accounttypes';
61 static private $enumerations = array();
63 static private function init($type)
65 if (Platal
::globals()->cacheEnabled() && S
::has('__DE_' . $type)) {
66 self
::$enumerations[$type] = S
::v('__DE_' . $type);
68 $cls = "DE_" . ucfirst($type);
70 self
::$enumerations[$type] = $obj;
71 if (Platal
::globals()->cacheEnabled()
72 && $obj->capabilities
& DirEnumeration
::SAVE_IN_SESSION
) {
73 S
::set('__DE_' . $type, $obj);
78 /** Retrieves all options for a given type
79 * @param $type Type of enum for which options are requested
80 * @return Array of the results
82 static public function getOptions($type)
84 if (!array_key_exists($type, self
::$enumerations)) {
87 $obj = self
::$enumerations[$type];
88 if ($obj->capabilities
& DirEnumeration
::HAS_OPTIONS
) {
89 return call_user_func(array($obj, 'getOptions'));
95 /** Retrieves all options for a given type
96 * @param $type Type of enum for which options are requested
97 * @return PlIterator over the results
99 static public function getOptionsIter($type)
101 if (!array_key_exists($type, self
::$enumerations)) {
104 $obj = self
::$enumerations[$type];
105 $args = func_get_args();
107 if ($obj->capabilities
& DirEnumeration
::HAS_OPTIONS
) {
108 return call_user_func_array(array($obj, 'getOptionsIter'), $args);
110 return PlIteratorUtils
::fromArray(array());
114 /** Retrieves all options with number of profiles for autocompletion
115 * @param $type Type of enum for which options are requested
116 * @param $text Text to autocomplete
117 * @return PlIterator over the results
119 static public function getAutoComplete($type, $text)
121 if (!array_key_exists($type, self
::$enumerations)) {
124 $obj = self
::$enumerations[$type];
125 if ($obj->capabilities
& DirEnumeration
::HAS_AUTOCOMP
) {
126 return call_user_func(array($obj, 'getAutoComplete'), $text);
128 return PlIteratorUtils
::fromArray(array());
132 /** Retrieves a list of IDs for a given type
133 * @param $type Type of enum for which IDs are requested
134 * @param $text Text to search in enum valuees
135 * @param $mode Mode of search for those IDs (prefix/suffix/infix)
137 static public function getIDs($type, $text, $mode = XDB
::WILDCARD_EXACT
)
139 if (!array_key_exists($type, self
::$enumerations)) {
142 $obj = self
::$enumerations[$type];
143 if ($obj->capabilities
& DirEnumeration
::HAS_OPTIONS
) {
144 return call_user_func(array($obj, 'getIDs'), $text, $mode);
150 /** Retrieves a single ID for a given type.
151 * @param $type Type of the enum for which an ID is requested
152 * @param $text Text to search in enum values
153 * @param $mode Mode of search of that ID (prefix/suffix/infix/exact)
155 static public function getID($type, $text, $mode = XDB
::WILDCARD_EXACT
)
157 $ids = self
::getIDs($type, $text, $mode);
158 return array_shift($ids);
163 // {{{ class DirEnumeration
164 abstract class DirEnumeration
166 const AUTOCOMPLETE_LIMIT
= 11;
168 const HAS_OPTIONS
= 0x001;
169 const HAS_AUTOCOMP
= 0x002;
170 const SAVE_IN_SESSION
= 0x004;
172 public $capabilities = 0x003; // self::HAS_OPTIONS | self::HAS_AUTOCOMP;
174 /** An internal array of ID => optionTxt
176 protected $options = null
;
178 /** Description of the MySQL storage of the fields
180 protected $idfield = 'id';
181 protected $valfield = 'text';
182 protected $valfield2 = null
;
184 protected $join = '';
185 protected $where = '';
187 /** Fields for autocompletion
189 protected $ac_join = ''; // Additional joins
190 protected $ac_where = null
; // Additional where
191 protected $ac_beginwith = true
; // Whether to search for 'x%' or for '%x%'
192 protected $ac_unique; // Which field is to be taken as unique
193 protected $ac_distinct = true
; // Whether we want to keep only distinct valfield value
194 protected $ac_withid = true
; // Do we want to fetch id too ?
196 protected function _fetchOptions()
198 if (is_null($this->options
)) {
199 $this->loadOptions();
203 public function getOptions()
205 $this->_fetchOptions();
206 return $this->options
;
209 public function getOptionsIter()
211 $options = $this->getOptions();
212 $options = self
::expandArray($options);
213 return PlIteratorUtils
::fromArray($options, 1, true
);
216 // {{{ function getIDs
217 /** Retrieves possible IDs for given text
218 * @param $text Text to search for IDs
219 * @param $mode Mode of search (PREFIX, SUFFIX, CONTAINS)
220 * @return An array of matching IDs ; if empty, input should be considered invalid
222 public function getIDs($text, $mode)
224 if ($mode == XDB
::WILDCARD_EXACT
) {
225 $options = $this->getOptions();
226 return array_keys($options, $text);
228 if ($this->where
== null
) {
231 $where = $this->where
. ' AND ';
234 $conds[] = $this->valfield
. XDB
::formatWildcards($mode, $text);
235 if ($this->valfield2
!= null
) {
236 $conds[] = $this->valfield2
. XDB
::formatWildcards($mode, $text);
238 $where .= '(' . implode(' OR ', $conds) . ')';
240 return XDB
::fetchColumn('SELECT ' . $this->idfield
. '
241 FROM ' . $this->from
. '
244 GROUP BY ' . $this->idfield
);
249 /** Builds a list of query parts for searching @$text in @$field :
250 * field LIKE 'text%', field LIKE '% text%', field LIKE '%-text%'
252 private function mkTests($field, $text)
255 $tests[] = $field . XDB
::formatWildcards(XDB
::WILDCARD_PREFIX
, $text);
256 if (!$this->ac_beginwith
) {
257 $tests[] = $field . XDB
::formatWildcards(XDB
::WILDCARD_CONTAINS
, ' ' . $text);
258 $tests[] = $field . XDB
::formatWildcards(XDB
::WILDCARD_CONTAINS
, '-' . $text);
263 static protected function expandArray(array $tab, $keyname = 'id', $valname = 'field')
266 foreach ($tab as $key => $val) {
275 // {{{ function getAutoComplete
276 public function getAutoComplete($text)
278 $text = str_replace(array('%', '_'), '', $text);
280 if (is_null($this->ac_where
) ||
$this->ac_where
== '') {
283 $where = $this->ac_where
. ' AND ';
286 $tests = $this->mkTests($this->valfield
, $text);
287 if (!is_null($this->valfield2
)) {
288 $tests = array_merge($tests, $this->mkTests($this->valfield2
, $text));
291 $where .= '(' . implode(' OR ', $tests) . ')';
293 return XDB
::iterator('SELECT ' . $this->valfield
. ' AS field'
294 . ($this->ac_distinct ?
(', COUNT(DISTINCT ' . $this->ac_unique
. ') AS nb') : '')
295 . ($this->ac_withid ?
(', ' . $this->idfield
. ' AS id') : '') . '
296 FROM ' . $this->from
. '
297 ' . $this->ac_join
. '
299 GROUP BY ' . $this->valfield
. '
300 ORDER BY ' . ($this->ac_distinct ?
'nb DESC' : $this->valfield
) . '
301 LIMIT ' . self
::AUTOCOMPLETE_LIMIT
);
305 // {{{ function loadOptions
306 /** The function used to load options
308 protected function loadOptions()
310 $this->options
= XDB
::fetchAllAssoc('id', 'SELECT ' . $this->valfield
. ' AS field,
311 ' . $this->idfield
. ' AS id
312 FROM ' . $this->from
. '
315 GROUP BY ' . $this->valfield
. '
316 ORDER BY ' . $this->valfield
);
322 // {{{ class DE_WithSuboption
323 /** A class for DirEnum with possibility to select only suboptions for a given parameter (country, school, ...)
325 abstract class DE_WithSuboption
extends DirEnumeration
329 protected $suboptions = null
;
331 protected function loadOptions()
333 $opts = XDB
::fetchAllAssoc('id', 'SELECT ' . $this->valfield
. ' AS field,
334 ' . $this->optfield
. ' AS subid,
335 ' . $this->idfield
. ' AS id
336 FROM ' . $this->from
. '
339 GROUP BY ' . $this->valfield
. '
340 ORDER BY ' . $this->valfield
);
341 $this->options
= array();
342 $this->suboptions
= array();
343 foreach ($opts as $id => $opt) {
344 $this->options
[$id] = $opt['field'];
345 if (!array_key_exists($opt['subid'], $this->suboptions
)) {
346 $this->suboptions
[$opt['subid']] = array();
348 $this->suboptions
[$opt['subid']][$id] = $opt['field'];
352 public function getOptions($subid = null
)
354 $this->_fetchOptions();
355 if ($subid == null
) {
356 return $this->options
;
357 } else if (array_key_exists($subid, $this->suboptions
)) {
358 return $this->suboptions
[$subid];
364 public function getOptionsIter($subid = null
)
366 return PlIteratorUtils
::fromArray(self
::expandArray($this->getOptions($subid)), 1, true
);
369 public function getIDs($text, $mode, $subid = null
)
371 if ($mode == XDB
::WILDCARD_EXACT
) {
372 $options = $this->getOptions($subid);
373 return array_keys($options, $text);
375 if ($this->where
== null
) {
378 $where = $this->where
. ' AND ';
380 if ($subid != null
&& array_key_exists($subid, $this->suboptions
)) {
381 $where .= XDB
::format($this->optfield
. ' = {?} AND ', $subid);
385 $conds[] = $this->valfield
. XDB
::formatWildcards($mode, $text);
386 if ($this->valfield2
!= null
) {
387 $conds[] = $this->valfield2
. XDB
::formatWildcards($mode, $text);
389 $where .= '(' . implode(' OR ', $conds) . ')';
391 return XDB
::fetchColumn('SELECT ' . $this->idfield
. '
392 FROM ' . $this->from
. '
395 GROUP BY ' . $this->idfield
);
399 public function getAutoComplete($text, $subid = null
)
401 $text = str_replace(array('%', '_'), '', $text);
403 if (is_null($this->ac_where
) ||
$this->ac_where
== '') {
406 $where = $this->ac_where
. ' AND ';
409 if ($subid != null
&& array_key_exists($subid, $this->suboptions
)) {
410 $where .= XDB
::format($this->optfield
. ' = {?} AND ', $subid);
413 $tests = $this->mkTests($this->valfield
, $text);
414 if (!is_null($this->valfield2
)) {
415 $tests = array_merge($tests, $this->mkTests($this->valfield2
, $text));
418 $where .= '(' . implode(' OR ', $tests) . ')';
420 return XDB
::iterator('SELECT ' . $this->valfield
. ' AS field'
421 . ($this->ac_distinct ?
(', COUNT(DISTINCT ' . $this->ac_unique
. ') AS nb') : '')
422 . ($this->ac_withid ?
(', ' . $this->idfield
. ' AS id') : '') . '
423 FROM ' . $this->from
. '
424 ' . $this->ac_join
. '
426 GROUP BY ' . $this->valfield
. '
427 ORDER BY ' . ($this->ac_distinct ?
'nb DESC' : $this->valfield
) . '
428 LIMIT ' . self
::AUTOCOMPLETE_LIMIT
);
433 // {{{ class DE_NameTypes
434 // returns 'system' names ('lastname', 'lastname_marital', ...)
435 class DE_NameTypes
extends DirEnumeration
437 public $capabilities = 0x005; // self::HAS_OPTIONS | self::SAVE_IN_SESSION;
439 protected $from = 'profile_name_enum';
440 protected $valfield = 'type';
444 // {{{ class DE_Names
445 // returns 'system' names ('lastname', 'lastname_marital', ...)
446 class DE_Names
extends DirEnumeration
448 public $capabilities = 0x005; // self::HAS_OPTIONS | self::SAVE_IN_SESSION;
450 protected $from = 'profile_name_enum';
451 protected $idfield = 'type';
452 protected $valfield = 'name';
458 // {{{ class DE_Binets
459 class DE_Binets
extends DirEnumeration
461 protected $from = 'profile_binet_enum';
463 protected $ac_join = 'INNER JOIN profile_binets ON (profile_binet_enum.id = profile_binets.binet_id)';
464 protected $ac_unique = 'profile_binets.pid';
468 // {{{ class DE_Sections
469 class DE_Sections
extends DirEnumeration
471 protected $from = 'profile_section_enum';
473 protected $ac_join = 'INNER JOIN profiles ON (profiles.section = profile_section_enum.id)';
474 protected $ac_unique = 'profiles.pid';
478 // {{{ class DE_GroupesX
479 class DE_GroupesX
extends DirEnumeration
481 protected $idfield = 'groups.id';
482 protected $valfield = 'groups.nom';
483 protected $valfield2 = 'groups.diminutif';
484 protected $from = 'groups';
485 protected $where = 'WHERE (cat = \'GroupesX\' OR cat = \'Institutions\') AND pub = \'public\'';
487 protected $ac_join = "INNER JOIN group_members ON (groups.id = group_members.asso_id
488 AND (groups.cat = 'GroupesX' OR groups.cat = 'Institutions')
489 AND groups.pub = 'public')";
490 protected $ac_unique = 'group_members.uid';
496 // {{{ class DE_EducationSchools
497 class DE_EducationSchools
extends DirEnumeration
499 protected $idfield = 'profile_education_enum.id';
500 protected $valfield = 'profile_education_enum.name';
501 protected $valfield2 = 'profile_education_enum.abbreviation';
502 protected $from = 'profile_education_enum';
504 protected $ac_join = 'INNER JOIN profile_education ON (profile_education.eduid = profile_education_enum.id)';
505 protected $ac_unique = 'profile_education.pid';
509 // {{{ class DE_EducationDegrees
510 class DE_EducationDegrees
extends DirEnumeration
512 public $capabilities = self
::HAS_OPTIONS
;
514 protected $idfield = 'profile_education_degree.degreeid';
515 protected $optfield = 'profile_education_degree.eduid';
516 protected $valfield = 'profile_education_degree_enum.degree';
517 protected $from = 'profile_education_degree_enum';
518 protected $join = 'INNER JOIN profile_education_degree ON (profile_education_degree.degreeid = profile_education_degree_enum.id)';
523 // {{{ class DE_EducationFields
524 class DE_EducationFields
extends DirEnumeration
526 protected $valfield = 'profile_education_field_enum.field';
527 protected $from = 'profile_education_field_enum';
529 protected $ac_join = 'INNER JOIN profile_education ON (profile_education.fieldid = profile_education_field_enum.id)';
530 protected $ac_unique = 'profile_education.pid';
534 // {{{ class DE_Corps
535 class DE_Corps
extends DirEnumeration
537 protected $idfield = 'profile_corps_enum.id';
538 protected $valfield = 'profile_corps_enum.name';
539 protected $valfield2 = 'profile_corps_enum.abbrev';
540 protected $from = 'profile_corps_enum';
542 protected $ac_unique = 'profile_corps.pid';
543 protected $ac_join = 'INNER JOIN profile_corps ON (profile_corps.current_corpsid = profile_corps_enum.id)';
547 // {{{ class DE_CorpsRanks
548 class DE_CorpsRanks
extends DirEnumeration
550 protected $idfield = 'profile_corps_rank_enum.id';
551 protected $valfield = 'profile_corps_rank_enum.name';
552 protected $valfield2 = 'profile_corps_rank_enum.abbrev';
553 protected $from = 'profile_corps_rank_enum';
555 protected $ac_unique = 'profile_corps.pid';
556 protected $ac_join = 'INNER JOIN profile_corps ON (profile_corps.rankid = profile_corps_rank_enum.id)';
562 // {{{ class DE_Nationalities
563 class DE_Nationalities
extends DirEnumeration
565 protected $idfield = 'geoloc_countries.iso_3166_1_a2';
566 protected $valfield = 'geoloc_countries.nationalityFR';
567 protected $valfield2 = 'geoloc_countries.nationality';
568 protected $from = 'geoloc_countries';
569 protected $join = 'INNER JOIN profiles ON (geoloc_countries.iso_3166_1_a2 IN (profiles.nationality1, profiles.nationality2, profiles.nationality3))';
571 protected $ac_join = 'INNER JOIN profiles ON (geoloc_countries.iso_3166_1_a2 IN (profiles.nationality1, profiles.nationality2, profiles.nationality3))';
572 protected $ac_unique = 'profiles.pid';
576 // {{{ class DE_Countries
577 class DE_Countries
extends DirEnumeration
579 protected $idfield = 'geoloc_countries.iso_3166_1_a2';
580 protected $valfield = 'geoloc_countries.countryFR';
581 protected $valfield2 = 'geoloc_countries.country';
582 protected $from = 'geoloc_countries';
584 protected $ac_join = 'INNER JOIN profile_addresses ON (geoloc_countries.iso_3166_1_a2 = profile_addresses.countryId)';
585 protected $ac_unique = 'profile_addresses.pid';
589 // {{{ class DE_AdminAreas
590 class DE_AdminAreas
extends DE_WithSuboption
592 protected $idfield = 'geoloc_administrativeareas.id';
593 protected $optfield = 'geoloc_administrativeareas.country';
594 protected $valfield = 'geoloc_administrativeareas.name';
595 protected $from = 'geoloc_administrativeareas';
597 protected $ac_join = 'INNER JOIN profile_addresses ON (profile_addresses.administrativeAreaId = geoloc_administrativeareas.id)';
598 protected $ac_unique = 'profile_addresses.pid';
602 // {{{ class DE_Localities
603 class DE_Localities
extends DirEnumeration
605 protected $idfield = 'geoloc_localities.id';
606 protected $valfield = 'geoloc_localities.name';
607 protected $from = 'geoloc_localities';
609 protected $ac_join = 'INNER JOIN profile_addresses ON (profile_addresses.localityID = geoloc_localities.id)';
610 protected $ac_unique = 'profile_addresses.pid';
616 // {{{ class DE_Companies
617 class DE_Companies
extends DirEnumeration
619 protected $idfield = 'profile_job_enum.id';
620 protected $valfield = 'profile_job_enum.name';
621 protected $valfield2 = 'profile_job_enum.acronym';
622 protected $from = 'profile_job_enum';
624 protected $ac_join = 'INNER JOIN profile_job ON (profile_job.jobid = profile_job_enum.id)';
625 protected $ac_unique = 'profile_job.pid';
629 // {{{ class DE_JobDescription
630 class DE_JobDescription
extends DirEnumeration
632 protected $valfield = 'profile_job.description';
633 protected $from = 'profile_job';
634 protected $idfield = 'profile_job.pid';
636 protected $ac_unique = 'profile_job.pid';
640 // {{{ class DE_JobTerms
641 class DE_JobTerms
extends DirEnumeration
643 // {{{ function getAutoComplete
644 public function getAutoComplete($text)
646 $tokens = JobTerms
::tokenize($text.'%');
647 if (count($tokens) == 0) {
648 return PlIteratorUtils
::fromArray(array());
650 $token_join = JobTerms
::token_join_query($tokens, 'e');
651 return XDB
::iterator('SELECT e.jtid AS id, e.full_name AS field, COUNT(DISTINCT p.pid) AS nb
652 FROM profile_job_term_enum AS e
653 INNER JOIN profile_job_term_relation AS r ON (r.jtid_1 = e.jtid)
654 INNER JOIN profile_job_term AS p ON (r.jtid_2 = p.jtid)
657 ORDER BY nb DESC, field
658 LIMIT ' . self
::AUTOCOMPLETE_LIMIT
);
666 // {{{ class DE_Networking
667 class DE_Networking
extends DirEnumeration
669 protected $idfield = 'profile_networking_enum.nwid';
670 protected $valfield = 'profile_networking_enum.name';
671 protected $from = 'profile_networking_enum';
674 protected $ac_join = 'INNER JOIN profile_networking ON (profile_networking.nwid = profile_networking_enum.nwid)';
675 protected $ac_unique = 'profile_networking.pid';
681 // {{{ class DE_Medals
682 class DE_Medals
extends DirEnumeration
684 protected $from = 'profile_medal_enum';
686 protected $ac_join = 'INNER JOIN profile_medals ON (profile_medals.mid = profile_medal_enum.id)';
687 protected $ac_unique = 'profile_medals.pid';
693 // {{{ class DE_AccountTypes
694 class DE_AccountTypes
extends DirEnumeration
696 public $capabilities = 0x005; // self::HAS_OPTIONS | self::SAVE_IN_SESSION;
698 protected $from = 'account_types';
699 protected $valfield = 'perms';
700 protected $idfield = 'type';
704 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8: