Class: I2CE FormField DB DATE: Difference between revisions
No edit summary |
No edit summary |
||
| Line 3: | Line 3: | ||
*Definition in [[#modules/Forms/lib/fields/I2CE_FormField_DB_DATE.php|modules/Forms/lib/fields/I2CE_FormField_DB_DATE.php]] | *Definition in [[#modules/Forms/lib/fields/I2CE_FormField_DB_DATE.php|modules/Forms/lib/fields/I2CE_FormField_DB_DATE.php]] | ||
=modules/Forms/lib/fields/I2CE_FormField_DB_DATE.php= | =modules/Forms/lib/fields/I2CE_FormField_DB_DATE.php= | ||
This article desrcibes the1 class '''I2CE_FormField_DB_DATE'''which extends the class [[Class: I2CE_FormField | I2CE_FormField]] | This article desrcibes the1 class '''I2CE_FormField_DB_DATE''' which extends the class [[Class: I2CE_FormField | I2CE_FormField]] | ||
It is contained in the module [[iHRIS Module List#forms|forms]] in the package [https://launchpad.net/i2ce I2CE] | It is contained in the module [[iHRIS Module List#forms|forms]] in the package [https://launchpad.net/i2ce I2CE] | ||
The class is defined in the file: [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.0-release/files/head:modules/Forms/lib/fields/I2CE_FormField_DB_DATE.php modules/Forms/lib/fields/I2CE_FormField_DB_DATE.php] | |||
The class is defined in the file: [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.0-release/files/head:/modules/Forms/lib/fields/I2CE_FormField_DB_DATE.php modules/Forms/lib/fields/I2CE_FormField_DB_DATE.php] | |||
@author Luke Duncan <lduncan@intrahealth.org> | @author Luke Duncan <lduncan@intrahealth.org> | ||
@since v2.0.0 | @since v2.0.0 | ||
@version v2.0.0 | @version v2.0.0 | ||
Class for defining all the database fields used by a {@link I2CE_Form} object. | Class for defining all the database fields used by a {@link I2CE_Form} object. | ||
@package I2CE | @package I2CE | ||
@access public | @access public | ||
==Constants== | ==Constants== | ||
| Line 222: | Line 229: | ||
This method is inherited from [[Class: I2CE_Fuzzy#userMessage() | I2CE_Fuzzy->userMessage()]] | This method is inherited from [[Class: I2CE_Fuzzy#userMessage() | I2CE_Fuzzy->userMessage()]] | ||
=modules/Forms/lib/fields/I2CE_FormField_DB_DATE.php= | =modules/Forms/lib/fields/I2CE_FormField_DB_DATE.php= | ||
This article desrcibes the1 class '''I2CE_FormField_DB_DATE'''which extends the class [[Class: I2CE_FormField | I2CE_FormField]] | This article desrcibes the1 class '''I2CE_FormField_DB_DATE''' which extends the class [[Class: I2CE_FormField | I2CE_FormField]] | ||
It is contained in the module [[iHRIS Module List#forms|forms]] in the package [https://launchpad.net/i2ce I2CE] | It is contained in the module [[iHRIS Module List#forms|forms]] in the package [https://launchpad.net/i2ce I2CE] | ||
The class is defined in the file: [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.0-release/files/head:modules/Forms/lib/fields/I2CE_FormField_DB_DATE.php modules/Forms/lib/fields/I2CE_FormField_DB_DATE.php] | |||
The class is defined in the file: [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.0-release/files/head:/modules/Forms/lib/fields/I2CE_FormField_DB_DATE.php modules/Forms/lib/fields/I2CE_FormField_DB_DATE.php] | |||
@author Luke Duncan <lduncan@intrahealth.org> | @author Luke Duncan <lduncan@intrahealth.org> | ||
@since v2.0.0 | @since v2.0.0 | ||
@version v2.0.0 | @version v2.0.0 | ||
Class for defining all the database fields used by a {@link I2CE_Form} object. | Class for defining all the database fields used by a {@link I2CE_Form} object. | ||
@package I2CE | @package I2CE | ||
@access public | @access public | ||
==Constants== | ==Constants== | ||
Revision as of 20:20, 16 October 2009
The class I2CE_FormField_DB_DATE contains 2 definitions:
- Definition in modules/Forms/lib/fields/I2CE_FormField_DB_DATE.php
- Definition in modules/Forms/lib/fields/I2CE_FormField_DB_DATE.php
modules/Forms/lib/fields/I2CE_FormField_DB_DATE.php
This article desrcibes the1 class I2CE_FormField_DB_DATE which extends the class I2CE_FormField It is contained in the module forms in the package I2CE
The class is defined in the file: modules/Forms/lib/fields/I2CE_FormField_DB_DATE.php
@author Luke Duncan <lduncan@intrahealth.org>
@since v2.0.0
@version v2.0.0
Class for defining all the database fields used by a {@link I2CE_Form} object.
@package I2CE
@access public
Constants
I2CE_FormField_DB_DATE::FIELD_TYPE_I2CE
A string type for the field Defined as: 'date'
I2CE_FormField_DB_DATE::FIELD_TYPE_DB
The database type for the field Defined as: 'datetime default NULL'
I2CE_FormField_DB_DATE::FIELD_TYPE_MDB2
The MDB2 type for the field. Defined as: 'timestamp'
Variables
$start_year
The start year for drop downs for picking the year if this is a date.
- Type: protected nteger $start_year
$end_year
The end year for drop downs for picking the year if this is a date.
- Type: protected nteger $end_year
Methods
__construct()
Create a new instance of a I2CE_FormField
- Signature: public function __construct($name,$options)
Parameters:
compare()
Compares this form field agains the given form field.
- Signature: public function compare($db_value)
- Returns: -1,0,1
Parameters:
- mixed $db_value
Either a DB Value or an I2CE_FormField
getDBValue()
Returns the value of this field ready to be stored in the database.
- Signature: public function getDBValue()
- Returns: mixed
getDisplayValue()
Returns the value of this field as a human readable format. entry for this field.
- Signature: public function getDisplayValue($entry)
- Returns: mixed
Parameters:
- I2CE_Entry $entry
If a I2CE_Entry object has been passed to this method then it will return the value for that entry assuming it's an- Default Value: false
getFromDB()
Return the value of this field from the database format for the given type @param integer $type The type of the field to be returned.
- Signature: public function getFromDB($value)
Parameters:
- mixed $value
getYearRange()
Return the year range for this field if it's a date.
- Signature: public function getYearRange()
- Returns: array
@global array
isSameValue()
Check to see if the given DB value is equivalent to this value. @param mixed $value
- Signature: public function isSameValue($db_value)
- Returns: boolean
Parameters:
- $db_value
isValid()
Checks to see if the current value for this is set and valid.
- Signature: public function isValid()
- Returns: boolean
issetValue()
Checks to see if the value has been set.
- Signature: public function issetValue()
- Returns: boolean
setYearRange()
- Signature: public function setYearRange($start,$end)
Parameters:
- $start
- $end
- Default Value: 0
Inherited Variables
$name
Theis protected variable is inherited from I2CE_FormField->$name
$options
Theis protected variable is inherited from I2CE_FormField->$options
$value
Theis protected variable is inherited from I2CE_FormField->$value
$headers
Theis protected variable is inherited from I2CE_FormField->$headers
$href
Theis protected variable is inherited from I2CE_FormField->$href
$form
Theis protected variable is inherited from I2CE_FormField->$form
$history
Theis protected variable is inherited from I2CE_FormField->$history
$history_idx
Theis protected variable is inherited from I2CE_FormField->$history_idx
$attributes
Theis protected variable is inherited from I2CE_FormField->$attributes
$invalid
Theis protected variable is inherited from I2CE_FormField->$invalid
Inherited Fuzzy Methods
cachedTableReference()
This method is inherited from I2CE_FormField->cachedTableReference()
isNumeric()
This method is inherited from I2CE_FormField->isNumeric()
getLimitStyles()
This method is inherited from I2CE_FormField->getLimitStyles()
generateLimit()
This method is inherited from I2CE_FormField->generateLimit()
generateLimit_null()
This method is inherited from I2CE_FormField->generateLimit_null()
generateLimit_not_null()
This method is inherited from I2CE_FormField->generateLimit_not_null()
generateLimit_null_not_null()
This method is inherited from I2CE_FormField->generateLimit_null_not_null()
checkLimit_null()
This method is inherited from I2CE_FormField->checkLimit_null()
checkLimit_not_null()
This method is inherited from I2CE_FormField->checkLimit_not_null()
checkLimit_null_not_null()
This method is inherited from I2CE_FormField->checkLimit_null_not_null()
checkLimitString_null()
This method is inherited from I2CE_FormField->checkLimitString_null()
checkLimitString_not_null()
This method is inherited from I2CE_FormField->checkLimitString_not_null()
checkLimitString_null_not_null()
This method is inherited from I2CE_FormField->checkLimitString_null_not_null()
getLimitMenu_null()
This method is inherited from I2CE_FormField->getLimitMenu_null()
getLimitMenu_not_null()
This method is inherited from I2CE_FormField->getLimitMenu_not_null()
getLimitMenu_null_not_null()
This method is inherited from I2CE_FormField->getLimitMenu_null_not_null()
processLimitMenu_null()
This method is inherited from I2CE_FormField->processLimitMenu_null()
processLimitMenu_not_null()
This method is inherited from I2CE_FormField->processLimitMenu_not_null()
processLimitMenu_null_not_null()
This method is inherited from I2CE_FormField->processLimitMenu_null_not_null()
generateLimit_max_parent()
This method is inherited from I2CE_FormField->generateLimit_max_parent()
generateLimit_min_parent()
This method is inherited from I2CE_FormField->generateLimit_min_parent()
generateLimit_max_parent_form()
This method is inherited from I2CE_FormField->generateLimit_max_parent_form()
generateLimit_min_parent_form()
This method is inherited from I2CE_FormField->generateLimit_min_parent_form()
getLimitMenu_max_parent()
This method is inherited from I2CE_FormField->getLimitMenu_max_parent()
getLimitMenu_min_parent()
This method is inherited from I2CE_FormField->getLimitMenu_min_parent()
getLimitMenu_max_parent_form()
This method is inherited from I2CE_FormField->getLimitMenu_max_parent_form()
getLimitMenu_min_parent_form()
This method is inherited from I2CE_FormField->getLimitMenu_min_parent_form()
processLimitMenu_max_parent()
This method is inherited from I2CE_FormField->processLimitMenu_max_parent()
processLimitMenu_min_parent()
This method is inherited from I2CE_FormField->processLimitMenu_min_parent()
processLimitMenu_max_parent_form()
This method is inherited from I2CE_FormField->processLimitMenu_max_parent_form()
processLimitMenu_min_parent_form()
This method is inherited from I2CE_FormField->processLimitMenu_min_parent_form()
save()
This method is inherited from I2CE_FormField->save()
populateHistory()
This method is inherited from I2CE_FormField->populateHistory()
userMessage()
This method is inherited from I2CE_Fuzzy->userMessage()
modules/Forms/lib/fields/I2CE_FormField_DB_DATE.php
This article desrcibes the1 class I2CE_FormField_DB_DATE which extends the class I2CE_FormField It is contained in the module forms in the package I2CE
The class is defined in the file: modules/Forms/lib/fields/I2CE_FormField_DB_DATE.php
@author Luke Duncan <lduncan@intrahealth.org>
@since v2.0.0
@version v2.0.0
Class for defining all the database fields used by a {@link I2CE_Form} object.
@package I2CE
@access public
Constants
I2CE_FormField_DB_DATE::FIELD_TYPE_I2CE
A string type for the field Defined as: 'date'
I2CE_FormField_DB_DATE::FIELD_TYPE_DB
The database type for the field Defined as: 'datetime default NULL'
I2CE_FormField_DB_DATE::FIELD_TYPE_MDB2
The MDB2 type for the field. Defined as: 'timestamp'
Variables
$start_year
The start year for drop downs for picking the year if this is a date.
- Type: protected nteger $start_year
$end_year
The end year for drop downs for picking the year if this is a date.
- Type: protected nteger $end_year
Methods
__construct()
Create a new instance of a I2CE_FormField
- Signature: public function __construct($name,$options)
Parameters:
compare()
Compares this form field agains the given form field.
- Signature: public function compare($db_value)
- Returns: -1,0,1
Parameters:
- mixed $db_value
Either a DB Value or an I2CE_FormField
getDBValue()
Returns the value of this field ready to be stored in the database.
- Signature: public function getDBValue()
- Returns: mixed
getDisplayValue()
Returns the value of this field as a human readable format. entry for this field.
- Signature: public function getDisplayValue($entry)
- Returns: mixed
Parameters:
- I2CE_Entry $entry
If a I2CE_Entry object has been passed to this method then it will return the value for that entry assuming it's an- Default Value: false
getFromDB()
Return the value of this field from the database format for the given type @param integer $type The type of the field to be returned.
- Signature: public function getFromDB($value)
Parameters:
- mixed $value
getYearRange()
Return the year range for this field if it's a date.
- Signature: public function getYearRange()
- Returns: array
@global array
isSameValue()
Check to see if the given DB value is equivalent to this value. @param mixed $value
- Signature: public function isSameValue($db_value)
- Returns: boolean
Parameters:
- $db_value
isValid()
Checks to see if the current value for this is set and valid.
- Signature: public function isValid()
- Returns: boolean
issetValue()
Checks to see if the value has been set.
- Signature: public function issetValue()
- Returns: boolean
setYearRange()
- Signature: public function setYearRange($start,$end)
Parameters:
- $start
- $end
- Default Value: 0
Inherited Variables
$name
Theis protected variable is inherited from I2CE_FormField->$name
$options
Theis protected variable is inherited from I2CE_FormField->$options
$value
Theis protected variable is inherited from I2CE_FormField->$value
$headers
Theis protected variable is inherited from I2CE_FormField->$headers
$href
Theis protected variable is inherited from I2CE_FormField->$href
$form
Theis protected variable is inherited from I2CE_FormField->$form
$history
Theis protected variable is inherited from I2CE_FormField->$history
$history_idx
Theis protected variable is inherited from I2CE_FormField->$history_idx
$attributes
Theis protected variable is inherited from I2CE_FormField->$attributes
$invalid
Theis protected variable is inherited from I2CE_FormField->$invalid
Inherited Fuzzy Methods
cachedTableReference()
This method is inherited from I2CE_FormField->cachedTableReference()
isNumeric()
This method is inherited from I2CE_FormField->isNumeric()
getLimitStyles()
This method is inherited from I2CE_FormField->getLimitStyles()
generateLimit()
This method is inherited from I2CE_FormField->generateLimit()
generateLimit_null()
This method is inherited from I2CE_FormField->generateLimit_null()
generateLimit_not_null()
This method is inherited from I2CE_FormField->generateLimit_not_null()
generateLimit_null_not_null()
This method is inherited from I2CE_FormField->generateLimit_null_not_null()
checkLimit_null()
This method is inherited from I2CE_FormField->checkLimit_null()
checkLimit_not_null()
This method is inherited from I2CE_FormField->checkLimit_not_null()
checkLimit_null_not_null()
This method is inherited from I2CE_FormField->checkLimit_null_not_null()
checkLimitString_null()
This method is inherited from I2CE_FormField->checkLimitString_null()
checkLimitString_not_null()
This method is inherited from I2CE_FormField->checkLimitString_not_null()
checkLimitString_null_not_null()
This method is inherited from I2CE_FormField->checkLimitString_null_not_null()
getLimitMenu_null()
This method is inherited from I2CE_FormField->getLimitMenu_null()
getLimitMenu_not_null()
This method is inherited from I2CE_FormField->getLimitMenu_not_null()
getLimitMenu_null_not_null()
This method is inherited from I2CE_FormField->getLimitMenu_null_not_null()
processLimitMenu_null()
This method is inherited from I2CE_FormField->processLimitMenu_null()
processLimitMenu_not_null()
This method is inherited from I2CE_FormField->processLimitMenu_not_null()
processLimitMenu_null_not_null()
This method is inherited from I2CE_FormField->processLimitMenu_null_not_null()
generateLimit_max_parent()
This method is inherited from I2CE_FormField->generateLimit_max_parent()
generateLimit_min_parent()
This method is inherited from I2CE_FormField->generateLimit_min_parent()
generateLimit_max_parent_form()
This method is inherited from I2CE_FormField->generateLimit_max_parent_form()
generateLimit_min_parent_form()
This method is inherited from I2CE_FormField->generateLimit_min_parent_form()
getLimitMenu_max_parent()
This method is inherited from I2CE_FormField->getLimitMenu_max_parent()
getLimitMenu_min_parent()
This method is inherited from I2CE_FormField->getLimitMenu_min_parent()
getLimitMenu_max_parent_form()
This method is inherited from I2CE_FormField->getLimitMenu_max_parent_form()
getLimitMenu_min_parent_form()
This method is inherited from I2CE_FormField->getLimitMenu_min_parent_form()
processLimitMenu_max_parent()
This method is inherited from I2CE_FormField->processLimitMenu_max_parent()
processLimitMenu_min_parent()
This method is inherited from I2CE_FormField->processLimitMenu_min_parent()
processLimitMenu_max_parent_form()
This method is inherited from I2CE_FormField->processLimitMenu_max_parent_form()
processLimitMenu_min_parent_form()
This method is inherited from I2CE_FormField->processLimitMenu_min_parent_form()
save()
This method is inherited from I2CE_FormField->save()
populateHistory()
This method is inherited from I2CE_FormField->populateHistory()
userMessage()
This method is inherited from I2CE_Fuzzy->userMessage()
Fuzzy Methods
generateLimit_in()
This method is implemented by I2CE_Module_FormLimits->generateLimit_DB_DATE_in()
generateLimit_greaterthan_now()
This method is implemented by I2CE_Module_FormLimits->generateLimit_greaterthan_now()
generateLimit_lessthan_now()
This method is implemented by I2CE_Module_FormLimits->generateLimit_lessthan_now()
checkLimit_in()
This method is implemented by I2CE_Module_FormLimits->checkLimit_DB_DATE_in()
checkLimitString_in()
This method is implemented by I2CE_Module_FormLimits->checkLimitString_DB_DATE_in()
getLimitMenu_in()
This method is implemented by I2CE_Module_FormLimits->I2CE_FormField_DB_DATE_DISPLAYFIELDSTYLE_in()
processLimitMenu_in()
This method is implemented by I2CE_Module_FormLimits->I2CE_FormField_DB_DATE_PROCESSFIELDSTYLE_in()
checkLimit_greaterthan_now()
This method is implemented by I2CE_Module_FormLimits->checkLimit_DB_DATE_greaterthan_now()
checkLimitString_greaterthan_now()
This method is implemented by I2CE_Module_FormLimits->checkLimitString_DB_DATE_greaterthan_now()
getLimitMenu_greaterthan_now()
This method is implemented by I2CE_Module_FormLimits->I2CE_FormField_DB_DATE_DISPLAYFIELDSTYLE_greaterthan_now()
processLimitMenu_greaterthan_now()
This method is implemented by I2CE_Module_FormLimits->I2CE_FormField_DB_DATE_PROCESSFIELDSTYLE_greaterthan_now()
checkLimit_lessthan_now()
This method is implemented by I2CE_Module_FormLimits->checkLimit_DB_DATE_lessthan_now()
checkLimitString_lessthan_now()
This method is implemented by I2CE_Module_FormLimits->checkLimitString_DB_DATE_lessthan_now()
getLimitMenu_lessthan_now()
This method is implemented by I2CE_Module_FormLimits->I2CE_FormField_DB_DATE_DISPLAYFIELDSTYLE_lessthan_now()
processLimitMenu_lessthan_now()
This method is implemented by I2CE_Module_FormLimits->I2CE_FormField_DB_DATE_PROCESSFIELDSTYLE_lessthan_now()
