grouped_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";
 
class DataGroup
{
     var $parent;   
     var $title;         
     var $key;      
     var $expanded; 
     var $fixed;         
     
     function DataGroup($parent, $title, $key, $expanded = false, $fixed = false)
     {
          $this->parent = $parent;
          $this->title = $title;
          $this->key = $key;
          $this->expanded = $expanded;
     }
 
     function draw()
     {
          $cssClass = ($this->fixed || $this->parent->mode == 'fixed') ? "fixed" : ($this->expanded) ? "expanded" : "collapsed";
          $select = ($this->parent->selectable && $this->parent->showSelectAll) ? "<a href='#' class='button' style='float: right' onclick='new DOMEvent(event).stop(); GroupingTable.toggleGroup(this, \"{$this->parent->groupClass}\"); return false;'>Select All</a>" : "";          
?>
     <tr class="<?echo $this->parent->groupClass?> <?echo $cssClass?>">
      <td colspan="<?echo $this->parent->columnCount?>"><?echo $select?><?echo $this->title?></td>
     </tr>
<?
     }
}
 
class GroupedDataListView
{
     var $columns;       
     var $footerColumns; 
     var $cssClass;      
     var $groupClass;    
     var $id;            
     var $cssStyle;      
     var $emptyMessage;  
     var $onStartRow;    
     var $onDrawFooter;  
     var $mode;               
     var $groups;        
     var $items;              
     var $excelFile;          
     var $summary;       
     var $selectable  = false;     
     var $showSelectAll = true;    
     var $rowId = false; // whether to include an id tag for each tr row
     var $rowIdFormat = null;                
     var $groupFooterColumns = array(); // subtotal footer for group
     var $totalCallbacks = array(); // the onStartRow callbacks for totalling
     var $groupAsWorksheets = false; 
     var $menu = null;                       
     var $commandMenuIcon = "/fakoli/images/data_view_menu.png"; 
     var $hideExcelIcon = false;             
     var $tagRowCallbacks = array();     
     // Scrolling Table parameters
     
     var $height;
     var $scrollable = false;
     var $resizable  = true;
     
     function GroupedDataListView($items, $id, $cssClass = "list", $groupClass = "subheading")
     {
          $this->items = $items;
          $this->id = $id;
          $this->cssClass = $cssClass;
          $this->groupClass = $groupClass;
          $this->cssStyle = null;
          $this->emptyMessage = "No matching items.";
          $this->onStartRow = null;
          $this->onDrawFooter = false;
          $this->mode = "fixed";
          $this->excelFile = null;
     }
     
     function getID()
     {
          return $this->id;
     }
     
     function addFacetTaggingHandler($handler)
     {
          $this->tagRowCallbacks[] = $handler;
     }
     
     function group($title, $key, $expanded = false, $fixed = false)
     {
          $this->groups[] = new DataGroup($this, $title, $key, $expanded);
          return $this;
     }
     
     function groupBy($groups, $format = null, $field = "", $expandedFn = null, $fixedFn = null)
     {
          if (count($groups) == 0) return;
          if (!$field) $field = $groups[0]->primary_key;
          
          foreach($groups as $group)
          {
               $expanded = ($expandedFn) ? $expandedFn($group) : false;
               $fixed = ($fixedFn) ? $fixedFn($group) : false;
               
               $this->group($this->format($group, $format), $group->$field, $expanded, $fixed);
          } 
     }
 
     function autoGroup()
     {
          $categories = array_keys($this->items);
          foreach($categories as $category)
          {
               $this->group($category, $category);
          }
     }
     
     function format($group, $template)
     {
          if(!is_callable($template))
               return $group->format($template);
          else
               return call_user_func($template, $group);
     }
          
     function scrollable($height = 300, $resizable = true)
     {
          $this->scrollable = true;
          $this->height = $height;
          $this->resizable = $resizable;
     }
     
     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 selector($format = "")
     {
          if(count($this->items))
          {
               foreach($this->items as $groupKey => $items)
               {
                    $pk = $items[0]->getPrimaryKey();
                    break;
               }
          }
          
          if (!$format && count($items))
               $format = "<input type='checkbox' class='checkbox' name='{$pk}[]' id='{$pk}_{{$pk}}' value='{{$pk}}'/>";
                    
          if($format == "radio" && count($items))
               $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 "id='{$pk}_" . $item->$pk . "'";
     }    
     
     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)
     {
          $column =  new FooterTotalColumn($field, $template = "", $style, $colspan);
          $this->footerColumns[] = $column;
          $this->totalCallbacks[] = array($column, onStartRow);
          
          return $this;
     }
     
     function groupFooterText($text = "", $style = "", $colspan = 1)
     {
          $this->groupFooterColumns[] = new FooterTextColumn($text, $style, $colspan);
          return $this;
     }
     
     
     function groupFooterTotal($field, $style = "text-align: right", $colspan = 1)
     {
          $column =  new FooterTotalColumn($field, $template = "", $style, $colspan);
          $this->groupFooterColumns[] = $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 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 commandMenu()
     {
          $this->menu = new ContextMenu($this->id . "_menu", "#{$this->id}_menu_button");
          $this->menu->trigger = "click";
          $this->menu->position = "element";
          
          return $this->menu;
     }
     
     function getExcelLink()
     {
          $qs = appendToQueryString(getFullQueryString(), "__excel={$this->id}");
          return baseURI().$qs;
     }
     
     function writeScript()
     {
          $this->setID(); // Set to a default ID if none was specified.
          
          if ($this->excelFile && $_REQUEST["__excel"] == $this->id)
          {
               $this->writeExcelFile($this->excelFile);     
          }
                    
          if (count($this->items) == 0) return;
          
          $script = "<script type='text/javascript' src='/fakoli/js/grouping_table.js'></script>\n";
          
          $constructor = "";
               
          $constructor = "\n\t\tvar {$this->id} = new GroupingTable('{$this->id}', {mode: '{$this->mode}'});";
 
          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)
          {
               $script .=  "\t<script type='text/javascript'>\n\twindow.addEvent('domready', function()\n\t{";
               $script .= $constructor;
               $script .= "\n\t});\n\t</script>\n";
          }
 
          if ($this->menu) $script .= $this->menu->writeScript();
          
          return $script;
     }
     
     function drawView()
     {
          if (count($this->items) > 0)
          {
               if (count($this->groups) == 0) 
               {
                    $this->autoGroup();
               }
               
               $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";
                    $attrs .= "'";
               }
               
               if ($this->cssStyle)
               {
                    $attrs .= " style='{$this->cssStyle}'";
               }
               
               if ($this->summary)
               {
                    $attrs .= " summary='".htmlSafe($this->summary)."'";
               }
 
               $this->columnCount = count($this->columns);
          
               if ($this->scrollable)
               {    
                    $tbodyAttrs = " style='height: ".($this->height - 24)."px'";
                    echo "<div class='scrollContainer' style='height: {$this->height}px'>";
               }              
          
?>
          <table<?echo $attrs?>>
           <thead>
            <tr>
<?
               $first = true;
               
               foreach($this->columns as $column)
               {
                    if ($column->exportOnly) continue;
                    
                    $attrs = "";
                    $cssClass = "nosort";
                    if ($column->style)
                    {
                         if (preg_match("/^[\\w_]*$/", $column->style))
                         {
                              $cssClass = $column->style;
                         }
                         else
                         {
                              $attrs .= " style='{$column->style}'";
                         }
                    }
 
                    if ($cssClass)
                    {
                         $attrs .= " class='$cssClass'";
                    }
?>
               <th<?echo $attrs?>>
<?
                    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"/>
<?                                           
                         }
 
                         $first = false;
                    }
?>             
<?echo $column->title?></th>
<?
               }
?>
            </tr>   
           </thead>
           <tbody<?php echo $tbodyAttrs?>>
<?
               foreach($this->groups as $group)
               {
                    if (array_key_exists($group->key, $this->items))
                    {
                         $group->draw();
 
                         foreach($this->items[$group->key] as $item)
                         {
                              $cl = "";
                              
                              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);
                              }
                              
                              if ($cl) $cl = "class='$cl' ";
?>
          <tr<?echo $rowAttrs?> <?php echo $cl.$rowId ?>>
<?
                              foreach($this->columns as $column)
                              {
                                   if ($column->exportOnly) continue;
                    
                                   $attrs = "";
                                   if ($column->style)
                                   {
                                        $attrs .= " style='{$column->style}'";
                                   }
?>
              <td<?echo $attrs?>><?echo $column->format($item)?></td>
<?
                              }
?>
            </tr>
<?
                         } // end foreach group items as items
                         $this->drawSubFooterColumns();
                    } // end if group key is in items array
               } // end for each groups as group
?>
          </tbody>
<?
               if ($this->onDrawFooter) call_user_func($this->onDrawFooter);
               
               if (count($this->footerColumns) > 0)
               {
?>
          <tfoot>
            <tr>         
<?
                    foreach($this->footerColumns as $column)
                    {
                         $attrs = $this->getFooterColumnFormatting($column);
                         ?>
               <td<?echo $attrs?>><?echo $column->format()?></td>                                        
<?
                    }
?>
            </tr>
          </tfoot>  
<?
               }
?>        
          </table>
<?
               if ($this->scrollable) echo "</div>\n";
               if ($this->menu) echo $this->menu->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 getFooterColumnFormatting($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)
          {
               $attrs .= " colspan='{$column->colspan}'";
          }
               
          return $attrs;
     }
     
     function drawSubFooterColumns()
     {
          if (count($this->groupFooterColumns) == 0)
               return;
?>
           <tr>          
<?
          foreach($this->groupFooterColumns as $column)
          {         
               $attrs = $this->getFooterColumnFormatting($column);
?>
               <td<?echo $attrs?>><?echo $column->format()?></td>                                        
<?
               // reset to 0 before start of next group
               $column->total = 0;
          }
?>
           </tr>
<?   
     }
     
     function writeExcelFile($file)
     {
          $x = ExcelFileWriter::create($file);
 
          if (count($this->groups) == 0)
          {
               $this->autoGroup();
          }
          
          $writeColumnHeadings = true;
          $firstGroup = true;
          
          foreach($this->groups as $group)
          {
               if ($this->groupAsWorksheets)
               {
                    //AJG: Excel can't cope with slashes in worksheet names
                    $title = str_replace("/", " ", $group->title);
                    
                    if ($firstGroup)
                    {
                         $x->setWorksheetTitle($title);
                    }
                    else
                    {
                         $x->addWorksheet($title);
                    }
                    
                    $writeColumnHeadings = true;
                    $firstGroup = false;
               }
 
               $c = 0;
 
               if ($writeColumnHeadings)
               {
                    foreach($this->columns as $column)
                    {
                         $x->writeHeading(0, $c, $column->title);
                         ++$c;
                    }
                    
                    $r = 1;
                    $writeColumnHeadings = false;                
               }
               
               if (array_key_exists($group->key, $this->items))
               {
                    if (!$this->groupAsWorksheets)
                    {                   
                         $x->writeSubheading($r, 0, stripHTML($group->title));
                         $r++;
                    }
                    
                    foreach($this->items[$group->key] as $item)
                    {
                         $c = 0;
                         if ($this->onStartRow)
                         {
                              call_user_func($this->onStartRow, $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 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, stripHTML($val));
                                   }
                              }
                                             
                              ++$c;
                         }
                         ++$r;
                    }
               }
          }
 
          $c = 0;
          
          if ($this->footerColumns)
          {
               foreach($this->footerColumns as $column)
               {
                    $val = $column->format();
                    if (preg_match("/^[\\d\\.]+$/", $val))
                    {
                         $x->writeFooterNumber($r, $c, $val);
                    }
                    else
                    {
                         // No HTML required in Excel output
                         $x->writeFooter($r, $c, stripHTML($val));
                    }
                    $c += $column->colspan;
               }
          }
                    
          $x->send();
          die();
     }
}?>