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 ***************************************************************************/
22 // {{{ class ProfileField
23 /** To store a "field" from the profile
24 * Provides functions for loading a batch of such data
26 abstract class ProfileField
28 public static $fields = array(
29 Profile
::FETCH_ADDRESSES
=> 'ProfileAddresses',
30 Profile
::FETCH_CORPS
=> 'ProfileCorps',
31 Profile
::FETCH_EDU
=> 'ProfileEducation',
32 Profile
::FETCH_JOBS
=> 'ProfileJobs',
33 Profile
::FETCH_MEDALS
=> 'ProfileMedals',
34 Profile
::FETCH_NETWORKING
=> 'ProfileNetworking',
35 Profile
::FETCH_PHONES
=> 'ProfilePhones',
36 Profile
::FETCH_MENTOR_SECTOR
=> 'ProfileMentoringSectors',
37 Profile
::FETCH_MENTOR_COUNTRY
=> 'ProfileMentoringCountries',
40 /** The profile to which this field belongs
44 /** Fetches data from the database for the given pids, compatible with
45 * the visibility context.
46 * @param $pids An array of pids
47 * @param $visibility The level of visibility fetched fields must have
48 * @return a PlIterator yielding data suitable for a "new ProfileBlah($data)"
49 * XXX MUST be reimplemented for each kind of ProfileField
51 public static function fetchData(array $pids, ProfileVisibility
$visibility)
53 return PlIteratorUtils
::emptyIterator();
56 public static function buildForPID($cls, $pid, ProfileVisibility
$visibility)
58 $res = self
::buildFromPIDs($cls, array($pid), $visibility);
59 return array_pop($res);
62 /** Build a list of ProfileFields from a set of pids
63 * @param $cls The name of the field to create ('ProfileMedals', ...)
64 * @param $pids An array of pids
65 * @param $visibility An array of allowed visibility contexts
66 * @return An array of $pid => ProfileField
68 public static function buildFromPIDs($cls, array $pids, ProfileVisibility
$visibility)
70 $it = new ProfileFieldIterator($cls, $pids, $visibility);
72 while ($pf = $it->next()) {
78 public static function getForPID($cls, $pid, ProfileVisibility
$visibility)
80 $it = new ProfileFieldIterator($cls, array($pid), $visibility);
86 // {{{ class ProfileFieldIterator
87 class ProfileFieldIterator
implements PlIterator
92 public function __construct($cls, array $pids, ProfileVisibility
$visibility)
94 $this->data
= call_user_func(array($cls, 'fetchData'), $pids, $visibility);
98 public function next()
100 $d = $this->data
->next();
109 public function total()
111 return $this->data
->total();
114 public function first()
116 return $this->data
->first();
119 public function last()
121 return $this->data
->last();
129 const TYPE_FAX
= 'fax';
130 const TYPE_FIXED
= 'fixed';
131 const TYPE_MOBILE
= 'mobile';
136 public $comment = '';
138 const LINK_JOB
= 'job';
139 const LINK_ADDRESS
= 'address';
140 const LINK_PROFILE
= 'user';
141 const LINK_COMPANY
= 'hq';
146 * $type, $search, $display, $link_type, $link_id, $comment, $pid, $id
148 public function __construct($data)
150 foreach ($data as $key => $val) {
163 public $phone = null
;
164 public $address = null
;
167 * $id, $name, $acronym, $url
169 public function __construct($data)
171 foreach ($data as $key => $val) {
176 public function setPhone(Phone
&$phone)
178 if ($phone->link_type
== Phone
::LINK_COMPANY
&& $phone->link_id
== $this->id
) {
179 $this->phone
= $phone;
183 public function setAddress(Address
&$address)
185 if ($address->link_type
== Address
::LINK_COMPANY
&& $address->link_id
== $this->id
) {
186 $this->address
= $address;
198 public $company = null
;
199 private $phones = array();
200 private $address = null
;
210 public $subsubsector;
213 * pid, id, company_id, description, url, email
215 public function __construct($data)
217 foreach ($data as $key => $val) {
220 $this->company
= CompanyList
::get($this->jobid
);
223 public function phones()
225 return $this->phones
;
228 public function address()
230 return $this->address
;
233 public function addPhone(Phone
&$phone)
235 if ($phone->link_type
== Phone
::LINK_JOB
&& $phone->link_id
== $this->id
&& $phone->pid
== $this->pid
) {
236 $this->phones
[] = $phone;
240 public function setAddress(Address
$address)
242 if ($address->link_id
== Address
::LINK_JOB
&& $address->link_id
== $this->id
&& $address->pid
== $this->pid
) {
243 $this->address
= $address;
251 const LINK_JOB
= 'job';
252 const LINK_COMPANY
= 'hq';
253 const LINK_PROFILE
= 'home';
265 public $subAdministrativeArea;
266 public $administrativeArea;
271 private $phones = array();
274 * pîd, id, link_id, link_type, flags, text, postcode, country
276 public function __construct($data)
278 foreach ($data as $key => $val) {
281 $this->flags
= new PlFlagSet($this->flags
);
284 public function addPhone(Phone
&$phone)
286 if ($phone->link_type
== Phone
::LINK_ADDRESS
&& $phone->link_id
== $this->id
&& $phone->pid
== $this->pid
) {
287 $this->phones
[] = $phone;
291 public function phones()
293 return $this->phones
;
296 public function hasFlag($flag)
298 return $this->flags
->hasFlag($flag);
302 // {{{ class Education
314 public $school_short;
319 public $degree_short;
320 public $degree_level;
324 public function __construct(array $data)
326 foreach ($data as $key => $val) {
329 $this->flags
= new PlFlagSet($this->flags
);
334 // {{{ class ProfileEducation [ Field ]
335 class ProfileEducation
extends ProfileField
337 private $educations = array();
339 public function __construct(PlInnerSubIterator
$it)
341 $this->pid
= $it->value();
342 while ($edu = $it->next()) {
343 $this->educations
[$edu['id']] = new Education($edu);
347 public function get($flags, $limit)
349 $educations = array();
351 $year = $year['year'];
353 foreach ($this->educations
as $id => $edu) {
355 (($flags & Profile
::EDUCATION_MAIN
) && $edu->flags
->hasFlag('primary'))
357 (($flags & Profile
::EDUCATION_EXTRA
) && !$edu->flags
->hasFlag('primary'))
359 (($flags & Profile
::EDUCATION_FINISHED
) && $edu->grad_year
<= $year)
361 (($flags & Profile
::EDUCATION_CURRENT
) && $edu->grad_year
> $year)
363 ($flags & Profile
::EDUCATION_ALL
)
365 $educations[$id] = $edu;
368 if ($limit != null
&& $nb >= $limit) {
375 public static function fetchData(array $pids, ProfileVisibility
$visibility)
377 $data = XDB
::iterator('SELECT pe.id, pe.pid,
378 pe.entry_year, pe.grad_year, pe.program, pe.flags,
379 pee.name AS school, pee.abbreviation AS school_short,
380 pee.url AS school_url, gc.countryFR AS country,
381 pede.degree, pede.abbreviation AS degree_short, pede.level AS degree_level,
383 FROM profile_education AS pe
384 LEFT JOIN profile_education_enum AS pee ON (pee.id = pe.eduid)
385 LEFT JOIN geoloc_countries AS gc ON (gc.iso_3166_1_a2 = pee.country)
386 LEFT JOIN profile_education_degree_enum AS pede ON (pede.id = pe.degreeid)
387 LEFT JOIN profile_education_field_enum AS pefe ON (pefe.id = pe.fieldid)
389 ORDER BY ' . XDB
::formatCustomOrder('pid', $pids) . ',
390 NOT FIND_IN_SET(\'primary\', pe.flags), pe.entry_year, pe.id',
393 return PlIteratorUtils
::subIterator($data, PlIteratorUtils
::arrayValueCallback('pid'));
397 // {{{ class ProfileMedals [ Field ]
398 class ProfileMedals
extends ProfileField
400 public $medals = array();
402 public function __construct(PlInnerSubIterator
$it)
404 $this->pid
= $it->value();
405 while ($medal = $it->next()) {
406 $this->medals
[$medal['mid']] = $medal;
410 public static function fetchData(array $pids, ProfileVisibility
$visibility)
412 $data = XDB
::iterator('SELECT pm.pid, pm.mid, pm.gid, pme.text, pme.img
413 FROM profile_medals AS pm
414 LEFT JOIN profiles AS p ON (pm.pid = p.pid)
415 LEFT JOIN profile_medal_enum AS pme ON (pme.id = pm.mid)
416 WHERE pm.pid IN {?} AND p.medals_pub IN {?}
417 ORDER BY ' . XDB
::formatCustomOrder('pm.pid', $pids),
418 $pids, $visibility->levels());
420 return PlIteratorUtils
::subIterator($data, PlIteratorUtils
::arrayValueCallback('pid'));
424 // {{{ class ProfileNetworking [ Field ]
425 class ProfileNetworking
extends ProfileField
427 private $networks = array();
429 public function __construct(PlIterator
$it)
431 while ($network = $it->next()) {
432 $this->networks
[$network['nwid']] = $network['address'];
436 public static function fetchData(array $pids, ProfileVisibility
$visibility)
438 $data = XDB
::iterator('SELECT pid, nwid, address, network_type
439 FROM profile_networking
440 WHERE pid IN {?} AND pub IN {?}
441 ORDER BY ' . XDB
::formatCustomOrder('pid', $pids) . ',
443 $pids, $visibility->levels());
445 return PlIteratorUtils
::subIterator($data, PlIteratorUtils
::arrayValueCallback('pid'));
448 public function get($flags, $limit = null
)
452 foreach ($this->networks
as $id => $nw) {
453 // XXX hardcoded reference to web site index
455 (($flags & Profile
::NETWORKING_WEB
) && $nw['network_type'] == 0)
457 (! ($flags & Profile
::NETWORKING_WEB
))
470 // {{{ class ProfileCorps [ Field ]
471 class ProfileCorps
extends ProfileField
476 public $original_name;
477 public $original_abbrev;
478 public $original_still_exists;
480 public $current_name;
481 public $current_abbrev;
482 public $current_still_exists;
483 public $current_rank;
484 public $current_rank_abbrev;
486 public function __construct(array $data)
488 foreach ($data as $key => $val) {
493 public static function fetchData(array $pids, ProfileVisibility
$visibility)
495 $data = XDB
::iterator('SELECT pc.pid, pc.original_corpsid AS original, pc.current_corpsid AS current,
496 pceo.name AS original_name, pceo.abbreviation AS original_abbrev,
497 pceo.still_exists AS original_still_exists,
498 pcec.name AS current_name, pcec.abbreviation AS current_abbrev,
499 pcec.still_exists AS current_still_exists,
500 pcrec.name AS current_rank, pcrec.abbreviation AS current_rank_abbrev,
502 FROM profile_corps AS pc
503 LEFT JOIN profile_corps_enum AS pceo ON (pceo.id = pc.original_corpsid)
504 LEFT JOIN profile_corps_enum AS pcec ON (pcec.id = pc.current_corpsid)
505 LEFT JOIN profile_corps_rank_enum AS pcrec ON (pcrec.id = pc.rankid)
506 WHERE pc.pid IN {?} AND pc.corps_pub IN {?}
507 ORDER BY ' . XDB
::formatCustomOrder('pid', $pids),
508 $pids, $visibility->levels());
514 // {{{ class ProfileMentoringSectors [ Field ]
515 class ProfileMentoringSectors
extends ProfileField
517 public $sectors = array();
519 public function __construct(PlInnerSubIterator
$it)
521 $this->pid
= $it->value();
522 while ($sector = $it->next()) {
523 $this->sectors
[] = $sector;
527 public static function fetchData(array $pids, ProfileVisibility
$visibility)
529 $data = XDB
::iterator('SELECT pms.pid, pjse.name AS sector, pjsse.name AS subsector
530 FROM profile_mentor_sector AS pms
531 LEFT JOIN profile_job_sector_enum AS pjse ON (pjse.id = pms.sectorid)
532 LEFT JOIN profile_job_subsector_enum AS pjsse ON (pjsse.id = pms.subsectorid)
534 ORDER BY ' . XDB
::formatCustomOrder('pms.pid', $pids),
537 return PlIteratorUtils
::subIterator($data, PlIteratorUtils
::arrayValueCallback('pid'));
541 // {{{ class ProfileMentoringCountries [ Field ]
542 class ProfileMentoringCountries
extends ProfileField
544 public $countries = array();
546 public function __construct(PlInnerSubIterator
$it)
548 $this->pid
= $it->value();
549 while ($country = $it->next()) {
550 $this->countries
[$country['id']] = $country['name'];
554 public static function fetchData(array $pids, ProfileVisibility
$visibility)
556 $data = XDB
::iterator('SELECT pmc.pid, pmc.country AS id, gc.countryFR AS name
557 FROM profile_mentor_country AS pmc
558 LEFT JOIN geoloc_countries AS gc ON (gc.iso_3166_1_a2 = pmc.country)
560 ORDER BY ' . XDB
::formatCustomOrder('pmc.pid', $pids),
563 return PlIteratorUtils
::subIterator($data, PlIteratorUtils
::arrayValueCallback('pid'));
568 /** Loading of data for a Profile :
569 * 1) load jobs, addresses, phones
570 * 2) attach phones to addresses, jobs and profiles
571 * 3) attach addresses to jobs and profiles
574 // {{{ class ProfileAddresses [ Field ]
575 class ProfileAddresses
extends ProfileField
577 private $addresses = array();
579 public function __construct(PlIterator
$it)
581 if ($it instanceof PlInnerSubIterator
) {
582 $this->pid
= $it->value();
585 while ($addr = $it->next()) {
586 $this->addresses
[] = new Address($addr);
590 public function get($flags, $limit = null
)
594 foreach ($this->addresses
as $addr) {
596 ($flags & Profile
::ADDRESS_ALL
)
598 (($flags & Profile
::ADDRESS_MAIN
) && $addr->hasFlag('current'))
600 (($flags & Profile
::ADDRESS_POSTAL
) && $addr->hasFlag('mail'))
602 (($flags & Profile
::ADDRESS_PERSO
) && $addr->link_type
== 'home')
604 (($flags & Profile
::ADDRESS_PRO
) && $addr->link_type
== 'job')
609 if ($limit != null
&& $nb == $limit) {
616 public static function fetchData(array $pids, ProfileVisibility
$visibility)
618 $data = XDB
::iterator('SELECT pa.id, pa.pid, pa.flags, pa.type AS link_type,
619 IF(pa.type = \'home\', pid, jobid) AS link_id,
620 pa.text, pa.postalCode, pa.latitude, pa.longitude, pa.comment,
621 gl.name AS locality, gas.name AS subAdministrativeArea,
622 ga.name AS administrativeArea, gc.countryFR AS country
623 FROM profile_addresses AS pa
624 LEFT JOIN geoloc_localities AS gl ON (gl.id = pa.localityId)
625 LEFT JOIN geoloc_administrativeareas AS ga ON (ga.id = pa.administrativeAreaId)
626 LEFT JOIN geoloc_administrativeareas AS gas ON (gas.id = pa.subAdministrativeAreaId)
627 LEFT JOIN geoloc_countries AS gc ON (gc.iso_3166_1_a2 = pa.countryId)
628 WHERE pa.pid in {?} AND pa.pub IN {?}
629 ORDER BY ' . XDB
::formatCustomOrder('pid', $pids),
630 $pids, $visibility->levels());
632 return PlIteratorUtils
::subIterator($data, PlIteratorUtils
::arrayValueCallback('pid'));
635 public function addPhones(ProfilePhones
$phones)
637 $p = $phones->get(0);
638 foreach ($p as $phone) {
639 if ($phone->link_type
== Phone
::LINK_ADDRESS
&& array_key_exists($phone->link_id
, $this->addresses
)) {
640 $this->addresses
[$phone->link_id
]->addPhone($phone);
646 // {{{ class ProfilePhones [ Field ]
647 class ProfilePhones
extends ProfileField
649 private $phones = array();
651 public function __construct(PlInnerSubIterator
$it)
653 $this->pid
= $it->value();
654 while ($phone = $it->next()) {
655 $this->phones
[] = new Phone($phone);
659 public function get($flags, $limit = null
)
663 foreach ($this->phones
as $id => $phone) {
664 $phones[$id] = $phone;
666 if ($limit != null
&& $nb == $limit) {
673 public static function fetchData(array $pids, ProfileVisibility
$visibility)
675 $data = XDB
::iterator('SELECT tel_type AS type, search_tel AS search, display_tel AS display, link_type, comment
677 WHERE pid IN {?} AND pub IN {?}
678 ORDER BY ' . XDB
::formatCustomOrder('pid', $pids),
679 $pids, $visibility->levels());
680 return PlIteratorUtils
::subIterator($data, PlIteratorUtils
::arrayValueCallback('pid'));
684 // {{{ class ProfileJobs [ Field ]
685 class ProfileJobs
extends ProfileField
687 private $jobs = array();
689 public function __construct(PlInnerSubIterator
$jobs)
691 $this->pid
= $jobs->value();
692 while ($job = $jobs->next()) {
693 $this->jobs
[$job['id']] = new Job($job);
697 public static function fetchData(array $pids, ProfileVisibility
$visibility)
699 CompanyList
::preload($pids);
700 $data = XDB
::iterator('SELECT pj.id, pj.pid, pj.description, pj.url as user_site,
701 IF(pj.email_pub IN {?}, pj.email, NULL) AS user_email,
702 pj.jobid, pjse.name AS sector, pjsse.name AS subsector,
703 pjssse.name AS subsubsector
704 FROM profile_job AS pj
705 LEFT JOIN profile_job_sector_enum AS pjse ON (pjse.id = pj.sectorid)
706 LEFT JOIN profile_job_subsector_enum AS pjsse ON (pjsse.id = pj.subsectorid)
707 LEFT JOIN profile_job_subsubsector_enum AS pjssse ON (pjssse.id = pj.subsubsectorid)
708 WHERE pj.pid IN {?} AND pj.pub IN {?}
709 ORDER BY ' . XDB
::formatCustomOrder('pid', $pids) . ',
711 $visibility->levels(), $pids, $visibility->levels());
712 return PlIteratorUtils
::subIterator($data, PlIteratorUtils
::arrayValueCallback('pid'));
715 public function get($flags, $limit = null
)
719 foreach ($this->jobs
as $id => $job) {
722 if ($limit != null
&& $nb >= $limit) {
729 public function addPhones(ProfilePhones
$phones)
731 $p = $phones->get(0);
732 foreach ($p as $phone) {
733 if ($phone->link_type
== Phone
::LINK_JOB
&& array_key_exists($phone->link_id
, $this->jobs
)) {
734 $this->jobs
[$phone->link_id
]->addPhones($phone);
739 public static function addAddresses(ProfileAddresses
$addresses)
741 $a = $addresses->get(Profile
::ADDRESS_PRO
);
742 foreach ($a as $address) {
743 if ($address->link_type
== Address
::LINK_JOB
&& array_key_exists($address->link_id
, $this->jobs
)) {
744 $this->jobs
[$address->link_id
]->setAddress($address);
749 public static function addCompanies(array $companies)
751 foreach ($this->jobs
as $job)
753 $job->company
= $companies[$job->jobid
];
759 // {{{ class CompanyList
762 static private $fullload = false
;
763 static private $companies = array();
765 static public function preload($pids = array())
767 if (self
::$fullload) {
772 $join = 'LEFT JOIN profile_job ON (profile_job.jobid = pje.id)';
773 $where = 'WHERE profile_job.pid IN ' . XDB
::formatArray($pids);
779 $it = XDB
::iterator('SELECT pje.id, pje.name, pje.acronym, pje.url,
780 pa.flags, pa.text, pa.postalCode, pa.countryId,
782 FROM profile_job_enum AS pje
783 LEFT JOIN profile_addresses AS pa ON (pje.id = pa.jobid AND pa.type = \'hq\')
786 while ($row = $it->next()) {
787 $cp = new Company($row);
788 $addr = new Address($row);
789 $cp->setAddress($addr);
790 self
::$companies[$row['id']] = $cp;
793 // TODO: add phones to addresses
794 if (count($pids) == 0) {
795 self
::$fullload = true
;
799 static public function get($id)
801 if (!array_key_exists($id, self
::$companies)) {
804 return self
::$companies[$id];
808 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8: