Class: I2CE CustomReport (4.1.4)

From IHRIS Wiki
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
For other versions, see Class: I2CE_CustomReport (versions) .


This article describes the class I2CE_CustomReport .

I2CE_CustomReport

Variables

$config

The magic data node holding the configuration information for this report $var protected I2CE_MagicDataNode $config

$table

$var protected string $table the name of the cached table of the report

$tmp_table

$var protected string $tmp_table the temporary name of the cached table of the report

$db

The instance of the database to perform queries on.

$populate_queries

an array of queries used to populate the cached reports table(s)

$id_length

The length for the id and parent columns in cached report tables.

$get_field_def

$report_table_cols

$hooman

$reportedFunctions

Methods

__construct()

The constructor

_generateCache()

dropTable()

Drop the zebra_XXX table

generateCache()

Below is the code to actually handle generation of reports Generate the cached report

  • Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport.php on line 397
  • Signature: public function generateCache($force,$cache_forms)
  • Parameters:
    • boolean $force
      Defaults to false. If set to true, it will force the regeneration of the report if it is in_progress
      • Default Value: false
    • boolean $cache_forms
      Defaults to True. If set to true, it will cache the forms required by this report
      • Default Value: true

getCachedTableName()

Below is the static code to actually handle checking/setting the status of a cached report

  • Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport.php on line 159
  • Signature: static public function getCachedTableName($report,$withDB,$table_prefix,$counter)
  • Parameters:
    • $report
    • $withDB
      • Default Value: true
    • $table_prefix
      • Default Value:
    • $counter
      • Default Value: false

getColumnsInReportTable()

Get the actual columns in the cached report table

getCreateField()

getFormRelationship()

getFormsRequiredByReport()

Gets the forms required by the report @param string $report

getLastGenerationTime()

getQueryAsName()

Return the array or string with the portion before the ' AS ' removed.

getReportedFunctions()

getReports()

Get all available report

getSingleQueryAsName()

Return the named as value for a select query. e.g. `demographic`.`id` AS `demographic+id` would return `demographic+id`

getStatus()

Get the status of the requested report

  • Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport.php on line 274
  • Signature: static public function getStatus($report,$hooman_readable)
  • Parameters:
    • string $report @param boolean hooman_readable defaults to false.
    • $hooman_readable
      • Default Value: false
  • Returns: string
    'does_not_exist','not_generated','generated','failed','in_progress', 'stale' if it is not hooman readable *

hasFailed()

Checks to see if a report has failed in its generation

hooman()

isStale()

Check to see if a report is stale.

reportExists()

Checks to see if a report exists

setStatus()

Set the status us a report.

setupQueries()

Inherited Methods

_hasMethod()

This public method is inherited from I2CE_Fuzzy->_hasMethod()

Inherited Fuzzy Methods

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()

Retrieved from "https://wiki.ihris.org/mediawiki/index.php?title=Class:_I2CE_CustomReport_(4.1.4)&oldid=46009"