Classes
class	DataListView
	DataListView displays a list of DataItems (or InnerJoinResults) in tabular format. More...

class	FileNode

class	FolderNode

class	DirectoryTreeControl

class	DraggableList
	DraggableList provides a simple user interface for sorting a list of items. More...

class	ExcelFileWriter
	ExcelFileWriter is an abstract factory to allow different Excel libraries to be used at the programmer's preference. More...

interface	IExcelFile
	Minimum base interface that must be provided by an ExcelFile implementation. More...

class	ExcelFile
	Generate a binary format Microsoft Excel file for download. More...

class	ExpandingList
	The ExpandingList class provides a simple User Interface control to allow the display of list items by heading. More...

interface	FacetFilterable

class	AbstractFacetFilter

class	FacetManager

class	PanelFacetManager

class	FieldFacetFilter

class	ExpressionFacetFilter

class	MultiSelectFacetFilter

class	CrossReferenceFacetFilter

class	CheckListFacetFilter

class	DataGroup
	Represents a grouped collection of data within a table. More...

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

class	GroupedListGroup
	Represents a grouped collection of data within a table. More...

class	GroupedList

class	PagedList
	The PagedList class provides a simple User Interface control to allow pagination of HTML lists of DataItems. More...

class	ServerPagedList
	ServerPagedList provides the same interface and functionality as PagedList, with the difference that paging is handled at the server. More...

class	StatusTrees

class	StatusBlockView

class	TreeNode
	TreeNode represents a node in the tree. More...

class	TreeControl
	The TreeControl provides a class that can be used to generate dynamic tree controls for use in PHP forms (or pages). More...

Functions
	DataListView::DataListView ($items, $id, $cssClass="list", $sortable=true, $pageSize=0, $filter=false)
	Creates a new DataListView object. More...

	DataListView::getID ()

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

	DataListView::enableDragReorder ($handler)
	Turns on drag & drop item reordering for the table. More...

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

	DataListView::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...

	DataListView::setColumnOrder ($order)
	Override the column order. More...

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

	DataListView::formatRowId ($item)

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

	DataListView::contextMenu ()
	Adds a right-click context menu to the table that can contain a list of operations that can be performed on subselections of the table's contents. More...

	DataListView::addToolbarCallback ($callback)
	Registers a toolbar callback. More...

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

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

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

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

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

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

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

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

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

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

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

	FileNode::FileNode ($id, $title, $value)

	FileNode::calculateOpenState ()

	FileNode::writeHTML ()

	FolderNode::FolderNode ($id, $title, $value="", $checked=false, $closedStyle="tree_node_closed", $openStyle="tree_node_open", $leafStyle="tree_node_plain")

	FolderNode::writeHTML ()

	FolderNode::add (&$n)

	FolderNode::calculateOpenState ()

	DirectoryTreeControl::DirectoryTreeControl ($id, $title="", $showFiles=true, $style="tree", $scroll=true, $width=500, $height=400)

	DirectoryTreeControl::buildFolderTree ($folder, $base)

	DirectoryTreeControl::_buildFolderTreeAux ($folder, $base)

	DirectoryTreeControl::addFiles ($folder, $base, $filter=null)

	DirectoryTreeControl::writeScript ()

	DirectoryTreeControl::writeHTML ()

	DirectoryTreeControl::getIcon ($file)

	DirectoryTreeControl::add (&$n)

	DirectoryTreeControl::findFolder ($path)

&	DirectoryTreeControl::findNode ($path)

	PagedList::PagedList ($items, $id="paged_list", $format=null)
	Creates a new PagedList control. More...

	PagedList::getID ()

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

	PagedList::writeScript ()

	PagedList::drawList ()

	PagedList::formatIdTag ($item)

	PagedList::drawListToString ()
	Helpful utility function - generates the list HTML in an output buffer and returns the string representation. More...

	ServerPagedList::__construct ($items, $id="paged_list", $format=null)

	ServerPagedList::writeScript ()

	ServerPagedList::drawList ()

	ServerPagedList::formatIdTag ($item)

Variables
	DataListView::$columns
	The column definitions for the table. More...

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

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

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

	DataListView::$sortable
	Specifies whether to enable client-side sorting for this table. More...

	DataListView::$pageSize
	Specifies the number of items per page - set to zero for unpaginated. More...

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

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

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

	DataListView::$onDrawfooter
	Callback hook that gets called after all rows have been drawn. More...

	DataListView::$tagRowCallbacks
	Array of callbacks for adding extra attributes to each row. More...

	DataListView::$totalCallbacks
	Array of callbacks for totalling columns. More...

	DataListView::$filter
	Specifies whether to enable client-side filtering for this table. More...

	DataListView::$excelFile
	Filename for automatic Excel export. More...

	DataListView::$paginate = true
	Specifies whether table should be paginated (false for view only pages) More...

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

	DataListView::$zebra
	Specifies whether alternate rows in the table should be striped. More...

	DataListView::$height

	DataListView::$scrollable = false

	DataListView::$resizable = true

	DataListView::$rowId = false
	whether to include an id tag for each tr row More...

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

	DataListView::$dragReorder = false
	Enabled drag & drop reordering. More...

	DataListView::$reorderHandler = null
	Handler script that implements reordering records. More...

	DataListView::$dragColumnReorder = false
	Enable drag & drop column reordering and show/hide capabilities. More...

	DataListView::$columnReorderCallback = null
	Javascript callback function that is triggered when columns are reordered. More...

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

	DataListView::$onRowClick = null
	Javascript callback function that is triggered with a row is clicked. More...

	DataListView::$onRowHover = null
	Javascript callback function that is triggered with a row is hovered over. More...

	DataListView::$dragText = ""
	Optional text to display above reorderable table. More...

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

	DataListView::$showSelectAll = false
	Show Select All button for selectable tables. More...

	DataListView::$menu = null
	Command menu for selection-based operations. More...

	DataListView::$contextMenu = null
	Right-click context menu for selection based operations. More...

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

	DataListView::$toolbarCallbacks = array()
	Override this callback to add toolbar links into the first header cell. More...

