|
|
| (16 intermediate revisions by one other user not shown) |
| Line 1: |
Line 1: |
| This article describes the class ''I2CE_CustomReport_Template''.
| | #REDIRECT [[Class: I2CE_CustomReport_Template (4.1.12)]] |
| *Extends the class: [[Class: I2CE_MagicDataTemplate | I2CE_MagicDataTemplate]].
| |
| *Parent Classses: [[Class: I2CE_MagicDataTemplate | I2CE_MagicDataTemplate]] [[Class: I2CE_TemplateMeister | I2CE_TemplateMeister]] [[Class: I2CE_Fuzzy | I2CE_Fuzzy]]
| |
| *Location: Part of the module [[I2CE 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_Template.php modules/CustomReports/lib/I2CE_CustomReport_Template.php]
| |
| *Author: Carl Leitner <litlfred@ibiblio.org>
| |
| I2CE_CustomReport_Relationship_Template
| |
| ==Variables==
| |
| ===$templates===
| |
| An array of requested relationships templates I2CE_CustomReport_Template indexed by the type and then by name @protected static array $templates
| |
| *Type: static protected $templates
| |
| | |
| ===$types===
| |
| An array index by configTypes. the values are arrays whose keys are fields with values the config types the fields are supposed to have array $types
| |
| *Type: static protected static $types
| |
| | |
| ===$blanket===
| |
| An array with keys config types such that all sub-nodes of a node with this configType will have the configType specified by the value associated to the key array $blanket
| |
| *Type: static protected static $blanket
| |
| | |
| ===$required===
| |
| an array with keys configTypes with values the required fields for that config type. will cause a failure if not present $var protecected static $required
| |
| *Type: static protected $required
| |
| | |
| ===$ensure===
| |
| *Type: static protected $ensure
| |
| | |
| ===$permissions===
| |
| *Type: static protected $permissions
| |
| | |
| ==Methods==
| |
| ===compareByDisplayName()===
| |
| Compares to arrays with keys 'display_name' to see which is "bigger"
| |
| *Signature: static public function compareByDisplayName($m,$n)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $m
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $n
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
| |
| ===createExport()===
| |
| Create an export node by appending on to the given configurationGroup node the values stored in the magic data.
| |
| *Signature: public function createExport($configNode,$config,$pipe,$configType,$status)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/class.domnode.php DOMNode ] $configNode <br/>A configurationGroup node.
| |
| ** [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $config <br/>The data we wish to store at this node
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $pipe <br/>A path component or an array of path components relative to the $config. If the pipe is a non-empty array, we export only the keys specifed by the lowest member of $pipe, if it exists. Otherwise, if the pipe is empty or null, we export all keys. Defaults to empty array
| |
| ***Default Value: null
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $configType <br/>Defaults to the empty string. The configuration type to give the configuration node.
| |
| ***Default Value: ''
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $status <br/>An array of status options we should set for this configuration node. Defaults to the empty array
| |
| ***Default Value: array()
| |
| ===createExportNodeConfigurationGroup()===
| |
| Create an configurationGroup node by appending on to the given configurationGroup node the values stored in the magic data at the specified $key.
| |
| *Signature: public function createExportNodeConfigurationGroup($configNode,$config,$pipe,$key,$configType,$status)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/class.domnode.php DOMNode ] $configNode <br/>A configurationGroup node.
| |
| ** [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $config <br/>The data we wish to store at this node
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $pipe <br/>An array of path components relative to the $config. If the pipe is a non-empty array, we export only the keys specifed by the lowest member of $pipe, if it exists. Otherwise, if the pipe is empty, we export all keys
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $key <br/>The key. (Warning. It assumes it exists in the magic data!)
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $configType <br/>Defaults to the empty string. The configuration type to give the configuration node.
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $status <br/>An array of status options we should set for this configuration node. Defaults to the empty array
| |
| ===getFormFromReportForm()===
| |
| Looks up the form associated to a reportform in the specified relationship
| |
| *Signature: static public function getFormFromReportForm($relationship,$reportform)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $relationship
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $reportform <br/>If $reportform == 'primary_form' or $relationship then we are looking up the primary form
| |
| *Returns: string.<br/>The false on failure
| |
| ===getRelationshipFromReport()===
| |
| Get the relationship associated to a report
| |
| *Signature: static public function getRelationshipFromReport($report)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $report
| |
| *Returns: strng.<br/>The empty string on failure
| |
| ===getReportFields()===
| |
| Get the reported fields for a report
| |
| *Signature: static public function getReportFields($report,$get_disabled)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $report
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $get_disabled <br/>Defaults to false
| |
| ***Default Value: false
| |
| *Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>with keys the field name of the form "$form+$field" and values the header for the field
| |
| ===getReportNames()===
| |
| Get a list of the existing reports
| |
| *Signature: static public function getReportNames($cheat)
| |
| *Parameters:
| |
| **$cheat
| |
| ***Default Value: false
| |
| *Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>with keys report shortnames and values an array with indices 'display_name' and 'description' and 'category' and 'config_node'. the last is template config node for the report reports are sorted aplhpabeticaly by 'display_name'
| |
| ===getReportViews()===
| |
| Get a list of the existing report views
| |
| *Signature: static public function getReportViews()
| |
| *Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>with keys report view names/index and values an array with indices 'display_name' and 'description' and 'report' and 'config_node', the last is the template confignode which contains the view reports are sorted alhpabeticaly by 'display_name'
| |
| ===getReportViewsByReport()===
| |
| Get the report view sorted by report
| |
| *Signature: static public function getReportViewsByReport()
| |
| *Returns: array.<br/>a multi-dimensional array. the first index is the short name of the report. the second index is the name/index of the report view. This in turn refers to an array with keys 'display_name' and 'description' and 'config_node', the last is the template confignode which contains the view
| |
| ===getReportsByCategory()===
| |
| Get the reports available by category
| |
| *Signature: static public function getReportsByCategory($cheat)
| |
| *Parameters:
| |
| **$cheat
| |
| ***Default Value: false
| |
| *Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>a multi-dimensional array. the first set of indices is the category sorted alphabetically the second set of indices are the reports for that category. for each of these we have an array indexed by 'display_name' and 'description' and 'config_node'. the last is template config node for the report the second set of indices is sorted alphabetically by 'display_name'
| |
| ===getTemplate()===
| |
| Gets a template. Also caches the results
| |
| *Signature: static public function getTemplate($type,$name)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $type <br/>one of report, relationship or reportView. Defaults to null meaning we get everything under /modules/CustomReports
| |
| ***Default Value: null
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $name <br/>Defaults to null meaning we get all the <$type>s of the specified name
| |
| ***Default Value: null
| |
| *Returns: I2CE_CustomReportTemplate<br/>on sucess
| |
| | |
| | |
| [[Category:Class Documentation]]
| |
