PivotTableHelper Class Reference

The PivotTableHelper class provides support for configuring display tables (DataListViews and GroupedDataListViews) dynamically, based upon the structure of a pivot query. More...

Public Member Functions
	__construct ($pivot, $table)
	Creates a new PivotTableHelper. More...
	column ($pattern, $format, $sortable=true, $style="", $typeHint=null, $onExport=null, $sortFormat=null, $footerTotal=false)
	Adds a column specification. More...
	create ()
	Adds columns to the table based on the column specifications that have been provided. More...

Public Attributes
	$pivot
	$table
	$columnSpecs = array()

Detailed Description

The PivotTableHelper class provides support for configuring display tables (DataListViews and GroupedDataListViews) dynamically, based upon the structure of a pivot query.

Author

Andy Green

Definition at line 631 of file pivot.inc.

Constructor & Destructor Documentation

__construct()

PivotTableHelper::__construct	(		$pivot,
			$table
	)

Creates a new PivotTableHelper.

Parameters

object	$pivot	the source PivotQuery or GroupedPivotQuery
object	$table	the target DataListView or GroupedDataListView

Definition at line 643 of file pivot.inc.

     {
          $this->pivot = $pivot;
          $this->table = $table;
     }

Member Function Documentation

column()

PivotTableHelper::column	(		$pattern,
			$format,
			$sortable = true,
			$style = "",
			$typeHint = null,
			$onExport = null,
			$sortFormat = null,
			$footerTotal = false
	)

Adds a column specification.

Column specifications match fields by regular expression and provide the output format, styles and hints for the generated columns.

Parameters

string	$pattern	The field matching pattern
string	$format	The output format template
boolean	$sortable	Whether the column is sortable (optional)
string	$style	CSS styles for the column (optional)
string	$typeHint	Type hint for the column (optional)
string	$onExport	Data export callback for the column (optional)
string	$sortFormat	sorting format for the column (optional)

Returns

PivotTableHelper

Definition at line 661 of file pivot.inc.

     {
          $this->columnSpecs[$pattern] = array("format" => $format, "sortable" => $sortable, "style" => $style, 
                                                        "typeHint" => $typeHint, "onExport" => $onExport, "sortFormat" => $sortFormat, 
                                                        "footerTotal" => $footerTotal);
          return $this;
     }

create()

PivotTableHelper::create

(

)

Adds columns to the table based on the column specifications that have been provided.

Definition at line 672 of file pivot.inc.

     {
          $item = $this->pivot->createPivotItem();
          
          $fields = $item->getFields();
          
          foreach($fields as $field => $type)
          {
               foreach($this->columnSpecs as $spec => $details)
               {
                    $matches = array();
                    if (preg_match("/{$spec}/", $field, $matches))
                    {
                         $format = str_replace("%FIELD%", $field, $details["format"]);
                         
                         if ($matches[1]) $format = str_replace("%KEY%", $matches[1], $format);
                         
                         $this->table->column($item->prettifyFieldName($field), $format, $details["sortable"], $details["style"], 
                                                   $details["typeHint"], $details["onExport"], $details["sortFormat"]);
                         if ($details["footerTotal"])
                         {
                              $this->table->footerTotal($format);
                         }
                         break;
                    }
               }
          }
     }

Member Data Documentation

$columnSpecs

PivotTableHelper::$columnSpecs = array()

Definition at line 636 of file pivot.inc.

$pivot

PivotTableHelper::$pivot

Definition at line 633 of file pivot.inc.

$table

PivotTableHelper::$table

Definition at line 634 of file pivot.inc.

---

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

• C:/code/cms.sonjara.com/framework/pivot.inc