data_view.inc

Go to the documentation of this file.

<?php
/**************************************************************
 
 Copyright (c) 2007-2010 Sonjara, Inc
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation
 files (the "Software"), to deal in the Software without
 restriction, including without limitation the rights to use,
 copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the
 Software is furnished to do so, subject to the following
 conditions:
 
 The above copyright notice and this permission notice shall be
 included in all copies or substantial portions of the Software.
 
 Except as contained in this notice, the name(s) of the above 
 copyright holders shall not be used in advertising or otherwise 
 to promote the sale, use or other dealings in this Software 
 without prior written authorization.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 OTHER DEALINGS IN THE SOFTWARE.
 
*****************************************************************/
 
require_once realpath(dirname(__FILE__))."/data_column.inc";
require_once realpath(dirname(__FILE__))."/join.inc";
require_once realpath(dirname(__FILE__))."/excel.inc";
require_once realpath(dirname(__FILE__))."/facet_manager.inc";
 
class DataListView implements FacetFilterable
{
     var $columns;       
     var $footerColumns; 
     var $cssClass;      
     var $id;            
     var $sortable;      
     var $pageSize;      
     var $cssStyle;      
     var $emptyMessage;  
     var $onStartRow;    
     var $onDrawfooter;  
     var $tagRowCallbacks; 
     var $totalCallbacks;
     var $filter;        
     var $excelFile;          
     var $paginate = true; 
     var $summary;         
     var $zebra;              
 
     // Scrolling Table parameters
     
     var $height;
     var $scrollable = false;
     var $resizable  = true;
     
     // Javascript interaction parameters
     
     var $rowId = false;                     
     var $rowIdFormat = null;                
     var $dragReorder = false;               
     var $reorderHandler = null;             
     var $dragColumnReorder = false;         
     var $columnReorderCallback = null; 
     var $hideExcelIcon = false;             
     var $onRowClick = null;                 
     var $onRowHover = null;                 
     
     var $dragText = "";                     
     // Selection and Commands
     
     var $selectable  = false;               
     var $showSelectAll = false;             
     var $menu = null;                       
     var $contextMenu = null;           
     var $commandMenuIcon = "/fakoli/images/data_view_menu.png"; 
     var $toolbarCallbacks = array();        
     static $includesWritten = false;
     
     function DataListView($items, $id, $cssClass = "list", $sortable = true, $pageSize = 0, $filter = false)
     {
          $this->items = $items;
          $this->id = $id;
          $this->cssClass = $cssClass;
          $this->sortable = $sortable;
          $this->filter = $filter;
          $this->pageSize = $pageSize;
          $this->cssStyle = null;
          $this->emptyMessage = "No matching items.";
          $this->onStartRow = null;
          $this->excelFile = null;
          $this->summary = null;
          $this->zebra = true;
          $this->totalCallbacks = array();
          $this->tagRowCallbacks = array();
          
          return $this;
     }
 
 
     function getID()
     {
          return $this->id;
     }
     
     function scrollable($height = 300, $resizable = true)
     {
          $this->scrollable = true;
          $this->height = $height;
          $this->resizable = $resizable;
     }
     
     function enableDragReorder($handler)
     {
          $this->sortable = false;
          $this->filter = false;
          $this->pageSize = 0;
          $this->paginate = false;
          $this->dragReorder = true;
          $this->rowId = true;
          $this->zebra = false;
          
          $this->reorderHandler = $handler;
     }
     
     function column($title, $format, $sortable = false, $style = null, $typeHint = null, $onExport = null, $sortFormat = null)
     {
          $this->columns[] = new DataColumn($title, $format, $sortable, $style, $typeHint, $onExport, $sortFormat);
          return $this;
     }
 
     function exportColumn($title, $format, $sortable = false, $style = null, $typeHint = null, $onExport = null, $sortFormat = null)
     {
          $column = new DataColumn($title, $format, $sortable, $style, $typeHint, $onExport, $sortFormat);
          $column->exportOnly = true;
          $this->columns[] = $column;
          return $this;
     }
     
     function setColumnOrder($order)
     {
          $columnsByTitle = reindexList($this->columns, "title");
          $columns = array();
          foreach($order as $title)
          {
               if (array_key_exists($title, $columnsByTitle))
               {
                    $columns[] = $columnsByTitle[$title];
               }
          }
          
          $this->columns = $columns;
     }
     
     function selector($format = "")
     {
          if (!$format && count($this->items))
          {
               $pk = $this->items[0]->primary_key;
               $format = "<input type='checkbox' class='checkbox' name='{$pk}[]' id='{$pk}_{{$pk}}' value='{{$pk}}'/>";
          }
                    
          if($format == "radio" && count($this->items) ){
               $pk = $this->items[0]->primary_key;
               $format = "<input type='radio' class='radio' name='{$pk}[]' id='{$pk}_{{$pk}}' value='{{$pk}}'/>";
          }    
          
          $this->column("&nbsp;", $format, false, "text-align: center");
          $this->selectable = true;
          return $this; 
     }
     
     function formatRowId($item)
     {
          if ($this->rowIdFormat)
          {
               return $item->format($this->rowIdFormat);
          }
          
          $pk = $item->getPrimaryKey();
          return "{$pk}_" . $item->$pk;
     }    
     
     function commandMenu()
     {
          if ($this->menu) return $this->menu;
          
          $this->menu = new ContextMenu($this->id . "_menu", "#{$this->id}_menu_button");
          $this->menu->trigger = "click";
          $this->menu->position = "element";
          
          if ($this->showSelectAll)
          {
               $this->menu->command("toggle_select_all", "Select All", "new DOMEvent(event).stop(); SortingTable.toggleSelect(this, '{$this->id}');", false);
          }
          return $this->menu;
     }
     
     function contextMenu()
     {
          if ($this->contextMenu) return $this->contextMenu;
          
          $this->contextMenu = new ContextMenu($this->id . "_context_menu", "#{$this->id}");
          $this->contextMenu->trigger = "contextmenu";
          $this->contextMenu->position = "pointer";
          
          if ($this->showSelectAll)
          {
               $this->contextMenu->command("toggle_select_all", "Select All", "new DOMEvent(event).stop(); SortingTable.toggleSelect(this, '{$this->id}');", false);
          }
          return $this->contextMenu;
     }
     
     function addToolbarCallback($callback)
     {
          $this->toolbarCallbacks[] = $callback;
     }
     
     function footerText($text = "", $style = "", $colspan = 1)
     {
          $this->footerColumns[] = new FooterTextColumn($text, $style, $colspan);
          return $this;
     }
     
     function footerValue($callback, $style = "", $colspan = 1)
     {
          $this->footerColumns[] = new FooterValueColumn($callback, $style, $colspan);
          return $this;
     }
     
     function footerTotal($field, $style = "text-align: right", $colspan = 1, $typeHint = Number)
     {
          $column =  new FooterTotalColumn($field, $template = "", $style, $colspan, $typeHint);
          $this->footerColumns[] = $column;
          $this->totalCallbacks[] = array($column, onStartRow);
          
          return $this;
     }
     
     function setID($id = null)
     {
          if ($this->id) return;
          if ($id)
          {
               $this->id = $id;
               return;
          }
          
          $this->id = makeRandomString(6);
     }
     
     function addFacetTaggingHandler($handler)
     {
          $this->tagRowCallbacks[] = $handler;
     }
     
     function getExcelLink()
     {
          $qs = appendToQueryString(getFullQueryString(), "__excel={$this->id}");
          return baseURI().$qs;
     }
     
     function autoPopulate($item)
     {
          if (count($this->columns) > 0) return;
 
          $fields = $item->getFieldArray();
          foreach($fields as $field)
          {
               if ($item->primary_key == $field) continue;
               
               $this->column($item->prettifyFieldName($field), "{".$field."}", $true);
          }
     }
     
     function writeScript()
     {
          $this->setID(); // Set to a default ID if none was specified.
          
          if ($_REQUEST["__column_order"])
          {
               $this->setColumnOrder(explode("|", $_REQUEST["__column_order"]));
          }
          
          if ($this->excelFile && $_REQUEST["__excel"] == $this->id)
          {
               $this->writeExcelFile($this->excelFile);     
          }
          
          if (count($this->items) == 0) return;
          
          if (!DataListView::$includesWritten)
          {
               $script = 
               "\t<script type='text/javascript' src='/fakoli/js/sorting_table.js'></script>\n".
               "\t<script type='text/javascript' src='/fakoli/js/paginating_table.js'></script>\n".  
               "\t<script type='text/javascript' src='/fakoli/js/filtering_table.js'></script>\n".
               "\t<script type='text/javascript' src='/fakoli/js/scrolling_table.js'></script>\n";
               
               DataListView::$includesWritten = true;
          }
                    
          $constructor = "";
          if (!$this->sortable && $this->pageSize <= 0 && !$this->filter && !$this->dragReorder)
          {
               return "";
          }
 
          $zebra = $this->zebra ? "true" : "false";
          
          if ($this->pageSize > 0 AND $this->paginate)
          {
               $constructor = "\n\t\tvar {$this->id}_paginator = new PaginatingTable('{$this->id}', '{$this->id}_paginator', {per_page: {$this->pageSize}, zebra: $zebra});";
          }
          else
          {
               $constructor = "\n\t\tvar {$this->id}_paginator = false;";
          }
 
          if ($this->filter !== false)
          {
               $constructor .= "\n\t\tvar {$this->id}_filter = new FilteringTable('{$this->id}', '{$this->id}_filter', {column: {$this->filter}, paginator: {$this->id}_paginator});";        
          }
          else
          {
               $constructor .= "\n\t\tvar {$this->id}_filter = false;";
          }
 
          if ($this->sortable)
          {
               $constructor .= "\n\t\tvar {$this->id}_sort = new SortingTable('{$this->id}', { paginator: {$this->id}_paginator, filter: {$this->id}_filter, zebra: $zebra});";
          }
          
          if ($this->selectable)
          {
               $constructor .= "\n\t\tdocument.id('{$this->id}').getSelectedValues = function() { var values = []; this.getElements(\"input[type='checkbox']\").each(function(e) { if (e.checked) values.push(e.value); }); return values; };";
          }
 
          if ($this->scrollable) 
          {
               $constructor .= "\n\t\tnew ScrollingTable('{$this->id}');";
          }
          
          if ($constructor || $this->dragReorder || $this->dragColumnReorder)
          {
               $script .=  "\t<script type='text/javascript'>\n\twindow.addEvent('domready', function()\n{";
               $script .= $constructor;
               
               if ($this->dragReorder)
               {
                    $script .= "\n\t\tnew DraggableTable('#{$this->id} tbody', '{$this->reorderHandler}', '{$this->items[0]->primary_key}');";
               }
               
               if ($this->dragColumnReorder)
               {
                    $options = ($this->columnReorderCallback) ? ", {onColumnsReordered: $this->columnReorderCallback}" : "";
                    $script .= "\n\tnew DraggableColumnTable('{$this->id}'$options);";
               }
                    
               $script .= "\n\t});\n\t</script>\n";
          }
 
          
          if ($this->menu)         $script .= $this->menu->writeScript();
          if ($this->contextMenu) $script .= $this->contextMenu->writeScript();
          
          return $script;
     }
     
     function drawView()
     {
          trace("Number of Items: ".count($this->items), 3);
          
          if (count($this->items) > 0)
          {
               if (!count($this->columns)) $this->autoPopulate($this->items[0]); // Autopopulate the column list from the first object, if not specified
               $attrs = "";
               if ($this->id)
               {
                    $attrs .= " id='{$this->id}'";
               }
               
               if ($this->cssClass)
               {
                    $attrs .= " class='{$this->cssClass}";
                    if ($this->sortable) $attrs .=" sortable";
                    if ($this->scrollable) $attrs.= " scroll";
                    if ($this->dragReorder) $attrs .= " reorder";
                    $attrs .= "'";
               }
               
               if ($this->cssStyle)
               {
                    $attrs .= " style='{$this->cssStyle}'";
               }
 
               if ($this->summary)
               {
                    $attrs .= " summary='".htmlSafe($this->summary)."'";
               }
               
               /* 
                * JDG 6/15/2010 - if the cssStyle has a width setting, either px or
                * &, apply that width style to the filter and paginator to avoid 
                * formatting problems. 
                */
               $width = 'width: 100%';
               if (preg_match("/^\\width:.*?\\d{1,5}px|width:.*?\\d{1,3}%/", $this->cssStyle, $matches))
                    $width = $matches[0]; 
          
?>             
          <div style="<?echo $width ?>">
          <?php 
          if($this->pageSize)
          {
               ?>
               <div style="float: right;" class="paginator"><ul id="<?echo $this->id?>_paginator"></ul></div>
               <?php
          }
          
          if($this->filter)
          {
          ?>
               <div style="float: left" class="filter" id="<?echo $this->id?>_filter"></div>
          <?php 
          }
          
          if ($this->dragReorder)
          {
               echo $this->dragText;
          }
          ?>
          </div>
          
          <?php
               if ($this->scrollable)
               {    
                    $tbodyAttrs = " style='height: ".($this->height - 24)."px'";
                    echo "<div class='scrollContainer' style='height: {$this->height}px'>";
               }              
          ?>
          <table border="0" cellpadding="0" cellspacing="0"<?echo $attrs?>>
           <thead>
            <tr>
<?php
               $first = true;
               
               foreach($this->columns as $column)
               {
                    if ($column->exportOnly) continue;
                    
                    $attrs = "";
                    $cssClass = "";
 
                    if (!$column->sortable)
                    {
                         $cssClass = trim($cssClass." nosort");
                    }
 
                    if ($cssClass)
                    {
                         $attrs .= " class='$cssClass'";
                    }
                    
                    if (preg_match("/^\\width:.*?\\d{1,3}px|width:.*?\\d{1,3}%/", $column->style, $matches))
                    {
                         $attrs .= " style='{$matches[0]}'";
                    } 
                         
                    if ($column->sortFormat) $attrs .= " data-sort='true'";
?>
               <th<?echo $attrs?>>
<?php
               
                    if ($first)
                    {
                         if ($this->excelFile)
                         {    
                              $qs = $this->getExcelLink();
                         }
 
                         if ($this->excelFile && !$this->menu && !$this->hideExcelIcon)
                         {
?>
          <a href='<?echo $qs?>' style="float: left"><img src="/fakoli/images/msexcel_icon_small.png" alt="Excel" style="border: none; display:inline-block;vertical-align: middle"/></a>
<?                                           
                         }
                         else if ($this->menu)
                         {
                              if ($this->excelFile)
                              {
                                   $this->menu->command($this->id."_excel", "Save as Excel...", $qs, true, "/fakoli/images/msexcel_icon_small.png");
                              }
?>
          <img id="<?echo $this->id?>_menu_button" src="<?echo $this->commandMenuIcon?>" alt="Table Menu" style="border: none; display:inline-block;vertical-align: middle"/>
<?                                           
                         }
                         
                         if ($this->contextMenu && $this->excelFile)
                         {
                              $this->menu->command($this->id."_context_excel", "Save as Excel...", $qs, true, "/fakoli/images/msexcel_icon_small.png");
                         }
                         
                         foreach($this->toolbarCallbacks as $callback)
                         {
                              echo "<div style='display: inline-block; float: left'>";
                              echo call_user_func($callback, $this);
                              echo "</div>";
                         }
                    }
                    $first = false;
?>
<?echo $column->title?></th>
<?
               }
?>
            </tr>   
           </thead>
           <tbody<?echo $tbodyAttrs?>>
<?
               foreach($this->items as $item)
               {
                    $cl = array();
                    if($this->rowId)
                         $rowId = $this->formatRowId($item);
                         
                    if ($this->onStartRow)
                    {
                         $retval = call_user_func($this->onStartRow, $item);
                         if ($retval === false) continue; // return false to indicate row should be skipped
                         if ($retval) $cl[] = $retval; // return a string to indicate a css class for the row
                    }
                    
                    $dataAttrs = array();
                    foreach($this->tagRowCallbacks as $cb)
                    {
                         $dataAttrs = call_user_func($cb, $item, $dataAttrs);
                    }
                    
                    $rowAttrs = "";
                    foreach($dataAttrs as $name => $value)
                    {
                         $rowAttrs .= " ".$name."='".$value."'";
                    }
                    
                    foreach($this->totalCallbacks as $cb)
                    {
                         call_user_func($cb, $item);
                    }
                    
                    $onclick = "";
                    
                    if ($this->onRowClick)
                    {
                         $onclick =  " onclick=\"" . $item->format($this->onRowClick) . "\" onmouseover=\"this.addClass('hover');";
                         if ($this->onRowHover) $onlick .= $item->format($this->onRowHover);
                         $onclick .=" return false;\" onmouseout=\"this.removeClass('hover'); return false;\"";
                         $cl[] = "clickable";
                    }
                    
                    $cl = implode(" ", $cl);
                    if ($cl) $cl = "class='$cl'";
                    if ($rowId) $rowId = "id='$rowId' ";
?>
          <tr <?echo $rowId?><?php echo $cl?><?echo $onclick?><?echo $rowAttrs?>>
<?php
                    foreach($this->columns as $column)
                    {
                         if ($column->exportOnly) continue;
                    
                         $attrs = "";
                         $cssClass = "";
                         
                         if (preg_match("/^[\\w_]*$/", $column->style))
                         {
                              $cssClass = $column->style;
                         }
                         else
                         {
                              $attrs .= " style='{$column->style}'";
                         }
                                             
                         if ($cssClass)
                         {
                              $attrs .= " class='$cssClass'";
                         }
                         
                         if ($column->sortFormat) $attrs .= " data-sort='".htmlentities($item->format($column->sortFormat))."'";
?>
              <td<?echo $attrs?>><?echo $column->format($item)?></td>
<?php
                    }
?>
            </tr>
<?php
               }
?>
          </tbody>
<?php
               if ($this->onDrawFooter) call_user_func($this->onDrawFooter);
               
               if (count($this->footerColumns) > 0)
               {
?>
          <tfoot>
            <tr>         
<?php
                    foreach($this->footerColumns as $column)
                    {
                         $attrs = "";
                         $cssClass = "";
                         if ($column->style)
                         {
                              if (preg_match("/^[\\w_]*$/", $column->style))
                              {
                                   $attrs .= " class='{$column->style}'";
                              }
                              else
                              {
                                   $attrs .= " style='{$column->style}'";
                              }
                         }
 
                         if ($column->colspan > 1)
                         {
                              if (!$this->dragColumnReorder)
                              {
                                   $attrs .= " colspan='{$column->colspan}'";
                         ?>
               <td<?echo $attrs?>><?echo $column->format()?></td>                                        
<?php
                              }
                              else if (preg_match("/text-align:\\s*right/i", $column->style))
                              {
                                   for($i = 1; $i < $column->colspan; ++$i)
                                   {
                                        echo "<td>&nbsp;</td>";
                                   }
?>
<td<?echo $attrs?>><?echo $column->format()?></td>
<?
                              }
                              else
                              {
?>
<td<?echo $attrs?>><?echo $column->format()?></td>
<?
                                   for($i = 1; $i < $column->colspan; ++$i)
                                   {
                                        echo "<td>&nbsp;</td>";
                                   }
                              }
                         }
                         else
                         {
?>
<td<?echo $attrs?>><?echo $column->format()?></td>
<?
                         }
                    }                             
?>
            </tr>
          </tfoot>  
<?php
               }
?>        
          </table>
<?php
               if ($this->scrollable) echo "</div>";
               
               if ($this->menu) echo $this->menu->writeMenu();
               if ($this->contextMenu) echo $this->contextMenu->writeMenu();
          }
          else
          {
               echo "<p><em>{$this->emptyMessage}</em></p>";
          }
     }
     
     function drawViewToString()
     {
          ob_start();
          $this->drawView();
          $out = ob_get_contents();
          ob_end_clean();
          return $out;
     }
     
     function writeExcelFile($file)
     {
          $x = ExcelFileWriter::create($file);
          
          $c = 0;
          foreach($this->columns as $column)
          {
               $x->writeHeading(0, $c, stripHTMLTags(stripHTML($column->title)));
               ++$c;
          }
          
          $r = 1;
          foreach($this->items as $item)
          {
               $c = 0;
               if ($this->onStartRow)
               {
                    $retval = call_user_func($this->onStartRow, $item);
                    if ($retval === false) continue;
               }
                              
               foreach($this->totalCallbacks as $cb)
               {
                    call_user_func($cb, $item);
               }
 
               foreach($this->columns as $column)
               {
                    if (is_callable($column->onExport))
                    {
                         $val = call_user_func($column->onExport, $item, $column);
                    }
                    else if ($column->onExport)
                    {
                         $val = $item->format($column->onExport);
                    }
                    else
                    {
                         $val = $column->format($item);
                    }
                    
                    switch($column->typeHint)
                    {
                    case String:
 
                         $x->writeText($r, $c, stripHTMLTags(stripHTML($val)));
                         break;
                         
                    case Text:
                         
                         $x->writeText($r, $c, stripHTMLTags(stripHTML($val)), true);
                         break;
                         
                    case Number:
                         
                         $x->writeNumber($r, $c, $val);
                         break;
                         
                    case Currency:
                         
                         $val = str_replace(array("$", ","), array("", ""), $val);
                         $x->writeCurrency($r, $c, $val);
                         break;
                         
                    case Percentage:
                         
                         $x->writePercentage($r, $c, $val);
                         break;
                              
                    default:
                         
                         /* JDG 5/11/10 currency export fix */
                         if (preg_match("/^[\\d\\,\\.\\$]+$/", $val))
                         {
                              $val = str_replace(array("$", ","), array("", ""), $val);
                              $x->writeNumber($r, $c, $val);
                         }
                         else
                         {
                              // No HTML required in Excel output
                              $x->writeText($r, $c, stripHTMLTags(stripHTML($val)));
                         }
                    }
                    
                    ++$c;
               }
               ++$r;
          }
          
          $c = 0;
          
          if ($this->footerColumns)
          {
               foreach($this->footerColumns as $column)
               {
                    $val = $column->format();
                    /* JDG 5/11/10 currency export fix */
                    if (preg_match("/^[\\d\\,\\.]+$/", $val))
                    {
                         $val = str_replace(",", "", $val);
                         $x->writeFooterNumber($r, $c, $val);
                    }
                    else
                    {
                         // No HTML required in Excel output
                         $x->writeFooter($r, $c, stripHTMLTags(stripHTML($val)));
                    }
                    $c += $column->colspan;
               }
          }
                    
          $x->send();
          
          session_write_close();
          exit();
     }
}