GroupedDataListView displays a list of DataItems (or InnerJoinResults) in tabular format grouped by a specific field. More...

Public Member Functions
	GroupedDataListView ($items, $id, $cssClass="list", $groupClass="subheading")
	Creates a new GroupedDataListView object. More...

	getID ()

	addFacetTaggingHandler ($handler)
	Adds a row tagging handler. More...

	group ($title, $key, $expanded=false, $fixed=false)
	Adds a group to the view. More...

	groupBy ($groups, $format=null, $field="", $expandedFn=null, $fixedFn=null)
	Add groups based on the supplied list of DataItems. More...

	autoGroup ()

	format ($group, $template)
	Outputs the text for the groupedBy title bar using the given group dataitem object. More...

	scrollable ($height=300, $resizable=true)

	column ($title, $format, $sortable=false, $style=null, $typeHint=null, $onExport=null, $sortFormat=null)
	Adds a column definition to the DataListView. More...

	exportColumn ($title, $format, $sortable=false, $style=null, $typeHint=null, $onExport=null, $sortFormat=null)
	Adds a column definition to the DataListView that is only output when exporting the table to Excel. More...

	selector ($format="")
	Adds a selector column to the DataListView. More...

	formatRowId ($item)

	footerText ($text="", $style="", $colspan=1)
	Adds a text column to the table footer. More...

	footerValue ($callback, $style="", $colspan=1)
	Adds a value column to the table footer. More...

	footerTotal ($field, $style="text-align: right", $colspan=1)
	Sums the total for a column. More...

	groupFooterText ($text="", $style="", $colspan=1)
	Adds a text column to the table footer. More...

	groupFooterTotal ($field, $style="text-align: right", $colspan=1)

	setID ($id=null)
	Sets the client-side ID for this DataListView. More...

	autoPopulate ($item)
	Automatically build the table columns from the given DataItem. More...

	commandMenu ()
	Adds a ContextMenu to the table that can contain a list of operations that can be performed on subselections of the table's contents. More...

	getExcelLink ()
	Get the Excel Link. More...

	writeScript ()
	Write the Javascript to implement the table output. More...

	drawView ()
	Writes the HTML for the data table to the output buffer. More...

	drawViewToString ()
	Render the table view and return the generated HTML as a string. More...

	getFooterColumnFormatting ($column)

	drawSubFooterColumns ()

	writeExcelFile ($file)
	Writes the data table out as an Excel File. More...

Public Attributes
	$columns
	The column definitions for the table. More...

	$footerColumns
	The footer column definitions for the table. More...

	$cssClass
	Optional CSS class to apply to the table. More...

	$groupClass
	The CSS class to apply to the group subheading rows. More...

	$id
	ID of the table in the output script. More...

	$cssStyle
	Optional additional inline styles to apply to the table. More...

	$emptyMessage
	Message to display when no items are present in the data set. More...

	$onStartRow
	Callback hook that gets called at the start of each row. More...

	$onDrawFooter
	Callback hook that gets called after all rows have been drawn. More...

	$mode
	The display mode for the table: fixed or tree. More...

	$groups
	The group definitions. More...

	$items
	The items to be displayed. More...

	$excelFile
	Name of the Excel file for automatic export to excel. More...

	$summary
	Human-readable summary of the information contained in the table (for usability/accessiblity purposes) More...

	$selectable = false
	Whether the table provides a selection mechanism. More...

	$showSelectAll = true
	Show Select All buttons for selectable tables. More...

	$rowId = false

	$rowIdFormat = null
	Optionally specify a custom row ID format. More...

	$groupFooterColumns = array()

	$totalCallbacks = array()

	$groupAsWorksheets = false
	Format groups as separate worksheets when exporting to Excel (requires PHPExcel) More...

	$menu = null
	Context menu for selection-based operations. More...

	$commandMenuIcon = "/fakoli/images/data_view_menu.png"
	Icon to use for the command menu dropdown. More...

	$hideExcelIcon = false
	Suppress the automatic Excel icon if you want an external link. More...

	$tagRowCallbacks = array()
	Array of callbacks for adding extra attributes to each row. More...

	$height

	$scrollable = false

	$resizable = true

Detailed Description

GroupedDataListView displays a list of DataItems (or InnerJoinResults) in tabular format grouped by a specific field.

Grouped tables cannot be sortable or filterable by column or paginated. However, the groups can optionally be expandable by clicking, in either a "tree" or "accordion" style. With "tree" mode, each group can be expanded or hidden independently of the others. With "accordion" mode, only one group can be expanded at a time. With "fixed" mode, all the groups are displayed and cannot be hidden.

