Code

Added components directory
[gosa.git] / include / class_ObjectListViewport.inc
index e7ed7911e2cce8d63cf8eb38faafed981b17790b..4bf3f5bc89ef52c94cd63fda5580df9f84bc26cb 100644 (file)
@@ -23,15 +23,34 @@ class ObjectListViewportException extends Exception {
 
     \sa ObjectList
  */
-class ObjectListViewport {
+class ObjectListViewport extends GOsaGuiElement {
+
+  /* Internal variable for color alternation */
+  private $colorAlternator= 0;
+
+  protected $headline;
+  protected $footer;
+  protected $entryFormat;
+
+  /* Dummy here ----> */
+  private $attributes= array('cn', '_icon', '_actions', 'dn');
+  /* <---- Dummy here */
+
+  protected $displayHeaderFlag= TRUE;
+  protected $displayFooterFlag= TRUE;
+  private $numberOfColumns= 0;
 
   /*!
     \brief Container for objects
 
     This variable stores the ObjectList object to be displayed.
    */
-       private $objects;
+       protected $objects;
 
+  /*!
+    \brief Switch to handle multiselect or not
+   */
+       protected $multiselect;
 
   /*! \brief ObjectListViewport constructor
 
@@ -39,59 +58,113 @@ class ObjectListViewport {
 
     \param config Config section that is used to configure this ObjectListViewport
    */
-       public function __construct($config){
+       public function __construct($config, $multiselect= TRUE, $displayHeader= TRUE, $displayFooter= FALSE){
+
+    /* Initialize from parents method */
+    parent::__construct();
+
+    /* Transfer initialization values */
+    $this->displayFooterFlag= $displayFooter;
+    $this->displayHeaderFlag= $displayHeader;
+    $this->multiselect= $multiselect;
+
+    /* Load list configuration from ConfigManager */
+    $cr= Registry::getInstance("ConfigManager");
+    $cr->setSection($config);
+    $this->parseHeadline($cr->getValue("headline"));
+    $this->footer= $cr->getValue("footer");
+    $this->entryFormat= $cr->getValue("entryFormat");
 
     /* Load and instanciate classes, extract filter, icons, view hooks, etc. */
     $this->objects= new ObjectList($config);
   }
 
-       /*! \brief Handles _POST / _GET events
 
-           Processes the list of registered plugins to do their eventHandler and adapt
-      internal objectlist according to this.
+       /*! \brief Processes post events
+
+           Processes all post events and acts as needed.
+
+      \return bool for if changes are present or not
         */
-  public function eventHandler(){
-    /* Reloads the list if things have changed interally */
+  protected function __process(){
+
+    /* FIXME: Dummy Action*/
     $this->objects->reload();
+
+    /* TODO: process input */
+    return FALSE;
   }
 
 
-       /*! \brief Renders headline into a string
+       /*! \brief Renders entries from the ObjectList iterator into a string
+           Gets the entry descriptions from the ObjectList object and renders them.
+      \return HTML rendered list entries
+        */
+  private function renderEntry($entry){
 
-           Gets the headline description from the ObjectList object and renders it.
+    /* Copy template */
+    $buffer= $this->entryFormat;
 
-      \return HTML rendered headline
-        */
-  private function renderHeadline(){
-    return $this->objects->getHeadline()."\n";
-  }
+    /* Replace set of attributes */
+    foreach ($this->attributes as $attribute){
+      if (!isset($entry[$attribute])){
+        throw new ObjectListViewportException(sprintf(_("Can't locate attribute '%s' to replace in entry!"), $attribute));
+      } else {
+        $buffer= preg_replace('/\{'.$attribute.'\}/', $entry[$attribute],$buffer);
+      }
+    }
 
+    /* Execute optional filters */
+    preg_match_all ( '/\{_filter\(([^)]+)\)\}/', $buffer, $matches, PREG_SET_ORDER);
+    foreach ($matches as $match){
+      $filterName= preg_replace('/,.+$/', '', $match[1]);
+      $filterParameter= preg_replace('/^[^,]+,/', '', $match[1]);
+      $buffer= preg_replace('/\{_filter\('.normalizePreg($match[1]).'\)\}/',
+                            $this->applyEntryFilter($filterName, $filterParameter),
+                            $buffer);
+    }
 
-       /*! \brief Renders footer into a string
+    #TODO: Make $buffer a proper HTML table output
+    $tmp = split("\|",trim($buffer,"|"));  
+    $cols = array();
+
+    for($i= 0; $i < $this->numberOfColumns; $i++){
+
+      /* If current entry is the last to appen, then skip adding styles */
+      if($i == ($this->numberOfColumns-1)){
+        $cols[$i]['style1'] = $this->columnInformation[$i]['style'];
+        $cols[$i]['style2'] = "width:100%;overflow:hidden;";
+        $cols[$i]['value']   = $tmp[$i];
+      }else{
+        $cols[$i]['style1'] = $this->columnInformation[$i]['style'];
+        $cols[$i]['style2'] = "width:100%;overflow:hidden;".$this->columnInformation[$i]['style'];
+        $cols[$i]['value']   = $tmp[$i];
+      }
+    }
 
-           Gets the footer description from the ObjectList object and renders it.
+    /* Add class depending on given id, to alternate background colors */
+    if($this->colorAlternator++ & 1){
+      $data['row']['class'] = "ObjectListViewport_Entry_Row1";
+    }else{
+      $data['row']['class'] = "ObjectListViewport_Entry_Row2";
+    }
 
-      \return HTML rendered footer
-        */
-  private function renderFooter(){
-    return $this->objects->getFooter()."\n";
+    $data['cols'] = $cols;
+    return($data);
   }
 
 
-       /*! \brief Renders entries from the ObjectList iterator into a string
+       /*! \brief Applies filter to the given entry format string.
 
-           Gets the entry descriptions from the ObjectList object and renders them.
+           Instanciates the given ObjectListEntryFilter and calls the method.
 
-      \return HTML rendered list entries
+      \return rendered output
+      \sa ObjectListEntryFilter
         */
-  private function renderEntry($entry){
-    $buffer= "|";
-    foreach ($entry as $column){
-      $buffer.= "$column|";
-    }
-    $buffer.= "\n";
-
-    return $buffer;
+  private function applyEntryFilter($filterName, $string){
+    $className= "ObjectListEntryFilter_".$filterName;
+    $cl= new $className;
+    return $cl->filter("$string");
   }
 
 
@@ -99,19 +172,105 @@ class ObjectListViewport {
 
       \return HTML rendered list
         */
-  public function render() {
-    /* Generate fixed headline */
-    $buffer= $this->renderHeadline();
-
-    /* Generate scrollable contents */
-    foreach ($this->objects as $value){
-      $buffer.= $this->renderEntry($value);
+  protected function __render() {
+
+    /* Apply current filter */
+    $entries = "";
+    $objects= new ObjectListFilterIterator($this->objects->getIterator());
+    foreach ($objects as $key =>  $value){
+      $entries[$key] = $this->renderEntry($value);
+      $this->createVariable("OLV_Entry_".$key);
     }
 
-    /* Generate footer */
-    $buffer.= $this->renderFooter();
+    #Fabian: _POST/_GET Variablen bitte mit $this->createVariable('name');
+    #        erstellen.
+    #        Damit kann das von der übergreifenden Funktion extrahiert werden
+    #        und wir haben keinen doppelten Code dafür.
+    #        
+    #        Wurde z.B. eine Variable via $this->createVariable('cn') erzeugt und via
+    #        smarty eingebunden, dann kann Sie nach einem _POST oder _GET via
+    #        $this->getRequestVariable_cn() wieder abgefragt werden.
+
+    $smarty = get_smarty();
+    $smarty->assign("OLV_Entries",$entries);
+    $smarty->assign("OLV_List_Id",$this->id);
+    $smarty->assign("OLV_Multiselect_Enabled",$this->multiselect);
+
+    /* Footer variables */
+    $smarty->assign("OLV_Footer_Enabled",$this->displayFooterFlag);
+    $smarty->assign("OLV_Footer_Message",$this->footer);
+    $smarty->assign("OLV_Num_Cols",$this->numberOfColumns);
+
+    /* Assign Headline values */
+    $smarty->assign("OLV_Header_Enabled",$this->displayHeaderFlag);
+    $smarty->assign("OLV_Header",$this->columnInformation);
+    return($smarty->fetch("ObjectListViewport.tpl"));
+  }
 
-    return ($buffer);
+
+       /*! \brief Parses the given headline format string 
+
+      \return Array with cell properties (width, alignment,name)
+        */
+  private function parseHeadline($data)
+  {
+    /* Each cell definition is seperated by | 
+     *  split by and go through each definition
+     */
+    $this->columnInformation= array();
+    $this->numberOfColumns= 0;
+    $tmp= split("\|", trim($data, "|")); 
+    $cell_formats= array();
+
+    foreach($tmp as $key => $dta){
+
+      $width= "";
+      $alignment= "";
+      $name= preg_replace("/\{[^\}]*+\}/", "", $dta);
+      $style= "";
+    
+      /* Parse format string and detect width & alignment */
+      if(preg_match("/\{.*\}/", $dta)){
+        $format= preg_replace("/^[^\{]*+\{([^\}]*).*$/", "\\1", $dta);
+    
+        /* Get aligment */
+        if(preg_match("/:/",$format)){
+          $al= preg_replace("/^[^:]*+:([a-z]*).*$/i", "\\1", $format);
+
+          if(preg_match("/T/i", $al)){
+            $alignment.= "top-";
+            $style.= "vertical-align: top;";
+          }
+
+          if(preg_match("/B/i", $al)){
+            $alignment.= "bottom-";
+            $style.= "vertical-align: bottom;";
+          }
+
+          if(preg_match("/R/i", $al)){
+            $alignment.= "right";
+            $style.= "text-align: right;";
+          }elseif(preg_match("/L/i", $al)){
+            $alignment.= "left";
+            $style.= "text-align: left;";
+          }elseif(preg_match("/C/i", $al) || preg_match("/M/i", $al) ){
+            $alignment.= "center";
+            $style.= "text-align: center;";
+          }
+        }
+
+        /* Get width */
+        $width = preg_replace("/^([^:]*).*$/","\\1", $format);
+        if(!empty($width)){
+          $style.= "width: ".$width.";";
+        }
+      }
+
+      $cell_formats[$key]= array("name" => $name, "width" => $width, "alignment" => $alignment, "style" => $style);
+      $this->numberOfColumns++;
+    }
+    $this->columnInformation= $cell_formats;
   }
 
 }