static	DataListView::$includesWritten = false

	$_writtenDirectoryTreeControlScript = false

	FileNode::$id

	FileNode::$title

	FileNode::$value

	FolderNode::$children = array()

	FolderNode::$id

	FolderNode::$title

	FolderNode::$value

	FolderNode::$checked

	FolderNode::$closedStyle

	FolderNode::$openStyle

	FolderNode::$open

	DirectoryTreeControl::$id

	DirectoryTreeControl::$title

	DirectoryTreeControl::$style

	DirectoryTreeControl::$scroll

	DirectoryTreeControl::$width

	DirectoryTreeControl::$height

	DirectoryTreeControl::$showFiles = true

	DirectoryTreeControl::$selectedValue

	DirectoryTreeControl::$multiSelect = false

	DirectoryTreeControl::$selectMode = "folder"

	DirectoryTreeControl::$children

	DirectoryTreeControl::$images

	DirectoryTreeControl::$icons

	PagedList::$items
	The items to be displayed in the list. More...

	PagedList::$id
	The HTML id of the list. More...

	PagedList::$format
	The formatter used to display the list items (either a format string or a callback function or method) More...

	PagedList::$pageSize = 10
	The number of items per page. More...

	PagedList::$listTag = "ul"
	The HTML list tag type. More...

	PagedList::$CSSclass = null
	CSS class(es) to be applied to the list. More...

	PagedList::$styles = null
	Specific CSS styles to be applied to the list. More...

	PagedList::$emptyList = "No items in the list"
	Message to display when the list is empty. More...

	PagedList::$paginate = true
	Specifies whether list should be paginated (false for view only pages) More...

	PagedList::$writeIdTag = false
	whether to include an id tag for each li item More...

	PagedList::$tagRowCallbacks
	Array of callbacks for adding extra attributes to each row. More...

	PagedList::$onStartRow
	Callback for setting the CSS class / visibility of each item in the list. More...

	PagedList::$displayMode = "list-item"
	CSS display type for visible items. More...

	ServerPagedList::$items

	ServerPagedList::$id

	ServerPagedList::$format

	ServerPagedList::$pageSize = 10
	The number of items per page. More...

	ServerPagedList::$listTag = "ul"
	The HTML list tag type. More...

	ServerPagedList::$CSSclass = null
	CSS class(es) to be applied to the list. More...

	ServerPagedList::$styles = null
	Specific CSS styles to be applied to the list. More...

	ServerPagedList::$emptyList = "No items in the list"
	Message to display when the list is empty. More...

	ServerPagedList::$paginate = true
	Specifies whether list should be paginated. More...

	ServerPagedList::$page = -1

	ServerPagedList::$writeIdTag = false
	whether to include an id tag for each li item More...

	$_writtenTreeControlScript = false
	This file provides a class-based API for generating expanding tree controls. More...

	$_activeTree = null
	Global reference to currently drawing tree instance. More...

Detailed Description

Function Documentation

◆ __construct()

ServerPagedList::__construct	(	$items,
		$id = `"paged_list"`,
		$format = `null`
	)

Definition at line 214 of file paged_list.inc.

      {
           $this->items = $items;
           $this->id = $id;
           $this->format = $format;
      }

◆ _buildFolderTreeAux()

DirectoryTreeControl::_buildFolderTreeAux	(	$folder,
		$base
	)

Definition at line 287 of file directory_tree.inc.

      {
           $f = $base . DIRECTORY_SEPARATOR . $folder;
           trace("Directory tree: buildFolderTreeAux f $f", 3);
           $dir = opendir($f);
      
           $id = $this->id."_".str_replace(DIRECTORY_SEPARATOR, "_", $folder);
           if ($this->permissionCallback && !call_user_func($this->permissionCallback, $folder)) return null;
           
           $node = new FolderNode($id, basename($folder), $folder);
           while( $directory = readdir($dir))
           {
                if ($directory == "." || $directory == "..") continue;
                
                if (is_dir($base . DIRECTORY_SEPARATOR . $folder . DIRECTORY_SEPARATOR . $directory))
                {                   
                     $node->add($this->_buildFolderTreeAux($folder . DIRECTORY_SEPARATOR . $directory, $base));
                }
           }
           
           closedir($dir);
           $this->folders[$folder] = $node;
           
           return $node;
      }

◆ add() [1/2]

FolderNode::add ( & $n )

Definition at line 190 of file directory_tree.inc.

      {
           if (!$n) return;
           
           trace($this->id." adding ".$n->id, 3);
           if (is_array($n))
           {
                for($i = 0; $i < count($n); ++$i)
                {
                     $this->children[$n[$i]->title] = $n[$i];
                }
           }
           else
           {
                $this->children[$n->title] = $n;
           }
      }

◆ add() [2/2]

DirectoryTreeControl::add ( & $n )

Definition at line 452 of file directory_tree.inc.

      {
           trace($this->id." adding ".$n->id, 3);
           if (is_array($n))
           {
                for($i = 0; $i < count($n); ++$i)
                {
                     $this->children[$n[$i]->title] = &$n[$i];
                }
           }
           else
           {
                $this->children[$n->title] =& $n;
           }
      }

◆ addFacetTaggingHandler() [1/2]

DataListView::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.

Implements FacetFilterable.

Definition at line 376 of file data_view.inc.

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

◆ addFacetTaggingHandler() [2/2]

PagedList::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.

Implements FacetFilterable.

Definition at line 82 of file paged_list.inc.

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

◆ addFiles()

DirectoryTreeControl::addFiles	(	$folder,
		$base,
		$filter = `null`
	)

Definition at line 313 of file directory_tree.inc.

      {
           $f = $base . DIRECTORY_SEPARATOR . $folder;
           $dir = opendir($f);
      
           $id = str_replace(DIRECTORY_SEPARATOR, "_", $folder);
           if ($this->permissionCallback && !call_user_func($this->permissionCallback, $folder)) return null;
           
           while( $file = readdir($dir))
           {
                if ($file == "." || $file == "..") continue;
                
                $f = $base . DIRECTORY_SEPARATOR . $folder . DIRECTORY_SEPARATOR . $file;
                if (is_dir($f))
                {
                     $this->addFiles($folder . DIRECTORY_SEPARATOR . $file, $base, $filter);
                }
                else if (is_file($f))
                {
                     if ($filter && !call_user_func($filter, $f))
                     {
                          continue;
                     }
                     
                     trace("$f", 3);
                     
                     $node = new FileNode($id . "_" . str_replace(".", "_", $file), $file, $folder . DIRECTORY_SEPARATOR . $file);
                     $this->findFolder($folder)->add($node);
                }
           }
      }

◆ addToolbarCallback()

DataListView::addToolbarCallback ( $callback )

Registers a toolbar callback.

These can be used to add custom controls into the first header cell of the table, next to the Excel export icon or command menu dropdown icon.

Parameters

callable $callback the callback function or method

Definition at line 308 of file data_view.inc.

      {
           $this->toolbarCallbacks[] = $callback;
      }

◆ autoPopulate()

DataListView::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 DataItem the item to use as a template for the columns.

Definition at line 395 of file 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);
           }
      }

◆ buildFolderTree()

DirectoryTreeControl::buildFolderTree	(	$folder,
		$base
	)

Definition at line 280 of file directory_tree.inc.

      {
           trace("Building Folder Tree: $folder, $base", 3);
           $root = $this->_buildFolderTreeAux($folder, $base);
           $this->children[$folder] = $root;
      } 

◆ calculateOpenState() [1/2]

FileNode::calculateOpenState ( )

Definition at line 54 of file directory_tree.inc.

      {
           return false;
      }

◆ calculateOpenState() [2/2]

FolderNode::calculateOpenState ( )

Definition at line 208 of file directory_tree.inc.

      {
           if ($this->open) return true;
           if ($this->checked)
           {
                $this->open = true;
                return true;
           }
           
           $c = count($this->children);
           
           foreach($this->children as $key => $child)
           {
                if ($child->calculateOpenState())
                {
                     $this->open = true;
                     return true;
                }
           }
           
           $this->open = false;
           return false;
      }

◆ column()

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

Adds a column definition to the DataListView.

Parameters

string	$title	the title of the column
string	$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.)
boolean	$sortable	whether this column is sortable
string	$style	any inline styles specific to this column
string	$typeHint	hint for cell type to use when exporting to Excel
callable	$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 178 of file data_view.inc.

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

◆ commandMenu()

DataListView::commandMenu ( )

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

A dropdown control is automatically attached to the top left of the table. If Excel exporting has been enabled, it will be added to the command menu.

Returns: ContextMenu

Definition at line 266 of file data_view.inc.

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

◆ contextMenu()

DataListView::contextMenu ( )

Adds a right-click context menu to the table that can contain a list of operations that can be performed on subselections of the table's contents.

If Excel exporting has been enabled, it will be added to the context menu.

Returns: ContextMenu

Definition at line 287 of file data_view.inc.

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

◆ DataListView()

DataListView::DataListView	(	$items,
		$id,
		$cssClass = `"list"`,
		$sortable = `true`,
		$pageSize = `0`,
		$filter = `false`
	)

Creates a new DataListView 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 114 of file data_view.inc.

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

◆ DirectoryTreeControl()

DirectoryTreeControl::DirectoryTreeControl	(	$id,
		$title = `""`,
		$showFiles = `true`,
		$style = `"tree"`,
		$scroll = `true`,
		$width = `500`,
		$height = `400`
	)

Definition at line 268 of file directory_tree.inc.

      {
           $this->id = $id;
           $this->title = $title;
           $this->style = $style;
           $this->scroll = $scroll;
           $this->width = $width;
           $this->height = $height;
           $this->showFiles = $showFiles;
      }

◆ drawList() [1/2]

PagedList::drawList ( )

Definition at line 105 of file paged_list.inc.

      {
           if (!count($this->items))
           {
                echo "<p>{$this->emptyList}</p>";
                return;
           }
           
           $attrs = "";
           if ($this->CSSclass) $attrs .= " class='{$this->CSSclass}'";
           if ($this->styles) $attrs .= " style='{$this->styles}'";
           if($this->paginate)
           {
 ?>
                <div style="float: right;" class="paginator">
                <ul id="<?echo $this->id?>_paginator"></ul>
                </div>
           <?php 
           }
           ?>
                <<?echo $this->listTag?> id="<?echo $this->id?>"<?echo $attrs?>>
 <?
           foreach($this->items as $item)
           {
                $css = "";
                
                
                if ($this->onStartRow)
                {
                     $css = call_user_func($this->onStartRow, $item);
                     if ($css === false) continue; // Skip this record if false returned
                }
  
                if ($css) $css = " class='$css'";
                
                if($this->writeIdTag)
                {
                     $idTag = "id='".$this->formatIdTag($item)."'";    
                }
                
                $dataAttrs = array();
                foreach($this->tagRowCallbacks as $cb)
                {
                     $dataAttrs = call_user_func($cb, $item, $dataAttrs);
                }
                
                $rowAttrs = "";
                foreach($dataAttrs as $name => $value)
                {
                     $rowAttrs .= " ".$name."='".$value."'";
                }
                
                echo "<li {$idTag}{$css}{$rowAttrs}>";
                
                if (is_callable($this->format))
                {
                     echo call_user_func($this->format, $item);
                }
                else echo $item->format($this->format);
                
                echo "</li>\n";
           }
           echo "</{$this->listTag}>\n";
      }

◆ drawList() [2/2]

ServerPagedList::drawList ( )

Definition at line 226 of file paged_list.inc.

      {
           if (!count($this->items))
           {
                echo "<p>{$this->emptyList}</p>";
                return;
           }
      
           if ($this->page == -1)
           {
                $this->page = checkNumeric($_GET["page"]);
                if (!$this->page) $this->page = 1;
           }
           
           if ($this->paginate)
           {
                $start = ($this->page - 1) * $this->pageSize;
                if ($start < 0) $start = 0;
                
                $end = $start + $this->pageSize;
                if ($end > count($this->items)) $end = count($this->items);
           }
           else
           {
                $start = 0;
                $end = count($this->items);
           }
           
           $attrs = "";
           if ($this->CSSclass) $attrs .= " class='{$this->CSSclass}'";
           if ($this->styles) $attrs .= " style='{$this->styles}'";
      
           if($this->paginate)
           {
  
                $prev = $this->page - 1;
                if ($prev < 1) $prev = 1;
                $next = $this->page + 1;
                $total = intval((count($this->items) - 1) / $this->pageSize + 1);
                if ($next > $total) $next = $total;
                ?>             
                     <div style="float: right;" class="paginator">
                     <ul id="<?echo $this->id?>_paginator">
                       <li><a href="?page=<?echo $prev?>" class="paginate"><span>&lt;&lt; Prev</span></a></li>
                       <li class="pager"><a href="#" class="goto-page">Page <?echo $this->page?> of <?echo $total?></a></li>
                       <li><a href="?page=<?echo $next?>" class="paginate"><span>Next &gt;&gt;</span></a></li>
                     </ul>
                     </div>
                <?php 
           }
                ?>
           <<?echo $this->listTag?> id="<?echo $this->id?>"<?echo $attrs?>>
 <?
           for($i = $start; $i < $end; ++$i)
           {
                $item = $this->items[$i];
                
                if($this->writeIdTag)
                {
                     $idTag = " id='".$this->formatIdTag($item)."'";   
                }
                
                echo "<li{$idTag}>";
                
                if (is_callable($this->format))
                {
                     echo call_user_func($this->format, $item);
                }
                else echo $item->format($this->format);
                
                echo "</li>\n";
           }
           echo "</{$this->listTag}>\n";
      }

◆ drawListToString()

PagedList::drawListToString ( )

Helpful utility function - generates the list HTML in an output buffer and returns the string representation.

This is useful for resolving issues in rendering order that can occur when working with facets.

Returns: string the HTML output for the list

Definition at line 182 of file paged_list.inc.

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

◆ drawView()

DataListView::drawView ( )

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

Definition at line 509 of file data_view.inc.

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

◆ drawViewToString()

DataListView::drawViewToString ( )

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

Returns: string the generated HTML for the table

Definition at line 823 of file data_view.inc.

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

◆ enableDragReorder()

DataListView::enableDragReorder ( $handler )

Turns on drag & drop item reordering for the table.

This feature disables sorting, paging and filtering for the table.

Parameters

string $handler URL of the handler script that processes the item reordering

Definition at line 153 of file data_view.inc.

      {
           $this->sortable = false;
           $this->filter = false;
           $this->pageSize = 0;
           $this->paginate = false;
           $this->dragReorder = true;
           $this->rowId = true;
           $this->zebra = false;
           
           $this->reorderHandler = $handler;
      }

◆ exportColumn()

DataListView::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

string	$title	the title of the column
string	$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.)
boolean	$sortable	whether this column is sortable
string	$style	any inline styles specific to this column
string	$typeHint	hint for cell type to use when exporting to Excel
callable	$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 198 of file data_view.inc.

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

◆ FileNode()

FileNode::FileNode	(	$id,
		$title,
		$value
	)

Definition at line 46 of file directory_tree.inc.

      {
           $this->id = $id;
           $this->title = $title;
           $this->value = $value;
      }

◆ findFolder()

DirectoryTreeControl::findFolder ( $path )

Definition at line 468 of file directory_tree.inc.

      {
           return $this->folders[$path];
      }

◆ findNode()

& DirectoryTreeControl::findNode ( $path )

Definition at line 473 of file directory_tree.inc.

      {
           trace("DirectoryTree:findNode($path)", 4);
           $elts = explode(DIRECTORY_SEPARATOR, $path);
           
           $node =& $this;
           
           foreach($elts as $elt)
           {
                $match = false;
                
                if (isset($node->children[$elt]))
                {
                     $node =& $node->children[$elt];
                }
                else return null;
           }
           
           if ($node === $this) $node = null;
           
           trace("Found Node: {$node->id}", 3);
           return $node;
      }

◆ FolderNode()

FolderNode::FolderNode	(	$id,
		$title,
		$value = `""`,
		$checked = `false`,
		$closedStyle = `"tree_node_closed"`,
		$openStyle = `"tree_node_open"`,
		$leafStyle = `"tree_node_plain"`
	)

Definition at line 82 of file directory_tree.inc.

      {
           $this->id          = $id;
           $this->title       = $title;
           $this->value       = $value;
           $this->checked     = $checked;
           $this->closedStyle = $closedStyle;
           $this->openStyle   = $openStyle;
           $this->leafStyle   = $leafStyle;
           $this->open        = false;
      }

◆ footerText()

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

Adds a text column to the table footer.

Parameters

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

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

Definition at line 320 of file data_view.inc.

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

◆ footerTotal()

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

Sums the total for a column.

Parameters

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

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

Definition at line 347 of file data_view.inc.

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

◆ footerValue()

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

Adds a value column to the table footer.

Parameters

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

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

Definition at line 333 of file data_view.inc.

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

◆ formatIdTag() [1/2]

PagedList::formatIdTag ( $item )

Definition at line 170 of file paged_list.inc.

      {
           $pk = $item->getPrimaryKey();
           return "{$pk}_{$item->get($pk)}";
      }

◆ formatIdTag() [2/2]

ServerPagedList::formatIdTag ( $item )

Definition at line 302 of file paged_list.inc.

      {
           $pk = $item->getPrimaryKey();
           return "{$pk}_{$item->get($pk)}";
      }

◆ formatRowId()

DataListView::formatRowId ( $item )

Definition at line 248 of file data_view.inc.

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

◆ getExcelLink()

DataListView::getExcelLink ( )

Get the Excel Link.

Definition at line 384 of file data_view.inc.

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

◆ getIcon()

DirectoryTreeControl::getIcon ( $file )

Definition at line 438 of file directory_tree.inc.

      {
           $ext = substr($file, strrpos($file, "."));
           $icon = $this->icons[$ext];
           trace("getIcon($file) $ext $icon", 4);
           
           if (!isset($icon))
           {
                $icon = $this->icons["default"];
           }
           
           return $icon;            
      }

◆ getID() [1/2]

DataListView::getID ( )

Implements FacetFilterable.

Definition at line 135 of file data_view.inc.

      {
           return $this->id;
      }

◆ getID() [2/2]

PagedList::getID ( )

Implements FacetFilterable.

Definition at line 73 of file paged_list.inc.

      {
           return $this->id;
      }

◆ PagedList()

PagedList::PagedList	(	$items,
		$id = `"paged_list"`,
		$format = `null`
	)

Creates a new PagedList control.

Parameters

array	$items	the array of DataItems to be displayed in the list
string	$id	the HTML id of the list
mixed	$format	The formatter used to display the list items (either a format string or a callback function or method)

Definition at line 65 of file paged_list.inc.

      {
           $this->items = $items;
           $this->id = $id;
           $this->format = $format;
           $this->tagRowCallbacks = array();
      }

◆ scrollable()

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

Definition at line 140 of file data_view.inc.

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

◆ selector()

DataListView::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

string $format (optional) format to use for the selector

Definition at line 230 of file data_view.inc.

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

◆ setColumnOrder()

DataListView::setColumnOrder ( $order )

Override the column order.

Parameters

array $order An array of column titles in the order they are to be displayed

Definition at line 210 of file data_view.inc.

      {
           $columnsByTitle = reindexList($this->columns, "title");
           $columns = array();
           foreach($order as $title)
           {
                if (array_key_exists($title, $columnsByTitle))
                {
                     $columns[] = $columnsByTitle[$title];
                }
           }
           
           $this->columns = $columns;
      }

◆ setID()

DataListView::setID ( $id = null )

Sets the client-side ID for this DataListView.

Parameters

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

Definition at line 360 of file data_view.inc.

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

◆ writeExcelFile()

DataListView::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 839 of file data_view.inc.

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

◆ writeHTML() [1/3]

FileNode::writeHTML ( )

Definition at line 59 of file directory_tree.inc.

      {
           $icon_image = $this->_tree->getIcon($this->title);
           $class = ($this->value == $this->_tree->selectedValue) ? "selected" : "file";
 ?>
           <div><img src="<?echo $this->_tree->images['toggle_blank']?>" align="absmiddle"><img src="<?echo $icon_image?>" align="absmiddle"><a id="<?echo $this->id?>_link" class="<?echo $class?>" href="javascript:DirectoryTree.selectItem('<?echo $this->_tree->id?>', '<?echo $this->id?>', '<?echo jsSafe($this->value)?>')" ondblclick="<?echo $this->_tree->id?>_onDoubleClick()"><?echo $this->title?></a></div>
 <?
      }

◆ writeHTML() [2/3]

FolderNode::writeHTML ( )

Definition at line 94 of file directory_tree.inc.

      {
           ksort($this->children);
           
           $c = count($this->children);
  
           if ($c == 0)
           {
                echo "<div class=\"{$this->leafStyle}\"><img src=\"{$this->_tree->images['toggle_blank']}\" align=\"absmiddle\"><img src=\"{$this->_tree->images['folder_closed']}\" align=\"absbottom\">";
                // Leaf node
                if ($this->value)
                {
                     if ($this->_tree->selectMode == "folder" || $this->_tree->selectMode = "both")
                     {
                          if ($this->_tree->multiSelect)
                          {
 ?>
                <input type="checkbox" class="checkbox" name="<? echo $this->id?>" value="<? echo $this->value?>"<? if ($this->checked) echo " checked";?>> <?echo $this->title?>
 <?
                          }
                          else
                          {
                               $class = ($this->value == $this->_tree->selectedValue) ? "selected" : "folder";
 ?>
                <a id="<?echo $this->id?>_link" class="<? echo $class?>" href="javascript:DirectoryTree.selectItem('<?echo $this->_tree->id?>', '<?echo $this->id?>', '<?echo jsSafe($this->value)?>')"><?echo $this->title?></a>
 <?
                          }
                     }
                     else
                     {
 ?>
                          <a id="<?echo $this->id?>_link" class="folder" href="" onclick="return false;"><?echo $this->title?></a>
 <?
                     }
                     
                }
           
                echo "</div>";
           }
           else
           {
                if ($this->open)
                {
                     $toggle = $this->_tree->images['toggle_open'];
                     $folder = $this->_tree->images['folder_open'];
                     $display = "block";
                }
                else
                {
                     $toggle = $this->_tree->images['toggle_closed'];
                     $folder = $this->_tree->images['folder_closed'];            
                     $display = "none";
                }
 ?>
           <div id='<?echo $this->id?>'><img id="<?echo $this->id?>_toggle" src="<?echo $toggle?>" align="absmiddle" onclick="DirectoryTree.toggleDirectoryFolder('<?echo $this->id?>')"><img id="<?echo $this->id?>_folder" align="absmiddle" src="<?echo $folder?>" onclick="DirectoryTree.toggleDirectoryFolder('<?echo $this->id?>')">
 <?
                if ($this->value)
                {
                     if ($this->_tree->selectMode == "folder" || $this->_tree->selectMode == "both")
                     {
                          if ($this->_tree->multiSelect)
                          {
 ?>
                     <input type="checkbox" class="checkbox" name="<? echo $this->id?>" value="<? echo $this->value?>"<? if ($this->checked) echo " checked";?>> <?echo $this->title?>
 <?
                          }
                          else
                          {
                               $class = ($this->value == $this->_tree->selectedValue) ? "selected" : "folder";
 ?>
                     <a id="<?echo $this->id?>_link" class="folder" href="javascript:DirectoryTree.selectItem('<?echo $this->_tree->id?>', '<?echo $this->id?>', '<?echo jsSafe($this->value)?>')"><?echo $this->title?></a>
 <?
                          }
                     }
                     else
                     {
 ?>
                          <a id="<?echo $this->id?>_link" class="folder" href="javascript:DirectoryTree.toggleDirectoryFolder('<?echo $this->id?>')"><?echo $this->title?></a>
 <?
                     }              }
 ?>
           </div>
           <div id='<?echo $this->id?>_contents' style='padding-left: 16px; display: <? echo $display?>'>
                
 <?             
                foreach($this->children as $key => $child)
                {
                     $child->_tree =& $this->_tree;
                     $child->writeHTML();
                }
 ?>
           </div>
 <?
           }
      }

◆ writeHTML() [3/3]

DirectoryTreeControl::writeHTML ( )

Definition at line 390 of file directory_tree.inc.

      {    
           $width = is_numeric($this->width) ? "{$this->width}px" : $this->width;
           $height = is_numeric($this->height) ? "{$this->height}px" : $this->height;
           //ksort($this->children);
           $this->writeScript();
 ?>
           <input type="hidden" name="<?echo $this->id?>_value" id="<?echo $this->id?>_value" value="<?echo $this->selectedValue?>"/>
           <input type="hidden" name="<?echo $this->id?>_node" id="<?echo $this->id?>_node" value=""/>
           <table id="<?echo $this->id?>" class="<? echo $this->style?>" style="width: <? echo $width?>;height: <?echo $height?>" cellpadding="0" cellspacing="0">
            <? 
            if ($this->title)
            {
            ?>        
            <tr>
             <th><? echo $this->title?></th>
            </tr>
            <?
            }
            ?>
            <tr>
             <td>
              <div style="margin: 0; padding: 0;width: 100%;height: <?echo $height?>;<?if ($this->scroll) echo "overflow: auto"?>">
 <?
           $c = count($this->children);
           foreach($this->children as $key => $child)
           {
                trace("Writing $key,{$child->title}", 3);
                try
                {
                     $child->_tree =& $this;
                     $child->calculateOpenState();
                     $child->writeHTML();
                }
                catch(Error $e)
                {
                     var_dump($child);
                     throw $e;
                }
           }
 ?>
              </div>
             </td>
            </tr>
           </table>
 <?
      }

◆ writeScript() [1/4]

DataListView::writeScript ( )

Write the Javascript to implement the table output.

Returns: string containing the required Javascript.

Definition at line 412 of file data_view.inc.

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

◆ writeScript() [2/4]

DirectoryTreeControl::writeScript ( )

Definition at line 345 of file directory_tree.inc.

      {
      // Event Hooks
 ?>
 <script type="text/javascript">
 function <?echo $this->id?>_onSelectItem(itemID, itemValue)
 {
 <? 
      if ($this->onSelectionChanged)
      {
 ?>
           <?echo $this->onSelectionChanged?>(itemID, itemValue);
 <?
      }
 ?>
 }
  
 function <?echo $this->id?>_onClearSelection()
 {
 <? 
      if ($this->onSelectionChanged)
      {
 ?>
           <? echo $this->onSelectionChanged?>(null, null);
 <?
      }
 ?>
 }
  
 function <?echo $this->id?>_onDoubleClick(itemID, itemValue)
 {
 <?
      if ($this->onDoubleClick)
      {
 ?>
           <? echo $this->onDoubleClick?>(itemID, itemValue);
 <?
      }
 ?>
 }
  
 </script>
 <?
      }

◆ writeScript() [3/4]

PagedList::writeScript ( )

Definition at line 87 of file paged_list.inc.

      {
           if(!$this->paginate && count($this->tagRowCallbacks) == 0) return "";
           
           ob_start();                   
 ?>
      <script type="text/javascript">
      window.addEvent('domready', function()
      {
           var <?echo $this->id?> = new PaginatingList('<?echo $this->id ?>', '<?echo $this->id?>_paginator', {per_page: <?echo $this->pageSize ?>, display_mode: '<?echo $this->displayMode?>'});
      });
      </script>
 <?
           $script = ob_get_contents();
           ob_end_clean();
           return $script;
      }

◆ writeScript() [4/4]

ServerPagedList::writeScript ( )

Definition at line 222 of file paged_list.inc.

223 {

224 }

Variable Documentation

◆ $_activeTree

$_activeTree = null

Global reference to currently drawing tree instance.

Definition at line 53 of file tree.inc.

◆ $_writtenDirectoryTreeControlScript

$_writtenDirectoryTreeControlScript = false

Definition at line 38 of file directory_tree.inc.

◆ $_writtenTreeControlScript

$_writtenTreeControlScript = false

This file provides a class-based API for generating expanding tree controls.

Global flag to indicate whether the implement Javascript for the tree control has been written yet for this page output.

Definition at line 48 of file tree.inc.

◆ $checked

FolderNode::$checked

Definition at line 77 of file directory_tree.inc.

◆ $children [1/2]

FolderNode::$children = array()

Definition at line 72 of file directory_tree.inc.

◆ $children [2/2]

DirectoryTreeControl::$children

Definition at line 247 of file directory_tree.inc.

◆ $closedStyle

FolderNode::$closedStyle

Definition at line 78 of file directory_tree.inc.

◆ $columnReorderCallback

DataListView::$columnReorderCallback = null

Javascript callback function that is triggered when columns are reordered.

Definition at line 88 of file data_view.inc.

◆ $columns

DataListView::$columns

The column definitions for the table.

Definition at line 57 of file data_view.inc.

◆ $commandMenuIcon

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

Icon to use for the command menu dropdown.

Definition at line 100 of file data_view.inc.

◆ $contextMenu

DataListView::$contextMenu = null

Right-click context menu for selection based operations.

Definition at line 99 of file data_view.inc.

◆ $cssClass

DataListView::$cssClass

Optional CSS class to apply to the table.

Definition at line 59 of file data_view.inc.

◆ $CSSclass [1/2]

PagedList::$CSSclass = null

CSS class(es) to be applied to the list.

Definition at line 50 of file paged_list.inc.

◆ $CSSclass [2/2]

ServerPagedList::$CSSclass = null

CSS class(es) to be applied to the list.

Definition at line 207 of file paged_list.inc.

◆ $cssStyle

DataListView::$cssStyle

Optional additional inline styles to apply to the table.

Definition at line 63 of file data_view.inc.

◆ $displayMode

PagedList::$displayMode = "list-item"

CSS display type for visible items.

Definition at line 57 of file paged_list.inc.

◆ $dragColumnReorder

DataListView::$dragColumnReorder = false

Enable drag & drop column reordering and show/hide capabilities.

Definition at line 87 of file data_view.inc.

◆ $dragReorder

DataListView::$dragReorder = false

Enabled drag & drop reordering.

Definition at line 85 of file data_view.inc.

◆ $dragText

DataListView::$dragText = ""

Optional text to display above reorderable table.

Definition at line 93 of file data_view.inc.

◆ $emptyList [1/2]

PagedList::$emptyList = "No items in the list"

Message to display when the list is empty.

Definition at line 52 of file paged_list.inc.

◆ $emptyList [2/2]

ServerPagedList::$emptyList = "No items in the list"

Message to display when the list is empty.

Definition at line 209 of file paged_list.inc.

◆ $emptyMessage

DataListView::$emptyMessage

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

Definition at line 64 of file data_view.inc.

◆ $excelFile

DataListView::$excelFile

Filename for automatic Excel export.

Definition at line 70 of file data_view.inc.

◆ $filter

DataListView::$filter

Specifies whether to enable client-side filtering for this table.

Definition at line 69 of file data_view.inc.

◆ $footerColumns

DataListView::$footerColumns

The footer column definitions for the table.

Definition at line 58 of file data_view.inc.

◆ $format [1/2]

PagedList::$format

The formatter used to display the list items (either a format string or a callback function or method)

Definition at line 47 of file paged_list.inc.

◆ $format [2/2]

ServerPagedList::$format

Definition at line 204 of file paged_list.inc.

◆ $height [1/2]

DataListView::$height

Definition at line 77 of file data_view.inc.

◆ $height [2/2]

DirectoryTreeControl::$height

Definition at line 241 of file directory_tree.inc.

◆ $hideExcelIcon

DataListView::$hideExcelIcon = false

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

Definition at line 89 of file data_view.inc.

◆ $icons

DirectoryTreeControl::$icons

Initial value:

= array(  ".doc"         =>   "/fakoli/images/msword_icon.png",
                              ".docx"        =>   "/fakoli/images/msword_icon.png",
                              ".xls"         =>   "/fakoli/images/msexcel_icon.png",
                              ".xlsx"        =>   "/fakoli/images/msexcel_icon.png",
                              ".pdf"         =>   "/fakoli/images/pdf_icon.png",
                              ".ppt"         =>   "/fakoli/images/ppt_icon.png",
                              ".pptx"        =>   "/fakoli/images/ppt_icon.png",
                              ".gif"         =>   "/fakoli/images/image_icon.png",
                              ".png"         =>   "/fakoli/images/image_icon.png",
                              ".jpg"         =>   "/fakoli/images/image_icon.png",
                              "default" =>   "/fakoli/images/file_icon.png")

Definition at line 255 of file directory_tree.inc.

◆ $id [1/6]

DataListView::$id

ID of the table in the output script.

Definition at line 60 of file data_view.inc.

◆ $id [2/6]

FileNode::$id

Definition at line 42 of file directory_tree.inc.

◆ $id [3/6]

FolderNode::$id

Definition at line 74 of file directory_tree.inc.

◆ $id [4/6]

DirectoryTreeControl::$id

Definition at line 236 of file directory_tree.inc.

◆ $id [5/6]

PagedList::$id

The HTML id of the list.

Definition at line 46 of file paged_list.inc.

◆ $id [6/6]

ServerPagedList::$id

Definition at line 203 of file paged_list.inc.

◆ $images

DirectoryTreeControl::$images

Initial value:

= array("toggle_open"    =>   "/fakoli/images/toggle_open.png",
                              "toggle_closed"     =>   "/fakoli/images/toggle_closed.png",
                              "toggle_blank"  =>  "/fakoli/images/toggle_blank.png",
                              "folder_open"  =>   "/fakoli/images/folder_open.png",
                              "folder_closed"     =>   "/fakoli/images/folder_closed.png",
                              "generic_file" =>   "/fakoli/images/file.png")

Definition at line 248 of file directory_tree.inc.

◆ $includesWritten

DataListView::$includesWritten = false

static

Definition at line 102 of file data_view.inc.

◆ $items [1/2]

PagedList::$items

The items to be displayed in the list.

Definition at line 45 of file paged_list.inc.

◆ $items [2/2]

ServerPagedList::$items

Definition at line 202 of file paged_list.inc.

◆ $listTag [1/2]

PagedList::$listTag = "ul"

The HTML list tag type.

Definition at line 49 of file paged_list.inc.

◆ $listTag [2/2]

ServerPagedList::$listTag = "ul"

The HTML list tag type.

Definition at line 206 of file paged_list.inc.

◆ $menu

DataListView::$menu = null

Command menu for selection-based operations.

Definition at line 98 of file data_view.inc.

◆ $multiSelect

DirectoryTreeControl::$multiSelect = false

Definition at line 244 of file directory_tree.inc.

◆ $onDrawfooter

DataListView::$onDrawfooter

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

Definition at line 66 of file data_view.inc.

◆ $onRowClick

DataListView::$onRowClick = null

Javascript callback function that is triggered with a row is clicked.

Definition at line 90 of file data_view.inc.

◆ $onRowHover

DataListView::$onRowHover = null

Javascript callback function that is triggered with a row is hovered over.

Definition at line 91 of file data_view.inc.

◆ $onStartRow [1/2]

DataListView::$onStartRow

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

Definition at line 65 of file data_view.inc.

◆ $onStartRow [2/2]

PagedList::$onStartRow

Callback for setting the CSS class / visibility of each item in the list.

Definition at line 56 of file paged_list.inc.

◆ $open

FolderNode::$open

Definition at line 80 of file directory_tree.inc.

◆ $openStyle

FolderNode::$openStyle

Definition at line 79 of file directory_tree.inc.

◆ $page

ServerPagedList::$page = -1

Definition at line 211 of file paged_list.inc.

◆ $pageSize [1/3]

DataListView::$pageSize

Specifies the number of items per page - set to zero for unpaginated.

Definition at line 62 of file data_view.inc.

◆ $pageSize [2/3]

PagedList::$pageSize = 10

The number of items per page.

Definition at line 48 of file paged_list.inc.

◆ $pageSize [3/3]

ServerPagedList::$pageSize = 10

The number of items per page.

Definition at line 205 of file paged_list.inc.

◆ $paginate [1/3]

DataListView::$paginate = true

Specifies whether table should be paginated (false for view only pages)

Definition at line 71 of file data_view.inc.

◆ $paginate [2/3]

PagedList::$paginate = true

Specifies whether list should be paginated (false for view only pages)

Definition at line 53 of file paged_list.inc.

◆ $paginate [3/3]

ServerPagedList::$paginate = true

Specifies whether list should be paginated.

Definition at line 210 of file paged_list.inc.

◆ $reorderHandler

DataListView::$reorderHandler = null

Handler script that implements reordering records.

Definition at line 86 of file data_view.inc.

◆ $resizable

DataListView::$resizable = true

Definition at line 79 of file data_view.inc.

◆ $rowId

DataListView::$rowId = false

whether to include an id tag for each tr row

Definition at line 83 of file data_view.inc.

◆ $rowIdFormat

DataListView::$rowIdFormat = null

Optionally specify a custom row ID format.

Definition at line 84 of file data_view.inc.

◆ $scroll

DirectoryTreeControl::$scroll

Definition at line 239 of file directory_tree.inc.

◆ $scrollable

DataListView::$scrollable = false

Definition at line 78 of file data_view.inc.

◆ $selectable

DataListView::$selectable = false

Whether the table provides a selection mechanism.

Definition at line 96 of file data_view.inc.

◆ $selectedValue

DirectoryTreeControl::$selectedValue

Definition at line 243 of file directory_tree.inc.

◆ $selectMode

DirectoryTreeControl::$selectMode = "folder"

Definition at line 245 of file directory_tree.inc.

◆ $showFiles

DirectoryTreeControl::$showFiles = true

Definition at line 242 of file directory_tree.inc.

◆ $showSelectAll

DataListView::$showSelectAll = false

Show Select All button for selectable tables.

Definition at line 97 of file data_view.inc.

◆ $sortable

DataListView::$sortable

Specifies whether to enable client-side sorting for this table.

Definition at line 61 of file data_view.inc.

◆ $style

DirectoryTreeControl::$style

Definition at line 238 of file directory_tree.inc.

◆ $styles [1/2]

PagedList::$styles = null

Specific CSS styles to be applied to the list.

Definition at line 51 of file paged_list.inc.

◆ $styles [2/2]

ServerPagedList::$styles = null

Specific CSS styles to be applied to the list.

Definition at line 208 of file paged_list.inc.

◆ $summary

DataListView::$summary

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

Definition at line 72 of file data_view.inc.

◆ $tagRowCallbacks [1/2]

DataListView::$tagRowCallbacks

Array of callbacks for adding extra attributes to each row.

Definition at line 67 of file data_view.inc.

◆ $tagRowCallbacks [2/2]

PagedList::$tagRowCallbacks

Array of callbacks for adding extra attributes to each row.

Definition at line 55 of file paged_list.inc.

◆ $title [1/3]

FileNode::$title

Definition at line 43 of file directory_tree.inc.

◆ $title [2/3]

FolderNode::$title

Definition at line 75 of file directory_tree.inc.

◆ $title [3/3]

DirectoryTreeControl::$title

Definition at line 237 of file directory_tree.inc.

◆ $toolbarCallbacks

DataListView::$toolbarCallbacks = array()

Override this callback to add toolbar links into the first header cell.

Definition at line 101 of file data_view.inc.

◆ $totalCallbacks

DataListView::$totalCallbacks

Array of callbacks for totalling columns.

Definition at line 68 of file data_view.inc.

◆ $value [1/2]

FileNode::$value

Definition at line 44 of file directory_tree.inc.

◆ $value [2/2]

FolderNode::$value

Definition at line 76 of file directory_tree.inc.

◆ $width

DirectoryTreeControl::$width

Definition at line 240 of file directory_tree.inc.

◆ $writeIdTag [1/2]

PagedList::$writeIdTag = false

whether to include an id tag for each li item

Definition at line 54 of file paged_list.inc.

◆ $writeIdTag [2/2]

ServerPagedList::$writeIdTag = false

whether to include an id tag for each li item

Definition at line 212 of file paged_list.inc.

◆ $zebra

DataListView::$zebra

Specifies whether alternate rows in the table should be striped.

Definition at line 73 of file data_view.inc.

Classes

Functions

Variables

Detailed Description

Function Documentation

◆ __construct()

◆ _buildFolderTreeAux()

◆ add() [1/2]

◆ add() [2/2]

◆ addFacetTaggingHandler() [1/2]

◆ addFacetTaggingHandler() [2/2]

◆ addFiles()

◆ addToolbarCallback()

◆ autoPopulate()

◆ buildFolderTree()

◆ calculateOpenState() [1/2]

◆ calculateOpenState() [2/2]

◆ column()

◆ commandMenu()

◆ contextMenu()

◆ DataListView()

◆ DirectoryTreeControl()

◆ drawList() [1/2]

◆ drawList() [2/2]

◆ drawListToString()

◆ drawView()

◆ drawViewToString()

◆ enableDragReorder()

◆ exportColumn()

◆ FileNode()

◆ findFolder()

◆ findNode()

◆ FolderNode()

◆ footerText()

◆ footerTotal()

◆ footerValue()

◆ formatIdTag() [1/2]

◆ formatIdTag() [2/2]

◆ formatRowId()

◆ getExcelLink()

◆ getIcon()

◆ getID() [1/2]

◆ getID() [2/2]

◆ PagedList()

◆ scrollable()

◆ selector()

◆ setColumnOrder()

◆ setID()

◆ writeExcelFile()

◆ writeHTML() [1/3]

◆ writeHTML() [2/3]

◆ writeHTML() [3/3]

◆ writeScript() [1/4]

◆ writeScript() [2/4]

◆ writeScript() [3/4]

◆ writeScript() [4/4]

Variable Documentation

◆ $_activeTree

◆ $_writtenDirectoryTreeControlScript

◆ $_writtenTreeControlScript

◆ $checked

◆ $children [1/2]

◆ $children [2/2]

◆ $closedStyle

◆ $columnReorderCallback

◆ $columns

◆ $commandMenuIcon

◆ $contextMenu

◆ $cssClass

◆ $CSSclass [1/2]

◆ $CSSclass [2/2]

◆ $cssStyle

◆ $displayMode

◆ $dragColumnReorder

◆ $dragReorder

◆ $dragText

◆ $emptyList [1/2]

◆ $emptyList [2/2]

◆ $emptyMessage

◆ $excelFile