include/class_ObjectListViewport.inc

   1 <?php
   2
   3 /*! \brief   Exception implementation for ObjectListViewport
   4     \author  Cajus Pollmeier <pollmeier@gonicus.de>
   5     \version 1.00
   6     \date    2007/11/02
   7
   8     This class handles the exceptions occuring in ObjectListViewport.
   9  */
  10 class ObjectListViewportException extends Exception {
  11         public function __construct($message, $code = 0) {
  12                 parent::__construct($message, $code);
  13         }
  14 }
  15
  16
  17 /*! \brief   Implementation for ObjectListViewport
  18     \author  Cajus Pollmeier <pollmeier@gonicus.de>
  19     \version 1.00
  20     \date    2007/11/02
  21
  22     This class handles painting of ObjectList objects.
  23
  24     \sa ObjectList
  25  */
  26 class ObjectListViewport {
  27
  28   /*!
  29     \brief Container for objects
  30
  31     This variable stores the ObjectList object to be displayed.
  32    */
  33         private $objects;
  34
  35
  36   /*! \brief ObjectListViewport constructor
  37
  38     The ObjectListViewport class renders/handles the ObjectList defined by $config.
  39
  40     \param config Config section that is used to configure this ObjectListViewport
  41    */
  42         public function __construct($config){
  43
  44     /* Load and instanciate classes, extract filter, icons, view hooks, etc. */
  45     $this->objects= new ObjectList($config);
  46   }
  47
  48         /*! \brief Handles _POST / _GET events
  49
  50             Processes the list of registered plugins to do their eventHandler and adapt
  51       internal objectlist according to this.
  52          */
  53   public function eventHandler(){
  54     /* Reloads the list if things have changed interally */
  55     $this->objects->reload();
  56   }
  57
  58
  59         /*! \brief Renders headline into a string
  60
  61             Gets the headline description from the ObjectList object and renders it.
  62
  63       \return HTML rendered headline
  64          */
  65   private function renderHeadline(){
  66     return $this->objects->getHeadline()."\n";
  67   }
  68
  69
  70         /*! \brief Renders footer into a string
  71
  72             Gets the footer description from the ObjectList object and renders it.
  73
  74       \return HTML rendered footer
  75          */
  76   private function renderFooter(){
  77     return $this->objects->getFooter()."\n";
  78   }
  79
  80
  81         /*! \brief Renders entries from the ObjectList iterator into a string
  82
  83             Gets the entry descriptions from the ObjectList object and renders them.
  84
  85       \return HTML rendered list entries
  86          */
  87   private function renderEntry($entry){
  88     $buffer= "|";
  89     foreach ($entry as $column){
  90       $buffer.= "$column|";
  91     }
  92     $buffer.= "\n";
  93
  94     return $buffer;
  95   }
  96
  97
  98         /*! \brief Renders complete ObjectList into a string
  99
 100       \return HTML rendered list
 101          */
 102   public function render() {
 103     /* Generate fixed headline */
 104     $buffer= $this->renderHeadline();
 105
 106     /* Generate scrollable contents */
 107     foreach ($this->objects as $value){
 108       $buffer.= $this->renderEntry($value);
 109     }
 110
 111     /* Generate footer */
 112     $buffer.= $this->renderFooter();
 113
 114     return ($buffer);
 115   }
 116
 117 }
 118
 119 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
 120 ?>