X-Git-Url: http://git.polytechnique.org/?a=blobdiff_plain;f=include%2Fufbuilder.inc.php;h=fc7da8a429cef99a0d3a78ea3246601eb153e94a;hb=1745c7c830c7ac1aa89ee732dbfbe6939a1b32ff;hp=79b918a99ae017a1f99c39da640fcd23c8e9f433;hpb=290dca06a494e75001f2bde2e5836938dacac88d;p=platal.git diff --git a/include/ufbuilder.inc.php b/include/ufbuilder.inc.php index 79b918a..fc7da8a 100644 --- a/include/ufbuilder.inc.php +++ b/include/ufbuilder.inc.php @@ -1,6 +1,6 @@ ufb = $ufb; + $this->ufc = $ufc; + $this->env = $env; + } + + public function export() + { + $export = new PlDict(); + $export->set('type', self::TYPE_UFB); + $export->set('condition', $this->ufc->export()); + $export->set('env', $this->env); + return $export; + } + + public function getEnv() + { + return $this->env; + } + + public function fillFromExport($export) + { + $export = new PlDict($export); + if (!$export->has('type')) { + throw new Exception("Missing 'type' field in export."); + } + if ($export->s('type') != self::TYPE_UFB) { + throw new Exception("Unknown type '$type' in export."); + } + $this->ufc = UserFilterCondition::fromExport($export->v('condition')); + $this->env = $export->v('env', array()); + } + + public function updateFromEnv($env) + { + $this->ufb->setFakeEnv($env); + if ($this->ufb->isValid()) { + $this->env = $env; + $this->ufc = $this->ufb->getUFC(); + return true; + } else { + $this->ufb->clearFakeEnv(); + return false; + } + } + + public function refresh() + { + if ($this->isValid()) { + $this->ufc = $this->ufb->getUFC(); + } + } + + public function getUFC() + { + return $this->ufc; + } + + public function isValid() + { + $this->ufb->setFakeEnv($this->env); + return $this->ufb->isValid(); + } + + public function isEmpty() + { + $this->ufb->setFakeEnv($this->env); + return $this->ufb->isEmpty(); + } +} +// }}} + // {{{ class UserFilterBuilder class UserFilterBuilder { @@ -27,6 +110,7 @@ class UserFilterBuilder private $valid = true; private $ufc = null; private $orders = array(); + private $fake_env = null; /** Constructor * @param $fields An array of UFB_Field objects @@ -38,6 +122,16 @@ class UserFilterBuilder $this->envprefix = $envprefix; } + public function setFakeEnv($env) + { + $this->fake_env = new PlDict($env); + } + + public function clearFakeEnv() + { + $this->fake_env = null; + } + /** Builds the UFC; returns as soon as a field says it is invalid */ private function buildUFC() @@ -48,19 +142,19 @@ class UserFilterBuilder $this->ufc = new PFC_And(); foreach ($this->fields as $field) { - $this->valid = $field->apply(&$this); + $this->valid = $field->apply($this); if (!$this->valid) { return; } } } - public function addCond(PlFilterCondition &$cond) + public function addCond(PlFilterCondition $cond) { $this->ufc->addChild($cond); } - public function addOrder(PlFilterOrder &$order) + public function addOrder(PlFilterOrder $order) { $this->order[] = $order; } @@ -89,7 +183,11 @@ class UserFilterBuilder { $this->buildUFC(); if ($this->valid) { - return $this->ufc; + if ($this->isEmpty()) { + return new PFC_True(); + } else { + return $this->ufc; + } } else { return new PFC_False(); } @@ -103,41 +201,98 @@ class UserFilterBuilder return $this->orders; } + public function getEnvFieldNames() + { + $fields = array(); + foreach ($this->fields as $ufbf) { + $fields = array_merge($fields, $ufbf->getEnvFieldNames()); + } + return array_unique($fields); + } + + public function getEnv() + { + $values = array(); + foreach ($this->getEnvFieldNames() as $field) { + if ($this->has($field)) { + $values[$field] = $this->v($field); + } + } + return $values; + } + + public function setEnv($values) + { + foreach ($this->getEnvFieldNames() as $field) { + if (array_key_exists($field, $values)) { + Env::set($this->envprefix . $field, $values[$field]); + } + } + } + /** Wrappers around Env::i/s/..., to add envprefix */ public function s($key, $def = '') { - return Env::s($this->envprefix . $key, $def); + if ($this->fake_env) { + return $this->fake_env->s($key, $def); + } else { + return Env::s($this->envprefix . $key, $def); + } } public function t($key, $def = '') { - return Env::t($this->envprefix . $key, $def); + if ($this->fake_env) { + return $this->fake_env->t($key, $def); + } else { + return Env::t($this->envprefix . $key, $def); + } } public function i($key, $def = 0) { - return Env::i($this->envprefix . $key, $def); + if ($this->fake_env) { + return $this->fake_env->i($key, $def); + } else { + return Env::i($this->envprefix . $key, $def); + } } public function v($key, $def = null) { - return Env::v($this->envprefix . $key, $def); + if ($this->fake_env) { + return $this->fake_env->v($key, $def); + } else { + return Env::v($this->envprefix . $key, $def); + } } public function b($key, $def = false) { - return Env::b($this->envprefix . $key, $def); + if ($this->fake_env) { + return $this->fake_env->b($key, $def); + } else { + return Env::b($this->envprefix . $key, $def); + } } public function has($key) { - return Env::has($this->envprefix . $key); + if ($this->fake_env) { + return $this->fake_env->has($key); + } else { + return Env::has($this->envprefix . $key); + } } public function blank($key, $strict = false) { - return Env::blank($key, $strict); + if ($this->fake_env) { + return $this->fake_env->blank($key, $strict); + } else { + return Env::blank($key, $strict); + } } public function hasAlnum($key) @@ -241,6 +396,28 @@ class UFB_MentorSearch extends UserFilterBuilder } // }}} +// {{{ class UFB_NewsLetter +class UFB_NewsLetter extends UserFilterBuilder +{ + const FIELDS_PROMO = 'promo'; + const FIELDS_AXID = 'axid'; + const FIELDS_GEO = 'geo'; + + public function __construct($flags, $envprefix = '') + { + $fields = array(); + if ($flags->hasFlag(self::FIELDS_PROMO)) { + $fields[] = new UFBF_Promo('promo1', 'Promotion', 'egal1'); + $fields[] = new UFBF_Promo('promo2', 'Promotion', 'egal2'); + } + if ($flags->hasFlag(self::FIELDS_AXID)) { + $fields[] = new UFBF_SchoolIds('axid', 'Matricule AX', UFC_SchoolId::AX); + } + parent::__construct($fields, $envprefix); + } +} +// }}} + // {{{ class UFB_Field abstract class UFB_Field { @@ -275,7 +452,7 @@ abstract class UFB_Field return false; } - public function apply(UserFilterBuilder &$ufb) { + public function apply(UserFilterBuilder $ufb) { if (!$this->check($ufb)) { return false; } @@ -296,15 +473,26 @@ abstract class UFB_Field /** Create the UFC associated to the field; won't be called * if the field is "empty" - * @param &$ufb UFB to which fields must be added + * @param $ufb UFB to which fields must be added * @return UFC */ - abstract protected function buildUFC(UserFilterBuilder &$ufb); + abstract protected function buildUFC(UserFilterBuilder $ufb); /** This function is intended to run consistency checks on the value * @return boolean Whether the input is valid */ - abstract protected function check(UserFilterBuilder &$ufb); + abstract protected function check(UserFilterBuilder $ufb); + + // Simple form interface + + /** Retrieve a list of env field names used by that field + * their values will be recorded when saving the 'search' and used to prefill the form + * when needed. + */ + public function getEnvFieldNames() + { + return array($this->envfield); + } } // }}} @@ -321,7 +509,7 @@ abstract class UFBF_Text extends UFB_Field $this->maxlength = $maxlength; } - protected function check(UserFilterBuilder &$ufb) + protected function check(UserFilterBuilder $ufb) { if ($ufb->blank($this->envfield)) { $this->empty = true; @@ -358,7 +546,7 @@ abstract class UFBF_Range extends UFB_Field $this->max = $max; } - protected function check(UserFilterBuilder &$ufb) + protected function check(UserFilterBuilder $ufb) { if ($ufb->blank($this->envfield)) { $this->empty = true; @@ -381,7 +569,7 @@ abstract class UFBF_Range extends UFB_Field */ abstract class UFBF_Index extends UFB_Field { - protected function check(UserFilterBuilder &$ufb) + protected function check(UserFilterBuilder $ufb) { if ($ufb->blank($this->envfield)) { $this->empty = true; @@ -406,7 +594,7 @@ abstract class UFBF_Enum extends UFB_Field $this->strict = $strict; } - protected function check(UserFilterBuilder &$ufb) + protected function check(UserFilterBuilder $ufb) { if ($ufb->blank($this->envfield)) { $this->empty = true; @@ -429,7 +617,7 @@ abstract class UFBF_Enum extends UFB_Field // {{{ class UFBF_Bool abstract class UFBF_Bool extends UFB_Field { - protected function check(UserFilterBuilder &$ufb) + protected function check(UserFilterBuilder $ufb) { if ($ufb->blank($this->envfield)) { $this->empty = true; @@ -459,7 +647,7 @@ abstract class UFBF_Mixed extends UFB_Field $this->envfieldindex = $envfieldindex; } - protected function check(UserFilterBuilder &$ufb) + protected function check(UserFilterBuilder $ufb) { if ($ufb->blank($this->envfieldindex) && !$ufb->hasAlnum($this->envfield)) { $this->empty = true; @@ -484,13 +672,18 @@ abstract class UFBF_Mixed extends UFB_Field } return true; } + + public function getEnvFieldNames() + { + return array($this->envfieldindex, $this->envfield); + } } // }}} // {{{ class UFBF_Quick class UFBF_Quick extends UFB_Field { - protected function check(UserFilterBuilder &$ufb) + protected function check(UserFilterBuilder $ufb) { if ($ufb->blank($this->envfield)) { $this->empty = true; @@ -502,7 +695,7 @@ class UFBF_Quick extends UFB_Field return true; } - protected function buildUFC(UserFilterBuilder &$ufb) + protected function buildUFC(UserFilterBuilder $ufb) { $r = $s = $this->val; @@ -527,7 +720,7 @@ class UFBF_Quick extends UFB_Field } if (count($strings)) { - if (S::logged()) { + if (S::user()->checkPerms('directory_private')) { $flags = array(); } else { $flags = array('public'); @@ -580,14 +773,20 @@ class UFBF_SchoolIds extends UFB_Field { // One of UFC_SchoolId types protected $type; + protected $reversed_envfield; + protected $reversed = false; - public function __construct($envfield, $formtext, $type = UFC_SchoolId::AX) + public function __construct($envfield, $formtext, $type = UFC_SchoolId::AX, $reversed_envfield = '') { parent::__construct($envfield, $formtext); $this->type = $type; + if ($reversed_envfield == '') { + $reversed_envfield = $envfield . '_reversed'; + } + $this->reversed_envfield = $reversed_envfield; } - protected function check(UserFilterBuilder &$ufb) + protected function check(UserFilterBuilder $ufb) { if ($ufb->blank($this->envfield)) { $this->empty = true; @@ -595,7 +794,7 @@ class UFBF_SchoolIds extends UFB_Field } $value = $ufb->t($this->envfield); - $values = explode("\n", $value); + $values = explode("\r\n", $value); $ids = array(); foreach ($values as $val) { if (preg_match('/^[0-9A-Z]{0,8}$/', $val)) { @@ -606,13 +805,19 @@ class UFBF_SchoolIds extends UFB_Field return $this->raise("Le champ %s ne contient aucune valeur valide."); } + $this->reversed = $ufb->b($this->reversed_envfield); $this->val = $ids; return true; } - protected function buildUFC(UserFilterBuilder &$ufb) + protected function buildUFC(UserFilterBuilder $ufb) { - return new UFC_SchoolId($this->type, $this->val); + $ufc = new UFC_SchoolId($this->type, $this->val); + if ($this->reversed) { + return new PFC_Not($ufc); + } else { + return $ufc; + } } } // }}} @@ -620,7 +825,7 @@ class UFBF_SchoolIds extends UFB_Field // {{{ class UFBF_Name class UFBF_Name extends UFBF_Text { - protected function check(UserFilterBuilder &$ufb) + protected function check(UserFilterBuilder $ufb) { if (!parent::check($ufb)) { return false; @@ -633,7 +838,7 @@ class UFBF_Name extends UFBF_Text return true; } - protected function buildUFC(UserFilterBuilder &$ufb) + protected function buildUFC(UserFilterBuilder $ufb) { return new UFC_NameTokens($this->val, array(), $ufb->b('with_soundex'), $ufb->b('exact')); } @@ -647,13 +852,13 @@ class UFBF_Promo extends UFB_Field private $comp; private $envfieldcomp; - public function __construct($envfield, $fromtext = '', $envfieldcomp) + public function __construct($envfield, $formtext = '', $envfieldcomp) { - parent::__construct($envfield, $fromtext); + parent::__construct($envfield, $formtext); $this->envfieldcomp = $envfieldcomp; } - protected function check(UserFilterBuilder &$ufb) + protected function check(UserFilterBuilder $ufb) { if ($ufb->blank($this->envfield) || $ufb->blank($this->envfieldcomp)) { $this->empty = true; @@ -676,9 +881,14 @@ class UFBF_Promo extends UFB_Field return true; } - protected function buildUFC(UserFilterBuilder &$ufb) { + protected function buildUFC(UserFilterBuilder $ufb) { return new UFC_Promo($this->comp, UserFilter::GRADE_ING, $this->val); } + + public function getEnvFieldNames() + { + return array($this->envfield, $this->envfieldcomp); + } } // }}} @@ -702,7 +912,7 @@ class UFBF_Sex extends UFBF_Enum } } - protected function buildUFC(UserFilterBuilder &$ufb) + protected function buildUFC(UserFilterBuilder $ufb) { return new UFC_Sex(self::getVal($this->val)); } @@ -713,7 +923,7 @@ class UFBF_Sex extends UFBF_Enum // Simple field for selecting only alive, not registered users (for quick search) class UFBF_NotRegistered extends UFBF_Bool { - protected function buildUFC(UserFilterBuilder &$ufb) + protected function buildUFC(UserFilterBuilder $ufb) { if ($this->val) { return new PFC_And( @@ -733,7 +943,7 @@ class UFBF_Registered extends UFBF_Enum parent::__construct($envfield, $formtext, array(1, 2)); } - protected function buildUFC(UserFilterBuilder &$ufb) + protected function buildUFC(UserFilterBuilder $ufb) { if ($this->val == 1) { return new UFC_Registered(); @@ -752,7 +962,7 @@ class UFBF_Dead extends UFBF_Enum parent::__construct($envfield, $formtext, array(1, 2)); } - protected function buildUFC(UserFilterBuilder &$ufb) + protected function buildUFC(UserFilterBuilder $ufb) { if ($this->val == 1) { return new PFC_Not(new UFC_Dead()); @@ -782,7 +992,7 @@ class UFBF_Town extends UFBF_Text parent::__construct($envfield, $formtext, 2, 30); } - protected function buildUFC(UserFilterBuilder &$ufb) + protected function buildUFC(UserFilterBuilder $ufb) { if ($ufb->isOn($this->onlycurrentfield)) { $flags = UFC_Address::FLAG_CURRENT; @@ -808,6 +1018,11 @@ class UFBF_Town extends UFBF_Text } } } + + public function getEnvFieldNames() + { + return array($this->envfield, $this->onlycurrentfield); + } } // }}} @@ -823,7 +1038,7 @@ class UFBF_Country extends UFBF_Mixed $this->onlycurrentfield = $onlycurrentfield; } - protected function buildUFC(UserFilterBuilder &$ufb) + protected function buildUFC(UserFilterBuilder $ufb) { if ($ufb->isOn($this->onlycurrentfield)) { $flags = UFC_Address::FLAG_CURRENT; @@ -833,6 +1048,11 @@ class UFBF_Country extends UFBF_Mixed return new UFC_AddressField($this->val, UFC_AddressField::FIELD_COUNTRY, UFC_Address::TYPE_ANY, $flags); } + + public function getEnvFieldNames() + { + return array($this->envfield, $this->envfieldindex, $this->onlycurrentfield); + } } // }}} @@ -849,7 +1069,7 @@ class UFBF_AdminArea extends UFBF_Index } - protected function buildUFC(UserFilterBuilder &$ufb) + protected function buildUFC(UserFilterBuilder $ufb) { if ($ufb->isOn($this->onlycurrentfield)) { $flags = UFC_Address::FLAG_CURRENT; @@ -859,6 +1079,11 @@ class UFBF_AdminArea extends UFBF_Index return new UFC_AddressField($this->val, UFC_AddressField::FIELD_ADMAREA, UFC_Address::TYPE_ANY, $flags); } + + public function getEnvFieldNames() + { + return array($this->envfield, $this->onlycurrentfield); + } } // }}} @@ -875,7 +1100,7 @@ class UFBF_SubAdminArea extends UFBF_Index } - protected function buildUFC(UserFilterBuilder &$ufb) + protected function buildUFC(UserFilterBuilder $ufb) { if ($ufb->isOn($this->onlycurrentfield)) { $flags = UFC_Address::FLAG_CURRENT; @@ -885,6 +1110,11 @@ class UFBF_SubAdminArea extends UFBF_Index return new UFC_AddressField($this->val, UFC_AddressField::FIELD_SUBADMAREA, UFC_Address::TYPE_ANY, $flags); } + + public function getEnvFieldNames() + { + return array($this->envfield, $this->onlycurrentfield); + } } // }}} @@ -899,7 +1129,7 @@ class UFBF_JobCompany extends UFBF_Text $this->onlymentorfield = $onlymentorfield; } - public function check(UserFilterBuilder &$ufb) { + public function check(UserFilterBuilder $ufb) { if (parent::check($ufb)) { # No company check for mentors if ($ufb->isOn($this->onlymentorfield)) { @@ -911,17 +1141,22 @@ class UFBF_JobCompany extends UFBF_Text } } - protected function buildUFC(UserFilterBuilder &$ufb) + protected function buildUFC(UserFilterBuilder $ufb) { return new UFC_Job_Company(UFC_Job_Company::JOBNAME, $this->val); } + + public function getEnvFieldNames() + { + return array($this->envfield, $this->onlymentorfield); + } } // }}} // {{{ class UFBF_JobTerms class UFBF_JobTerms extends UFBF_Index { - protected function buildUFC(UserFilterBuilder &$ufb) + protected function buildUFC(UserFilterBuilder $ufb) { return new UFC_Job_Terms($this->val); } @@ -939,7 +1174,7 @@ class UFBF_JobDescription extends UFBF_Text $this->onlymentorfield = $onlymentorfield; } - protected function buildUFC(UserFilterBuilder &$ufb) + protected function buildUFC(UserFilterBuilder $ufb) { if ($ufb->isOn($this->onlymentorfield)) { return new UFC_Mentor_Expertise($this->val); @@ -947,6 +1182,11 @@ class UFBF_JobDescription extends UFBF_Text return new UFC_Job_Description($this->val, UserFilter::JOB_USERDEFINED); } } + + public function getEnvFieldNames() + { + return array($this->envfield, $this->onlymentorfield); + } } // }}} @@ -961,7 +1201,7 @@ class UFBF_JobCv extends UFBF_Text $this->onlymentorfield = $onlymentorfield; } - protected function buildUFC(UserFilterBuilder &$ufb) + protected function buildUFC(UserFilterBuilder $ufb) { if ($ufb->isOn($this->onlymentorfield)) { return new UFC_Mentor_Expertise($this->val); @@ -969,6 +1209,11 @@ class UFBF_JobCv extends UFBF_Text return new UFC_Job_Description($this->val, UserFilter::JOB_CV); } } + + public function getEnvFieldNames() + { + return array($this->envfield, $this->onlymentorfield); + } } // }}} @@ -977,7 +1222,7 @@ class UFBF_Nationality extends UFBF_Mixed { protected $direnum = DirEnum::NATIONALITIES; - protected function buildUFC(UserFilterBuilder &$ufb) + protected function buildUFC(UserFilterBuilder $ufb) { return new UFC_Nationality($this->val); } @@ -989,7 +1234,7 @@ class UFBF_Binet extends UFBF_Mixed { protected $direnum = DirEnum::BINETS; - protected function buildUFC(UserFilterBuilder &$ufb) + protected function buildUFC(UserFilterBuilder $ufb) { return new UFC_Binet($this->val); } @@ -1001,7 +1246,7 @@ class UFBF_Group extends UFBF_Mixed { protected $direnum = DirEnum::GROUPESX; - protected function buildUFC(UserFilterBuilder &$ufb) + protected function buildUFC(UserFilterBuilder $ufb) { if (count($this->val) == 1) { return new UFC_Group($this->val[0]); @@ -1021,7 +1266,7 @@ class UFBF_Section extends UFBF_Mixed { protected $direnum = DirEnum::SECTIONS; - protected function buildUFC(UserFilterBuilder &$ufb) + protected function buildUFC(UserFilterBuilder $ufb) { return new UFC_Section($this->val); } @@ -1033,7 +1278,7 @@ class UFBF_EducationSchool extends UFBF_Mixed { protected $direnum = DirEnum::EDUSCHOOLS; - protected function buildUFC(UserFilterBuilder &$ufb) + protected function buildUFC(UserFilterBuilder $ufb) { return new UFC_EducationSchool($this->val); } @@ -1045,7 +1290,7 @@ class UFBF_EducationDegree extends UFBF_Mixed { protected $direnum = DirEnum::EDUDEGREES; - protected function buildUFC(UserFilterBuilder &$ufb) + protected function buildUFC(UserFilterBuilder $ufb) { return new UFC_EducationDegree($this->val); } @@ -1057,7 +1302,7 @@ class UFBF_EducationField extends UFBF_Mixed { protected $direnum = DirEnum::EDUFIELDS; - protected function buildUFC(UserFilterBuilder &$ufb) + protected function buildUFC(UserFilterBuilder $ufb) { return new UFC_EducationField($this->val); } @@ -1067,7 +1312,7 @@ class UFBF_EducationField extends UFBF_Mixed // {{{ class UFBF_Comment class UFBF_Comment extends UFBF_Text { - protected function buildUFC(UserFilterBuilder &$ufb) + protected function buildUFC(UserFilterBuilder $ufb) { return new UFC_Comment($this->val); } @@ -1077,7 +1322,7 @@ class UFBF_Comment extends UFBF_Text // {{{ class UFBF_Phone class UFBF_Phone extends UFBF_Text { - protected function buildUFC(UserFilterBuilder &$ufb) + protected function buildUFC(UserFilterBuilder $ufb) { return new UFC_Phone($this->val); } @@ -1096,7 +1341,7 @@ class UFBF_Networking extends UFBF_Text $this->networktypefield = $networktypefield; } - public function check(UserFilterBuilder &$ufb) + public function check(UserFilterBuilder $ufb) { if (parent::check($ufb)) { $this->nwtype = $ufb->i($this->networktypefield); @@ -1111,17 +1356,22 @@ class UFBF_Networking extends UFBF_Text return parent::isEmpty() || $this->nwtype == 0; } - public function buildUFC(UserFilterBuilder &$ufb) + public function buildUFC(UserFilterBuilder $ufb) { return new UFC_Networking($this->nwtype, $this->val); } + + public function getEnvFieldNames() + { + return array($this->envfield, $this->networktypefield); + } } // }}} // {{{ class UFBF_Mentor class UFBF_Mentor extends UFBF_Bool { - protected function buildUFC(UserFilterBuilder &$ufb) + protected function buildUFC(UserFilterBuilder $ufb) { return new UFC_Mentor(); } @@ -1131,7 +1381,7 @@ class UFBF_Mentor extends UFBF_Bool // {{{ class UFBF_MentorCountry class UFBF_MentorCountry extends UFBF_Text { - protected function buildUFC(UserFilterBuilder &$ufb) + protected function buildUFC(UserFilterBuilder $ufb) { return new UFC_Mentor_Country($this->val); } @@ -1141,7 +1391,7 @@ class UFBF_MentorCountry extends UFBF_Text // {{{ class UFBF_Mentorterm class UFBF_MentorTerm extends UFBF_Index { - protected function buildUFC(UserFilterBuilder &$ufb) + protected function buildUFC(UserFilterBuilder $ufb) { return new UFC_Mentor_Terms($this->val); } @@ -1151,7 +1401,7 @@ class UFBF_MentorTerm extends UFBF_Index // {{{ class UFBF_MentorExpertise class UFBF_MentorExpertise extends UFBF_Text { - protected function buildUFC(UserFilterBuilder &$ufb) + protected function buildUFC(UserFilterBuilder $ufb) { return new UFC_Mentor_Expertise($this->val); }