<?php
/***************************************************************************
- * Copyright (C) 2003-2010 Polytechnique.org *
+ * Copyright (C) 2003-2011 Polytechnique.org *
* http://opensource.polytechnique.org/ *
* *
* This program is free software; you can redistribute it and/or modify *
* 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA *
***************************************************************************/
+// {{{ class StoredUserFilterBuilder
+class StoredUserFilterBuilder
+{
+ // Possible stored types (currently only 'ufb' exists)
+ const TYPE_UFB = 'ufb';
+
+ protected $ufb;
+ protected $env;
+ protected $ufc;
+
+ public function __construct(UserFilterBuilder $ufb, PlFilterCondition $ufc = null, array $env = array())
+ {
+ $this->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
{
private $valid = true;
private $ufc = null;
private $orders = array();
+ private $fake_env = null;
/** Constructor
* @param $fields An array of UFB_Field objects
$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()
$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;
}
{
$this->buildUFC();
if ($this->valid) {
- return $this->ufc;
+ if ($this->isEmpty()) {
+ return new PFC_True();
+ } else {
+ return $this->ufc;
+ }
} else {
return new PFC_False();
}
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)
}
// }}}
+// {{{ 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
{
return false;
}
- public function apply(UserFilterBuilder &$ufb) {
+ public function apply(UserFilterBuilder $ufb) {
if (!$this->check($ufb)) {
return false;
}
/** 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);
+ }
}
// }}}
$this->maxlength = $maxlength;
}
- protected function check(UserFilterBuilder &$ufb)
+ protected function check(UserFilterBuilder $ufb)
{
if ($ufb->blank($this->envfield)) {
$this->empty = true;
$this->max = $max;
}
- protected function check(UserFilterBuilder &$ufb)
+ protected function check(UserFilterBuilder $ufb)
{
if ($ufb->blank($this->envfield)) {
$this->empty = true;
*/
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;
$this->strict = $strict;
}
- protected function check(UserFilterBuilder &$ufb)
+ protected function check(UserFilterBuilder $ufb)
{
if ($ufb->blank($this->envfield)) {
$this->empty = true;
// {{{ 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;
$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;
}
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;
return true;
}
- protected function buildUFC(UserFilterBuilder &$ufb)
+ protected function buildUFC(UserFilterBuilder $ufb)
{
$r = $s = $this->val;
}
if (count($strings)) {
- if (S::logged()) {
+ if (S::user()->checkPerms('directory_private')) {
$flags = array();
} else {
$flags = array('public');
{
// 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;
}
$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)) {
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;
+ }
}
}
// }}}
// {{{ 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;
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'));
}
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;
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);
+ }
}
// }}}
}
}
- protected function buildUFC(UserFilterBuilder &$ufb)
+ protected function buildUFC(UserFilterBuilder $ufb)
{
return new UFC_Sex(self::getVal($this->val));
}
// 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(
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();
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());
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;
}
}
}
+
+ public function getEnvFieldNames()
+ {
+ return array($this->envfield, $this->onlycurrentfield);
+ }
}
// }}}
$this->onlycurrentfield = $onlycurrentfield;
}
- protected function buildUFC(UserFilterBuilder &$ufb)
+ protected function buildUFC(UserFilterBuilder $ufb)
{
if ($ufb->isOn($this->onlycurrentfield)) {
$flags = UFC_Address::FLAG_CURRENT;
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);
+ }
}
// }}}
}
- protected function buildUFC(UserFilterBuilder &$ufb)
+ protected function buildUFC(UserFilterBuilder $ufb)
{
if ($ufb->isOn($this->onlycurrentfield)) {
$flags = UFC_Address::FLAG_CURRENT;
return new UFC_AddressField($this->val, UFC_AddressField::FIELD_ADMAREA, UFC_Address::TYPE_ANY, $flags);
}
+
+ public function getEnvFieldNames()
+ {
+ return array($this->envfield, $this->onlycurrentfield);
+ }
}
// }}}
}
- protected function buildUFC(UserFilterBuilder &$ufb)
+ protected function buildUFC(UserFilterBuilder $ufb)
{
if ($ufb->isOn($this->onlycurrentfield)) {
$flags = UFC_Address::FLAG_CURRENT;
return new UFC_AddressField($this->val, UFC_AddressField::FIELD_SUBADMAREA, UFC_Address::TYPE_ANY, $flags);
}
+
+ public function getEnvFieldNames()
+ {
+ return array($this->envfield, $this->onlycurrentfield);
+ }
}
// }}}
$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)) {
}
}
- 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);
}
$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);
return new UFC_Job_Description($this->val, UserFilter::JOB_USERDEFINED);
}
}
+
+ public function getEnvFieldNames()
+ {
+ return array($this->envfield, $this->onlymentorfield);
+ }
}
// }}}
$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);
return new UFC_Job_Description($this->val, UserFilter::JOB_CV);
}
}
+
+ public function getEnvFieldNames()
+ {
+ return array($this->envfield, $this->onlymentorfield);
+ }
}
// }}}
{
protected $direnum = DirEnum::NATIONALITIES;
- protected function buildUFC(UserFilterBuilder &$ufb)
+ protected function buildUFC(UserFilterBuilder $ufb)
{
return new UFC_Nationality($this->val);
}
{
protected $direnum = DirEnum::BINETS;
- protected function buildUFC(UserFilterBuilder &$ufb)
+ protected function buildUFC(UserFilterBuilder $ufb)
{
return new UFC_Binet($this->val);
}
{
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]);
{
protected $direnum = DirEnum::SECTIONS;
- protected function buildUFC(UserFilterBuilder &$ufb)
+ protected function buildUFC(UserFilterBuilder $ufb)
{
return new UFC_Section($this->val);
}
{
protected $direnum = DirEnum::EDUSCHOOLS;
- protected function buildUFC(UserFilterBuilder &$ufb)
+ protected function buildUFC(UserFilterBuilder $ufb)
{
return new UFC_EducationSchool($this->val);
}
{
protected $direnum = DirEnum::EDUDEGREES;
- protected function buildUFC(UserFilterBuilder &$ufb)
+ protected function buildUFC(UserFilterBuilder $ufb)
{
return new UFC_EducationDegree($this->val);
}
{
protected $direnum = DirEnum::EDUFIELDS;
- protected function buildUFC(UserFilterBuilder &$ufb)
+ protected function buildUFC(UserFilterBuilder $ufb)
{
return new UFC_EducationField($this->val);
}
// {{{ 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);
}
// {{{ 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);
}
$this->networktypefield = $networktypefield;
}
- public function check(UserFilterBuilder &$ufb)
+ public function check(UserFilterBuilder $ufb)
{
if (parent::check($ufb)) {
$this->nwtype = $ufb->i($this->networktypefield);
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();
}
// {{{ 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);
}
// {{{ 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);
}
// {{{ 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);
}
projects / platal.git / blobdiff