ReportManager provides a generic mechanism for implementing user configurable reports based on DataItem classes. More...

Public Member Functions
	ReportManager ()
	Creates a new ReportManager instance. More...

	__sleep ()
	Tidy up the request data and limit the fields returned when serializing a ReportManager. More...

	table ($class, $title="", $useOutputFilter=false)
	Add a table to the report. More...

	drawForm ()
	Draw the configuration/search form. More...

	getTable ($class)
	Retrieve the ReportTable object for the specified DataItem class. More...

	populateSelected ()

	setSelected ($table, $checkRequest=true)
	Set the given table as selected. More...

	generateConstraint ()
	Generate the search constraint for the current report configuration. More...

	generateReport ($inlineScript=false)

	isColumnSelected ($column)

	writeResultsFormButtons ($excel)

	preSaveReport ()
	Alternative implementation - presave version of report is stored in session with a. More...

	save ()

	fromRequest ()

Static Public Member Functions
static	deleteUser ($user)
	Respond to fired event DeleteUser. More...

static	load ($report_id, $mode="")

Public Attributes
	$report_id
	ID of the saved report as persisted in the database. More...

	$title
	Title of the report. More...

	$description
	Longer description of the report. More...

	$resultsPage = "custom_report_results"
	The page used to display the search results. More...

	$editorPage = "custom_report"
	The page used to display the report editor. More...

	$target
	The target window for the form results. More...

	$columnOrder
	Override the default column order. More...

	$tables

	$join

	$report

	$request

	$interstitialMessage = ""
	Optional interstitial message to display while report is being generated. More...

	$limit
	Optional limit to number of records retrieved, depending on acceptable load times for results. More...

Detailed Description

ReportManager provides a generic mechanism for implementing user configurable reports based on DataItem classes.

To use ReportManager:

1) create a component "report" in your application's components and create its manifest.inc file

2) create folder "pages" with a file for each type of report needed in the application with names such as "custom_xx_report" (e.g., custom_program_report)

3) The page or pages should contain this code:

Fakoli::using("report");

$report = new XXReportManager();

if ($method == "POST" || isset($_REQUEST["__excel"])) { $report->generateReport(); } else { $report->drawForm(); }

4) On the top level in the report component, add a php file xx_report_manager.inc with the code:

class XXReportManager extends ReportManager { function XXReportManager() { $this->ReportManager();

$this->table(MyDataItemClass, "MyTitle")
->column("My Field Label", "{my_field}", true, "") ... ; } }

the same way you would create a DataListView Before closing the column list with the semicolon, you can also add search fields with the search mode (equal if not provided):

->searchFields("contact_id", "name:like")

For fields that have values in a related table, create a RelatedItemSelectFieldRenderer for the search filter Example:

new RelatedItemSelectFieldRenderer($this->getTable(Program)->form, "affiliation_id", "Primary Program Type", Affiliation, "ORDER BY sort_order, affiliation", "affiliation", "affiliation_id");

If the field has a set of options defined in the DataItem class, create SelectFieldRenderer. Example:

new SelectFieldRenderer($this->getTable(Program)->form, "residency_requirement", "Residency Requirement", Program::$residencyTypes);

If you need to search on a field that is not in the table but is instead in an xref table, such as the obj is linked to a set of states through a item_state_xref table, then create the RelatedItemSelectFieldRenderer but set an additional or custom callback parameter handler:

new RelatedItemSelectFieldRenderer($this->getTable(Program)->form, "state", "State", State, "ORDER BY name", "name", "state_id");

$this->getTable(Program)->params->setParam("state", "equal", $_REQUEST["state:equal"]); $this->getTable(Program)->params->setHandler("state", array(ProgramReportManager, getStateConstraint));

Author: andy

Definition at line 118 of file report_manager.inc.

Member Function Documentation

◆ __sleep()

ReportManager::__sleep ( )

Tidy up the request data and limit the fields returned when serializing a ReportManager.

Returns: array

Definition at line 156 of file report_manager.inc.

      {
           $this->request = array_remove_keys($this->request, "custom_report_mode", "PHPSESSID", "__utma", "__utmb", "__utmc", "__utmz");         
           return array('report_id', 'title', 'description', 'request');    
      }

◆ deleteUser()

static ReportManager::deleteUser ( $user )

static

Respond to fired event DeleteUser.

Delete any records in this component that have dependencies on user object.

Parameters

obj $user - class SiteUser or custom user class

Definition at line 181 of file report_manager.inc.

      {
           $pk = $user->getPrimaryKey();
           $user_id = $user->$pk;
           
           trace("Component report_manager is deleting objects dependent on user_id {$user_id}", 3);
      
           $report = new CustomReport();
           $report->delete("WHERE user_id={$user_id}");
           
           return $user;
      }

◆ drawForm()

ReportManager::drawForm ( )

Draw the configuration/search form.

Definition at line 197 of file report_manager.inc.

      {
           global $script;
           
           $tableNavigator = new ReportTableNavigator($this->tables);
           $filterNavigator = new ReportFilterNavigator($this->tables);
           
           $script .= $tableNavigator->writeScript();
           $script .= $filterNavigator->writeScript();
           
           $action = $this->resultsPage ? $this->resultsPage : Fakoli::scriptName();
           $target = $this->target ? " target='{$this->target}'" : "";
           
           $interstitial = $this->interstitialMessage ? " onsubmit='interstitial(\"".jsSafe($this->interstitialMessage).".\"); return true;'" : "";
           $targetClass = CustomReportManager::getTarget($this);
           
           echo "<form method='POST' action='$action?report_id={$_GET['report_id']}&target={$targetClass}'$target id='custom_report'$interstitial>";
           echo "<input type='hidden' name='report_id' value='{$this->report_id}'/>";
           echo "<input type='hidden' name='custom_report_mode' value='search' id='custom_report_mode'/>";
           echo "<input type='hidden' name='custom_report_title' value='' id='custom_report_title'/>";
           echo "<input type='hidden' name='custom_report_description' value='' id='custom_report_description'/>";
           $tableNavigator->drawView();
           $filterNavigator->drawView();
           
           
           $incomplete = ($this->request["__include_incomplete"] || $this->report_id == 0) ? " checked='checked'" : "";
           $excel = $this->request["__excel"] ? " checked='checked'": "";
           
           echo "<div style='clear: left'><br/><input type='checkbox' name='__include_incomplete' value='1'$incomplete/> <strong>Include Incomplete Records in Results</strong>";
           //echo "<br/><input type='checkbox' name='__excel' value='custom_report'$excel/> <strong>Output as Excel</strong>";
           echo "<br/><br/><input type='submit' class='button' value='Generate Report'/>";
           //echo "&nbsp;&nbsp;<button class='button' onclick='ReportManager.saveReport($this->report_id); return false;'>Save Report</button>";
           echo "</div></form>";
      }

◆ fromRequest()

ReportManager::fromRequest ( )

Definition at line 521 of file report_manager.inc.

      {
           $this->request = $_REQUEST;
           $this->populateSelected();
      }

◆ generateConstraint()

ReportManager::generateConstraint ( )

Generate the search constraint for the current report configuration.

Returns: string the SQL constraint for the search

Definition at line 307 of file report_manager.inc.

      {
           $first = true;
           foreach($this->tables as $table)
           if ($this->selected["table_{$table->class}"])
           {
                $this->constraint .= $table->getConstraint($first, $this->request);
                $first = false;
           }
           
           if($this->limit && is_numeric($this->limit))
           {
                $this->constraint .= " LIMIT {$this->limit}";
           }
           
           //var_dump($this->request);
      }

◆ generateReport()

ReportManager::generateReport ( $inlineScript = false )

Definition at line 325 of file report_manager.inc.

      {
           $t1 = microtime(true);
           
           $this->preSaveReport();
           
           global $script;
           
           if (!isset($this->selected))
           {
                $this->populateSelected();
           }
           
           $this->generateConstraint();
           
           if ($_REQUEST["custom_report_mode"] == "save")
           {
                $this->save();
                return;
           }
           
           $joinClass = ($this->request['__include_incomplete'] == "1") ? LeftOuterJoin : InnerJoin;
           
           $this->join = new $joinClass;
           $this->join->unique = true;
           $constraint .= "";
           $first = true;
           
           foreach($this->tables as $table)
           {
                if ($this->selected["table_{$table->class}"])
                {
                     $table->createJoin($this);
                     
                     
                     $first = false;
                }
           }
           
           //echo "constraint {$this->constraint}<br>";
           $results = $this->join->iteratedQuery($this->constraint);
           
           $report = new DataListView($results, "custom_report_results");
           
           foreach($this->tables as $table)
           {
                if ($this->selected["table_{$table->class}"])
                {
                     $table->createColumns($this, $report);
                }
           }
           
           $report->dragColumnReorder = true;
           $report->columnReorderCallback = "ReportManager.setColumnOrder";
           
           if ($this->columnOrder)
           {
                $report->setColumnOrder(explode("|",$this->columnOrder));
           }
           
           $reportTitle = ($this->title) ?  codify($this->title)."_".date("Y_m_d_Hi") : "custom_report_".date("Y_m_d_Hi");
           //if(isset($this->request["__excel"]))
           //{
                $report->excelFile = $reportTitle . ".xls";
           //}
           /* to do - pdf output 
           else
           {
                $identifier = $this->request["identifier"];
                $pdf = new PDF("/$identifier", false, true, $reportTitle . ".pdf");
                $pdf->generate();
           }
           */
           if ($inlineScript)
           {
                echo $report->writeScript();
           }
           else
           {
                $script .= $report->writeScript();
           }
                     
           $report->cssClass = "list small";
           $report->hideExcelIcon = true;
           
           $excel = $report->getExcelLink();
           
           if($this->limit && count($results))
           {
                echo "<p class='report_limit'>Results are limited to the first {$this->limit} records.</p>\n";
           }
           
           $this->writeResultsFormButtons($excel);
           
           $report->drawView();
           
           if (count($results))
           {
                $this->writeResultsFormButtons($excel);
           }
           
           $t2 = microtime(true);
           $elapsed = ($t2 - $t1);
           echo "<p><em>Report generated in ".number_format($elapsed, 2)." seconds</em></p>";
      }

◆ getTable()

ReportManager::getTable ( $class )

Retrieve the ReportTable object for the specified DataItem class.

Parameters

string $class the class identifying the ReportTable to be retrieved.

Definition at line 236 of file report_manager.inc.

      {
           foreach($this->tables as $table)
           {
                if ($table->class == $class) return $table;
           }
           
           return null;
      }

◆ isColumnSelected()

ReportManager::isColumnSelected ( $column )

Definition at line 431 of file report_manager.inc.

      {
           return $this->selected["column_".codify($column->title)];
      }

◆ load()

static ReportManager::load	(	$report_id,
		$mode = `""`
	)

static

Definition at line 482 of file report_manager.inc.

      {
           if (is_numeric($report_id))
           {
                $report = new CustomReport($report_id);
      
                $proto = unserialize($report->configuration);
                $cl = get_class($proto);
      
                if ($mode != "save")
                {
                     //$_REQUEST = $proto->request;
                }
                
                $instance = new $cl;
                $instance->request = ($mode == "save" || $mode == "post") ? $_REQUEST : $proto->request;
                
                $instance->populateSelected();
                $instance->columnOrder = $report->column_order;
                $instance->report_id = $report_id;
                return $instance;
           }
           else if (startsWith($report_id, "tmp-"))
           {
                $proto = unserialize($_SESSION[$report_id]);
                $cl = get_class($proto);
                $instance = new $cl;
                $instance->request = $proto->request;
                $instance->populateSelected();
                $instance->columnOrder = $report->column_order;
                $instance->report_id = 0;
                return $instance;
           }
           else
           {
                throw new FakoliException("Invalid report id");
           }
      }

◆ populateSelected()

ReportManager::populateSelected ( )

Definition at line 253 of file report_manager.inc.

      {
           if ($this->request["custom_report_title"]) $this->title = $this->request["custom_report_title"];
           if ($this->request["custom_report_description"]) $this->description = $this->request["custom_report_description"];
           
           foreach($this->tables as $table)
           {
                if ($this->request["table_{$table->class}"])
                {
                     $this->setSelected($table);
                }
                $table->load($this->request);
           }
           
           if(count($this->selected) == 0)
           {
                $this->setSelected($this->tables[0], false);
           }
           
      }

◆ preSaveReport()

ReportManager::preSaveReport ( )

Alternative implementation - presave version of report is stored in session with a.

Definition at line 449 of file report_manager.inc.

      {         
           global $user;
           
           if (!$this->report_id)
           {
                $sleeper = serialize($this);
                $mgr = new UserManager();
                
                $this->report_id = "tmp-" .sha1($user->get($mgr->getUsernameField()) . $sleeper . now());
                $_SESSION[$this->report_id] = $sleeper;
                $_SESSION[$this->report_id . "-class"] = get_class($this);                 
           }    
      }

◆ ReportManager()

ReportManager::ReportManager ( )

Creates a new ReportManager instance.

Definition at line 137 of file report_manager.inc.

      {
           $this->selected = null;
           
           $this->report_id = 0;
           $this->tables = array();
           $this->request = $_REQUEST; // For config serialization
           if ($this->request["custom_report_mode"] == "save")
           {
                $this->title = $this->request["custom_report_title"];
                $this->description = $this->request["custom_report_description"];
           }         
      }

◆ save()

ReportManager::save ( )

Definition at line 464 of file report_manager.inc.

      {
           global $user;
           
           $report = new CustomReport();
           $report->report_id = $this->report_id;
           $report->title = $this->title;
           $report->description = $this->description;
           $report->user_id = $user->user_id;
           $report->configuration = serialize($this);
           $report->manager_class = get_class($this);
           $report->column_order = $this->columnOrder;
           
           $report->save();
           
           $this->report_id = $report->report_id;
      }

◆ setSelected()

ReportManager::setSelected	(	$table,
		$checkRequest = `true`
	)

Set the given table as selected.

Parameters

ReportTable	$table	the table to select
boolean	$checkRequest	the check request flag

Definition at line 280 of file report_manager.inc.

      {
           $table->selected = true;
           $this->selected["table_{$table->class}"] = true;
           //$this->constraint .= $table->getConstraint($first, $this->request);
  
           $colCount = 0;
           foreach($table->columns as $column)
           {
                $col = "column_".codify($column->title);
                if ($this->request[$col] || !$checkRequest)
                {
                     $column->selected = true;
                     $this->selected[$col] = true;
                     $colCount ++;            
                }
           }    
           
           if($colCount == 0)
                $this->setSelected($table, false);
      }

◆ table()

ReportManager::table	(	$class,
		$title = `""`,
		$useOutputFilter = `false`
	)

Add a table to the report.

Parameters

string	$class	the DataItem class representing the table in the datamodel
string	$title	(optional) the title to present to the user in the configuration interface

Definition at line 167 of file report_manager.inc.

      {
           $table = new ReportTable($class, $title, $this->request, $useOutputFilter);
           $this->tables[] = $table;
           return $table;
      }

◆ writeResultsFormButtons()

ReportManager::writeResultsFormButtons ( $excel )

Definition at line 436 of file report_manager.inc.

      {
           $url = $this->editorPage;
           echo "<p><a class='button' href='#' onclick='go(\"{$url}?report_id={$this->report_id}&edit=1\"); return false;'><i class='fa-fw fas fa-pencil-alt'></i> Edit Report Settings</a></p>";
           echo "<p><a class='button' href='#' onclick='ReportManager.updateReport(\"{$this->report_id}\"); return false;'><i class='fa-fw far fa-save'></i> Save Report</a>\n";
           echo "&nbsp;&nbsp;<a class='button' href='#' onclick='ReportManager.exportToExcel(\"$excel\"); return false;'><i class='fa-fw far fa-file-excel'></i> Export to Excel</a>";         
           echo "\n&nbsp;&nbsp;<a class='button' href='#' onclick='ReportManager.createReportDialog();return false;'><i class='fa-fw fas fa-plus'></i> Create a New Report</a></p>\n";
      }

Member Data Documentation

◆ $columnOrder

ReportManager::$columnOrder

Override the default column order.

Definition at line 126 of file report_manager.inc.

◆ $description

ReportManager::$description

Longer description of the report.

Definition at line 122 of file report_manager.inc.

◆ $editorPage

ReportManager::$editorPage = "custom_report"

The page used to display the report editor.

Definition at line 124 of file report_manager.inc.

◆ $interstitialMessage

ReportManager::$interstitialMessage = ""

Optional interstitial message to display while report is being generated.

Definition at line 131 of file report_manager.inc.

◆ $join

ReportManager::$join

Definition at line 128 of file report_manager.inc.

◆ $limit

ReportManager::$limit

Optional limit to number of records retrieved, depending on acceptable load times for results.

Definition at line 132 of file report_manager.inc.

◆ $report

ReportManager::$report

Definition at line 129 of file report_manager.inc.

◆ $report_id

ReportManager::$report_id

ID of the saved report as persisted in the database.

Definition at line 120 of file report_manager.inc.

◆ $request

ReportManager::$request

Definition at line 130 of file report_manager.inc.

◆ $resultsPage

ReportManager::$resultsPage = "custom_report_results"

The page used to display the search results.

Definition at line 123 of file report_manager.inc.

◆ $tables

ReportManager::$tables

Definition at line 127 of file report_manager.inc.

◆ $target

ReportManager::$target

The target window for the form results.

Definition at line 125 of file report_manager.inc.

◆ $title

ReportManager::$title

Title of the report.

Definition at line 121 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

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ __sleep()

◆ deleteUser()

◆ drawForm()

◆ fromRequest()

◆ generateConstraint()

◆ generateReport()

◆ getTable()

◆ isColumnSelected()

◆ load()

◆ populateSelected()

◆ preSaveReport()

◆ ReportManager()

◆ save()

◆ setSelected()

◆ table()

◆ writeResultsFormButtons()

Member Data Documentation

◆ $columnOrder

◆ $description

◆ $editorPage

◆ $interstitialMessage

◆ $join

◆ $limit

◆ $report

◆ $report_id

◆ $request

◆ $resultsPage

◆ $tables

◆ $target

◆ $title