ReportTable Class Reference

Public Member Functions
	__construct ($class, $title="", $request=null, $outputFilter=false)
	__sleep ()
	__wakeup ()
	load ($request)
	getFields ()
	column ($title, $format, $sortable=true, $style="", $type=null, $outputFields=null)
	excludeKeyFromJoin ($key)
	getTitle ()
	searchFields ()
	favoriteColumns ()
	additionalConstraints ($constraint)
	getConstraint ($first, $request)
	configureForm ($configurator=null)
	footerText ($text="", $style="")
	Adds a text column to the table footer. More...
	footerValue ($title, $callback, $style="")
	Adds a value column to the table footer. More...
	footerTotal ($title, $field, $style="text-align: right")
	Sums the total for a column. More...
	createJoin ($mgr)
	filterOutput ($mgr, $class)
	createColumns ($mgr, $report)

Public Attributes
	$class
	$proto
	$fields
	$title
	$form
	$constraints
	$params
	$help
	$excludedKeys
	$columns = array()
	$footerColumns = array()
	$totalCallbacks = array()
	$outputFilter = null

Detailed Description

Definition at line 528 of file report_manager.inc.

Constructor & Destructor Documentation

__construct()

ReportTable::__construct	(		$class,
			$title = "",
			$request = null,
			$outputFilter = false
	)

Definition at line 544 of file report_manager.inc.

     {
          $this->class = $class;
          $this->proto = new $class;
          
          if ($outputFilter) 
          {
               $this->outputFilter = new InclusionFilter();
               $this->outputFilter->add($this->proto->getPrimaryKey());
          }
          
          $this->fields = array();
          $this->title = $title ? $title : $this->proto->prettifyClassName();
          $this->constraints = $constraints;
          
          if ($request) $this->proto->fromDataSet($request);
          
          $this->form = new SearchForm($this->proto);
          $this->form->id = "custom_report";
          // JDG 2/2012 - set params here to allow additional parameters
          // to be set by the calling class
          $this->params = $this->form->params; //new SearchParameters($this->proto);
          
          $this->excludedKeys = array();
          $this->help = "";
     }

Member Function Documentation

__sleep()

ReportTable::__sleep

(

)

Definition at line 573 of file report_manager.inc.

     {
          return array('class', 'fields', 'title', 'constraints', 'params', 'excludedKeys', 'columns', 'footerColumns', 'totalCallbacks');  
     }

__wakeup()

ReportTable::__wakeup

(

)

Definition at line 578 of file report_manager.inc.

     {
          $this->proto = new $this->class;
          $this->form = new SearchForm($this->proto);
     }

additionalConstraints()

ReportTable::additionalConstraints

(

$constraint

)

Definition at line 650 of file report_manager.inc.

     {
          $this->constraints = $constraint;
          
          return $this;
     }

column()

ReportTable::column	(		$title,
			$format,
			$sortable = true,
			$style = "",
			$type = null,
			$outputFields = null
	)

Definition at line 598 of file report_manager.inc.

     {
          $this->columns[] = new ReportColumn($title, $format, $sortable, $style, $type, $outputFields);
               
          return $this;
     }

configureForm()

ReportTable::configureForm

(

$configurator = null

)

Definition at line 677 of file report_manager.inc.

     {
          if ($configurator) $configurator($this->form);
     }

createColumns()

ReportTable::createColumns	(		$mgr,
			$report
	)

Definition at line 757 of file report_manager.inc.

     {
          foreach($this->columns as $column)
          {
               if ($mgr->isColumnSelected($column))
               {
                    $report->column($column->title, $column->format, $column->sortable, $column->style, $column->type);
                    
                    if(array_key_exists($column->title, $this->footerColumns))
                    {
                         $footer = $this->footerColumns[$column->title];
                         $report->footerColumns[] = $footer;
                         if(get_class($footer) == FooterTotalColumn)
                         {
                              $report->totalCallbacks[] = array($footer, onStartRow);
                         }
                    }
                    else 
                    {
                         $report->footerColumns[] = new FooterTextColumn(" ");
                    }
               }
          }         
     }

createJoin()

ReportTable::createJoin

(

$mgr

)

Definition at line 727 of file report_manager.inc.

     {
          $mgr->join->add($this->class);
          $this->filterOutput($mgr, $this->class);
          
          foreach($this->excludedKeys as $excluded)
          {
               $mgr->join->excludeKeyFromJoin($this->class, $excluded);
          }
     }

excludeKeyFromJoin()

ReportTable::excludeKeyFromJoin

(

$key

)

Definition at line 605 of file report_manager.inc.

     {
          $this->excludedKeys[] = $key;
          return $this;
     }

favoriteColumns()

ReportTable::favoriteColumns

(

)

