Class: I2CE Entry: Difference between revisions

From IHRIS Wiki
No edit summary
No edit summary
Line 1: Line 1:
This article describes the class ''I2CE_Entry''.
This article describes the class ''I2CE_Entry''.
*Location: Part of the module [[I2CE Module List#forms|forms]] in the package [https://launchpad.net/i2ce I2CE]
*Location: Part of the module [[I2CE Module List#forms|forms]] in the package [https://launchpad.net/i2ce I2CE]
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.1-release/annotate/head:/modules/Forms/lib/I2CE_Entry.php modules/Forms/lib/I2CE_Entry.php]
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Entry.php#L33 modules/Forms/lib/I2CE_Entry.php] on line 33
*Author: Luke Duncan <lduncan@intrahealth.org>
*Author: Luke Duncan <lduncan@intrahealth.org>
*Since: v2.0.0
*Since: v2.0.0
Line 9: Line 9:
===$date===
===$date===
The date this entry was added.
The date this entry was added.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Entry.php#L38 i2ce/modules/Forms/lib/I2CE_Entry.php] on line 38
*Type: public [[Class: I2CE_Date | I2CE_Date]] $date
*Type: public [[Class: I2CE_Date | I2CE_Date]] $date


===$who===
===$who===
The user id of the person who made this entry.
The user id of the person who made this entry.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Entry.php#L42 i2ce/modules/Forms/lib/I2CE_Entry.php] on line 42
*Type: public integer $who
*Type: public integer $who


===$change_type===
===$change_type===
The type of change for this entry.
The type of change for this entry.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Entry.php#L46 i2ce/modules/Forms/lib/I2CE_Entry.php] on line 46
*Type: public integer $change_type
*Type: public integer $change_type


===$value===
===$value===
The value for this entry.
The value for this entry.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Entry.php#L50 i2ce/modules/Forms/lib/I2CE_Entry.php] on line 50
*Type: public [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $value
*Type: public [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $value


Line 26: Line 30:
===__construct()===
===__construct()===
Create a new instance of a I2CE_Entry. This will usually be done by the [[Class: I2CE_FormField | ]] object when it needs access to the history for this field.
Create a new instance of a I2CE_Entry. This will usually be done by the [[Class: I2CE_FormField | ]] object when it needs access to the history for this field.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Entry.php#L61 i2ce/modules/Forms/lib/I2CE_Entry.php] on line 61
*Signature: public function __construct($date,$who,$change_type,$value)
*Signature: public function __construct($date,$who,$change_type,$value)
*Parameters:
*Parameters:
Line 34: Line 39:
===getValue()===
===getValue()===
Return the value of this entry
Return the value of this entry
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Entry.php#L72 i2ce/modules/Forms/lib/I2CE_Entry.php] on line 72
*Signature: public function getValue()
*Signature: public function getValue()
*Returns: mixed;
*Returns: mixed;

Revision as of 09:49, 10 November 2009

This article describes the class I2CE_Entry.

Class for representing an entry in the database. Multiple entries may exist for any value to track all changes since the record was created.

Variables

$date

The date this entry was added.

$who

The user id of the person who made this entry.

$change_type

The type of change for this entry.

$value

The value for this entry.

Methods

__construct()

Create a new instance of a I2CE_Entry. This will usually be done by the object when it needs access to the history for this field.

getValue()

Return the value of this entry