array lists of defined filters
protected $efilters; /// array lists of defined filters
protected $form_prefix; /// string displayed form prefix
protected $action; /// string form action page
protected $hideform; /// boolean start form display hidden by default or not
protected $extra_data; /// string columns form
protected $name; /// string fieldset name
/**
Inits dcFilterSet object
@param core dcCore Dotclear core reference
@param form_prefix string form prefix to use for parameters
*/
public function __construct($name,$action,$form_prefix="f_") {
$this->name = $name;
$this->form_prefix=$form_prefix;
$this->lfilters = new ArrayObject();
$this->efilters = new ArrayObject();
$this->action = $action;
$this->extra_data = '';
$this->filtered = false;
}
/**
Adds a new filter to list
@param filter dcFilter the filter to add
*/
public function addFilter (Filter $filter) {
$filter->setFormPrefix($this->form_prefix);
$filter->setFilterSet($this);
$this->efilters[$filter->id] = $filter;
$this->lfilters[$filter->id] = clone $filter;
return $this;
}
/**
Saves user filters to preferences
*/
protected function saveFilters() {
$ser = array();
$ws = $GLOBALS['core']->auth->user_prefs->addWorkspace('filters');
$data = array();
$data= $this->getFiltersAsParams($this->efilters);
$ws->put($this->name,serialize($data->getArrayCopy()),'string');
return $data;
}
/**
Loads user filters from preferences
*/
protected function loadFilters() {
$ws = $GLOBALS['core']->auth->user_prefs->addWorkspace('filters');
$data = (!is_null($ws->{$this->name})) ? unserialize($ws->{$this->name}) : array();
if (is_array($data))
return $data;
else
return array();
}
/**
Updates filters values according to form_data
To be called before any call to display() or getForm()
@param form_data array form values (usually $_GET or $_POST)
*/
protected function initializeFromData ($filters, $form_data) {
$this->hideform = true;
foreach ($filters as $filter) {
$filter->initializeFromData ($form_data);
}
}
/**
Defines additional form in layout (right column)
@param html string the code to add
*/
public function setExtraData($html)
{
$this->extra_data = $html;
}
/**
Returns form fields as hidden fields
@return string the corresponding html code
*/
public function getFormFieldsAsHidden() {
$ret='';
foreach ($this->lfilters as $filter) {
$ret.= $filter->getFormFieldAsHidden();
}
return $ret;
}
/**
Sets up filterset from $get and $post parameters
*/
public function setup($get,$post) {
/* Use cases :
(1) $post not empty for formfilter fields :
* efilters are set from $post
* lfilters are set from $get
* keep filters div shown
(2) $post empty :
* both efilters and lfilters are set from $get
* hide filter div
*/
$action = false;
$allowed_actions = array('clear_filters','add','del_','apply','reset');
// Fetch each $post parameter to see whether filters are concerned.
// Only 1 action at a time is allowed.
foreach ($post as $k => $v) {
if (strpos($k,$this->form_prefix)===0) {
$tmp = substr($k,strlen($this->form_prefix));
foreach ($allowed_actions as $a) {
if (strpos($tmp,$a)===0) {
$action = $tmp;
break;
}
}
}
}
if ($action !== false) {
// Use case (1)
if ($action != 'clear_filters' && $action != 'reset') {
$this->initializeFromData($this->efilters,$post);
if ($action == 'add'){
if (isset($post['add_filter'])
&& isset($this->efilters[$post['add_filter']])) {
$this->efilters[$post['add_filter']]->add();
}
} elseif (strpos($action,'del_') === 0) {
$count = preg_match('#del_(.+)_([0-9]+)#',$action,$match);
if (($count == 1) && isset($this->efilters[$match[1]])) {
$this->efilters[$match[1]]->remove($match[2]);
}
} elseif ($action=="apply") {
$data = $this->saveFilters();
http::redirect($this->action.'?'.http_build_query($data,'','&'));
exit;
}
}
if (isset($post[$this->form_prefix."query"])) {
parse_str($post[$this->form_prefix."query"],$out);
$this->initializeFromData($this->lfilters,$out);
if ($action == 'reset') {
$this->initializeFromData($this->efilters,$out);
}
}
$this->hideform=false;
} else {
// Use case (2)
if (count($get)==0) {
$get = $this->loadFilters();
}
$this->initializeFromData($this->efilters, $get);
$this->initializeFromData($this->lfilters, $get);
}
}
/**
Retrieves filterset generated form
@param method string form method to use (default: "get")
*/
public function getForm() {
$ret = '';
if ($this->hideform) {
$formclass = ' class="hidden"';
} else {
$formclass='';
}
$ret .= '
';
return $ret;
}
/**
Retrieves the filters values as parameters
@param filters array list of concerned filters
@return array the array of parameters
*/
protected function getFiltersAsParams($filters) {
$arr = new ArrayObject();
foreach ($filters as $f) {
if ($f->isEnabled())
$f->fillQS($arr);
}
return $arr;
}
public function getFiltersText() {
$ret = '
'.__('Currently applied filters :').'
';
foreach ($this->lfilters as $f) {
if ($f->isEnabled())
$ret .= '
'.$f->getAsText().'
'."\n";
}
$ret .= '
';
return $ret;
}
/**
Displays required fieldset http header
To be called in page header, of course.
*/
public function header() {
$ret = dcPage::jsLoad('js/filters.js');
foreach($this->efilters as $f) {
$ret .= $f->header();
}
return $ret;
}
/**
Displays the fieldset
*/
public function display() {
echo $this->getForm();
}
/**
Applies fieldset and return resulting parameters for request
@param method string form method to use (default: "get")
@param method string form method to use (default: "get")
*/
public function applyFilters($params) {
foreach ($this->lfilters as $filter) {
if ($filter->isEnabled()) {
$filter->applyFilter($params);
$this->filtered = true;
}
}
return $this->filtered;
}
public function getDelName($field_id,$pos) {
return $this->form_prefix.'del_'.$field_id.'_'.$pos;
}
}
/**
@ingroup DC_CORE
@nosubgrouping
@brief abstract filter class.
Dotclear Filter handles administration filters for each list
A filter fills in a parameter array, as defined in dcBlog class
*/
abstract class Filter {
public $filterset; ///string filterset parent
public $id; ///string field id (local to fieldset)
public $name; ///string filter name
public $desc; ///string field description
protected $request_param; ///string resulting parameter array key
protected $enabled; ///string true if filter is enabled
protected $values; ///array possible filter values
public $field_id; ///string field id (global to the page)
/**
Inits Filter object
@param id string field id
@param form_prefix string form prefix to use for parameters
*/
public function __construct ($id,$name,$desc,$request_param) {
$this->id = $id;
$this->name=$name;
$this->desc = $desc;
$this->request_param = $request_param;
$this->enabled=false;
$this->values = array();
$this->field_id = $this->id;
}
/**
Defines the filterset containing this filter
@param prefix dcFilterset the filterset
*/
public function setFilterSet($fs) {
$this->filterset = $fs;
}
/**
Defines form prefix for filter
@param prefix string the form prefix
*/
public function setFormPrefix($prefix) {
$this->field_id = $prefix.$this->id;
}
/**
Get a field id
@param pos integer position of field, in case of multiple field (0 if only 1 field set, default value)
@return string The field ID
*/
protected function getFieldId($pos=0) {
if ($pos == 0) {
return $this->field_id;
} else {
return $this->field_id.'_'.$pos;
}
}
/**
Tells whether the filter is enabled or not
@return boolean true if enabled, false otherwise
*/
public function isEnabled() {
return $this->enabled;
}
/**
Adds the current filter to the list
*/
public function add() {
// By default here, only 1 value allowed. Simply enable the filter
$this->enabled = true;
}
/**
Removes a value from filter
*/
public function remove($pos) {
if (isset($this->values[$pos])) {
array_splice($this->values,$pos,1);
$this->enabled = (count($this->values)!=0);
}
}
/**
Returns HTML code for form field
@param pos integer position of the field to display
(in case of multiple values)
@return string the html code
*/
abstract protected function getFormFields($pos=0);
/**
Extract values from data (data being an array, such as $_GET or $_POST)
@param $data array data to parse
@return array field values
*/
protected function getValuesFromData($data) {
$count=0;
$arr = array();
while (isset($data[$this->getFieldId($count)])) {
$arr[$count] = $data[$this->getFieldId($count)];
$count++;
}
return $arr;
}
public function initializeFromData($form_data) {
$this->values = $this->getValuesFromData($form_data);
$this->enabled = (count($this->values)!=0);
}
/**
Returns HTML code for the hole filter lines
@return string the html code
*/
public function getFormLine() {
$ret='';
for ($cur=0; $cur < count($this->values); $cur++) {
$ret .= '
';
}
return $ret;
}
public function fillQS($arr) {
for ($cur=0; $cur < count($this->values); $cur++) {
$arr[$this->getFieldId($cur)]=$this->values[$cur];
}
}
/**
Returns form fields as hidden fields
@return string the corresponding html code
*/
public function getFormFieldAsHidden () {
$ret='';
for ($cur=0; $cur < count($this->values); $cur++) {
$ret .= form::hidden($this->getFieldId($cur), $this->values[$cur]);
}
}
/**
Convert filter values into a $param filter, used for the upcoming SQL request
@param ArrayObject the parameters array to enrich
*/
public function applyFilter($params) {
}
public function setValues($value) {
$this->values = $value;
}
public function getValue() {
return $this->values;
}
public function header() {
return '';
}
public abstract function getAsText();
}
/**
@ingroup DC_CORE
@nosubgrouping
@brief abstract filter class.
Handle combo filter on admin side. Can be single or multi-valued
*/
class comboFilter extends Filter {
protected $options;
protected $default;
protected $no_value;
protected $verb;
protected $extra;
public function __construct($id,$name,$desc,$request_param,$options,$extra=array()) {
parent::__construct($id,$name,$desc,$request_param);
$this->options = $options;
$this->extra = $extra;
$this->verb = "is";
$this->values=array();
}
protected function getValuesFromData($data) {
$val = parent::getValuesFromData($data);
if (isset($data[$this->field_id.'_v'])) {
$verb = $data[$this->field_id.'_v'];
} else {
$verb = "is";
}
$arr = array(
'values' => $val,
'verb' => $verb
);
return $arr;
}
public function add() {
parent::add();
if (isset($this->extra['singleval']) && (count($this->values) > 0))
return;
$this->values[]=current($this->options);
}
public function getType() {
return "combo";
}
public function serialize() {
$data = parent::serialize();
$data['verb'] = $this->verb;
return $data;
}
public function unserialize ($data) {
parent::unserialize($data);
$this->verb = $data['verb'];
}
public function initializeFromData($form_data) {
$arr = $this->getValuesFromData($form_data);
$this->values = $arr['values'];
$this->verb = $arr['verb'];
$this->enabled = (count($this->values) != 0);
}
public function getFormFields($pos=0) {
if ($pos == 0) {
$ret = '
'.
''.$this->desc.' :
'.
'
'.
form::combo($this->field_id.'_v',
array(__('is')=>'is',__('is not')=>'isnot'),$this->verb,'','',
false,'title="'.sprintf(__('%s is or is not'),$this->desc).'"').
'
';
} else {
$ret = '
'.
__('or').' :
';
};
$ret .= '
'.form::combo($this->getFieldId($pos),$this->options,$this->values[$pos],
'','',false,'title="'.__('Choose an option').'"').'
';
return $ret;
}
public function getFormFieldAsHidden () {
return parent::getFormFieldAsHidden().form::hidden($this->field_id."_v",$this->verb);
}
public function fillQS($arr) {
parent::fillQS($arr);
$arr[$this->field_id.'_v']=$this->verb;
}
public function applyFilter($params) {
$attr = $this->request_param;
if ($this->verb != "is") {
$params[$attr."_not"] = true;
}
if (isset($this->extra['singleval']))
$params[$attr]=$this->values[0];
else
$params[$attr]=$this->values;
}
public function getValues() {
return array_merge($this->values,array($this->field_id.'_v',$this->verb));
}
public function getAsText() {
$arr=array();
foreach ($this->values as $value) {
$arr[]=array_search($value,$this->options);
}
return sprintf("%s %s %s",$this->desc,$this->verb,join(',',$arr));
}
}
class categoryFilter extends comboFilter {
public function getAsText() {
$arr=array();
foreach ($this->values as $value) {
$cat=array_search($value,$this->options);
$arr[]=preg_replace("#^.* ([^ ]+) .*$#",'$1',$cat);
}
return sprintf("%s %s %s",$this->desc,$this->verb,join(',',$arr));
}
}
/**
@ingroup DC_CORE
@nosubgrouping
@brief abstract filter class.
Handle boolean filter on admin side.
*/
class booleanFilter extends Filter {
protected $options;
public function __construct($id,$name,$desc,$request_param,$options) {
parent::__construct($id,$name,$desc,$request_param);
$this->options = $options;
$this->values=array();
}
public function getType() {
return "boolean";
}
public function add() {
parent::add();
$this->values=current($this->options);
}
public function getFormFields($pos=0) {
return '
'.$this->desc.'
'.
form::combo($this->getFieldId($pos),$this->options,$this->values[$pos],
'','',false,'title="'.__('Choose an option').'"').'
';
}
public function applyFilter($params) {
$params[$this->request_param]=$this->values[0];
}
public function getAsText() {
return sprintf("%s %s",$this->desc,$this->values[0]);
}
}
class textFilter extends Filter {
protected $size;
protected $max;
public function __construct($id,$name,$desc,$request_param,$size,$max) {
parent::__construct($id,$name,$desc,$request_param);
$this->size = $size;
$this->max = $max;
$this->values=array();
}
public function getType() {
return "text";
}
public function add() {
parent::add();
$this->values[]='';
}
public function getFormFields($pos=0) {
return '
';
}
public function applyFilter($params) {
$params[$this->request_param]=$this->values[0];
}
public function setValues($value) {
parent::setValues(array($value));
}
public function getAsText() {
return sprintf("%s %s",$this->desc,$this->values[0]);
}
}
?>
'.
''.
__('Toggle filters and display options').
'