Improve comments quality, fix minor bugs
[platal.git] / classes / userfilter.php
index ebe69f4..3bebf33 100644 (file)
@@ -24,6 +24,7 @@
  * CONDITIONS
  ******************/
 
+// {{{ interface UserFilterCondition
 interface UserFilterCondition
 {
     const COND_TRUE  = 'TRUE';
@@ -33,7 +34,9 @@ interface UserFilterCondition
      */
     public function buildCondition(UserFilter &$uf);
 }
+// }}}
 
+// {{{ class UFC_OneChild
 abstract class UFC_OneChild implements UserFilterCondition
 {
     protected $child;
@@ -50,7 +53,9 @@ abstract class UFC_OneChild implements UserFilterCondition
         $this->child =& $cond;
     }
 }
+// }}}
 
+// {{{ class UFC_NChildren
 abstract class UFC_NChildren implements UserFilterCondition
 {
     protected $children = array();
@@ -81,7 +86,9 @@ abstract class UFC_NChildren implements UserFilterCondition
         }
     }
 }
+// }}}
 
+// {{{ class UFC_True
 class UFC_True implements UserFilterCondition
 {
     public function buildCondition(UserFilter &$uf)
@@ -89,7 +96,9 @@ class UFC_True implements UserFilterCondition
         return self::COND_TRUE;
     }
 }
+// }}}
 
+// {{{ class UFC_False
 class UFC_False implements UserFilterCondition
 {
     public function buildCondition(UserFilter &$uf)
@@ -97,7 +106,9 @@ class UFC_False implements UserFilterCondition
         return self::COND_FALSE;
     }
 }
+// }}}
 
+// {{{ class UFC_Not
 class UFC_Not extends UFC_OneChild
 {
     public function buildCondition(UserFilter &$uf)
@@ -112,7 +123,9 @@ class UFC_Not extends UFC_OneChild
         }
     }
 }
+// }}}
 
+// {{{ class UFC_And
 class UFC_And extends UFC_NChildren
 {
     public function buildCondition(UserFilter &$uf)
@@ -136,7 +149,9 @@ class UFC_And extends UFC_NChildren
         }
     }
 }
+// }}}
 
+// {{{ class UFC_Or
 class UFC_Or extends UFC_NChildren
 {
     public function buildCondition(UserFilter &$uf)
@@ -160,7 +175,11 @@ class UFC_Or extends UFC_NChildren
         }
     }
 }
+// }}}
 
+// {{{ class UFC_Profile
+/** Filters users who have a profile
+ */
 class UFC_Profile implements UserFilterCondition
 {
     public function buildCondition(UserFilter &$uf)
@@ -168,7 +187,14 @@ class UFC_Profile implements UserFilterCondition
         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
 {
 
@@ -198,7 +224,14 @@ 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;
@@ -251,7 +284,13 @@ class UFC_Name implements UserFilterCondition
         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;
@@ -272,7 +311,14 @@ class UFC_Dead implements UserFilterCondition
         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;
@@ -299,7 +345,13 @@ class UFC_Registered implements UserFilterCondition
         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;
@@ -316,7 +368,13 @@ class UFC_ProfileUpdated implements UserFilterCondition
         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;
@@ -333,7 +391,12 @@ class UFC_Birthday implements UserFilterCondition
         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;
@@ -351,28 +414,39 @@ class UFC_Sex implements UserFilterCondition
         }
     }
 }
+// }}}
 
+// {{{ 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;
@@ -396,7 +470,12 @@ class UFC_Email implements UserFilterCondition
         }
     }
 }
+// }}}
 
+// {{{ 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;
@@ -438,7 +517,415 @@ class UFC_EmailList implements UserFilterCondition
         return '(' . implode(') OR (', $cond) . ')';
     }
 }
+// }}}
+
+// {{{ class UFC_Address
+/** Filters users based on their address
+ * @param $field Field of the address used for filtering (city, street, ...)
+ * @param $text Text for filter
+ * @param $mode Mode for search (PREFIX, SUFFIX, ...)
+ */
+class UFC_Address implements UserFilterCondition
+{
+    const PREFIX    = 1;
+    const SUFFIX    = 2;
+    const CONTAINS  = 3;
+
+    private $field;
+    private $text;
+    private $mode;
+
+    public function __construct($field, $text, $mode)
+    {
+        $this->field = $field;
+        $this->text  = $text;
+        $this->mode  = $mode;
+    }
+
+    public function buildCondition(UserFilter &$uf)
+    {
+        $left = 'pa.' . $field;
+        $op   = ' LIKE ';
+        if (($this->mode & 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);
+        }
+        $cond = $left . $op . $right;
+        $uf->addAddressFilter();
+        return $cond;
+    }
+}
+// }}}
+
+// {{{ 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 extends 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 extends 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 extends 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 extends 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 extends 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 extends 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 extends 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 extends 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 extends 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;
@@ -447,7 +934,11 @@ abstract class UFC_UserRelated implements UserFilterCondition
         $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)
