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 /** The profile to which this field belongs
32 /** Fetches data from the database for the given pids, compatible with
33 * the visibility context.
34 * @param $pids An array of pids
35 * @param $visibility The level of visibility fetched fields must have
36 * @return a PlIterator yielding data suitable for a "new ProfileBlah($data)"
37 * XXX MUST be reimplemented for each kind of ProfileField
39 public static function fetchData(array $pids, $visibility)
41 return PlIteratorUtils
::emptyIterator();
44 public static function buildForPID($cls, $pid, $visibility)
46 $res = self
::buildFromPIDs($cls, array($pid), $visibility);
47 return array_pop($res);
50 /** Build a list of ProfileFields from a set of pids
51 * @param $cls The name of the field to create ('ProfileMedals', ...)
52 * @param $pids An array of pids
53 * @param $visibility An array of allowed visibility contexts
54 * @return An array of $pid => ProfileField
56 public static function buildFromPIDs($cls, array $pids, $visibility)
58 $it = new ProfileFieldIterator($cls, $pids, $visibility);
60 while ($pf = $it->next()) {
66 public static function getForPID($cls, $pid, $visibility)
68 $it = new ProfileFieldIterator($cls, array($pid), $visibility);
74 // {{{ class ProfileFieldIterator
75 class ProfileFieldIterator
implements PlIterator
80 public function __construct($cls, array $pids, $visibility)
82 $this->data
= call_user_func(array($cls, 'fetchData'), $pids, $visibility);
86 public function next()
88 $d = $this->data
->next();
97 public function total()
99 return $this->data
->total();
102 public function first()
104 return $this->data
->first();
107 public function last()
109 return $this->data
->last();
117 const TYPE_FAX
= 'fax';
118 const TYPE_FIXED
= 'fixed';
119 const TYPE_MOBILE
= 'mobile';
124 public $comment = '';
126 const LINK_JOB
= 'job';
127 const LINK_ADDRESS
= 'address';
128 const LINK_PROFILE
= 'user';
129 const LINK_COMPANY
= 'hq';
134 * $type, $search, $display, $link_type, $link_id, $comment, $pid, $id
136 public function __construct($data)
138 foreach ($data as $key => $val) {
151 public $phone = null
;
152 public $address = null
;
155 * $id, $name, $acronym, $url
157 public function __construct($data)
159 foreach ($data as $key => $val) {
164 public function setPhone(Phone
&$phone)
166 if ($phone->link_type
== Phone
::LINK_COMPANY
&& $phone->link_id
== $this->id
) {
167 $this->phone
= $phone;
171 public function setAddress(Address
&$address)
173 if ($address->link_type
== Address
::LINK_COMPANY
&& $address->link_id
== $this->id
) {
174 $this->address
= $address;
186 public $company = null
;
187 private $phones = array();
188 private $address = null
;
198 public $subsubsector;
201 * pid, id, company_id, description, url, email
203 public function __construct($data)
205 foreach ($data as $key => $val) {
208 $this->company
= CompanyList
::get($this->jobid
);
211 public function phones()
213 return $this->phones
;
216 public function addPhone(Phone
&$phone)
218 if ($phone->link_type
== Phone
::LINK_JOB
&& $phone->link_id
== $this->id
&& $phone->pid
== $this->pid
) {
219 $this->phones
[] = $phone;
223 public function setAddress(Address
$address)
225 if ($address->link_id
== Address
::LINK_JOB
&& $address->link_id
== $this->id
&& $address->pid
== $this->pid
) {
226 $this->address
= $address;
234 const LINK_JOB
= 'job';
235 const LINK_COMPANY
= 'hq';
236 const LINK_PROFILE
= 'home';
248 public $subAdministrativeArea;
249 public $administrativeArea;
254 private $phones = array();
257 * pîd, id, link_id, link_type, flags, text, postcode, country
259 public function __construct($data)
261 foreach ($data as $key => $val) {
264 $this->flags
= new PlFlagSet($this->flags
);
267 public function addPhone(Phone
&$phone)
269 if ($phone->link_type
== Phone
::LINK_ADDRESS
&& $phone->link_id
== $this->id
&& $phone->pid
== $this->pid
) {
270 $this->phones
[] = $phone;
274 public function phones()
276 return $this->phones
;
279 public function hasFlag($flag)
281 return $this->flags
->hasFlag($flag);
285 // {{{ class Education
297 public $school_short;
302 public $degree_short;
303 public $degree_level;
305 public function __construct(array $data)
307 foreach ($data as $key => $val) {
310 $this->flags
= new PlFlagSet($this->flags
);
315 // {{{ class ProfileEducation [ Field ]
316 class ProfileEducation
extends ProfileField
318 private $educations = array();
320 public function __construct(PlInnerSubIterator
$it)
322 $this->pid
= $it->value();
323 $this->visibility
= Profile
::VISIBILITY_PUBLIC
;
324 while ($edu = $it->next()) {
325 $this->educations
[$edu['id']] = new Education($edu);
329 public function get($flags, $limit)
331 $educations = array();
333 $year = $year['year'];
335 foreach ($this->educations
as $id => $edu) {
337 (($flags & Profile
::EDUCATION_MAIN
) && $edu->flags
->hasFlag('primary'))
339 (($flags & Profile
::EDUCATION_EXTRA
) && !$edu->flags
->hasFlag('primary'))
341 (($flags & Profile
::EDUCATION_FINISHED
) && $edu->grad_year
<= $year)
343 (($flags & Profile
::EDUCATION_CURRENT
) && $edu->grad_year
> $year)
345 ($flags & Profile
::EDUCATION_ALL
)
347 $educations[$id] = $edu;
350 if ($limit != null
&& $nb >= $limit) {
357 public static function fetchData(array $pids, $visibility)
359 $data = XDB
::iterator('SELECT pe.id, pe.pid,
360 pe.entry_year, pe.grad_year, pe.program, pe.flags,
361 pee.name AS school, pee.abbreviation AS school_short,
362 pee.url AS school_url, gc.countryFR AS country,
363 pede.degree, pede.abbreviation AS degree_short, pede.level AS degree_level,
365 FROM profile_education AS pe
366 LEFT JOIN profile_education_enum AS pee ON (pee.id = pe.eduid)
367 LEFT JOIN geoloc_countries AS gc ON (gc.iso_3166_1_a2 = pee.country)
368 LEFT JOIN profile_education_degree_enum AS pede ON (pede.id = pe.degreeid)
369 LEFT JOIN profile_education_field_enum AS pefe ON (pefe.id = pe.fieldid)
371 ORDER BY ' . XDB
::formatCustomOrder('pid', $pids) . ',
372 NOT FIND_IN_SET(\'primary\', pe.flags), pe.entry_year, pe.id',
375 return PlIteratorUtils
::subIterator($data, PlIteratorUtils
::arrayValueCallback('pid'));
379 // {{{ class ProfileMedals [ Field ]
380 class ProfileMedals
extends ProfileField
382 public $medals = array();
384 public function __construct(PlInnerSubIterator
$it)
386 $this->pid
= $it->value();
387 while ($medal = $it->next()) {
388 $this->medals
[$medal['mid']] = $medal;
392 public static function fetchData(array $pids, $visibility)
394 $data = XDB
::iterator('SELECT pm.pid, pm.mid, pm.gid, pme.text, pme.img
395 FROM profile_medals AS pm
396 LEFT JOIN profiles AS p ON (pm.pid = p.pid)
397 LEFT JOIN profile_medal_enum AS pme ON (pme.id = pm.mid)
398 WHERE pm.pid IN {?} AND p.medals_pub IN {?}
399 ORDER BY ' . XDB
::formatCustomOrder('pm.pid', $pids),
402 return PlIteratorUtils
::subIterator($data, PlIteratorUtils
::arrayValueCallback('pid'));
406 // {{{ class ProfileNetworking [ Field ]
407 class ProfileNetworking
extends ProfileField
409 private $networks = array();
411 public function __construct(PlIterator
$it)
413 while ($network = $it->next()) {
414 $this->networks
[$network['nwid']] = $network['address'];
418 public static function fetchData(array $pids, $visibility)
420 $data = XDB
::iterator('SELECT pid, nwid, address, network_type
421 FROM profile_networking
422 WHERE pid IN {?} AND pub IN {?}
423 ORDER BY ' . XDB
::formatCustomOrder('pid', $pids) . ',
427 return PlIteratorUtils
::subIterator($data, PlIteratorUtils
::arrayValueCallback('pid'));
430 public function get($flags, $limit = null
)
434 foreach ($this->networks
as $id => $nw) {
435 // XXX hardcoded reference to web site index
437 (($flags & self
::NETWORKING_WEB
) && $nw['network_type'] == 0)
439 (! ($flags & self
::NETWORKING_WEB
))
452 // {{{ class ProfilePhoto [ Field ]
453 class ProfilePhoto
extends ProfileField
457 public function __construct(array $data)
459 if ($data == null ||
count($data) == 0) {
462 $this->pid
= $data['pid'];
463 $this->pic
= PlImage
::fromDATA($data['attach'],
470 public static function fetchData(array $pids, $visibility)
472 $data = XDB
::iterator('SELECT *
474 WHERE pid IN {?} AND attachmime IN (\'jpeg\', \'png\') AND pub IN {?}
475 ORDER BY ' . XDB
::formatCustomOrder('pid', $pids),
482 // {{{ class ProfileCorps [ Field ]
483 class ProfileCorps
extends ProfileField
488 public $original_name;
489 public $original_abbrev;
490 public $original_still_exists;
492 public $current_name;
493 public $current_abbrev;
494 public $current_still_exists;
495 public $current_rank;
496 public $current_rank_abbrev;
498 public function __construct(array $data)
500 foreach ($data as $key => $val) {
505 public static function fetchData(array $pids, $visibility)
507 $data = XDB
::iterator('SELECT pc.pid, pc.original_corpsid AS original, pc.current_corpsid AS current,
508 pceo.name AS original_name, pceo.abbreviation AS original_abbrev,
509 pceo.still_exists AS original_still_exists,
510 pcec.name AS current_name, pcec.abbreviation AS current_abbrev,
511 pcec.still_exists AS current_still_exists,
512 pcrec.name AS current_rank, pcrec.abbreviation AS current_rank_abbrev,
514 FROM profile_corps AS pc
515 LEFT JOIN profile_corps_enum AS pceo ON (pceo.id = pc.original_corpsid)
516 LEFT JOIN profile_corps_enum AS pcec ON (pcec.id = pc.current_corpsid)
517 LEFT JOIN profile_corps_rank_enum AS pcrec ON (pcrec.id = pc.rankid)
518 WHERE pc.pid IN {?} AND pc.corps_pub IN {?}
519 ORDER BY ' . XDB
::formatCustomOrder('pid', $pids),
527 /** Loading of data for a Profile :
528 * 1) load jobs, addresses, phones
529 * 2) attach phones to addresses, jobs and profiles
530 * 3) attach addresses to jobs and profiles
533 // {{{ class ProfileAddresses [ Field ]
534 class ProfileAddresses
extends ProfileField
536 private $addresses = array();
538 public function __construct(PlIterator
$it)
540 if ($it instanceof PlInnerSubIterator
) {
541 $this->pid
= $it->value();
544 while ($addr = $it->next()) {
545 $this->addresses
[] = new Address($addr);
549 public function get($flags, $limit = null
)
553 foreach ($this->addresses
as $addr) {
555 ($flags & Profile
::ADDRESS_ALL
)
557 (($flags & Profile
::ADDRESS_MAIN
) && $addr->hasFlag('current'))
559 (($flags & Profile
::ADDRESS_POSTAL
) && $addr->hasFlag('mail'))
561 (($flags & Profile
::ADDRESS_PERSO
) && $addr->link_type
== 'home')
563 (($flags & Profile
::ADDRESS_PRO
) && $addr->link_type
== 'job')
568 if ($limit != null
&& $nb == $limit) {
575 public static function fetchData(array $pids, $visibility)
577 $data = XDB
::iterator('SELECT pa.id, pa.pid, pa.flags, pa.type AS link_type,
578 IF(pa.type = \'home\', pid, jobid) AS link_id,
579 pa.text, pa.postalCode, pa.latitude, pa.longitude, pa.comment,
580 gl.name AS locality, gas.name AS subAdministrativeArea,
581 ga.name AS administrativeArea, gc.countryFR AS country
582 FROM profile_addresses AS pa
583 LEFT JOIN geoloc_localities AS gl ON (gl.id = pa.localityId)
584 LEFT JOIN geoloc_administrativeareas AS ga ON (ga.id = pa.administrativeAreaId)
585 LEFT JOIN geoloc_administrativeareas AS gas ON (gas.id = pa.subAdministrativeAreaId)
586 LEFT JOIN geoloc_countries AS gc ON (gc.iso_3166_1_a2 = pa.countryId)
587 WHERE pa.pid in {?} AND pa.pub IN {?}
588 ORDER BY ' . XDB
::formatCustomOrder('pid', $pids),
591 return PlIteratorUtils
::subIterator($data, PlIteratorUtils
::arrayValueCallback('pid'));
594 public function addPhones(ProfilePhones
$phones)
596 $p = $phones->get(0);
597 foreach ($p as $phone) {
598 if ($phone->link_type
== Phone
::LINK_ADDRESS
&& array_key_exists($phone->link_id
, $this->addresses
)) {
599 $this->addresses
[$phone->link_id
]->addPhone($phone);
605 // {{{ class ProfilePhones [ Field ]
606 class ProfilePhones
extends ProfileField
608 private $phones = array();
610 public function __construct(PlInnerSubIterator
$it)
612 $this->pid
= $it->value();
613 while ($phone = $it->next()) {
614 $this->phones
[] = new Phone($phone);
618 public function get($flags, $limit = null
)
622 foreach ($this->phones
as $id => $phone) {
623 $phones[$id] = $phone;
625 if ($limit != null
&& $nb == $limit) {
632 public static function fetchData(array $pids, $visibility)
634 $data = XDB
::iterator('SELECT tel_type AS type, search_tel AS search, display_tel AS display, link_type, comment
636 WHERE pid IN {?} AND pub IN {?}
637 ORDER BY ' . XDB
::formatCustomOrder('pid', $pids),
639 return PlIteratorUtils
::subIterator($data, PlIteratorUtils
::arrayValueCallback('pid'));
643 // {{{ class ProfileJobs [ Field ]
644 class ProfileJobs
extends ProfileField
646 private $jobs = array();
648 public function __construct(PlInnerSubIterator
$jobs)
650 $this->pid
= $jobs->value();
651 while ($job = $jobs->next()) {
652 $this->jobs
[$job['id']] = new Job($job);
656 public static function fetchData(array $pids, $visibility)
658 CompanyList
::preload($pids);
659 $data = XDB
::iterator('SELECT pj.id, pj.pid, pj.description, pj.url as user_site,
660 IF(pj.email_pub IN {?}, pj.email, NULL) AS user_email,
661 pj.jobid, pjse.name AS sector, pjsse.name AS subsector,
662 pjssse.name AS subsubsector
663 FROM profile_job AS pj
664 LEFT JOIN profile_job_sector_enum AS pjse ON (pjse.id = pj.sectorid)
665 LEFT JOIN profile_job_subsector_enum AS pjsse ON (pjsse.id = pj.subsectorid)
666 LEFT JOIN profile_job_subsubsector_enum AS pjssse ON (pjssse.id = pj.subsubsectorid)
667 WHERE pj.pid IN {?} AND pj.pub IN {?}
668 ORDER BY ' . XDB
::formatCustomOrder('pid', $pids) . ',
670 $visibility, $pids, $visibility);
671 return PlIteratorUtils
::subIterator($data, PlIteratorUtils
::arrayValueCallback('pid'));
674 public function get($flags, $limit = null
)
678 foreach ($this->jobs
as $id => $job) {
681 if ($limit != null
&& $nb >= $limit) {
688 public function addPhones(ProfilePhones
$phones)
690 $p = $phones->get(0);
691 foreach ($p as $phone) {
692 if ($phone->link_type
== Phone
::LINK_JOB
&& array_key_exists($phone->link_id
, $this->jobs
)) {
693 $this->jobs
[$phone->link_id
]->addPhones($phone);
698 public static function addAddresses(ProfileAddresses
$addresses)
700 $a = $addresses->get(Profile
::ADDRESS_PRO
);
701 foreach ($a as $address) {
702 if ($address->link_type
== Address
::LINK_JOB
&& array_key_exists($address->link_id
, $this->jobs
)) {
703 $this->jobs
[$address->link_id
]->setAddress($address);
708 public static function addCompanies(array $companies)
710 foreach ($this->jobs
as $job)
712 $job->company
= $companies[$job->jobid
];
718 // {{{ class CompanyList
721 static private $fullload = false
;
722 static private $companies = array();
724 static public function preload($pids = array())
726 if (self
::$fullload) {
731 $join = 'LEFT JOIN profile_job ON (profile_job.jobid = pje.id)';
732 $where = 'WHERE profile_job.pid IN ' . XDB
::formatArray($pids);
738 $it = XDB
::iterator('SELECT pje.id, pje.name, pje.acronym, pje.url,
739 pa.flags, pa.text, pa.postalCode, pa.countryId,
741 FROM profile_job_enum AS pje
742 LEFT JOIN profile_addresses AS pa ON (pje.id = pa.jobid AND pa.type = \'hq\')
745 while ($row = $it->next()) {
746 $cp = new Company($row);
747 $addr = new Address($row);
748 $cp->setAddress($addr);
749 self
::$companies[$row['id']] = $cp;
752 // TODO: add phones to addresses
753 if (count($pids) == 0) {
754 self
::$fullload = true
;
758 static public function get($id)
760 if (!array_key_exists($id, self
::$companies)) {
763 return self
::$companies[$id];
767 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8: