Changeset 755:38c4f75f3dd5

Timestamp:

11/10/11 10:03:55 (14 years ago)

Author:

Dsls <dsls@…>

Branch:

formfilters

Message:

Intermediate commit for form filters, breaks columns for the moment.

More to come soon...

Files:

• admin/posts.php (modified) (2 diffs)
• inc/admin/class.dc.filter.php (modified) (24 diffs)

admin/posts.php

@@ -151 +151 @@
 $core->callBehavior('adminPostsFilters',$filterSet);
 
-$filterSet->setFormValues($_GET);
+$filterSet->setup($_GET,$_POST);
 
 # Get posts
@@ -171 +171 @@
 }
 
-$filterSet->setColumnsForm($post_list->getColumnsForm());
+$filterSet->setExtraData($post_list->getColumnsForm());
 
 /* DISPLAY

inc/admin/class.dc.filter.php

@@ -20 +20 @@
 class dcFilterSet {
 
-     protected $filters;           /// <b>array</b> lists of defined filters
+     protected $lfilters;               /// <b>array</b> lists of defined filters
+     protected $efilters;               /// <b>array</b> lists of defined filters
      protected $form_prefix;       /// <b>string</b> displayed form prefix
      protected $action;            /// <b>string</b> form action page
      protected $hideform;          /// <b>boolean</b> start form display hidden by default or not
-     protected $columns_form; /// <b>string</b> columns form
+     protected $extra_data;   /// <b>string</b> columns form
      protected $name;              /// <b>string</b> fieldset name
+     
      /**
      Inits dcFilterSet object
@@ -35 +37 @@
           $this->name = $name;
           $this->form_prefix=$form_prefix;
-          $this->filters = array();
+          $this->lfilters = new ArrayObject();
+          $this->efilters = new ArrayObject();
           $this->action = $action;
-     }
-
+          $this->extra_data = '';
+     }
+     
      /**
      Adds a new filter to list
@@ -46 +50 @@
      public function addFilter (Filter $filter) {
           $filter->setFormPrefix($this->form_prefix);
-          $this->filters[$filter->id] = $filter;
+          $filter->setFilterSet($this);
+          $this->efilters[$filter->id] = $filter;
+          $this->lfilters[$filter->id] = clone $filter;
           return $this;
      }
@@ -56 +62 @@
           $ser = array();
           $ws = $GLOBALS['core']->auth->user_prefs->addWorkspace('filters');
-          foreach($this->filters as $filter) {
+          foreach($this->lfilters as $filter) {
                $ser[$filter->id]=$filter->serialize();
           }
@@ -70 +76 @@
           $settings = !is_null($ws->{$this->name}) ? unserialize($ws->{$this->name}) : array();
           foreach($settings as $k => $v) {
-               $this->filters[$k]->unserialize($v);
+               $this->lfilters[$k]->unserialize($v);
           }
      }
@@ -80 +86 @@
      @param    form_data <b>array</b>   form values (usually $_GET or $_POST)
      */
-     public function setFormValues ($form_data) {
+     protected function initializeFromData ($filters, $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();
+          foreach ($filters as $filter) {
+               $filter->initializeFromData ($form_data);
+          }
      }
      
@@ -111 +98 @@
      @param    html <b>string</b>       the code to add
      */
-     public function setColumnsForm($html)
+     public function setExtraData($html)
      {
-          $this->columns_form = $html;
+          $this->extra_data = $html;
      }
      
@@ -123 +110 @@
      public function getFormFieldsAsHidden() {
           $ret='';
-          foreach ($this->filters as $filter) {
+          foreach ($this->lfilters as $filter) {
                $ret.= $filter->getFormFieldAsHidden();
           }
@@ -130 +117 @@
 
      /**
+     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']])) {
+                              echo 'addadd';
+                         $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") {
+                         http::redirect($this->action.'?'.http_build_query($this->getFiltersAsParams($this->efilters),'','&'));
+                         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 {
+               $this->initializeFromData($this->efilters, $get);
+               $this->initializeFromData($this->lfilters, $get);
+          }
+     }
+     /**
      Retrieves filterset generated form
      
      @param    method    <b>string</b>       form method to use (default: "get")
      */
-     public function getForm($method="get") {
+     public function getForm() {
           $ret = '';
           
@@ -142 +192 @@
                $formclass='';
           }
-          $ret .= '<p><img alt="" src="images/minus.png" /> <a href="#" id="toggle-filters">'.__('Toggle filters and display options').'</a></p>';
+          $ret .= '<p><img alt="" src="images/minus.png" /> '.
+               '<a href="#" id="toggle-filters">'.
+               __('Toggle filters and display options').
+               '</a></p>';
+          
           $ret .=
                '<div class="two-cols">'.
-               '<form id="filters" action="'.$this->action.'" method="'.$method.'"'.$formclass.'>'.
+               '<form id="filters" action="'.$this->action.'" method="post"'.$formclass.'>'.
                '<div class="col70">'.
-               '<h3>'.__('Entries filters').'</h3>';
-               
+               '<h3>'.__('Entries filters').'</h3>'.
+               '<table summary="'.__('Query filters').'" id="tfilters">'.
+               '<tbody>';
           $count=0;
           $form_combo=array();
           $form_combo['-']='';
-          if (count($this->filters)) {
-               $ret .= '<ul>';
-               foreach ($this->filters as $filter) {
+          if (count($this->efilters)) {
+               foreach ($this->efilters as $filter) {
                     if ($filter->isEnabled()) {
                          $ret .= $filter->getFormLine();
@@ -161 +215 @@
                     $count++;
                }
-               $ret .= '</ul>';
-          }
-          $ret .= 
-               '<p class="clear"><input class="delete" type="submit" value="'.__('Delete all filters').'" name="clear_filters" /></p>'.
+          }
+          $ret .= '</tbody></table>'.
+               '<p class="clear"><input class="delete" type="submit" value="'.__('Delete all filters').'" name="'.
+               $this->form_prefix.'clear_filters" />'.
+               '&nbsp;<input  type="submit" value="'.__('Reset').'" name="'.
+               $this->form_prefix.'reset" /></p>'.
                '<h3 class="margintop">'.__('Add a filter').'</h3>'.
                '<p id="available_filters">'.
                form::combo("add_filter",$form_combo).
-               '<input type="submit" value=" + " title="'.__('Add this filter').'" name="apply" />'.
+               '<input type="submit" value=" + " title="'.__('Add this filter').'" name="'.$this->form_prefix.'add" />'.
                '</p>'.
-               '</div>'.
-               '<div class="col30">'.
-               $this->columns_form.
-               '</div>'.
-               '<p class="clear margintop"><input type="submit" value="'.__('Apply filters and display options').'" name="apply" /></p>'.
-
-               '</form></div>';
+               '</div>';
+          if ($this->extra_data != '') {
+               $ret .=
+                    '<div class="col30">'.
+                    $this->extra_data.
+                    '</div>';
+          }
+          $ret .=
+               '<p class="clear margintop">'.
+               '<input type="submit" value="'.__('Apply filters and display options').
+               '" name="'.$this->form_prefix.'apply" /></p>'.
+               form::hidden($this->form_prefix."query",http_build_query($this->getFiltersAsParams($this->lfilters))).
+               $GLOBALS['core']->formNonce().
+               '</form>'.
+               '</div>';
+          return $ret;
+     }
+     /**
+     Retrieves the filters values as parameters
+     
+     @param    filters   <b>array</b>   list of concerned filters
+     
+     @return   <b>array</b>   the array of parameters
+
+     */
+
+     protected function getFiltersAsParams($filters) {
+          $arr = new ArrayObject();
+          foreach ($filters as $f) {
+               if ($f->isEnabled())
+                    $f->fillQS($arr);
+          }
+          return $arr;
+     }
+     
+     protected function displayFilters($filters) {
+          $ret = '<ul>';
+          foreach ($filters as $f) {
+               if ($f->isEnabled())
+               $ret .= '<li>'.$f->getAsText().'</li>'."\n";
+          }
+          $ret .= '</ul>';
           return $ret;
      }
@@ -205 +296 @@
      public function applyFilters($params) {
           $filtered = false;
-          foreach ($this->filters as $filter) {
+          foreach ($this->lfilters as $filter) {
                if ($filter->isEnabled()) {
                     $filter->applyFilter($params);
@@ -214 +305 @@
      }
      
+     public function getDelName($field_id,$pos) {
+          return $this->form_prefix.'del_'.$field_id.'_'.$pos;
+     }
 }
 
@@ -226 +320 @@
 */
 abstract class Filter {
+     public $filterset;            ///<b>string</b> filterset parent
      public $id;                        ///<b>string</b> field id (local to fieldset)
      public $name;                 ///<b>string</b> filter name
@@ -251 +346 @@
      
      /**
+     Defines the filterset containing this filter
+     
+     @param    prefix         <b>dcFilterset</b>  the filterset
+     */
+     public function setFilterSet($fs) {
+          $this->filterset = $fs;
+     }
+     
+     /**
+     Defines form prefix for filter
+     
+     @param    prefix         <b>string</b>  the form prefix
+     */
+     public function setFormPrefix($prefix) {
+          $this->field_id = $prefix.$this->id;
+     }
+     
+     /**
      Get a field id
      
@@ -282 +395 @@
      
      /**
-     Defines form prefix for filter
-     
-     @param    prefix         <b>string</b>  the form prefix
-     */
-     public function setFormPrefix($prefix) {
-          $this->field_id = $prefix.$this->id;
-     }
-     
+     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       <b>integer</b> position of the field to display (in case of multiple values)
+     @param    pos       <b>integer</b> position of the field to display 
+                                             (in case of multiple values)
      @return <b>string</b> the html code
      */
-     public function getFormFields($pos=0) {
-          return '';
-     }
-     
-     /**
-     Returns filter values il a serialized way (array)
-     
-     @return        <b>array</b>   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     <b>array</b>   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     <b>array</b>   form data
-     */
-     public function setFormValues($form_data) {
+     abstract protected function getFormFields($pos=0);
+     
+     /**
+     Extract values from data (data being an array, such as $_GET or $_POST)
+     
+     @param    $data     <b>array</b>   data to parse
+     @return   <b>array</b>   field values
+     
+     */
+     protected function getValuesFromData($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]);
-               }
+          $arr = array();
+          while (isset($data[$this->getFieldId($count)])) {
+               $arr[$count] = $data[$this->getFieldId($count)];
                $count++;
-
-          }
-          $this->values = array_values($this->values);
+          }
+          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 <b>string</b> the html code
+     */
+     
+     public function getFormLine() {
+          $ret='';
+          for ($cur=0; $cur < count($this->values); $cur++) {
+               $ret .= '<tr class="'.$this->id.'">';
+               $del_id = $this->filterset->getDelName($this->id,$cur);
+               $ret .= '<td><input id="'.$del_id.'" class="delete" '.
+                         'type="submit" title="Delete the following filter : " value=" - " name="'.$del_id.'"/></td>'.
+                         $this->getFormFields($cur);
+               $ret .= '</tr>';
+          }
+          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
      
@@ -354 +471 @@
           }
      }
-     /**
-     Returns HTML code for the hole filter lines
-     
-     @return <b>string</b> the html code
-     */
-     
-     public function getFormLine() {
-          $ret="";
-          for ($cur=0; $cur < count($this->values); $cur++) {
-               $ret .= '<li id="'.$this->getFieldId($cur).'" class="line" title="'.$this->desc.'">'.
-                    $this->getFormFields($cur).
-                    '<input id="del_'.$this->getFieldId($cur).'" class="delete" '.
-                    'type="submit" title="Delete the following filter : " value=" - " name="del_'.$this->getFieldId($cur).'"/>'.
-                    '</li>';
-          }
-          return $ret;
-     }
      
      /**
@@ -387 +487 @@
           return $this->values;
      }
+
+     public abstract function getAsText();
+
      
 }
@@ -412 +515 @@
      }
      
+     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();
@@ -434 +551 @@
      }
      
-     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 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 = '<td id="'.$this->getFieldId($cur).'" title="'.$this->desc.'" class="filter-title">'.
+                    ''.$this->desc.' : </td>'.
+                    '<td>'.
+                    form::combo($this->field_id.'_v',
+                         array(__('is')=>'is',__('is not')=>'isnot'),$this->verb,'','',
+                         false,'title="'.sprintf(__('%s is or is not'),$this->desc).'"').
+                    '</td>';
+          } else {
+               $ret = '<td id="'.$this->getFieldId($cur).'" title="or" colspan="2" class="or">'.
+                    __('or').' : </td>';
+          };
+          $ret .= '<td>'.form::combo($this->getFieldId($pos),$this->options,$this->values[$pos],
+               '','',false,'title="'.__('Choose an option').'"').'</td>';
+          return $ret;
      }
 
@@ -444 +579 @@
           return parent::getFormFieldAsHidden().form::hidden($this->field_id."_v",$this->verb);
      }
-
-     public function getFormFields($pos=0) {
+     
+     public function fillQS($arr) {
+          parent::fillQS($arr);
           
-          if ($pos == 0) {
-               $desc = $this->desc.' : ';
-               $labelclass="filter-title";
-          } else {
-               $desc = __('or');
-               $labelclass = 'or';
-          };
-          return '<span class="'.$labelclass.'">'.$desc.'</span>'.
-               (($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').'"');
+          $arr[$this->field_id.'_v']=$this->verb;
      }
      
@@ -473 +595 @@
           else
                $params[$attr]=$this->values;
+}
+     
+     public function getValues() {
+          return array_merge($this->values,array($this->field_id.'_v',$this->verb));
+     }
+     
+     public function getAsText() {
+          return sprintf("%s %s %s",$this->desc,$this->verb,join(',',$this->values));
      }
 }
@@ -502 +632 @@
 
      public function getFormFields($pos=0) {
-          return '<span class="'.$labelclass.'">'.$this->desc.'</span>'.
+          return '<td><span class="'.$labelclass.'">'.$this->desc.'</span></td><td>'.
                form::combo($this->getFieldId($pos),$this->options,$this->values[$pos],
-                    '','',false,'title="'.__('Choose an option').'"');
+                    '','',false,'title="'.__('Choose an option').'"').'</td>';
      }
      
      public function applyFilter($params) {
           $params[$this->request_param]=$this->values[0];
+     }
+     
+     public function getAsText() {
+          return sprintf("%s %s",$this->desc,$this->values[0]);
      }
 }
@@ -546 +680 @@
      }
 
-     public function getValue() {
-          $v = parent::getValue();
-          return $v[0];
+     public function getAsText() {
+          return sprintf("%s %s",$this->desc,$this->values[0]);
      }