Class: I2CE Util: Difference between revisions

From IHRIS Wiki
No edit summary
(Redirected page to Class: I2CE Util (4.0.3))
Line 1: Line 1:
This article describes the class ''I2CE_Util''.
#REDIRECT [[Class: I2CE_Util (4.0.3)]]
*Location: Part of the module [[I2CE Module List#I2CE|I2CE]] in the package [https://launchpad.net/i2ce I2CE]
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Util.php#L31 lib/I2CE_Util.php] on line 31
*Author: Carl Leitner <litlfred@ibiblio.org>
I2CE_Util  @todo Better documentation
==Methods==
===array_unique()===
array unique which respects multi-dimensional arrays from: the link http://us.php.net/manual/en/function.array-unique.php#84750 sda
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Util.php#L74 i2ce/lib/I2CE_Util.php] on line 74
*Signature: static public function array_unique($arr)
*Parameters:
**$arr
===convertLikeToRegExp()===
Convers a sql like statement to a regular expression
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Util.php#L503 i2ce/lib/I2CE_Util.php] on line 503
*Signature: static public function convertLikeToRegExp($like,$escape)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $like
** [http://www.php.net/manual/en/language.types.string.php string ] $escape <br/>The escape character.  Defaults to \'
***Default Value: '\\'
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]
===explodeAndExecuteSQLQueries()===
Explode and execute a
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Util.php#L270 i2ce/lib/I2CE_Util.php] on line 270
*Signature: static public function explodeAndExecuteSQLQueries($sql,$db,$transact,$delimiter)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $sql <br/>a nuch of sql queries
**$db
** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $transact <br/>defaults to true meaning that the whole script is executed in a transaction.  If a string, it is the name of a savepoint to rollback to/release @param MDB2 connection $db
***Default Value: true
** [http://www.php.net/manual/en/language.types.string.php string ] $delimiter <br/>Defaults to ';'. Needs to be exactly one character
***Default Value: ';'
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]<br/>true on sucess or false
===flattenVariables()===
Flatten variables. Transforms an array of variables of a nested array ['key1']['key2']['key3'] to an array with keys of the form 'key1:key2:key3'
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Util.php#L102 i2ce/lib/I2CE_Util.php] on line 102
*Signature: static public function flattenVariables($vars,$flat,$encode,$skip_empty,$prefix)
*Parameters:
** [http://www.php.net/manual/en/language.types.array.php array ] $vars <br/>the variables to flatten.
** [http://www.php.net/manual/en/language.types.array.php array ] &$flat <br/>The array to store the falttened variables in
** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $encode <br/>Set to true (default) if we should urlencode the values
***Default Value: true
** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $skip_empty <br/>Set to true (default) skip empty values
***Default Value: true
** [http://www.php.net/manual/en/language.types.string.php string ] $prefix <br/>Defaults to '';
***Default Value: ''
===merge_recursive()===
Performs a recursive array merge which _overwrites_ values, not appends them ( the behaviour of array_merge_recursive). Warning:  This is not a symmetric operation.  Any multi-index that exists in $a and in $b  will result that the value in $a will be overwritten by the value in $a
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Util.php#L45 i2ce/lib/I2CE_Util.php] on line 45
*Signature: static public function merge_recursive($a,$b,$addNew,$addEmpty)
*Parameters:
** [http://www.php.net/manual/en/language.types.array.php array ] &$a <br/>the array to merge into
** [http://www.php.net/manual/en/language.types.array.php array ] $b <br/>the array to merge from
** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $addNew <br/>Defaults to true.  If false, we do not add new keys
***Default Value: true
** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $addEmpty <br/>Defaults to true.  If false, we do not add empty values
***Default Value: true
===runSQLScript()===
Executes a script
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Util.php#L194 i2ce/lib/I2CE_Util.php] on line 194
*Signature: static public function runSQLScript($file,$database,$transact,$dsn,$delimiter)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $file <br/>The SQL file to execute -- it must lie in the fileSearch's SQL category (this is ensured by addinging it to a <path name='sql'> node in the configuration XML
** [http://www.php.net/manual/en/language.types.string.php string ] $database <br/>If non-null it will connect to the named database.
***Default Value: null
** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $transact <br/>defaults to true meaning that the whole script is executed in a transaction.  If a string, it is the name of a save point to use (assumes you are already in a transaction)
***Default Value: true
** [http://www.php.net/manual/en/language.types.string.php string ] $dsn <br/>An option DSN to connect on.  If set $database is ignored. it will use whatever database is refered to by the MDB2::singleton()
***Default Value: null
** [http://www.php.net/manual/en/language.types.string.php string ] $delimiter <br/>Defaults to ';' Needs to be exactly one character
***Default Value: ';'
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]<br/>true on sucess, false on failure
===transformVariables()===
Transforms an array of variables with keys of the form 'key1:key2:key3' into a nested array ['key1']['key2']['key3']
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_Util.php#L136 i2ce/lib/I2CE_Util.php] on line 136
*Signature: static public function transformVariables($vars)
*Parameters:
** [http://www.php.net/manual/en/language.types.array.php array ] $vars
*Returns: [http://www.php.net/manual/en/language.types.array.php array ]
 
 
[[Category:Class Documentation]]

Revision as of 15:20, 10 March 2010