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_COUNTRY
=> 'ProfileMentoringCountries',
37 Profile
::FETCH_JOB_TERMS
=> 'ProfileJobTerms',
38 Profile
::FETCH_MENTOR_TERMS
=> 'ProfileMentoringTerms',
41 /** The profile to which this field belongs
45 /** Fetches data from the database for the given pids, compatible with
46 * the visibility context.
47 * @param $pids An array of pids
48 * @param $visibility The level of visibility fetched fields must have
49 * @return a PlIterator yielding data suitable for a "new ProfileBlah($data)"
51 * MUST be reimplemented for each kind of ProfileField.
53 public static function fetchData(array $pids, ProfileVisibility
$visibility)
55 return PlIteratorUtils
::emptyIterator();
58 public static function buildForPID($cls, $pid, ProfileVisibility
$visibility)
60 $res = self
::buildFromPIDs($cls, array($pid), $visibility);
61 return array_pop($res);
64 /** Build a list of ProfileFields from a set of pids
65 * @param $cls The name of the field to create ('ProfileMedals', ...)
66 * @param $pids An array of pids
67 * @param $visibility An array of allowed visibility contexts
68 * @return An array of $pid => ProfileField
70 public static function buildFromPIDs($cls, array $pids, ProfileVisibility
$visibility)
72 $it = new ProfileFieldIterator($cls, $pids, $visibility);
74 while ($pf = $it->next()) {
80 public static function getForPID($cls, $pid, ProfileVisibility
$visibility)
82 $it = new ProfileFieldIterator($cls, array($pid), $visibility);
88 // {{{ class ProfileFieldIterator
89 class ProfileFieldIterator
implements PlIterator
94 public function __construct($cls, array $pids, ProfileVisibility
$visibility)
96 if (is_numeric($cls) && isset(ProfileField
::$fields[$cls])) {
97 $cls = ProfileField
::$fields[$cls];
99 $this->data
= call_user_func(array($cls, 'fetchData'), $pids, $visibility);
103 public function next()
105 $d = $this->data
->next();
114 public function total()
116 return $this->data
->total();
119 public function first()
121 return $this->data
->first();
124 public function last()
126 return $this->data
->last();
138 public $phone = null
;
139 public $address = null
;
142 * $id, $name, $acronym, $url
144 public function __construct($data)
146 foreach ($data as $key => $val) {
151 public function setPhone(Phone
&$phone)
153 if ($phone->linkType() == Phone
::LINK_COMPANY
&& $phone->linkId() == $this->id
) {
154 $this->phone
= $phone;
158 public function setAddress(Address
&$address)
160 if ($address->type
== Address
::LINK_COMPANY
&& $address->jobid
== $this->id
) {
161 $this->address
= $address;
168 /** profile_job describes a Job, links to:
169 * - a Profile, through `pid`
170 * - a Company, through `jobid`
171 * The `id` field is the id of this job in the list of the jobs of its profile
173 * For the documentation of the phone table, please see classes/phone.php.
174 * For the documentation of the address table, please see classes/address.php.
176 * The possible relations are as follow:
177 * A Job is linked to a Company and a Profile
184 public $company = null
;
185 public $phones = array();
186 public $address = null
;
187 public $terms = array();
196 * pid, id, company_id, description, url, email
198 public function __construct($data)
200 foreach ($data as $key => $val) {
203 $this->company
= CompanyList
::get($this->jobid
);
204 if (is_null($this->company
)) {
205 $entreprise = ProfileValidate
::get_typed_requests($this->pid
, 'entreprise');
206 $this->company
= new Company(array('name' => $entreprise[$this->id
]->name
));
210 public function phones()
212 return $this->phones
;
215 public function address()
217 return $this->address
;
220 public function addPhone(Phone
&$phone)
222 if ($phone->linkType() == Phone
::LINK_JOB
&& $phone->linkId() == $this->id
&& $phone->pid() == $this->pid
) {
223 $this->phones
[$phone->uniqueId()] = $phone;
227 public function setAddress(Address
$address)
229 if ($address->type
== Address
::LINK_JOB
&& $address->id
== $this->id
&& $address->pid
== $this->pid
) {
230 $this->address
= $address;
234 public function addTerm(JobTerm
&$term)
236 $this->terms
[$term->jtid
] = $term;
249 * pid, jid, jtid, full_name
251 public function __construct($data)
253 foreach ($data as $key => $val) {
259 // {{{ class Education
271 public $school_short;
276 public $degree_short;
277 public $degree_level;
281 public function __construct(array $data)
283 foreach ($data as $key => $val) {
286 $this->flags
= new PlFlagSet($this->flags
);
291 // {{{ class ProfileEducation [ Field ]
292 class ProfileEducation
extends ProfileField
294 private $educations = array();
296 public function __construct(PlInnerSubIterator
$it)
298 $this->pid
= $it->value();
299 while ($edu = $it->next()) {
300 $this->educations
[$edu['id']] = new Education($edu);
304 public function get($flags, $limit)
306 $educations = array();
308 $year = $year['year'];
310 foreach ($this->educations
as $id => $edu) {
312 (($flags & Profile
::EDUCATION_MAIN
) && $edu->flags
->hasFlag('primary'))
314 (($flags & Profile
::EDUCATION_EXTRA
) && !$edu->flags
->hasFlag('primary'))
316 (($flags & Profile
::EDUCATION_FINISHED
) && $edu->grad_year
<= $year)
318 (($flags & Profile
::EDUCATION_CURRENT
) && $edu->grad_year
> $year)
320 ($flags & Profile
::EDUCATION_ALL
)
322 $educations[$id] = $edu;
325 if ($limit != null
&& $nb >= $limit) {
332 public static function fetchData(array $pids, ProfileVisibility
$visibility)
334 $data = XDB
::iterator('SELECT pe.id, pe.pid,
335 pe.entry_year, pe.grad_year, pe.program, pe.flags,
336 pee.name AS school, pee.abbreviation AS school_short,
337 pee.url AS school_url, gc.countryFR AS country,
338 pede.degree, pede.abbreviation AS degree_short, pede.level AS degree_level,
340 FROM profile_education AS pe
341 LEFT JOIN profile_education_enum AS pee ON (pee.id = pe.eduid)
342 LEFT JOIN geoloc_countries AS gc ON (gc.iso_3166_1_a2 = pee.country)
343 LEFT JOIN profile_education_degree_enum AS pede ON (pede.id = pe.degreeid)
344 LEFT JOIN profile_education_field_enum AS pefe ON (pefe.id = pe.fieldid)
346 ORDER BY ' . XDB
::formatCustomOrder('pid', $pids) . ',
347 NOT FIND_IN_SET(\'primary\', pe.flags), pe.entry_year, pe.id',
350 return PlIteratorUtils
::subIterator($data, PlIteratorUtils
::arrayValueCallback('pid'));
354 // {{{ class ProfileMedals [ Field ]
355 class ProfileMedals
extends ProfileField
357 public $medals = array();
359 public function __construct(PlInnerSubIterator
$it)
361 $this->pid
= $it->value();
362 while ($medal = $it->next()) {
363 $this->medals
[$medal['mid']] = $medal;
367 public static function fetchData(array $pids, ProfileVisibility
$visibility)
369 $data = XDB
::iterator('SELECT pm.pid, pm.mid, pm.gid, pme.text, pme.img, pmge.text AS grade
370 FROM profile_medals AS pm
371 LEFT JOIN profiles AS p ON (pm.pid = p.pid)
372 LEFT JOIN profile_medal_enum AS pme ON (pme.id = pm.mid)
373 LEFT JOIN profile_medal_grade_enum AS pmge ON (pmge.mid = pm.mid AND pmge.gid = pm.gid)
374 WHERE pm.pid IN {?} AND p.medals_pub IN {?}
375 ORDER BY ' . XDB
::formatCustomOrder('pm.pid', $pids),
376 $pids, $visibility->levels());
378 return PlIteratorUtils
::subIterator($data, PlIteratorUtils
::arrayValueCallback('pid'));
382 // {{{ class ProfileNetworking [ Field ]
383 class ProfileNetworking
extends ProfileField
385 private $networks = array();
387 public function __construct(PlInnerSubIterator
$it)
389 $this->pid
= $it->value();
390 while ($network = $it->next()) {
391 $network['network_type'] = new PlFlagSet($network['network_type']);
392 $this->networks
[$network['id']] = $network;
396 public static function fetchData(array $pids, ProfileVisibility
$visibility)
398 $data = XDB
::iterator('SELECT pid, id, address, pne.nwid, pne.network_type, pne.link, pne.name
399 FROM profile_networking AS pn
400 LEFT JOIN profile_networking_enum AS pne USING(nwid)
401 WHERE pid IN {?} AND pub IN {?}
402 ORDER BY ' . XDB
::formatCustomOrder('pid', $pids) . ',
404 $pids, $visibility->levels());
406 return PlIteratorUtils
::subIterator($data, PlIteratorUtils
::arrayValueCallback('pid'));
409 public function get($flags, $limit = null
)
413 foreach ($this->networks
as $id => $nw) {
414 if (($flags & Profile
::NETWORKING_WEB
) && $nw['network_type']->hasFlag('web') ||
415 ($flags & Profile
::NETWORKING_IM
) && $nw['network_type']->hasFlag('im') ||
416 ($flags & Profile
::NETWORKING_SOCIAL
) && $nw['network_type']->hasFlag('social') ||
417 ($flags == Profile
::NETWORKING_ALL
)) {
420 if (isset($limit) && $nb >= $limit) {
429 // {{{ class ProfileCorps [ Field ]
430 class ProfileCorps
extends ProfileField
435 public $original_name;
436 public $original_abbrev;
437 public $original_still_exists;
439 public $current_name;
440 public $current_abbrev;
441 public $current_still_exists;
442 public $current_rank;
443 public $current_rank_abbrev;
445 public function __construct(array $data)
447 foreach ($data as $key => $val) {
452 public static function fetchData(array $pids, ProfileVisibility
$visibility)
454 $data = XDB
::iterator('SELECT pc.pid, pc.original_corpsid AS original, pc.current_corpsid AS current,
455 pceo.name AS original_name, pceo.abbreviation AS original_abbrev,
456 pceo.still_exists AS original_still_exists,
457 pcec.name AS current_name, pcec.abbreviation AS current_abbrev,
458 pcec.still_exists AS current_still_exists,
459 pcrec.name AS current_rank, pcrec.abbreviation AS current_rank_abbrev,
461 FROM profile_corps AS pc
462 LEFT JOIN profile_corps_enum AS pceo ON (pceo.id = pc.original_corpsid)
463 LEFT JOIN profile_corps_enum AS pcec ON (pcec.id = pc.current_corpsid)
464 LEFT JOIN profile_corps_rank_enum AS pcrec ON (pcrec.id = pc.rankid)
465 WHERE pc.pid IN {?} AND pc.corps_pub IN {?} AND pceo.id != 1
466 ORDER BY ' . XDB
::formatCustomOrder('pid', $pids),
467 $pids, $visibility->levels());
473 // {{{ class ProfileMentoringCountries [ Field ]
474 class ProfileMentoringCountries
extends ProfileField
476 public $countries = array();
478 public function __construct(PlInnerSubIterator
$it)
480 $this->pid
= $it->value();
481 while ($country = $it->next()) {
482 $this->countries
[$country['id']] = $country['name'];
486 public static function fetchData(array $pids, ProfileVisibility
$visibility)
488 $data = XDB
::iterator('SELECT pmc.pid, pmc.country AS id, gc.countryFR AS name
489 FROM profile_mentor_country AS pmc
490 LEFT JOIN geoloc_countries AS gc ON (gc.iso_3166_1_a2 = pmc.country)
492 ORDER BY ' . XDB
::formatCustomOrder('pmc.pid', $pids),
495 return PlIteratorUtils
::subIterator($data, PlIteratorUtils
::arrayValueCallback('pid'));
499 // {{{ class ProfileAddresses [ Field ]
500 class ProfileAddresses
extends ProfileField
502 private $addresses = array();
504 public function __construct(PlInnerSubIterator
$it)
506 $this->pid
= $it->value();
507 while ($address = $it->next()) {
508 $this->addresses
[] = new Address($address);
512 public function get($flags, $limit = null
)
514 $addresses = array();
516 foreach ($this->addresses
as $address) {
517 if ((($flags & Profile
::ADDRESS_MAIN
) && $address->hasFlag('current'))
518 ||
(($flags & Profile
::ADDRESS_POSTAL
) && $address->hasFlag('mail'))
519 ||
(($flags & Profile
::ADDRESS_PERSO
) && $address->type
== Address
::LINK_PROFILE
)
520 ||
(($flags & Profile
::ADDRESS_PRO
) && $address->type
== Address
::LINK_JOB
)
522 $addresses[] = $address;
525 if ($limit != null
&& $nb == $limit) {
532 public static function fetchData(array $pids, ProfileVisibility
$visibility)
534 $it = Address
::iterate($pids, array(), array(), $visibility->levels());
535 return PlIteratorUtils
::subIterator($it->value(), PlIteratorUtils
::arrayValueCallback('pid'));
538 public function addPhones(ProfilePhones
$phones)
540 $p = $phones->get(Profile
::PHONE_LINK_ADDRESS | Profile
::PHONE_TYPE_ANY
);
541 foreach ($p as $phone) {
542 /* We must iterate on the addresses because id is not uniq thus,
543 * $this->addresse[$phone->linkId()] is invalid.
545 foreach ($this->addresses
as $address) {
546 if ($address->type
== Address
::LINK_PROFILE
&& $address->id
== $phone->linkId()) {
547 $address->addPhone($phone);
554 // {{{ class ProfilePhones [ Field ]
555 class ProfilePhones
extends ProfileField
557 private $phones = array();
559 public function __construct(PlInnerSubIterator
$it)
561 $this->pid
= $it->value();
562 while ($phone = $it->next()) {
563 $this->phones
[] = new Phone($phone);
567 public function get($flags, $limit = null
)
571 foreach ($this->phones
as $id => $phone) {
572 if ($phone->hasFlags($flags)) {
573 $phones[$id] = $phone;
575 if ($limit != null
&& $nb == $limit) {
583 public static function fetchData(array $pids, ProfileVisibility
$visibility)
585 $it = Phone
::iterate($pids, array(), array(), $visibility->levels());
586 return PlIteratorUtils
::subIterator($it->value(), PlIteratorUtils
::arrayValueCallback('pid'));
590 // {{{ class ProfileJobs [ Field ]
591 class ProfileJobs
extends ProfileField
593 private $jobs = array();
595 public function __construct(PlInnerSubIterator
$jobs)
597 $this->pid
= $jobs->value();
598 while ($job = $jobs->next()) {
599 $this->jobs
[$job['id']] = new Job($job);
603 public static function fetchData(array $pids, ProfileVisibility
$visibility)
605 CompanyList
::preload($pids);
606 $data = XDB
::iterator('SELECT id, pid, description, url as user_site, jobid,
607 IF(email_pub IN {?}, email, NULL) AS user_email
609 WHERE pid IN {?} AND pub IN {?}
610 ORDER BY ' . XDB
::formatCustomOrder('pid', $pids) . ', id',
611 $visibility->levels(), $pids, $visibility->levels());
612 return PlIteratorUtils
::subIterator($data, PlIteratorUtils
::arrayValueCallback('pid'));
615 public function get($flags, $limit = null
)
619 foreach ($this->jobs
as $id => $job) {
622 if ($limit != null
&& $nb >= $limit) {
629 public function addPhones(ProfilePhones
$phones)
631 $p = $phones->get(Profile
::PHONE_LINK_JOB | Profile
::PHONE_TYPE_ANY
);
632 foreach ($p as $phone) {
633 if ($phone->linkType() == Phone
::LINK_JOB
&& array_key_exists($phone->linkId(), $this->jobs
)) {
634 $this->jobs
[$phone->linkId()]->addPhone($phone);
639 public function addAddresses(ProfileAddresses
$addresses)
641 $a = $addresses->get(Profile
::ADDRESS_PRO
);
642 foreach ($a as $address) {
643 if ($address->type
== Address
::LINK_JOB
&& array_key_exists($address->jobid
, $this->jobs
)) {
644 $this->jobs
[$address->id
]->setAddress($address);
649 public function addCompanies(array $companies)
651 foreach ($this->jobs
as $job) {
652 $this->company
= $companies[$job->jobid
];
656 public function addJobTerms(ProfileJobTerms
$jobterms)
658 $terms = $jobterms->get();
659 foreach ($terms as $term) {
660 if ($this->pid
== $term->pid
&& array_key_exists($term->jid
, $this->jobs
)) {
661 $this->jobs
[$term->jid
]->addTerm(&$term);
667 // {{{ class ProfileJobTerms [ Field ]
668 class ProfileJobTerms
extends ProfileField
670 private $jobterms = array();
672 public function __construct(PlInnerSubIterator
$it)
674 $this->pid
= $it->value();
675 while ($term = $it->next()) {
676 $this->jobterms
[] = new JobTerm($term);
680 public function get()
682 return $this->jobterms
;
685 public static function fetchData(array $pids, ProfileVisibility
$visibility)
687 $data = XDB
::iterator('SELECT jt.jtid, jte.full_name, jt.pid, jt.jid
688 FROM profile_job_term AS jt
689 INNER JOIN profile_job AS j ON (jt.pid = j.pid AND jt.jid = j.id)
690 LEFT JOIN profile_job_term_enum AS jte USING(jtid)
691 WHERE jt.pid IN {?} AND j.pub IN {?}
692 ORDER BY ' . XDB
::formatCustomOrder('jt.pid', $pids),
693 $pids, $visibility->levels());
694 return PlIteratorUtils
::subIterator($data, PlIteratorUtils
::arrayValueCallback('pid'));
698 // {{{ class ProfileMentoringTerms [ Field ]
699 class ProfileMentoringTerms
extends ProfileJobTerms
701 public static function fetchData(array $pids, ProfileVisibility
$visibility)
703 $data = XDB
::iterator('SELECT mt.jtid, jte.full_name, mt.pid
704 FROM profile_mentor_term AS mt
705 LEFT JOIN profile_job_term_enum AS jte USING(jtid)
707 ORDER BY ' . XDB
::formatCustomOrder('mt.pid', $pids),
709 return PlIteratorUtils
::subIterator($data, PlIteratorUtils
::arrayValueCallback('pid'));
713 // {{{ class CompanyList
716 static private $fullload = false
;
717 static private $companies = array();
719 static public function preload($pids = array())
721 if (self
::$fullload) {
726 $join = 'LEFT JOIN profile_job ON (profile_job.jobid = pje.id)';
727 $where = 'WHERE profile_job.pid IN ' . XDB
::formatArray($pids);
733 $it = XDB
::iterator('SELECT pje.id, pje.name, pje.acronym, pje.url,
734 pa.flags, pa.text, pa.postalCode, pa.countryId,
736 FROM profile_job_enum AS pje
737 LEFT JOIN profile_addresses AS pa ON (pje.id = pa.jobid AND pa.type = \'hq\')
740 $newcompanies = array();
741 while ($row = $it->next()) {
742 $cp = new Company($row);
743 $addr = new Address($row);
744 $cp->setAddress($addr);
745 if (!array_key_exists($row['id'], self
::$companies)) {
746 $newcompanies[] = $row['id'];
748 self
::$companies[$row['id']] = $cp;
752 if (count($newcompanies)) {
753 $it = Phone
::iterate(array(), array(Phone
::LINK_COMPANY
), $newcompanies);
754 while ($phone = $it->next()) {
755 self
::$companies[$phone->linkId()]->setPhone($phone);
759 if (count($pids) == 0) {
760 self
::$fullload = true
;
764 static public function get($id)
766 if (!array_key_exists($id, self
::$companies)) {
769 return self
::$companies[$id];
773 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8: