* CONDITIONS
******************/
+// {{{ interface UserFilterCondition
+/** This interface describe objects which filter users based
+ * on various parameters.
+ * The parameters of the filter must be given to the constructor.
+ * The buildCondition function is called by UserFilter when
+ * actually building the query. That function must call
+ * $uf->addWheteverFilter so that the UserFilter makes
+ * adequate joins. It must return the 'WHERE' condition to use
+ * with the filter.
+ */
interface UserFilterCondition
{
const COND_TRUE = 'TRUE';
*/
public function buildCondition(UserFilter &$uf);
}
+// }}}
+// {{{ class UFC_OneChild
abstract class UFC_OneChild implements UserFilterCondition
{
protected $child;
$this->child =& $cond;
}
}
+// }}}
+// {{{ class UFC_NChildren
abstract class UFC_NChildren implements UserFilterCondition
{
protected $children = array();
}
}
}
+// }}}
+// {{{ class UFC_True
class UFC_True implements UserFilterCondition
{
public function buildCondition(UserFilter &$uf)
return self::COND_TRUE;
}
}
+// }}}
+// {{{ class UFC_False
class UFC_False implements UserFilterCondition
{
public function buildCondition(UserFilter &$uf)
return self::COND_FALSE;
}
}
+// }}}
+// {{{ class UFC_Not
class UFC_Not extends UFC_OneChild
{
public function buildCondition(UserFilter &$uf)
}
}
}
+// }}}
+// {{{ class UFC_And
class UFC_And extends UFC_NChildren
{
public function buildCondition(UserFilter &$uf)
}
}
}
+// }}}
+// {{{ class UFC_Or
class UFC_Or extends UFC_NChildren
{
public function buildCondition(UserFilter &$uf)
}
}
}
+// }}}
+// {{{ class UFC_Profile
+/** Filters users who have a profile
+ */
class UFC_Profile implements UserFilterCondition
{
public function buildCondition(UserFilter &$uf)
return '$PID IS NOT NULL';
}
}
-
+// }}}
+
+// {{{ class UFC_Promo
+/** Filters users based on promotion
+ * @param $comparison Comparison operator (>, =, ...)
+ * @param $grade Formation on which to restrict, UserFilter::DISPLAY for "any formation"
+ * @param $promo Promotion on which the filter is based
+ */
class UFC_Promo implements UserFilterCondition
{
}
}
}
-
+// }}}
+
+// {{{ class UFC_Name
+/** Filters users based on name
+ * @param $type Type of name field on which filtering is done (firstname, lastname...)
+ * @param $text Text on which to filter
+ * @param $mode Flag indicating search type (prefix, suffix, with particule...)
+ */
class UFC_Name implements UserFilterCondition
{
const PREFIX = 1;
return implode(' OR ', $conds);
}
}
+// }}}
+// {{{ class UFC_Dead
+/** Filters users based on death date
+ * @param $comparison Comparison operator
+ * @param $date Date to which death date should be compared
+ */
class UFC_Dead implements UserFilterCondition
{
private $comparison;
return $str;
}
}
-
+// }}}
+
+// {{{ class UFC_Registered
+/** Filters users based on registration state
+ * @param $active Whether we want to use only "active" users (i.e with a valid redirection)
+ * @param $comparison Comparison operator
+ * @param $date Date to which users registration date should be compared
+ */
class UFC_Registered implements UserFilterCondition
{
private $active;
return $date;
}
}
+// }}}
+// {{{ class UFC_ProfileUpdated
+/** Filters users based on profile update date
+ * @param $comparison Comparison operator
+ * @param $date Date to which profile update date must be compared
+ */
class UFC_ProfileUpdated implements UserFilterCondition
{
private $comparison;
return 'p.last_change ' . $this->comparison . XDB::format(' {?}', date('Y-m-d H:i:s', $this->date));
}
}
+// }}}
+// {{{ class UFC_Birthday
+/** Filters users based on next birthday date
+ * @param $comparison Comparison operator
+ * @param $date Date to which users next birthday date should be compared
+ */
class UFC_Birthday implements UserFilterCondition
{
private $comparison;
return 'p.next_birthday ' . $this->comparison . XDB::format(' {?}', date('Y-m-d', $this->date));
}
}
+// }}}
+// {{{ class UFC_Sex
+/** Filters users based on sex
+ * @parm $sex One of User::GENDER_MALE or User::GENDER_FEMALE, for selecting users
+ */
class UFC_Sex implements UserFilterCondition
{
private $sex;
}
}
}
+// }}}
+// {{{ class UFC_Group
+/** Filters users based on group membership
+ * @param $group Group whose members we are selecting
+ * @param $anim Whether to restrict selection to animators of that group
+ */
class UFC_Group implements UserFilterCondition
{
private $group;
- private $admin;
- public function __construct($group, $admin = false)
+ private $anim;
+ public function __construct($group, $anim = false)
{
$this->group = $group;
- $this->admin = $admin;
+ $this->anim = $anim;
}
public function buildCondition(UserFilter &$uf)
{
$sub = $uf->addGroupFilter($this->group);
$where = 'gpm' . $sub . '.perms IS NOT NULL';
- if ($this->admin) {
+ if ($this->anim) {
$where .= ' AND gpm' . $sub . '.perms = \'admin\'';
}
return $where;
}
}
+// }}}
+// {{{ class UFC_Email
+/** Filters users based on email address
+ * @param $email Email whose owner we are looking for
+ */
class UFC_Email implements UserFilterCondition
{
private $email;
}
}
}
+// }}}
+// {{{ class UFC_EmailList
+/** Filters users based on an email list
+ * @param $emails List of emails whose owner must be selected
+ */
class UFC_EmailList implements UserFilterCondition
{
private $emails;
return '(' . implode(') OR (', $cond) . ')';
}
}
+// }}}
+
+// {{{ class UFC_Address
+/** Filters users based on their address
+ * @param $text Text for filter in fulltext search
+ * @param $textSearchMode Mode for search (PREFIX, SUFFIX, ...)
+ * @param $type Filter on address type
+ * @param $flags Filter on address flags
+ * @param $countryId Filter on address countryId
+ * @param $administrativeAreaId Filter on address administrativeAreaId
+ * @param $subAdministrativeAreaId Filter on address subAdministrativeAreaId
+ * @param $localityId Filter on address localityId
+ * @param $postalCode Filter on address postalCode
+ */
+class UFC_Address implements UserFilterCondition
+{
+ /** Flags for text search
+ */
+ const PREFIX = 0x0001;
+ const SUFFIX = 0x0002;
+ const CONTAINS = 0x0003;
+
+ /** Valid address type ('hq' is reserved for company addresses)
+ */
+ const TYPE_HOME = 'home';
+ const TYPE_PRO = 'job';
+
+ /** Flags for addresses
+ */
+ const FLAG_CURRENT = 0x0001;
+ const FLAG_TEMP = 0x0002;
+ const FLAG_SECOND = 0x0004;
+ const FLAG_MAIL = 0x0008;
+ const FLAG_CEDEX = 0x0010;
+
+ // Binary OR of those flags
+ const FLAG_ANY = 0x001F;
+
+ /** Text of these flags
+ */
+ private static $flagtexts = array(
+ self::FLAG_CURRENT => 'current',
+ self::FLAG_TEMP => 'temporary',
+ self::FLAG_SECOND => 'secondary',
+ self::FLAG_MAIL => 'mail',
+ self::FLAG_CEDEX => 'cedex',
+ );
+
+ /** Data of the filter
+ */
+ private $text;
+ private $type;
+ private $flags;
+ private $countryId;
+ private $administrativeAreaId;
+ private $subAdministrativeAreaId;
+ private $localityId;
+ private $postalCode;
+
+ private $textSearchMode;
+
+ public function __construct($text = null, $textSearchMode = self::CONTAINS,
+ $type = null, $flags = self::FLAG_ANY, $countryId = null, $administrativeAreaId = null,
+ $subAdministrativeAreaId = null, $localityId = null, $postalCode = null)
+ {
+ $this->text = $text;
+ $this->textSearchMode = $textSearchMode;
+ $this->type = $type;
+ $this->flags = $flags;
+ $this->countryId = $countryId;
+ $this->administrativeAreaId = $administrativeAreaId;
+ $this->subAdministrativeAreaId = $subAdministrativeAreaId;
+ $this->localityId = $localityId;
+ $this->postalCode = $postalCode;
+ }
+ public function buildCondition(UserFilter &$uf)
+ {
+ $sub = $uf->addAddressFilter();
+ $conds = array();
+ if ($this->text != null) {
+ $left = $sub . '.text ';
+ $op = ' LIKE ';
+ if (($this->textSearchMode & self::CONTAINS) == 0) {
+ $right = XDB::format('{?}', $this->text);
+ $op = ' = ';
+ } else if (($this->mode & self::CONTAINS) == self::PREFIX) {
+ $right = XDB::format('CONCAT({?}, \'%\')', $this->text);
+ } else if (($this->mode & self::CONTAINS) == self::SUFFIX) {
+ $right = XDB::format('CONCAT(\'%\', {?})', $this->text);
+ } else {
+ $right = XDB::format('CONCAT(\'%\', {?}, \'%\')', $this->text);
+ }
+ $conds[] = $left . $op . $right;
+ }
+
+ if ($this->type != null) {
+ $conds[] = $sub . '.type = ' . XDB::format('{?}', $this->type);
+ }
+
+ if ($this->flags != self::FLAG_ANY) {
+ foreach(self::$flagtexts as $flag => $text) {
+ if ($flag & $this->flags) {
+ $conds[] = 'FIND_IN_SET(' . XDB::format('{?}', $text) . ', ' . $sub . '.flags)';
+ }
+ }
+ }
+
+ if ($this->countryId != null) {
+ $conds[] = $sub . '.countryId = ' . XDB::format('{?}', $this->countryId);
+ }
+ if ($this->administrativeAreaId != null) {
+ $conds[] = $sub . '.administrativeAreaId = ' . XDB::format('{?}', $this->administrativeAreaId);
+ }
+ if ($this->subAdministrativeAreaId != null) {
+ $conds[] = $sub . '.subAdministrativeAreaId = ' . XDB::format('{?}', $this->subAdministrativeAreaId);
+ }
+ if ($this->localityId != null) {
+ $conds[] = $sub . '.localityId = ' . XDB::format('{?}', $this->localityId);
+ }
+ if ($this->postalCode != null) {
+ $conds[] = $sub . '.postalCode = ' . XDB::format('{?}', $this->postalCode);
+ }
+
+ return implode(' AND ', $conds);
+ }
+}
+// }}}
+
+// {{{ class UFC_Corps
+/** Filters users based on the corps they belong to
+ * @param $corps Corps we are looking for (abbreviation)
+ * @param $type Whether we search for original or current corps
+ */
+class UFC_Corps implements UserFilterCondition
+{
+ const CURRENT = 1;
+ const ORIGIN = 2;
+
+ private $corps;
+ private $type;
+
+ public function __construct($corps, $type = self::CURRENT)
+ {
+ $this->corps = $corps;
+ $this->type = $type;
+ }
+
+ public function buildCondition(UserFilter &$uf)
+ {
+ /** Tables shortcuts:
+ * pc for profile_corps,
+ * pceo for profile_corps_enum - orginal
+ * pcec for profile_corps_enum - current
+ */
+ $sub = $uf->addCorpsFilter($this->type);
+ $cond = $sub . '.abbreviation = ' . $corps;
+ return $cond;
+ }
+}
+// }}}
+
+// {{{ class UFC_Corps_Rank
+/** Filters users based on their rank in the corps
+ * @param $rank Rank we are looking for (abbreviation)
+ */
+class UFC_Corps_Rank implements UserFilterCondition
+{
+ private $rank;
+ public function __construct($rank)
+ {
+ $this->rank = $rank;
+ }
+
+ public function buildCondition(UserFilter &$uf)
+ {
+ /** Tables shortcuts:
+ * pcr for profile_corps_rank
+ */
+ $sub = $uf->addCorpsRankFilter();
+ $cond = $sub . '.abbreviation = ' . $rank;
+ return $cond;
+ }
+}
+// }}}
+
+// {{{ class UFC_Job_Company
+/** Filters users based on the company they belong to
+ * @param $type The field being searched (self::JOBID, self::JOBNAME or self::JOBACRONYM)
+ * @param $value The searched value
+ */
+class UFC_Job_Company implements UserFilterCondition
+{
+ const JOBID = 'id';
+ const JOBNAME = 'name';
+ const JOBACRONYM = 'acronym';
+
+ private $type;
+ private $value;
+
+ public function __construct($type, $value)
+ {
+ $this->assertType($type);
+ $this->type = $type;
+ $this->value = $value;
+ }
+
+ private function assertType($type)
+ {
+ if ($type != self::JOBID && $type != self::JOBNAME && $type != self::JOBACRONYM) {
+ Platal::page()->killError("Type de recherche non valide.");
+ }
+ }
+
+ public function buildCondition(UserFilter &$uf)
+ {
+ $sub = $uf->addJobCompanyFilter();
+ $cond = $sub . '.' . $this->type . ' = ' . XDB::format('{?}', $this->value);
+ return $cond;
+ }
+}
+// }}}
+
+// {{{ class UFC_Job_Sectorization
+/** Filters users based on the ((sub)sub)sector they work in
+ * @param $sector The sector searched
+ * @param $subsector The subsector
+ * @param $subsubsector The subsubsector
+ */
+class UFC_Job_Sectorization implements UserFilterCondition
+{
+
+ private $sector;
+ private $subsector;
+ private $subsubsector;
+
+ public function __construct($sector = null, $subsector = null, $subsubsector = null)
+ {
+ $this->sector = $sector;
+ $this->subsector = $subsector;
+ $this->subsubsector = $subsubsector;
+ }
+
+ public function buildCondition(UserFilter &$uf)
+ {
+ // No need to add the JobFilter, it will be done by addJobSectorizationFilter
+ $conds = array();
+ if ($this->sector !== null) {
+ $sub = $uf->addJobSectorizationFilter(UserFilter::JOB_SECTOR);
+ $conds[] = $sub . '.id = ' . XDB::format('{?}', $this->sector);
+ }
+ if ($this->subsector !== null) {
+ $sub = $uf->addJobSectorizationFilter(UserFilter::JOB_SUBSECTOR);
+ $conds[] = $sub . '.id = ' . XDB::format('{?}', $this->subsector);
+ }
+ if ($this->subsubsector !== null) {
+ $sub = $uf->addJobSectorizationFilter(UserFilter::JOB_SUBSUBSECTOR);
+ $conds[] = $sub . '.id = ' . XDB::format('{?}', $this->subsubsector);
+ }
+ return implode(' AND ', $conds);
+ }
+}
+// }}}
+
+// {{{ class UFC_Job_Description
+/** Filters users based on their job description
+ * @param $description The text being searched for
+ * @param $fields The fields to search for (user-defined, ((sub|)sub|)sector)
+ */
+class UFC_Job_Description implements UserFilterCondition
+{
+
+ /** Meta-filters
+ * Built with binary OR on UserFilter::JOB_*
+ */
+ const ANY = 31;
+ const SECTORIZATION = 15;
+
+ private $description;
+ private $fields;
+
+ public function __construct($description)
+ {
+ $this->fields = $fields;
+ $this->description = $description;
+ }
+
+ public function buildCondition(UserFilter &$uf)
+ {
+ $conds = array();
+ if ($this->fields & UserFilter::JOB_USERDEFINED) {
+ $sub = $uf->addJobFilter();
+ $conds[] = $sub . '.description LIKE ' . XDB::format('CONCAT(\'%\', {?}, \'%\')', $this->description);
+ }
+ if ($this->fields & UserFilter::JOB_SECTOR) {
+ $sub = $uf->addJobSectorizationFilter(UserFilter::JOB_SECTOR);
+ $conds[] = $sub . '.name LIKE ' . XDB::format('CONCAT(\'%\', {?}, \'%\')', $this->description);
+ }
+ if ($this->fields & UserFilter::JOB_SUBSECTOR) {
+ $sub = $uf->addJobSectorizationFilter(UserFilter::JOB_SUBSECTOR);
+ $conds[] = $sub . '.name LIKE ' . XDB::format('CONCAT(\'%\', {?}, \'%\')', $this->description);
+ }
+ if ($this->fields & UserFilter::JOB_SUBSUBSECTOR) {
+ $sub = $uf->addJobSectorizationFilter(UserFilter::JOB_SUBSUBSECTOR);
+ $conds[] = $sub . '.name LIKE ' . XDB::format('CONCAT(\'%\', {?}, \'%\')', $this->description);
+ $sub = $uf->addJobSectorizationFilter(UserFilter::JOB_ALTERNATES);
+ $conds[] = $sub . '.name LIKE ' . XDB::format('CONCAT(\'%\', {?}, \'%\')', $this->description);
+ }
+ return implode(' OR ', $conds);
+ }
+}
+// }}}
+
+// {{{ class UFC_Networking
+/** Filters users based on network identity (IRC, ...)
+ * @param $type Type of network (-1 for any)
+ * @param $value Value to search
+ */
+class UFC_Networking implements UserFilterCondition
+{
+ private $type;
+ private $value;
+
+ public function __construct($type, $value)
+ {
+ $this->type = $type;
+ $this->value = $value;
+ }
+
+ public function buildCondition(UserFilter &$uf)
+ {
+ $sub = $uf->addNetworkingFilter();
+ $conds = array();
+ $conds[] = $sub . '.address = ' . XDB::format('CONCAT(\'%\', {?}, \'%\')', $this->value);
+ if ($this->type != -1) {
+ $conds[] = $sub . '.network_type = ' . XDB::format('{?}', $this->type);
+ }
+ return implode(' AND ', $conds);
+ }
+}
+// }}}
+
+// {{{ class UFC_Phone
+/** Filters users based on their phone number
+ * @param $num_type Type of number (pro/user/home)
+ * @param $phone_type Type of phone (fixed/mobile/fax)
+ * @param $number Phone number
+ */
+class UFC_Phone implements UserFilterCondition
+{
+ const NUM_PRO = 'pro';
+ const NUM_USER = 'user';
+ const NUM_HOME = 'address';
+ const NUM_ANY = 'any';
+
+ const PHONE_FIXED = 'fixed';
+ const PHONE_MOBILE = 'mobile';
+ const PHONE_FAX = 'fax';
+ const PHONE_ANY = 'any';
+
+ private $num_type;
+ private $phone_type;
+ private $number;
+
+ public function __construct($number, $num_type = self::NUM_ANY, $phone_type = self::PHONE_ANY)
+ {
+ require_once('profil.inc.php');
+ $this->number = $number;
+ $this->num_type = $num_type;
+ $this->phone_type = format_phone_number($phone_type);
+ }
+
+ public function buildCondition(UserFilter &$uf)
+ {
+ $sub = $uf->addPhoneFilter();
+ $conds = array();
+ $conds[] = $sub . '.search_tel = ' . XDB::format('{?}', $this->number);
+ if ($this->num_type != self::NUM_ANY) {
+ $conds[] = $sub . '.link_type = ' . XDB::format('{?}', $this->num_type);
+ }
+ if ($this->phone_type != self::PHONE_ANY) {
+ $conds[] = $sub . '.tel_type = ' . XDB::format('{?}', $this->phone_type);
+ }
+ return implode(' AND ', $conds);
+ }
+}
+// }}}
+
+// {{{ class UFC_Medal
+/** Filters users based on their medals
+ * @param $medal ID of the medal
+ * @param $grade Grade of the medal (null for 'any')
+ */
+class UFC_Medal implements UserFilterCondition
+{
+ private $medal;
+ private $grade;
+
+ public function __construct($medal, $grade = null)
+ {
+ $this->medal = $medal;
+ $this->grade = $grade;
+ }
+
+ public function buildCondition(UserFilter &$uf)
+ {
+ $conds = array();
+ $sub = $uf->addMedalFilter();
+ $conds[] = $sub . '.mid = ' . XDB::format('{?}', $this->medal);
+ if ($this->grade != null) {
+ $conds[] = $sub . '.gid = ' . XDB::format('{?}', $this->grade);
+ }
+ return implode(' AND ', $conds);
+ }
+}
+// }}}
+
+// {{{ class UFC_Mentor_Expertise
+/** Filters users by mentoring expertise
+ * @param $expertise Domain of expertise
+ */
+class UFC_Mentor_Expertise implements UserFilterCondition
+{
+ private $expertise;
+
+ public function __construct($expertise)
+ {
+ $this->expertise = $expertise;
+ }
+
+ public function buildCondition(UserFilter &$uf)
+ {
+ $sub = $uf->addMentorFilter(UserFilter::MENTOR_EXPERTISE);
+ return $sub . '.expertise LIKE ' . XDB::format('CONCAT(\'%\', {?}, \'%\'', $this->expertise);
+ }
+}
+// }}}
+
+// {{{ class UFC_Mentor_Country
+/** Filters users by mentoring country
+ * @param $country Two-letters code of country being searched
+ */
+class UFC_Mentor_Country implements UserFilterCondition
+{
+ private $country;
+
+ public function __construct($country)
+ {
+ $this->country = $country;
+ }
+
+ public function buildCondition(UserFilter &$uf)
+ {
+ $sub = $uf->addMentorFilter(UserFilter::MENTOR_COUNTRY);
+ return $sub . '.country = ' . XDB::format('{?}', $this->country);
+ }
+}
+// }}}
+
+// {{{ class UFC_Mentor_Sectorization
+/** Filters users based on mentoring (sub|)sector
+ * @param $sector ID of sector
+ * @param $subsector Subsector (null for any)
+ */
+class UFC_Mentor_Sectorization implements UserFilterCondition
+{
+ private $sector;
+ private $subsector;
+
+ public function __construct($sector, $subsector = null)
+ {
+ $this->sector = $sector;
+ $this->subsubsector = $subsector;
+ }
+
+ public function buildCondition(UserFilter &$uf)
+ {
+ $sub = $uf->addMentorFilter(UserFilter::MENTOR_SECTOR);
+ $conds = array();
+ $conds[] = $sub . '.sectorid = ' . XDB::format('{?}', $this->sector);
+ if ($this->subsector != null) {
+ $conds[] = $sub . '.subsectorid = ' . XDB::format('{?}', $this->subsector);
+ }
+ return implode(' AND ', $conds);
+ }
+}
+// }}}
+
+// {{{ class UFC_UserRelated
+/** Filters users based on a relation toward a user
+ * @param $user User to which searched users are related
+ */
abstract class UFC_UserRelated implements UserFilterCondition
{
protected $user;
$this->user =& $user;
}
}
+// }}}
+// {{{ class UFC_Contact
+/** Filters users who belong to selected user's contacts
+ */
class UFC_Contact extends UFC_UserRelated
{
public function buildCondition(UserFilter &$uf)
return 'c' . $sub . '.contact IS NOT NULL';
}
}
+// }}}
+// {{{ class UFC_WatchRegistration
+/** Filters users being watched by selected user
+ */
class UFC_WatchRegistration extends UFC_UserRelated
{
public function buildCondition(UserFilter &$uf)
}
}
}
+// }}}
+// {{{ class UFC_WatchPromo
+/** Filters users belonging to a promo watched by selected user
+ * @param $user Selected user (the one watching promo)
+ * @param $grade Formation the user is watching
+ */
class UFC_WatchPromo extends UFC_UserRelated
{
private $grade;
}
}
}
+// }}}
+// {{{ class UFC_WatchContact
+/** Filters users watched by selected user
+ */
class UFC_WatchContact extends UFC_Contact
{
public function buildCondition(UserFilter &$uf)
return parent::buildCondition($uf);
}
}
+// }}}
/******************
* ORDERS
******************/
+// {{{ class UserFilterOrder
+/** Base class for ordering results of a query.
+ * Parameters for the ordering must be given to the constructor ($desc for a
+ * descending order).
+ * The getSortTokens function is used to get actual ordering part of the query.
+ */
abstract class UserFilterOrder
{
protected $desc = false;
return $sel;
}
+ /** This function must return the tokens to use for ordering
+ * @param &$uf The UserFilter whose results must be ordered
+ * @return The name of the field to use for ordering results
+ */
abstract protected function getSortTokens(UserFilter &$uf);
}
+// }}}
+// {{{ class UFO_Promo
+/** Orders users by promotion
+ * @param $grade Formation whose promotion users should be sorted by (restricts results to users of that formation)
+ * @param $desc Whether sort is descending
+ */
class UFO_Promo extends UserFilterOrder
{
private $grade;
}
}
}
-
+// }}}
+
+// {{{ class UFO_Name
+/** Sorts users by name
+ * @param $type Type of name on which to sort (firstname...)
+ * @param $variant Variant of that name to use (marital, ordinary...)
+ * @param $particle Set to true if particles should be included in the sorting order
+ * @param $desc If sort order should be descending
+ */
class UFO_Name extends UserFilterOrder
{
private $type;
}
}
}
+// }}}
+// {{{ class UFO_Registration
+/** Sorts users based on registration date
+ */
class UFO_Registration extends UserFilterOrder
{
protected function getSortTokens(UserFilter &$uf)
return 'a.registration_date';
}
}
+// }}}
+// {{{ class UFO_Birthday
+/** Sorts users based on next birthday date
+ */
class UFO_Birthday extends UserFilterOrder
{
protected function getSortTokens(UserFilter &$uf)
return 'p.next_birthday';
}
}
+// }}}
+// {{{ class UFO_ProfileUpdate
+/** Sorts users based on last profile update
+ */
class UFO_ProfileUpdate extends UserFilterOrder
{
protected function getSortTokens(UserFilter &$uf)
return 'p.last_change';
}
}
+// }}}
+// {{{ class UFO_Death
+/** Sorts users based on death date
+ */
class UFO_Death extends UserFilterOrder
{
protected function getSortTokens(UserFilter &$uf)
return 'p.deathdate';
}
}
+// }}}
/***********************************
*********************************
***********************************/
+// {{{ class UserFilter
+/** This class provides a convenient and centralized way of filtering users.
+ *
+ * Usage:
+ * $uf = new UserFilter(new UFC_Blah($x, $y), new UFO_Coin($z, $t));
+ *
+ * Resulting UserFilter can be used to:
+ * - get a list of User objects matching the filter
+ * - get a list of UIDs matching the filter
+ * - get the number of users matching the filter
+ * - check whether a given User matches the filter
+ * - filter a list of User objects depending on whether they match the filter
+ *
+ * Usage for UFC and UFO objects:
+ * A UserFilter will call all private functions named XXXJoins.
+ * These functions must return an array containing the list of join
+ * required by the various UFC and UFO associated to the UserFilter.
+ * Entries in those returned array are of the following form:
+ * 'join_tablealias' => array('join_type', 'joined_table', 'join_criter')
+ * which will be translated into :
+ * join_type JOIN joined_table AS join_tablealias ON (join_criter)
+ * in the final query.
+ *
+ * In the join_criter text, $ME is replaced with 'join_tablealias', $PID with
+ * profile.pid, and $UID with auth_user_md5.user_id.
+ *
+ * For each kind of "JOIN" needed, a function named addXXXFilter() should be defined;
+ * its parameter will be used to set various private vars of the UserFilter describing
+ * the required joins ; such a function shall return the "join_tablealias" to use
+ * when referring to the joined table.
+ *
+ * For example, if data from profile_job must be available to filter results,
+ * the UFC object will call $uf-addJobFilter(), which will set the 'with_pj' var and
+ * return 'pj', the short name to use when referring to profile_job; when building
+ * the query, calling the jobJoins function will return an array containing a single
+ * row:
+ * 'pj' => array('left', 'profile_job', '$ME.pid = $UID');
+ *
+ * The 'register_optional' function can be used to generate unique table aliases when
+ * the same table has to be joined several times with different aliases.
+ */
class UserFilter
{
static private $joinMethods = array();
}
+ /** Stores a new (and unique) table alias in the &$table table
+ * @param &$table Array in which the table alias must be stored
+ * @param $val Value which will then be used to build the join
+ * @return Name of the newly created alias
+ */
private $option = 0;
private function register_optional(array &$table, $val)
{
}
+ /** ADDRESSES
+ */
+ private $with_pa = false;
+ public function addAddressFilter()
+ {
+ $this->with_pa = true;
+ return 'pa';
+ }
+
+ private function addressJoins()
+ {
+ $joins = array();
+ if ($this->with_pa) {
+ $joins['pa'] = array('left', 'profile_address', '$ME.pid = $PID');
+ }
+ return $joins;
+ }
+
+
+ /** CORPS
+ */
+
+ private $pc = false;
+ private $pce = array();
+ private $pcr = false;
+ public function addCorpsFilter($type)
+ {
+ $this->pc = true;
+ if ($type == UFC_Corps::CURRENT) {
+ $pce['pcec'] = 'current_corpsid';
+ return 'pcec';
+ } else if ($type == UFC_Corps::ORIGIN) {
+ $pce['pceo'] = 'original_corpsid';
+ return 'pceo';
+ }
+ }
+
+ public function addCorpsRankFilter()
+ {
+ $this->pc = true;
+ $this->pcr = true;
+ return 'pcr';
+ }
+
+ private function corpsJoins()
+ {
+ $joins = array();
+ if ($this->pc) {
+ $joins['pc'] = array('left', 'profile_corps', '$ME.uid = $UID');
+ }
+ if ($this->pcr) {
+ $joins['pcr'] = array('left', 'profile_corps_rank_enum', '$ME.id = pc.rankid');
+ }
+ foreach($this->pce as $sub => $field) {
+ $joins[$sub] = array('left', 'profile_corps_enum', '$ME.id = pc.' . $field);
+ }
+ return $joins;
+ }
+
+ /** JOBS
+ */
+
+ const JOB_SECTOR = 1;
+ const JOB_SUBSECTOR = 2;
+ const JOB_SUBSUBSECTOR = 4;
+ const JOB_ALTERNATES = 8;
+ const JOB_USERDEFINED = 16;
+
+ /** Joins :
+ * pj => profile_job
+ * pje => profile_job_enum
+ * pjse => profile_job_sector_enum
+ * pjsse => profile_job_subsector_enum
+ * pjssse => profile_job_subsubsector_enum
+ * pja => profile_job_alternates
+ */
+ private $with_pj = false;
+ private $with_pje = false;
+ private $with_pjse = false;
+ private $with_pjsse = false;
+ private $with_pjssse = false;
+ private $with_pja = false;
+
+ public function addJobFilter()
+ {
+ $this->with_pj = true;
+ return 'pj';
+ }
+
+ public function addJobCompanyFilter()
+ {
+ $this->addJobFilter();
+ $this->with_pje = true;
+ return 'pje';
+ }
+
+ public function addJobSectorizationFilter($type)
+ {
+ $this->addJobFilter();
+ if ($type == self::JOB_SECTOR) {
+ $this->with_pjse = true;
+ return 'pjse';
+ } else if ($type == self::JOB_SUBSECTOR) {
+ $this->with_pjsse = true;
+ return 'pjsse';
+ } else if ($type == self::JOB_SUBSUBSECTOR) {
+ $this->with_pjssse = true;
+ return 'pjssse';
+ } else if ($type == self::JOB_ALTERNATES) {
+ $this->with_pja = true;
+ return 'pja';
+ }
+ }
+
+ private function jobJoins()
+ {
+ $joins = array();
+ if ($this->with_pj) {
+ $joins['pj'] = array('left', 'profile_job', '$ME.uid = $UID');
+ }
+ if ($this->with_pje) {
+ $joins['pje'] = array('left', 'profile_job_enum', '$ME.id = pj.jobid');
+ }
+ if ($this->with_pjse) {
+ $joins['pjse'] = array('left', 'profile_job_sector_enum', '$ME.id = pj.sectorid');
+ }
+ if ($this->with_pjsse) {
+ $joins['pjsse'] = array('left', 'profile_job_subsector_enum', '$ME.id = pj.subsectorid');
+ }
+ if ($this->with_pjssse) {
+ $joins['pjssse'] = array('left', 'profile_job_subsubsector_enum', '$ME.id = pj.subsubsectorid');
+ }
+ if ($this->with_pja) {
+ $joins['pja'] = array('left', 'profile_job_alternates', '$ME.subsubsectorid = pj.subsubsectorid');
+ }
+ return $joins;
+ }
+
+ /** NETWORKING
+ */
+
+ private $with_pnw = false;
+ public function addNetworkingFilter()
+ {
+ $this->with_pnw = true;
+ return 'pnw';
+ }
+
+ private function networkingJoins()
+ {
+ $joins = array();
+ if ($this->with_pnw) {
+ $joins['pnw'] = array('left', 'profile_networking', '$ME.uid = $UID');
+ }
+ return $joins;
+ }
+
+ /** PHONE
+ */
+
+ private $with_ptel = false;
+
+ public function addPhoneFilter()
+ {
+ $this->with_ptel = true;
+ return 'ptel';
+ }
+
+ private function phoneJoins()
+ {
+ $joins = array();
+ if ($this->with_ptel) {
+ $joins['ptel'] = array('left', 'profile_phone', '$ME.uid = $UID');
+ }
+ return $joins;
+ }
+
+ /** MEDALS
+ */
+
+ private $with_pmed = false;
+ public function addMedalFilter()
+ {
+ $this->with_pmed = true;
+ return 'pmed';
+ }
+
+ private function medalJoins()
+ {
+ $joins = array();
+ if ($this->with_pmed) {
+ $joins['pmed'] = array('left', 'profile_medals_sub', '$ME.uid = $UID');
+ }
+ return $joins;
+ }
+
+ /** MENTORING
+ */
+
+ private $pms = array();
+ const MENTOR_EXPERTISE = 1;
+ const MENTOR_COUNTRY = 2;
+ const MENTOR_SECTOR = 3;
+
+ public function addMentorFilter($type)
+ {
+ switch($type) {
+ case MENTOR_EXPERTISE:
+ $pms['pme'] = 'profile_mentor';
+ return 'pme';
+ case MENTOR_COUNTRY:
+ $pms['pmc'] = 'profile_mentor_country';
+ return 'pmc';
+ case MENTOR_SECTOR:
+ $pms['pms'] = 'profile_mentor_sector';
+ return 'pms';
+ default:
+ Platal::page()->killError("Undefined mentor filter.");
+ }
+ }
+
+ private function mentorJoins()
+ {
+ $joins = array();
+ foreach ($this->pms as $sub => $tab) {
+ $joins[$sub] = array('left', $tab, '$ME.uid = $UID');
+ }
+ return $joins;
+ }
+
/** CONTACTS
*/
private $cts = array();
return $joins;
}
}
-
+// }}}
// vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
?>
projects / platal.git / blobdiff