Definition at line 635 of file report_manager.inc.

     {
          $args = func_get_args();
          $favorites = array_combine($args, $args);
          foreach($this->columns as $column)
          {
               if (array_key_exists($column->title, $favorites))
               {
                    $column->favorite = true;
               }
          }    
          
          return $this;
     }

filterOutput()

ReportTable::filterOutput	(		$mgr,
			$class
	)

Definition at line 738 of file report_manager.inc.

     {
          if ($this->outputFilter)
          {
               foreach($this->columns as $column)
               {
                    if ($mgr->isColumnSelected($column) && is_array($column->outputFields))
                    {
                         foreach($column->outputFields as $field)
                         {
                              $this->outputFilter->add($field);
                         }
                    }
               }
          
               $mgr->join->setFilter($class, $this->outputFilter);
          }
     }

footerText()

ReportTable::footerText	(		$text = "",
			$style = ""
	)

Adds a text column to the table footer.

Parameters

$title	the title of the columnn under which the footer value should be displayed
$text	the text to display
$style	any CSS classes or inline styles to apply

Returns

ReportManager returns the current instance, allowing function call chaining for the column definitions.

Definition at line 689 of file report_manager.inc.

     {
          $column = new ReportFooterColumn($title, $text, "", $style);
          $this->footerColumns[$title] = $column;
          
          return $column;
     }

footerTotal()

ReportTable::footerTotal	(		$title,
			$field,
			$style = "text-align: right"
	)

Sums the total for a column.

Parameters

$title	the title of the columnn under which the footer value should be displayed
$field	the field to total in the format "{field}"
$style	any CSS classes or inline styles to apply

Returns

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

Definition at line 719 of file report_manager.inc.

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

footerValue()

ReportTable::footerValue	(		$title,
			$callback,
			$style = ""
	)

Adds a value column to the table footer.

Parameters

$title	the title of the columnn under which the footer value should be displayed
$callback	Callback function or object method used to calculate the value for this column.
$style	any CSS classes or inline styles to apply

Returns

ReportManager returns the current instance, allowing function call chaining for the column definitions.

Definition at line 704 of file report_manager.inc.

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

getConstraint()

ReportTable::getConstraint	(		$first,
			$request
	)

Definition at line 657 of file report_manager.inc.

     {
          $this->params->fromArray($request);
          $constraint = $this->params->generateConstraint($first);
          
          if ($this->constraints)
          {
               if ($constraint)
               {
                    $constraint .= " AND $constraint";
               }
               else
               {
                    $constraint .= ($first ? "WHERE " : " AND ").$this->constraints;
               }
          }
          
          return $constraint;
     }

getFields()

ReportTable::getFields

(

)

Definition at line 594 of file report_manager.inc.

{ return $this->fields; }

getTitle()

ReportTable::getTitle

(

)

Definition at line 611 of file report_manager.inc.

     {
          return $this->title;
     }

load()

ReportTable::load

(

$request

)

Definition at line 584 of file report_manager.inc.

     {         
          if ($request) 
          {
               $this->proto->fromDataSet($request);
               $this->params->fromArray($request);
               $this->form->params->fromArray($request);
          }
     }

searchFields()

ReportTable::searchFields

(

)

Definition at line 616 of file report_manager.inc.

     {
          $filter = new InclusionFilter();
          for($i = 0; $i < func_num_args(); ++$i)
          {
               // JDG 2/2012 - putting func_get_arg inside the explode crashes for me if not
               $fieldMode = func_get_arg($i);
               list($field, $searchMode) = explode(":", $fieldMode);
               $filter->add($field);
               if ($searchMode)
               {
                    $this->form->setMatchingMode($searchMode, $field);
               }
          }
          
          $this->proto->filter = $filter;
          return $this;
     }

Member Data Documentation

$class

ReportTable::$class

Definition at line 530 of file report_manager.inc.

$columns

ReportTable::$columns = array()

Definition at line 539 of file report_manager.inc.

$constraints

ReportTable::$constraints

Definition at line 535 of file report_manager.inc.

$excludedKeys

ReportTable::$excludedKeys

Definition at line 538 of file report_manager.inc.

$fields

ReportTable::$fields

Definition at line 532 of file report_manager.inc.

$footerColumns

ReportTable::$footerColumns = array()

Definition at line 540 of file report_manager.inc.

$form

ReportTable::$form

Definition at line 534 of file report_manager.inc.

$help

ReportTable::$help

Definition at line 537 of file report_manager.inc.

$outputFilter

ReportTable::$outputFilter = null

Definition at line 542 of file report_manager.inc.

$params

ReportTable::$params

Definition at line 536 of file report_manager.inc.

$proto

ReportTable::$proto

Definition at line 531 of file report_manager.inc.

$title

ReportTable::$title

Definition at line 533 of file report_manager.inc.

$totalCallbacks

ReportTable::$totalCallbacks = array()

Definition at line 541 of file report_manager.inc.

---

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

• C:/code/cms.sonjara.com/cms/components/report_manager/report_manager.inc