@@ -456,7 +947,11 @@ class UFC_Contact extends UFC_UserRelated
         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)
@@ -472,7 +967,13 @@ class UFC_WatchRegistration extends UFC_UserRelated
         }
     }
 }
+// }}}
 
+// {{{ 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;
@@ -494,7 +995,11 @@ class UFC_WatchPromo extends UFC_UserRelated
         }
     }
 }
+// }}}
 
+// {{{ class UFC_WatchContact
+/** Filters users watched by selected user
+ */
 class UFC_WatchContact extends UFC_Contact
 {
     public function buildCondition(UserFilter &$uf)
@@ -505,12 +1010,14 @@ class UFC_WatchContact extends UFC_Contact
         return parent::buildCondition($uf);
     }
 }
+// }}}
 
 
 /******************
  * ORDERS
  ******************/
 
+// {{{ class UserFilterOrder
 abstract class UserFilterOrder
 {
     protected $desc = false;
@@ -535,7 +1042,13 @@ abstract class UserFilterOrder
 
     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;
@@ -557,7 +1070,15 @@ class UFO_Promo extends UserFilterOrder
         }
     }
 }
-
+// }}}
+
+// {{{ 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;
@@ -587,7 +1108,11 @@ class UFO_Name extends UserFilterOrder
         }
     }
 }
+// }}}
 
+// {{{ class UFO_Registration
+/** Sorts users based on registration date
+ */
 class UFO_Registration extends UserFilterOrder
 {
     protected function getSortTokens(UserFilter &$uf)
@@ -595,7 +1120,11 @@ class UFO_Registration extends UserFilterOrder
         return 'a.registration_date';
     }
 }
+// }}}
 
+// {{{ class UFO_Birthday
+/** Sorts users based on next birthday date
+ */
 class UFO_Birthday extends UserFilterOrder
 {
     protected function getSortTokens(UserFilter &$uf)
@@ -603,7 +1132,11 @@ class UFO_Birthday extends UserFilterOrder
         return 'p.next_birthday';
     }
 }
+// }}}
 
+// {{{ class UFO_ProfileUpdate
+/** Sorts users based on last profile update
+ */
 class UFO_ProfileUpdate extends UserFilterOrder
 {
     protected function getSortTokens(UserFilter &$uf)
@@ -611,7 +1144,11 @@ class UFO_ProfileUpdate extends UserFilterOrder
         return 'p.last_change';
     }
 }
+// }}}
 
+// {{{ class UFO_Death
+/** Sorts users based on death date
+ */
 class UFO_Death extends UserFilterOrder
 {
     protected function getSortTokens(UserFilter &$uf)
@@ -619,6 +1156,7 @@ class UFO_Death extends UserFilterOrder
         return 'p.deathdate';
     }
 }
+// }}}
 
 
 /***********************************
@@ -627,6 +1165,7 @@ class UFO_Death extends UserFilterOrder
   *********************************
  ***********************************/
 
+// {{{ class UserFilter
 class UserFilter
 {
     static private $joinMethods = array();
@@ -1108,6 +1647,235 @@ class UserFilter
     }
 
 
+    /** ADDRESSES
+     */
+    private $pa = false;
+    public function addAddressFilter()
+    {
+        $this->pa = true;
+    }
+
+    private function addressJoins()
+    {
+        $joins = array();
+        if ($this->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_phone = false;
+
+    public function addPhoneFilter()
+    {
+        $this->with_phone = true;
+        return 'ptel';
+    }
+
+    private function phoneJoins()
+    {
+        $joins = array();
+        if ($this->with_phone) {
+            $joins['ptel'] = array('left', 'profile_phone', '$ME.uid = $UID');
+        }
+        return $joins;
+    }
+
+    /** MEDALS
+     */
+
+    private $with_medals = false;
+    public function addMedalFilter()
+    {
+        $this->with_medals = true;
+        return 'pmed';
+    }
+
+    private function medalJoins()
+    {
+        $joins = array();
+        if ($this->with_medals) {
+            $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();
@@ -1184,7 +1952,7 @@ class UserFilter
         return $joins;
     }
 }
-
+// }}}
 
 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
 ?>