|
|
| (24 intermediate revisions by one other user not shown) |
| Line 1: |
Line 1: |
| This article desrcibes the class '''I2CE_CustomReport'''.
| | #REDIRECT [[Class: I2CE_CustomReport (4.1.12)]] |
| *Extends the class: [[Class: I2CE_Fuzzy | I2CE_Fuzzy]].
| |
| *Location: Part of the module [[iHRIS Module List#CustomReports|CustomReports]] in the package [https://launchpad.net/i2ce I2CE]
| |
| *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.0-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport.php modules/CustomReports/lib/I2CE_CustomReport.php]
| |
| | |
| *Author: Carl Leitner <litlfred@ibiblio.org>
| |
| I2CE_CustomReport
| |
| ==Variables==
| |
| ===$config===
| |
| The magic data node holding the configuration information for this report
| |
| $var protected I2CE_MagicDataNode $config
| |
| *Type: protected $config
| |
| | |
| ===$table===
| |
| $var protected string $table the name of the cached table of the report
| |
| *Type: protected $table
| |
| | |
| ===$tmp_table===
| |
| $var protected string $tmp_table the temporary name of the cached table of the report
| |
| *Type: protected $tmp_table
| |
| | |
| ===$db===
| |
| The instance of the database to perform queries on.
| |
| *Type: protected MDB2 $db
| |
| | |
| ===$populate_queries===
| |
| an array of queries used to populate the cached reports table(s)
| |
| *Type: protected y $populate_queries
| |
| | |
| ===$init_queries===
| |
| an array of queries used to inialize the cached reports table(s)
| |
| *Type: protected y $init_queries
| |
| | |
| ===$get_field_def===
| |
| *Type: protected MDB2_PreparedStatement $get_field_def
| |
| | |
| ===$report_table_cols===
| |
| *Type: static protected $report_table_cols
| |
| | |
| ===$hooman===
| |
| *Type: static protected $hooman
| |
| | |
| ===$reportedFunctions===
| |
| *Type: protected $reportedFunctions
| |
| | |
| ==Methods==
| |
| ===__construct()===
| |
| The constructor
| |
| *Signature: public function __construct($report)
| |
| Parameters:
| |
| * [http://www.php.net/manual/en/language.types.string.php string ] $report<br/>The report name
| |
| ===_generateCache()===
| |
| *Signature: protected function _generateCache()
| |
| ===generateCache()===
| |
| Below is the code to actually handle generation of reports
| |
| Generate the cached report
| |
| *Signature: public function generateCache($force,$cache_forms)
| |
| Parameters:
| |
| * [http://www.php.net/manual/en/language.types.boolean.php boolean ] $force<br/>Defaults to false. If set to true, it will force the regeneration of the report if it is in_progress
| |
| **Default Value: false
| |
| * [http://www.php.net/manual/en/language.types.boolean.php boolean ] $cache_forms<br/>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
| |
| *Signature: static public function getCachedTableName($report,$withDB,$table_prefix)
| |
| Parameters:
| |
| *$report
| |
| *$withDB
| |
| **Default Value: true
| |
| *$table_prefix
| |
| **Default Value: ''
| |
| ===getColumnsInReportTable()===
| |
| Get the actual columns in the cached report table
| |
| *Signature: static public function getColumnsInReportTable($report)
| |
| Parameters:
| |
| *$report
| |
| ===getCreateField()===
| |
| *Signature: protected function getCreateField($form,$field,$name)
| |
| Parameters:
| |
| *$form
| |
| *$field
| |
| *$name
| |
| ===getFormRelationship()===
| |
| *Signature: public function getFormRelationship()
| |
| ===getFormsRequiredByReport()===
| |
| Gets the forms required by the report
| |
| @param string $report
| |
| *Signature: public function getFormsRequiredByReport()
| |
| *Returns: [http://www.php.net/manual/en/language.types.array.php array ] of string
| |
| ===getLastGenerationTime()===
| |
| *Signature: static public function getLastGenerationTime($report)
| |
| *Returns: mixed. False on failure, int the time the last report generation on sucess
| |
| Parameters:
| |
| * [http://www.php.net/manual/en/language.types.string.php string ] $report<br/>The shortname for the report
| |
| ===getReportedFunctions()===
| |
| *Signature: protected function getReportedFunctions()
| |
| ===getStatus()===
| |
| Get the status of the requested report
| |
| @param boolean hooman_readable defaults to false.
| |
| *Signature: static public function getStatus($report,$hooman_readable)
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ] 'does_not_exist','not_generated','generated','failed','in_progress', 'stale' if it is not hooman readable
| |
| *
| |
| Parameters:
| |
| * [http://www.php.net/manual/en/language.types.string.php string ] $report
| |
| *$hooman_readable
| |
| **Default Value: false
| |
| ===hasFailed()===
| |
| Checks to see if a report has failed in its generation
| |
| *Signature: static public function hasFailed($report)
| |
| *Returns: mixed. True if it has failed, false if it has not failed, null if the report does not exist.
| |
| Parameters:
| |
| * [http://www.php.net/manual/en/language.types.string.php string ] $report
| |
| ===isStale()===
| |
| Check to see if a report is stale.
| |
| *Signature: static public function isStale($report)
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] true/false
| |
| Parameters:
| |
| * [http://www.php.net/manual/en/language.types.string.php string ] $report
| |
| ===processReportingFunctions()===
| |
| *Signature: protected function processReportingFunctions()
| |
| ===reportExists()===
| |
| Checks to see if a report exists
| |
| *Signature: static public function reportExists($report)
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
| |
| Parameters:
| |
| * [http://www.php.net/manual/en/language.types.string.php string ] $report
| |
| ===setStatus()===
| |
| Set the status us a report.
| |
| *Signature: static public function setStatus($report,$status)
| |
| Parameters:
| |
| * [http://www.php.net/manual/en/language.types.string.php string ] $report
| |
| * [http://www.php.net/manual/en/language.types.string.php string ] $status
| |
| ===setupQueries()===
| |
| *Signature: protected function setupQueries()
| |
| ==Inherited Fuzzy Methods==
| |
| ===userMessage()===
| |
| This method is inherited from [[Class: I2CE_Fuzzy#userMessage() | I2CE_Fuzzy->userMessage()]]
| |
| | |
| | |
| [[Category:Class Documentation]]
| |