GroupedDataListViews can also be rendered directly into binary Microsoft Excel format via the writeExcelFile() method.

Author: andy

Definition at line 100 of file grouped_data_view.inc.

Member Function Documentation

◆ addFacetTaggingHandler()

GroupedDataListView::addFacetTaggingHandler ( $handler )

Adds a row tagging handler.

This function will receive the data item for each row and can add custom attributes to the row tag.

Definition at line 166 of file grouped_data_view.inc.

      {
           $this->tagRowCallbacks[] = $handler;
      }

◆ autoGroup()

GroupedDataListView::autoGroup ( )

Definition at line 206 of file grouped_data_view.inc.

      {
           $categories = array_keys($this->items);
           foreach($categories as $category)
           {
                $this->group($category, $category);
           }
      }

◆ autoPopulate()

GroupedDataListView::autoPopulate ( $item )

Automatically build the table columns from the given DataItem.

Not recommended except for quick and dirty pages. This method is called automatically if no columns have been defined before drawing the view.

Parameters

$item the item to use as a template for the columns.

Definition at line 403 of file grouped_data_view.inc.

      {
           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);
           }
      }

◆ column()

GroupedDataListView::column	(	$title,
		$format,
		$sortable = `false`,
		$style = `null`,
		$typeHint = `null`,
		$onExport = `null`,
		$sortFormat = `null`
	)

Adds a column definition to the DataListView.

Parameters

	$title	the title of the column
	$format	the formatter for the column, either as a formatting string or callback function. (For details on format template specifications, see comments above class DataItem function format.)
	$sortable	whether this column is sortable
	$style	any inline styles specific to this column
	$typeHint	hint for cell type to use when exporting to Excel
	$onExport	optional callback function to format value for Excel
string	$sortFormat	Optional explicit format to use as the basis for sorting

Returns: DataListView returns the current instance, allowing function call chaining for the column definitions.

Definition at line 250 of file grouped_data_view.inc.

      {
           $this->columns[] = new DataColumn($title, $format, $sortable, $style, $typeHint, $onExport, $sortFormat);
           return $this;
      }

◆ commandMenu()

GroupedDataListView::commandMenu ( )

Adds a ContextMenu to the table that can contain a list of operations that can be performed on subselections of the table's contents.

Returns: ContextMenu

Definition at line 421 of file grouped_data_view.inc.

      {
           $this->menu = new ContextMenu($this->id . "_menu", "#{$this->id}_menu_button");
           $this->menu->trigger = "click";
           $this->menu->position = "element";
           
           return $this->menu;
      }

◆ drawSubFooterColumns()

GroupedDataListView::drawSubFooterColumns ( )

Definition at line 728 of file grouped_data_view.inc.

      {
           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>
 <?   
      }

◆ drawView()

GroupedDataListView::drawView ( )

Writes the HTML for the data table to the output buffer.

Definition at line 485 of file grouped_data_view.inc.

      {
           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>";
           }
      }

◆ drawViewToString()

GroupedDataListView::drawViewToString ( )

Render the table view and return the generated HTML as a string.

Returns: string the generated HTML for the table

Definition at line 694 of file grouped_data_view.inc.

      {
           ob_start();
           $this->drawView();
           $out = ob_get_contents();
           ob_end_clean();
           return $out;
      }

◆ exportColumn()

GroupedDataListView::exportColumn	(	$title,
		$format,
		$sortable = `false`,
		$style = `null`,
		$typeHint = `null`,
		$onExport = `null`,
		$sortFormat = `null`
	)

Adds a column definition to the DataListView that is only output when exporting the table to Excel.

Use this method for extended detail columns when space is constrained on the page but more details might be useful in an exported spreadsheet

Parameters

	$title	the title of the column
	$format	the formatter for the column, either as a formatting string or callback function. (For details on format template specifications, see comments above class DataItem function format.)
	$sortable	whether this column is sortable
	$style	any inline styles specific to this column
	$typeHint	hint for cell type to use when exporting to Excel
	$onExport	optional callback function to format value for Excel
string	$sortFormat	Optional explicit format to use as the basis for sorting

Returns: DataListView returns the current instance, allowing function call chaining for the column definitions.

Definition at line 270 of file grouped_data_view.inc.

      {
           $column = new DataColumn($title, $format, $sortable, $style, $typeHint, $onExport, $sortFormat);
           $column->exportOnly = true;
           $this->columns[] = $column;
           return $this;
      }

◆ footerText()

GroupedDataListView::footerText	(	$text = `""`,
		$style = `""`,
		$colspan = `1`
	)

Adds a text column to the table footer.

Parameters

$text	string the text to display
$style	string any CSS classes or inline styles to apply
$colspan	int the colspan for the column

Returns: DataListView returns the current instance, allowing function call chaining for the column definitions.

Definition at line 323 of file grouped_data_view.inc.

      {
           $this->footerColumns[] = new FooterTextColumn($text, $style, $colspan);
           return $this;
      }

◆ footerTotal()

GroupedDataListView::footerTotal	(	$field,
		$style = `"text-align: right"`,
		$colspan = `1`
	)

Sums the total for a column.

Parameters

$field	string the field to total in the format "{field}"
$style	string any CSS classes or inline styles to apply
$colspan	int the colspan for the column

Returns: DataListView returns the current instance, allowing function call chaining for the column definitions.

Definition at line 349 of file grouped_data_view.inc.

                                                       : right", $colspan = 1)
      {
           $column =  new FooterTotalColumn($field, $template = "", $style, $colspan);
           $this->footerColumns[] = $column;
           $this->totalCallbacks[] = array($column, onStartRow);
           
           return $this;
      }

◆ footerValue()

GroupedDataListView::footerValue	(	$callback,
		$style = `""`,
		$colspan = `1`
	)

Adds a value column to the table footer.

Parameters

$callback	callable Callback function or object method used to calculate the value for this column.
$style	string any CSS classes or inline styles to apply
$colspan	int the colspan for the column

Returns: DataListView returns the current instance, allowing function call chaining for the column definitions.

Definition at line 336 of file grouped_data_view.inc.

      {
           $this->footerColumns[] = new FooterValueColumn($callback, $style, $colspan);
           return $this;
      }

◆ format()

GroupedDataListView::format	(	$group,
		$template
	)

Outputs the text for the groupedBy title bar using the given group dataitem object.

This function should not be invoked directly, but is invoked as part of the GroupedDataListView's rendering operations.

Parameters

$group the dataitem object for the title bar being rendered

Returns: title for the titel bar.

Definition at line 223 of file grouped_data_view.inc.

      {
           if(!is_callable($template))
                return $group->format($template);
           else
                return call_user_func($template, $group);
      }

◆ formatRowId()

GroupedDataListView::formatRowId ( $item )

Definition at line 305 of file grouped_data_view.inc.

      {
           if ($this->rowIdFormat)
           {
                return $item->format($this->rowIdFormat);
           }
           
           $pk = $item->getPrimaryKey();
           return "id='{$pk}_" . $item->$pk . "'";
      }    

◆ getExcelLink()

GroupedDataListView::getExcelLink ( )

Get the Excel Link.

Definition at line 433 of file grouped_data_view.inc.

      {
           $qs = appendToQueryString(getFullQueryString(), "__excel={$this->id}");
           return baseURI().$qs;
      }

◆ getFooterColumnFormatting()

GroupedDataListView::getFooterColumnFormatting ( $column )

Definition at line 704 of file grouped_data_view.inc.

      {
           $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;
      }

◆ getID()

GroupedDataListView::getID ( )

Definition at line 157 of file grouped_data_view.inc.

      {
           return $this->id;
      }

◆ group()

GroupedDataListView::group	(	$title,
		$key,
		$expanded = `false`,
		$fixed = `false`
	)

Adds a group to the view.

Parameters

unknown_type	$title	the title text for the group.
unknown_type	$key	the key value for the group.
unknown_type	$expanded	true for expanded by default, false for collapsed by default

Returns: GroupDataListView returns the current instance, allowing function call chaining for the group definitions.

Definition at line 178 of file grouped_data_view.inc.

      {
           $this->groups[] = new DataGroup($this, $title, $key, $expanded);
           return $this;
      }

◆ groupBy()

GroupedDataListView::groupBy	(	$groups,
		$format = `null`,
		$field = `""`,
		$expandedFn = `null`,
		$fixedFn = `null`
	)

Add groups based on the supplied list of DataItems.

Parameters

$groups	array list of DataItems
$format	string format template for the group titles
$field	string the field to use for the key (defaults to the primary key of the group items if not specified)
$expandedFn	callable optional function that can be used to determine if each group should be expanded or collapsed
$fixedFn	callable optional function that can be used to determine if each group should be fixed

Definition at line 192 of file grouped_data_view.inc.

      {
           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);
           } 
      }

◆ GroupedDataListView()

GroupedDataListView::GroupedDataListView	(	$items,
		$id,
		$cssClass = `"list"`,
		$groupClass = `"subheading"`
	)

Creates a new GroupedDataListView object.

Parameters

array	$items	the array of DataItems or InnerJoinResults to be displayed
string	$id	the client-side ID for this table
string	$cssClass	Optional CSS class to apply to the table
string	$sortable	Specifies whether to enable client-side sorting for this table
integer	$pageSize	Specifies the number of items per page - set to zero for unpaginated
boolean	$filter	Specifies whether to enable client-side filtering for this table.

Definition at line 143 of file grouped_data_view.inc.

      {
           $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;
      }

◆ groupFooterText()

GroupedDataListView::groupFooterText	(	$text = `""`,
		$style = `""`,
		$colspan = `1`
	)

Adds a text column to the table footer.

Parameters

$text	the text to display
$style	any CSS classes or inline styles to apply
$colspan	the colspan for the column

Returns: DataListView returns the current instance, allowing function call chaining for the column definitions.

Definition at line 365 of file grouped_data_view.inc.

      {
           $this->groupFooterColumns[] = new FooterTextColumn($text, $style, $colspan);
           return $this;
      }

◆ groupFooterTotal()

GroupedDataListView::groupFooterTotal	(	$field,
		$style = `"text-align: right"`,
		$colspan = `1`
	)

Definition at line 372 of file grouped_data_view.inc.

                                                            : right", $colspan = 1)
      {
           $column =  new FooterTotalColumn($field, $template = "", $style, $colspan);
           $this->groupFooterColumns[] = $column;
           $this->totalCallbacks[] = array($column, onStartRow);
           
           return $this;
      }

◆ scrollable()

GroupedDataListView::scrollable	(	$height = `300`,
		$resizable = `true`
	)

Definition at line 231 of file grouped_data_view.inc.

      {
           $this->scrollable = true;
           $this->height = $height;
           $this->resizable = $resizable;
      }

◆ selector()

GroupedDataListView::selector ( $format = "" )

Adds a selector column to the DataListView.

If no format is specified then selection is handled via a checklist box for the list objects' primary keys.

Parameters

$format (optional) format to use for the selector

Definition at line 283 of file grouped_data_view.inc.

      {
           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; 
      }

◆ setID()

GroupedDataListView::setID ( $id = null )

Sets the client-side ID for this DataListView.

Parameters

$id	the ID to use. Passing in null will generate a random ID string.

Definition at line 386 of file grouped_data_view.inc.

      {
           if ($this->id) return;
           if ($id)
           {
                $this->id = $id;
                return;
           }
           
           $this->id = makeRandomString(6);
      }

◆ writeExcelFile()

GroupedDataListView::writeExcelFile ( $file )

Writes the data table out as an Excel File.

The file is output with an 'attachment' disposition, which will prompt a save dialog in the client browser.

Parameters

$file the name of the file to be output.

Returns: Does not return - exits script on completion to prevent corruption of the output file.

Definition at line 756 of file grouped_data_view.inc.

      {
           $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();
      }

◆ writeScript()

GroupedDataListView::writeScript ( )

Write the Javascript to implement the table output.

Returns: string containing the required Javascript.

Definition at line 443 of file grouped_data_view.inc.

      {
           $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;
      }

Member Data Documentation

◆ $columns

GroupedDataListView::$columns

The column definitions for the table.

Definition at line 102 of file grouped_data_view.inc.

◆ $commandMenuIcon

GroupedDataListView::$commandMenuIcon = "/fakoli/images/data_view_menu.png"

Icon to use for the command menu dropdown.

Definition at line 124 of file grouped_data_view.inc.

◆ $cssClass

GroupedDataListView::$cssClass

Optional CSS class to apply to the table.

Definition at line 104 of file grouped_data_view.inc.

◆ $cssStyle

GroupedDataListView::$cssStyle

Optional additional inline styles to apply to the table.

Definition at line 107 of file grouped_data_view.inc.

◆ $emptyMessage

GroupedDataListView::$emptyMessage

Message to display when no items are present in the data set.

Definition at line 108 of file grouped_data_view.inc.

◆ $excelFile

GroupedDataListView::$excelFile

Name of the Excel file for automatic export to excel.

Definition at line 114 of file grouped_data_view.inc.

◆ $footerColumns

GroupedDataListView::$footerColumns

The footer column definitions for the table.

Definition at line 103 of file grouped_data_view.inc.

◆ $groupAsWorksheets

GroupedDataListView::$groupAsWorksheets = false

Format groups as separate worksheets when exporting to Excel (requires PHPExcel)

Definition at line 122 of file grouped_data_view.inc.

◆ $groupClass

GroupedDataListView::$groupClass

The CSS class to apply to the group subheading rows.

Definition at line 105 of file grouped_data_view.inc.

◆ $groupFooterColumns

GroupedDataListView::$groupFooterColumns = array()

Definition at line 120 of file grouped_data_view.inc.

◆ $groups

GroupedDataListView::$groups

The group definitions.

Definition at line 112 of file grouped_data_view.inc.

◆ $height

GroupedDataListView::$height

Definition at line 129 of file grouped_data_view.inc.

◆ $hideExcelIcon

GroupedDataListView::$hideExcelIcon = false

Suppress the automatic Excel icon if you want an external link.

Definition at line 125 of file grouped_data_view.inc.

◆ $id

GroupedDataListView::$id

ID of the table in the output script.

Definition at line 106 of file grouped_data_view.inc.

◆ $items

GroupedDataListView::$items

The items to be displayed.

Definition at line 113 of file grouped_data_view.inc.

◆ $menu

GroupedDataListView::$menu = null

Context menu for selection-based operations.

Definition at line 123 of file grouped_data_view.inc.

◆ $mode

GroupedDataListView::$mode

The display mode for the table: fixed or tree.

Definition at line 111 of file grouped_data_view.inc.

◆ $onDrawFooter

GroupedDataListView::$onDrawFooter

Callback hook that gets called after all rows have been drawn.

Definition at line 110 of file grouped_data_view.inc.

◆ $onStartRow

GroupedDataListView::$onStartRow

Callback hook that gets called at the start of each row.

Definition at line 109 of file grouped_data_view.inc.

◆ $resizable

GroupedDataListView::$resizable = true

Definition at line 131 of file grouped_data_view.inc.

◆ $rowId

GroupedDataListView::$rowId = false

Definition at line 118 of file grouped_data_view.inc.

◆ $rowIdFormat

GroupedDataListView::$rowIdFormat = null

Optionally specify a custom row ID format.

Definition at line 119 of file grouped_data_view.inc.

◆ $scrollable

GroupedDataListView::$scrollable = false

Definition at line 130 of file grouped_data_view.inc.

◆ $selectable

GroupedDataListView::$selectable = false

Whether the table provides a selection mechanism.

Definition at line 116 of file grouped_data_view.inc.

◆ $showSelectAll

GroupedDataListView::$showSelectAll = true

Show Select All buttons for selectable tables.

Definition at line 117 of file grouped_data_view.inc.

◆ $summary

GroupedDataListView::$summary

Human-readable summary of the information contained in the table (for usability/accessiblity purposes)

Definition at line 115 of file grouped_data_view.inc.

◆ $tagRowCallbacks

GroupedDataListView::$tagRowCallbacks = array()

Array of callbacks for adding extra attributes to each row.

Definition at line 126 of file grouped_data_view.inc.

◆ $totalCallbacks

GroupedDataListView::$totalCallbacks = array()

Definition at line 121 of file grouped_data_view.inc.

The documentation for this class was generated from the following file:

C:/code/cms.sonjara.com/framework/grouped_data_view.inc

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ addFacetTaggingHandler()

◆ autoGroup()

◆ autoPopulate()

◆ column()

◆ commandMenu()

◆ drawSubFooterColumns()

◆ drawView()

◆ drawViewToString()

◆ exportColumn()

◆ footerText()

◆ footerTotal()

◆ footerValue()

◆ format()

◆ formatRowId()

◆ getExcelLink()

◆ getFooterColumnFormatting()

◆ getID()

◆ group()

◆ groupBy()

◆ GroupedDataListView()

◆ groupFooterText()

◆ groupFooterTotal()

◆ scrollable()

◆ selector()

◆ setID()

◆ writeExcelFile()

◆ writeScript()

Member Data Documentation

◆ $columns

◆ $commandMenuIcon

◆ $cssClass

◆ $cssStyle

◆ $emptyMessage

◆ $excelFile

◆ $footerColumns

◆ $groupAsWorksheets

◆ $groupClass

◆ $groupFooterColumns

◆ $groups

◆ $height

◆ $hideExcelIcon

◆ $id

◆ $items

◆ $menu

◆ $mode

◆ $onDrawFooter

◆ $onStartRow

◆ $resizable

◆ $rowId

◆ $rowIdFormat

◆ $scrollable

◆ $selectable

◆ $showSelectAll

◆ $summary

◆ $tagRowCallbacks

◆ $totalCallbacks