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 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 SUBADMINAREAS
= 'subadminareas';
50 const LOCALITIES
= 'localities';
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 loadOptions()
335 $opts = XDB
::fetchAllAssoc('id', 'SELECT ' . $this->valfield
. ' AS field,
336 ' . $this->optfield
. ' AS subid,
337 ' . $this->idfield
. ' AS id
338 FROM ' . $this->from
. '
341 GROUP BY ' . $this->valfield
. '
342 ORDER BY ' . $this->valfield
);
343 $this->options
= array();
344 $this->suboptions
= array();
345 foreach ($opts as $id => $opt) {
346 $this->options
[$id] = $opt['field'];
347 if (!array_key_exists($opt['subid'], $this->suboptions
)) {
348 $this->suboptions
[$opt['subid']] = array();
350 $this->suboptions
[$opt['subid']][$id] = $opt['field'];
354 public function getOptions($subid = null
)
356 $this->_fetchOptions();
357 if ($subid == null
) {
358 return $this->options
;
359 } else if (array_key_exists($subid, $this->suboptions
)) {
360 return $this->suboptions
[$subid];
366 public function getOptionsIter($subid = null
)
368 return PlIteratorUtils
::fromArray(self
::expandArray($this->getOptions($subid)), 1, true
);
371 public function getIDs($text, $mode, $subid = null
)
373 if ($mode == XDB
::WILDCARD_EXACT
) {
374 $options = $this->getOptions($subid);
375 return array_keys($options, $text);
377 if ($this->where
== null
) {
380 $where = $this->where
. ' AND ';
382 if ($subid != null
&& array_key_exists($subid, $this->suboptions
)) {
383 $where .= XDB
::format($this->optfield
. ' = {?} AND ', $subid);
387 $conds[] = $this->valfield
. XDB
::formatWildcards($mode, $text);
388 if ($this->valfield2
!= null
) {
389 $conds[] = $this->valfield2
. XDB
::formatWildcards($mode, $text);
391 $where .= '(' . implode(' OR ', $conds) . ')';
393 return XDB
::fetchColumn('SELECT ' . $this->idfield
. '
394 FROM ' . $this->from
. '
397 GROUP BY ' . $this->idfield
);
401 public function getAutoComplete($text, $subid = null
)
403 $text = str_replace(array('%', '_'), '', $text);
405 if (is_null($this->ac_where
) ||
$this->ac_where
== '') {
408 $where = $this->ac_where
. ' AND ';
411 if ($subid != null
&& array_key_exists($subid, $this->suboptions
)) {
412 $where .= XDB
::format($this->optfield
. ' = {?} AND ', $subid);
415 $tests = $this->mkTests($this->valfield
, $text);
416 if (!is_null($this->valfield2
)) {
417 $tests = array_merge($tests, $this->mkTests($this->valfield2
, $text));
420 $where .= '(' . implode(' OR ', $tests) . ')';
422 return XDB
::iterator('SELECT ' . $this->valfield
. ' AS field'
423 . ($this->ac_distinct ?
(', COUNT(DISTINCT ' . $this->ac_unique
. ') AS nb') : '')
424 . ($this->ac_withid ?
(', ' . $this->idfield
. ' AS id') : '') . '
425 FROM ' . $this->from
. '
426 ' . $this->ac_join
. '
428 GROUP BY ' . $this->valfield
. '
429 ORDER BY ' . ($this->ac_distinct ?
'nb DESC' : $this->valfield
) . '
430 LIMIT ' . self
::AUTOCOMPLETE_LIMIT
);
435 // {{{ class DE_NameTypes
436 // returns 'system' names ('lastname', 'lastname_marital', ...)
437 class DE_NameTypes
extends DirEnumeration
439 public $capabilities = 0x005; // self::HAS_OPTIONS | self::SAVE_IN_SESSION;
441 protected $from = 'profile_name_enum';
442 protected $valfield = 'type';
446 // {{{ class DE_Names
447 // returns 'system' names ('lastname', 'lastname_marital', ...)
448 class DE_Names
extends DirEnumeration
450 public $capabilities = 0x005; // self::HAS_OPTIONS | self::SAVE_IN_SESSION;
452 protected $from = 'profile_name_enum';
453 protected $idfield = 'type';
454 protected $valfield = 'name';
460 // {{{ class DE_Binets
461 class DE_Binets
extends DirEnumeration
463 protected $from = 'profile_binet_enum';
465 protected $ac_join = 'INNER JOIN profile_binets ON (profile_binet_enum.id = profile_binets.binet_id)';
466 protected $ac_unique = 'profile_binets.pid';
470 // {{{ class DE_Sections
471 class DE_Sections
extends DirEnumeration
473 protected $from = 'profile_section_enum';
475 protected $ac_join = 'INNER JOIN profiles ON (profiles.section = profile_section_enum.id)';
476 protected $ac_unique = 'profiles.pid';
480 // {{{ class DE_GroupesX
481 class DE_GroupesX
extends DirEnumeration
483 protected $idfield = 'groups.id';
484 protected $valfield = 'groups.nom';
485 protected $valfield2 = 'groups.diminutif';
486 protected $from = 'groups';
487 protected $where = 'WHERE (cat = \'GroupesX\' OR cat = \'Institutions\') AND pub = \'public\'';
489 protected $ac_join = "INNER JOIN group_members ON (groups.id = group_members.asso_id
490 AND (groups.cat = 'GroupesX' OR groups.cat = 'Institutions')
491 AND groups.pub = 'public')";
492 protected $ac_unique = 'group_members.uid';
498 // {{{ class DE_EducationSchools
499 class DE_EducationSchools
extends DirEnumeration
501 protected $idfield = 'profile_education_enum.id';
502 protected $valfield = 'profile_education_enum.name';
503 protected $valfield2 = 'profile_education_enum.abbreviation';
504 protected $from = 'profile_education_enum';
506 protected $ac_join = 'INNER JOIN profile_education ON (profile_education.eduid = profile_education_enum.id)';
507 protected $ac_unique = 'profile_education.pid';
511 // {{{ class DE_EducationDegrees
512 class DE_EducationDegrees
extends DirEnumeration
514 public $capabilities = self
::HAS_OPTIONS
;
516 protected $idfield = 'profile_education_degree.degreeid';
517 protected $optfield = 'profile_education_degree.eduid';
518 protected $valfield = 'profile_education_degree_enum.degree';
519 protected $from = 'profile_education_degree_enum';
520 protected $join = 'INNER JOIN profile_education_degree ON (profile_education_degree.degreeid = profile_education_degree_enum.id)';
525 // {{{ class DE_EducationFields
526 class DE_EducationFields
extends DirEnumeration
528 protected $valfield = 'profile_education_field_enum.field';
529 protected $from = 'profile_education_field_enum';
531 protected $ac_join = 'INNER JOIN profile_education ON (profile_education.fieldid = profile_education_field_enum.id)';
532 protected $ac_unique = 'profile_education.pid';
536 // {{{ class DE_Corps
537 class DE_Corps
extends DirEnumeration
539 protected $idfield = 'profile_corps_enum.id';
540 protected $valfield = 'profile_corps_enum.name';
541 protected $valfield2 = 'profile_corps_enum.abbrev';
542 protected $from = 'profile_corps_enum';
544 protected $ac_unique = 'profile_corps.pid';
545 protected $ac_join = 'INNER JOIN profile_corps ON (profile_corps.current_corpsid = profile_corps_enum.id)';
549 // {{{ class DE_CorpsRanks
550 class DE_CorpsRanks
extends DirEnumeration
552 protected $idfield = 'profile_corps_rank_enum.id';
553 protected $valfield = 'profile_corps_rank_enum.name';
554 protected $valfield2 = 'profile_corps_rank_enum.abbrev';
555 protected $from = 'profile_corps_rank_enum';
557 protected $ac_unique = 'profile_corps.pid';
558 protected $ac_join = 'INNER JOIN profile_corps ON (profile_corps.rankid = profile_corps_rank_enum.id)';
564 // {{{ class DE_Nationalities
565 class DE_Nationalities
extends DirEnumeration
567 protected $idfield = 'geoloc_countries.iso_3166_1_a2';
568 protected $valfield = 'geoloc_countries.nationality';
569 protected $valfield2 = 'geoloc_countries.nationalityEn';
570 protected $from = 'geoloc_countries';
571 protected $join = 'INNER JOIN profiles ON (geoloc_countries.iso_3166_1_a2 IN (profiles.nationality1, profiles.nationality2, profiles.nationality3))';
573 protected $ac_join = 'INNER JOIN profiles ON (geoloc_countries.iso_3166_1_a2 IN (profiles.nationality1, profiles.nationality2, profiles.nationality3))';
574 protected $ac_unique = 'profiles.pid';
578 // {{{ class DE_Countries
579 class DE_Countries
extends DirEnumeration
581 protected $idfield = 'geoloc_countries.iso_3166_1_a2';
582 protected $valfield = 'geoloc_countries.country';
583 protected $valfield2 = 'geoloc_countries.countryEn';
584 protected $from = 'geoloc_countries';
586 protected $ac_join = 'INNER JOIN profile_addresses ON (geoloc_countries.iso_3166_1_a2 = profile_addresses.countryId)';
587 protected $ac_unique = 'profile_addresses.pid';
591 // {{{ class DE_AdminAreas
592 class DE_AdminAreas
extends DE_WithSuboption
594 protected $idfield = 'geoloc_administrativeareas.id';
595 protected $optfield = 'geoloc_administrativeareas.country';
596 protected $valfield = 'geoloc_administrativeareas.name';
597 protected $from = 'geoloc_administrativeareas';
599 protected $ac_join = 'INNER JOIN profile_addresses ON (profile_addresses.administrativeAreaId = geoloc_administrativeareas.id)';
600 protected $ac_unique = 'profile_addresses.pid';
604 // {{{ class DE_SubAdminAreas
605 class DE_SubAdminAreas
extends DE_WithSuboption
607 protected $idfield = 'geoloc_subadministrativeareas.id';
608 protected $optfield = 'geoloc_subadministrativeareas.administrativearea';
609 protected $valfield = 'geoloc_subadministrativeareas.name';
610 protected $from = 'geoloc_subadministrativeareas';
612 protected $ac_join = 'INNER JOIN profile_addresses ON (profile_addresses.subadministrativeAreaId = geoloc_subadministrativeareas.id)';
613 protected $ac_unique = 'profile_addresses.pid';
617 // {{{ class DE_Localities
618 class DE_Localities
extends DirEnumeration
620 protected $idfield = 'geoloc_localities.id';
621 protected $valfield = 'geoloc_localities.name';
622 protected $from = 'geoloc_localities';
624 protected $ac_join = 'INNER JOIN profile_addresses ON (profile_addresses.localityID = geoloc_localities.id)';
625 protected $ac_unique = 'profile_addresses.pid';
631 // {{{ class DE_Companies
632 class DE_Companies
extends DirEnumeration
634 protected $idfield = 'profile_job_enum.id';
635 protected $valfield = 'profile_job_enum.name';
636 protected $valfield2 = 'profile_job_enum.acronym';
637 protected $from = 'profile_job_enum';
639 protected $ac_join = 'INNER JOIN profile_job ON (profile_job.jobid = profile_job_enum.id)';
640 protected $ac_unique = 'profile_job.pid';
644 // {{{ class DE_JobDescription
645 class DE_JobDescription
extends DirEnumeration
647 protected $valfield = 'profile_job.description';
648 protected $from = 'profile_job';
649 protected $idfield = 'profile_job.pid';
651 protected $ac_unique = 'profile_job.pid';
655 // {{{ class DE_JobTerms
656 class DE_JobTerms
extends DirEnumeration
658 // {{{ function getAutoComplete
659 public function getAutoComplete($text)
661 $tokens = JobTerms
::tokenize($text.'%');
662 if (count($tokens) == 0) {
663 return PlIteratorUtils
::fromArray(array());
665 $token_join = JobTerms
::token_join_query($tokens, 'e');
666 return XDB
::iterator('SELECT e.jtid AS id, e.full_name AS field, COUNT(DISTINCT p.pid) AS nb
667 FROM profile_job_term_enum AS e
668 INNER JOIN profile_job_term_relation AS r ON (r.jtid_1 = e.jtid)
669 INNER JOIN profile_job_term AS p ON (r.jtid_2 = p.jtid)
672 ORDER BY nb DESC, field
673 LIMIT ' . self
::AUTOCOMPLETE_LIMIT
);
681 // {{{ class DE_Networking
682 class DE_Networking
extends DirEnumeration
684 protected $idfield = 'profile_networking_enum.nwid';
685 protected $valfield = 'profile_networking_enum.name';
686 protected $from = 'profile_networking_enum';
689 protected $ac_join = 'INNER JOIN profile_networking ON (profile_networking.nwid = profile_networking_enum.nwid)';
690 protected $ac_unique = 'profile_networking.pid';
696 // {{{ class DE_Medals
697 class DE_Medals
extends DirEnumeration
699 protected $from = 'profile_medal_enum';
701 protected $ac_join = 'INNER JOIN profile_medals ON (profile_medals.mid = profile_medal_enum.id)';
702 protected $ac_unique = 'profile_medals.pid';
708 // {{{ class DE_AccountTypes
709 class DE_AccountTypes
extends DirEnumeration
711 public $capabilities = 0x005; // self::HAS_OPTIONS | self::SAVE_IN_SESSION;
713 protected $from = 'account_types';
714 protected $valfield = 'perms';
715 protected $idfield = 'type';
719 // {{{ class DE_Skins
720 class DE_Skins
extends DirEnumeration
722 public $capabilities = 0x005; // self::HAS_OPTIONS | self::SAVE_IN_SESSION;
724 protected $from = 'skins';
725 protected $valfield = 'name';
726 protected $idfield = 'skin_tpl';
730 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8: