Class: I2CE FormField DB DATE: Difference between revisions
No edit summary |
No edit summary |
||
| Line 33: | Line 33: | ||
Create a new instance of a I2CE_FormField | Create a new instance of a I2CE_FormField | ||
*Signature: public function __construct($name,$options) | *Signature: public function __construct($name,$options) | ||
Parameters: | *Parameters: | ||
* [http://www.php.net/manual/en/language.types.string.php string ] $name | ** [http://www.php.net/manual/en/language.types.string.php string ] $name | ||
* [http://www.php.net/manual/en/language.types.array.php array ] $options<br/>A list of options for this form field. | ** [http://www.php.net/manual/en/language.types.array.php array ] $options <br/>A list of options for this form field. | ||
===compare()=== | ===compare()=== | ||
Compares this form field agains the given form field. | Compares this form field agains the given form field. | ||
*Signature: public function compare($db_value) | *Signature: public function compare($db_value) | ||
*Parameters: | |||
** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $db_value <br/>Either a DB Value or an I2CE_FormField | |||
*Returns: -1,0,1 | *Returns: -1,0,1 | ||
===getDBValue()=== | ===getDBValue()=== | ||
Returns the value of this field ready to be stored in the database. | Returns the value of this field ready to be stored in the database. | ||
| Line 48: | Line 48: | ||
===getDisplayValue()=== | ===getDisplayValue()=== | ||
Returns the value of this field as a human readable format. | Returns the value of this field as a human readable format. | ||
*Signature: public function getDisplayValue($entry) | *Signature: public function getDisplayValue($entry) | ||
*Parameters: | |||
** [[Class: I2CE_Entry | I2CE_Entry]] $entry <br/>If a I2CE_Entry object has been passed to this method then it will return the value for that entry assuming it's an entry for this field. | |||
***Default Value: false | |||
*Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ] | *Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ] | ||
===getFromDB()=== | ===getFromDB()=== | ||
Return the value of this field from the database format for the given type | 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. | ||
@param integer $type The type of the field to be returned. | |||
*Signature: public function getFromDB($value) | *Signature: public function getFromDB($value) | ||
Parameters: | *Parameters: | ||
* [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $value | ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $value | ||
===getYearRange()=== | ===getYearRange()=== | ||
Return the year range for this field if it's a date. | Return the year range for this field if it's a date. | ||
*Signature: public function getYearRange() | *Signature: public function getYearRange() | ||
*Returns: [http://www.php.net/manual/en/language.types.array.php array ] | *Returns: [http://www.php.net/manual/en/language.types.array.php array ]@global array | ||
@global array | |||
===isSameValue()=== | ===isSameValue()=== | ||
Check to see if the given DB value is equivalent to this value. | Check to see if the given DB value is equivalent to this value. @param mixed $value | ||
@param mixed $value | |||
*Signature: public function isSameValue($db_value) | *Signature: public function isSameValue($db_value) | ||
*Parameters: | |||
*$db_value | |||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | ||
===isValid()=== | ===isValid()=== | ||
Checks to see if the current value for this is set and valid. | Checks to see if the current value for this is set and valid. | ||
| Line 82: | Line 78: | ||
===setYearRange()=== | ===setYearRange()=== | ||
*Signature: public function setYearRange($start,$end) | *Signature: public function setYearRange($start,$end) | ||
Parameters: | *Parameters: | ||
*$start | *$start | ||
*$end | *$end | ||
**Default Value: 0 | ***Default Value: 0 | ||
==Inherited Variables== | ==Inherited Variables== | ||
| Line 250: | Line 246: | ||
Create a new instance of a I2CE_FormField | Create a new instance of a I2CE_FormField | ||
*Signature: public function __construct($name,$options) | *Signature: public function __construct($name,$options) | ||
Parameters: | *Parameters: | ||
* [http://www.php.net/manual/en/language.types.string.php string ] $name | ** [http://www.php.net/manual/en/language.types.string.php string ] $name | ||
* [http://www.php.net/manual/en/language.types.array.php array ] $options<br/>A list of options for this form field. | ** [http://www.php.net/manual/en/language.types.array.php array ] $options <br/>A list of options for this form field. | ||
===compare()=== | ===compare()=== | ||
Compares this form field agains the given form field. | Compares this form field agains the given form field. | ||
*Signature: public function compare($db_value) | *Signature: public function compare($db_value) | ||
*Parameters: | |||
** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $db_value <br/>Either a DB Value or an I2CE_FormField | |||
*Returns: -1,0,1 | *Returns: -1,0,1 | ||
===getDBValue()=== | ===getDBValue()=== | ||
Returns the value of this field ready to be stored in the database. | Returns the value of this field ready to be stored in the database. | ||
| Line 265: | Line 261: | ||
===getDisplayValue()=== | ===getDisplayValue()=== | ||
Returns the value of this field as a human readable format. | Returns the value of this field as a human readable format. | ||
*Signature: public function getDisplayValue($entry) | *Signature: public function getDisplayValue($entry) | ||
*Parameters: | |||
** [[Class: I2CE_Entry | I2CE_Entry]] $entry <br/>If a I2CE_Entry object has been passed to this method then it will return the value for that entry assuming it's an entry for this field. | |||
***Default Value: false | |||
*Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ] | *Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ] | ||
===getFromDB()=== | ===getFromDB()=== | ||
Return the value of this field from the database format for the given type | 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. | ||
@param integer $type The type of the field to be returned. | |||
*Signature: public function getFromDB($value) | *Signature: public function getFromDB($value) | ||
Parameters: | *Parameters: | ||
* [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $value | ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $value | ||
===getYearRange()=== | ===getYearRange()=== | ||
Return the year range for this field if it's a date. | Return the year range for this field if it's a date. | ||
*Signature: public function getYearRange() | *Signature: public function getYearRange() | ||
*Returns: [http://www.php.net/manual/en/language.types.array.php array ] | *Returns: [http://www.php.net/manual/en/language.types.array.php array ]@global array | ||
@global array | |||
===isSameValue()=== | ===isSameValue()=== | ||
Check to see if the given DB value is equivalent to this value. | Check to see if the given DB value is equivalent to this value. @param mixed $value | ||
@param mixed $value | |||
*Signature: public function isSameValue($db_value) | *Signature: public function isSameValue($db_value) | ||
*Parameters: | |||
*$db_value | |||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | ||
===isValid()=== | ===isValid()=== | ||
Checks to see if the current value for this is set and valid. | Checks to see if the current value for this is set and valid. | ||
| Line 299: | Line 291: | ||
===setYearRange()=== | ===setYearRange()=== | ||
*Signature: public function setYearRange($start,$end) | *Signature: public function setYearRange($start,$end) | ||
Parameters: | *Parameters: | ||
*$start | *$start | ||
*$end | *$end | ||
**Default Value: 0 | ***Default Value: 0 | ||
==Inherited Variables== | ==Inherited Variables== | ||
Revision as of 22:41, 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.
- Extends the class: I2CE_FormField.
- Location: Part of the module forms in the package I2CE
- Source: Defined in the file modules/Forms/lib/fields/I2CE_FormField_DB_DATE.php
- Author: Luke Duncan <lduncan@intrahealth.org>
- Since: v2.0.0
Class for defining all the database fields used by a I2CE_Form object.
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)
- Parameters:
- mixed $db_value
Either a DB Value or an I2CE_FormField
- mixed $db_value
- Returns: -1,0,1
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.
- Signature: public function getDisplayValue($entry)
- 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 entry for this field.- Default Value: false
- I2CE_Entry $entry
- Returns: mixed
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)
- Parameters:
- $db_value
- Returns: boolean
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.
- Extends the class: I2CE_FormField.
- Location: Part of the module forms in the package I2CE
- Source: Defined in the file modules/Forms/lib/fields/I2CE_FormField_DB_DATE.php
- Author: Luke Duncan <lduncan@intrahealth.org>
- Since: v2.0.0
Class for defining all the database fields used by a I2CE_Form object.
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)
- Parameters:
- mixed $db_value
Either a DB Value or an I2CE_FormField
- mixed $db_value
- Returns: -1,0,1
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.
- Signature: public function getDisplayValue($entry)
- 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 entry for this field.- Default Value: false
- I2CE_Entry $entry
- Returns: mixed
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)
- Parameters:
- $db_value
- Returns: boolean
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()
