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 $columns_form; /// 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->filters = array();
$this->action = $action;
}
/**
Adds a new filter to list
@param filter dcFilter the filter to add
*/
public function addFilter (Filter $filter) {
$filter->setFormPrefix($this->form_prefix);
$this->filters[$filter->id] = $filter;
return $this;
}
/**
Saves user filters to preferences
*/
protected function saveFilters() {
$ser = array();
$ws = $GLOBALS['core']->auth->user_prefs->addWorkspace('filters');
foreach($this->filters as $filter) {
$ser[$filter->id]=$filter->serialize();
}
$ws->put($this->name,serialize($ser),'string');
}
/**
Loads user filters from preferences
*/
protected function loadFilters() {
$ws = $GLOBALS['core']->auth->user_prefs->addWorkspace('filters');
$settings = !is_null($ws->{$this->name}) ? unserialize($ws->{$this->name}) : array();
foreach($settings as $k => $v) {
$this->filters[$k]->unserialize($v);
}
}
/**
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)
*/
public function setFormValues ($form_data) {
$this->hideform = true;
if (isset($form_data['clear_filters'])) {
$this->saveFilters();
return;
}
if (!isset($form_data['apply'])) {
$this->loadFilters();
}
foreach ($this->filters as $filter) {
$filter->setFormValues ($form_data);
if ($filter->isEnabled()) {
$this->hideform=false;
}
}
if (isset($form_data['apply'])) {
if (trim($form_data['apply']) == '+'
&& isset($form_data['add_filter'])
&& isset($this->filters[$form_data['add_filter']])) {
$this->filters[$form_data['add_filter']]->add();
$this->hideform=false;
}
}
$this->saveFilters();
}
/**
Defines additional form in layout (right column)
@param html string the code to add
*/
public function setColumnsForm($html)
{
$this->columns_form = $html;
}
/**
Returns form fields as hidden fields
@return string the corresponding html code
*/
public function getFormFieldsAsHidden() {
$ret='';
foreach ($this->filters as $filter) {
$ret.= $filter->getFormFieldAsHidden();
}
return $ret;
}
/**
Retrieves filterset generated form
@param method string form method to use (default: "get")
*/
public function getForm($method="get") {
$ret = '';
if ($this->hideform) {
$formclass = ' class="hidden"';
} else {
$formclass='';
}
$ret .= '
';
return $ret;
}
/**
Displays required fieldset http header
To be called in page header, of course.
*/
public function header() {
return dcPage::jsLoad('js/filters.js');
}
/**
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) {
$filtered = false;
foreach ($this->filters as $filter) {
if ($filter->isEnabled()) {
$filter->applyFilter($params);
$filtered = true;
}
}
return $filtered;
}
}
/**
@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 $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;
}
/**
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;
}
/**
Defines form prefix for filter
@param prefix string the form prefix
*/
public function setFormPrefix($prefix) {
$this->field_id = $prefix.$this->id;
}
/**
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
*/
public function getFormFields($pos=0) {
return '';
}
/**
Returns filter values il a serialized way (array)
@return array serialized data
*/
public function serialize() {
return array(
'values' => $this->values,
'enabled' => $this->enabled
);
}
/**
Defines filter values from serialized data (array)
To be used in conjunction with serialize method
@param $data array serialized data to retrieve
*/
public function unserialize ($data) {
$this->values = $data['values'];
$this->enabled = $data['enabled'];
}
/**
Set filter values from form_data (usually $_GET)
@param $form_data array form data
*/
public function setFormValues($form_data) {
$count=0;
while (isset($form_data[$this->getFieldId($count)])) {
if (!isset($form_data['del_'.$this->getFieldId($count)])) {
$this->values[$count] = $form_data[$this->getFieldId($count)];
} elseif (isset($this->values[$count])) {
unset($this->values[$count]);
}
$count++;
}
$this->values = array_values($this->values);
$this->enabled = (count($this->values)!=0);
}
/**
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]);
}
}
/**
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 .= '
'.
$this->getFormFields($cur).
''.
'
';
}
return $ret;
}
/**
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;
}
}
/**
@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();
}
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 setFormValues($form_data) {
parent::setFormValues($form_data);
if (isset($form_data[$this->field_id."_v"])) {
$this->verb = ($form_data[$this->field_id."_v"] == 'is') ? 'is' : 'isnot';
}
}
public function getFormFieldAsHidden () {
return parent::getFormFieldAsHidden().form::hidden($this->field_id."_v",$this->verb);
}
public function getFormFields($pos=0) {
if ($pos == 0) {
$desc = $this->desc.' : ';
$labelclass="filter-title";
} else {
$desc = __('or');
$labelclass = 'or';
};
return ''.$desc.''.
(($pos == 0)
?form::combo($this->field_id.'_v',
array(__('is')=>'is',__('is not')=>'isnot'),$this->verb,'','',
false,'title="'.sprintf(__('%s is or is not'),$this->desc).'"')
:'').
form::combo($this->getFieldId($pos),$this->options,$this->values[$pos],
'','',false,'title="'.__('Choose an option').'"');
}
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;
}
}
/**
@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];
}
}
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 ''.$this->desc.''.
form::field($this->getFieldId($pos),$this->size,$this->max,html::escapeHTML($this->values[0]));
}
public function applyFilter($params) {
$params[$this->request_param]=$this->values[0];
}
public function setValues($value) {
parent::setValues(array($value));
}
public function getValue() {
$v = parent::getValue();
return $v[0];
}
}
?>
'.__('Toggle filters and display options').'