Class: I2CE MagicDataStorageDBAlt (Development): Difference between revisions
From IHRIS Wiki
No edit summary |
No edit summary |
||
Line 2: | Line 2: | ||
This article describes the class ''I2CE_MagicDataStorageDBAlt'' . | This article describes the class ''I2CE_MagicDataStorageDBAlt'' . | ||
*Extends the class: [[Class: I2CE_MagicDataStorage (Development) | I2CE_MagicDataStorage]]. | *Extends the class: [[Class: I2CE_MagicDataStorage (Development) | I2CE_MagicDataStorage]]. | ||
*Location: Part of the module [[I2CE Module List (Development)#I2CE|I2CE]] in the package [https://launchpad.net/i2ce I2CE] 4. | *Location: Part of the module [[I2CE Module List (Development)#I2CE|I2CE]] in the package [https://launchpad.net/i2ce I2CE] 4.1-dev | ||
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_MagicDataStorageDBAlt.php#L37 lib/I2CE_MagicDataStorageDBAlt.php] on line 37 | ||
Configuration class to lookup and save configuration options. | Configuration class to lookup and save configuration options. | ||
==Variables== | ==Variables== | ||
===$db_statements=== | ===$db_statements=== | ||
An array of prepared statements for looking up stored magic data. | An array of prepared statements for looking up stored magic data. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_MagicDataStorageDBAlt.php#L42 i2ce/lib/I2CE_MagicDataStorageDBAlt.php] on line 42 | ||
*Type: private [http://www.php.net/manual/en/language.types.array.php array ] $db_statements | *Type: private [http://www.php.net/manual/en/language.types.array.php array ] $db_statements | ||
===$db=== | |||
DB instnace | |||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_MagicDataStorageDBAlt.php#L47 i2ce/lib/I2CE_MagicDataStorageDBAlt.php] on line 47 | |||
*Type: protected MDB2 $db | |||
===$use_quick=== | ===$use_quick=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_MagicDataStorageDBAlt.php#L206 i2ce/lib/I2CE_MagicDataStorageDBAlt.php] on line 206 | ||
*Type: protected $use_quick | *Type: protected $use_quick | ||
==Methods== | ==Methods== | ||
===__construct()=== | ===__construct()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_MagicDataStorageDBAlt.php#L49 i2ce/lib/I2CE_MagicDataStorageDBAlt.php] on line 49 | ||
*Signature: public function __construct($name) | *Signature: public function __construct($name) | ||
*Parameters: | *Parameters: | ||
Line 23: | Line 28: | ||
===clear()=== | ===clear()=== | ||
Clear the all keys/values associated with this storage | Clear the all keys/values associated with this storage | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_MagicDataStorageDBAlt.php#L242 i2ce/lib/I2CE_MagicDataStorageDBAlt.php] on line 242 | ||
*Signature: public function clear() | *Signature: public function clear() | ||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | ||
===destroy()=== | ===destroy()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_MagicDataStorageDBAlt.php#L229 i2ce/lib/I2CE_MagicDataStorageDBAlt.php] on line 229 | ||
*Signature: public function destroy($node) | *Signature: public function destroy($node) | ||
*Parameters: | *Parameters: | ||
Line 33: | Line 38: | ||
===isAvailable()=== | ===isAvailable()=== | ||
Returns true if this storage mechanism is ready to be used. false otherwise. | Returns true if this storage mechanism is ready to be used. false otherwise. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_MagicDataStorageDBAlt.php#L211 i2ce/lib/I2CE_MagicDataStorageDBAlt.php] on line 211 | ||
*Signature: public function isAvailable() | *Signature: public function isAvailable() | ||
===renameChild()=== | |||
Renames a child node | |||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_MagicDataStorageDBAlt.php#L255 i2ce/lib/I2CE_MagicDataStorageDBAlt.php] on line 255 | |||
*Signature: public function renameChild($node,$old,$new) | |||
*Parameters: | |||
** [[Class: I2CE_MagicDataNode (Development) | I2CE_MagicDataNode]] $node | |||
** [http://www.php.net/manual/en/language.types.string.php string ] $old | |||
** [http://www.php.net/manual/en/language.types.string.php string ] $new | |||
*Returns: boolean.<br/>True on success, false on failure | |||
===retrieve()=== | ===retrieve()=== | ||
Retrieve the given I2CE_MagicDataNode value and type. | Retrieve the given I2CE_MagicDataNode value and type. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_MagicDataStorageDBAlt.php#L140 i2ce/lib/I2CE_MagicDataStorageDBAlt.php] on line 140 | ||
*Signature: public function retrieve($node) | *Signature: public function retrieve($node) | ||
*Parameters: | *Parameters: | ||
Line 44: | Line 58: | ||
===setUpStatements()=== | ===setUpStatements()=== | ||
Set up a cache of prepared statements. | Set up a cache of prepared statements. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_MagicDataStorageDBAlt.php#L70 i2ce/lib/I2CE_MagicDataStorageDBAlt.php] on line 70 | ||
*Signature: protected function setUpStatements() | *Signature: protected function setUpStatements() | ||
*Returns: MDB2_Statement_Common | *Returns: MDB2_Statement_Common | ||
===store()=== | ===store()=== | ||
Store the given I2CE_MagicDataNode into the database. | Store the given I2CE_MagicDataNode into the database. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_MagicDataStorageDBAlt.php#L102 i2ce/lib/I2CE_MagicDataStorageDBAlt.php] on line 102 | ||
*Signature: public function store($node) | *Signature: public function store($node) | ||
*Parameters: | *Parameters: | ||
** [[Class: I2CE_MagicDataNode (Development) | I2CE_MagicDataNode]] $node | ** [[Class: I2CE_MagicDataNode (Development) | I2CE_MagicDataNode]] $node | ||
==Inherited Methods== | ==Inherited Methods== | ||
===getChildPath()=== | |||
This public method is inherited from [[Class: I2CE_MagicDataStorage (Development)#getChildPath() | I2CE_MagicDataStorage->getChildPath()]] | |||
===getHash()=== | ===getHash()=== | ||
This public method is inherited from [[Class: I2CE_MagicDataStorage (Development)#getHash() | I2CE_MagicDataStorage->getHash()]] | This public method is inherited from [[Class: I2CE_MagicDataStorage (Development)#getHash() | I2CE_MagicDataStorage->getHash()]] |
Latest revision as of 08:15, 6 May 2015
For other versions, see Class: I2CE_MagicDataStorageDBAlt (versions) .
This article describes the class I2CE_MagicDataStorageDBAlt .
- Extends the class: I2CE_MagicDataStorage.
- Location: Part of the module I2CE in the package I2CE 4.1-dev
- Source: Defined in the file lib/I2CE_MagicDataStorageDBAlt.php on line 37
Configuration class to lookup and save configuration options.
Variables
$db_statements
An array of prepared statements for looking up stored magic data.
- Defined in i2ce/lib/I2CE_MagicDataStorageDBAlt.php on line 42
- Type: private array $db_statements
$db
DB instnace
- Defined in i2ce/lib/I2CE_MagicDataStorageDBAlt.php on line 47
- Type: protected MDB2 $db
$use_quick
- Defined in i2ce/lib/I2CE_MagicDataStorageDBAlt.php on line 206
- Type: protected $use_quick
Methods
__construct()
- Defined in i2ce/lib/I2CE_MagicDataStorageDBAlt.php on line 49
- Signature: public function __construct($name)
- Parameters:
- $name
clear()
Clear the all keys/values associated with this storage
- Defined in i2ce/lib/I2CE_MagicDataStorageDBAlt.php on line 242
- Signature: public function clear()
- Returns: boolean
destroy()
- Defined in i2ce/lib/I2CE_MagicDataStorageDBAlt.php on line 229
- Signature: public function destroy($node)
- Parameters:
- $node
isAvailable()
Returns true if this storage mechanism is ready to be used. false otherwise.
- Defined in i2ce/lib/I2CE_MagicDataStorageDBAlt.php on line 211
- Signature: public function isAvailable()
renameChild()
Renames a child node
- Defined in i2ce/lib/I2CE_MagicDataStorageDBAlt.php on line 255
- Signature: public function renameChild($node,$old,$new)
- Parameters:
- I2CE_MagicDataNode $node
- string $old
- string $new
- Returns: boolean.
True on success, false on failure
retrieve()
Retrieve the given I2CE_MagicDataNode value and type.
- Defined in i2ce/lib/I2CE_MagicDataStorageDBAlt.php on line 140
- Signature: public function retrieve($node)
- Parameters:
- I2CE_MagicDataNode $node
- Returns: array
setUpStatements()
Set up a cache of prepared statements.
- Defined in i2ce/lib/I2CE_MagicDataStorageDBAlt.php on line 70
- Signature: protected function setUpStatements()
- Returns: MDB2_Statement_Common
store()
Store the given I2CE_MagicDataNode into the database.
- Defined in i2ce/lib/I2CE_MagicDataStorageDBAlt.php on line 102
- Signature: public function store($node)
- Parameters:
- I2CE_MagicDataNode $node
Inherited Methods
getChildPath()
This public method is inherited from I2CE_MagicDataStorage->getChildPath()
getHash()
This public method is inherited from I2CE_MagicDataStorage->getHash()
Inherited Variables
$name
Theis protected variable is inherited from I2CE_MagicDataStorage->$name