View source for Class: I2CE FieldContainer (4.0.19)

{{otherversions|Class: I2CE_FieldContainer}}
This article describes the ''abstract'' class ''I2CE_FieldContainer'' .
*Extends the class: [[Class: I2CE_Fuzzy (4.0.19) | I2CE_Fuzzy]].
*Implements the interface [http://www.php.net/manual/en/class.iterator.php Iterator ]
*Child Classes:
** [[Class: I2CE_Form (4.0.19) | I2CE_Form]]
*** [[Class: I2CE_List (4.0.19) | I2CE_List]]
**** [[Class: iHRIS_Contact (4.0.19) | iHRIS_Contact]]
***** [[Class: iHRIS_NamedContact (4.0.19) | iHRIS_NamedContact]]
***** [[Class: iHRIS_NextOfKin (4.0.19) | iHRIS_NextOfKin]]
**** [[Class: iHRIS_Country (4.0.19) | iHRIS_Country]]
**** [[Class: I2CE_SimpleList (4.0.19) | I2CE_SimpleList]]
**** [[Class: I2CE_User_Form (4.0.19) | I2CE_User_Form]]
**** [[Class: iHRIS_Position (4.0.19) | iHRIS_Position]]
**** [[Class: iHRIS_Cadre (4.0.19) | iHRIS_Cadre]]
**** [[Class: iHRIS_Scheduled_Training_Course (4.0.19) | iHRIS_Scheduled_Training_Course]]
**** [[Class: iHRIS_Training_Course (4.0.19) | iHRIS_Training_Course]]
**** [[Class: iHRIS_ContinuingEducationCourse (4.0.19) | iHRIS_ContinuingEducationCourse]]
**** [[Class: iHRIS_Currency (4.0.19) | iHRIS_Currency]]
**** [[Class: iHRIS_ListByCountry (4.0.19) | iHRIS_ListByCountry]]
***** [[Class: iHRIS_Facility (4.0.19) | iHRIS_Facility]]
****** [[Class: iHRIS_HealthFacility (4.0.19) | iHRIS_HealthFacility]]
***** [[Class: iHRIS_QualifyTrainingInstitution (4.0.19) | iHRIS_QualifyTrainingInstitution]]
**** [[Class: iHRIS_County (4.0.19) | iHRIS_County]]
**** [[Class: iHRIS_District (4.0.19) | iHRIS_District]]
**** [[Class: iHRIS_Region (4.0.19) | iHRIS_Region]]
**** [[Class: I2CE_Form_Locale (4.0.19) | I2CE_Form_Locale]]
**** [[Class: iHRIS_Degree (4.0.19) | iHRIS_Degree]]
**** [[Class: I2CE_ArchivedReport (4.0.19) | I2CE_ArchivedReport]]
**** [[Class: I2CE_Role (4.0.19) | I2CE_Role]]
**** [[Class: iHRIS_EstablishmentPeriod (4.0.19) | iHRIS_EstablishmentPeriod]]
**** [[Class: iHRIS_Establishment (4.0.19) | iHRIS_Establishment]]
**** [[Class: iHRIS_Classification (4.0.19) | iHRIS_Classification]]
**** [[Class: iHRIS_SalaryGrade (4.0.19) | iHRIS_SalaryGrade]]
**** [[Class: iHRIS_Job (4.0.19) | iHRIS_Job]]
***** [[Class: iHRIS_ManageJob (4.0.19) | iHRIS_ManageJob]]
**** [[Class: iHRIS_Department (4.0.19) | iHRIS_Department]]
**** [[Class: iHRIS_ConfirmationType (4.0.19) | iHRIS_ConfirmationType]]
**** [[Class: iHRIS_Certificate (4.0.19) | iHRIS_Certificate]]
**** [[Class: iHRIS_DisciplinaryActionReason (4.0.19) | iHRIS_DisciplinaryActionReason]]
**** [[Class: iHRIS_TrainingDisruptionReason (4.0.19) | iHRIS_TrainingDisruptionReason]]
**** [[Class: iHRIS_TrainingProgram (4.0.19) | iHRIS_TrainingProgram]]
**** [[Class: iHRIS_ISCO_08_Major (4.0.19) | iHRIS_ISCO_08_Major]]
**** [[Class: iHRIS_ISCO_08_Sub_Major (4.0.19) | iHRIS_ISCO_08_Sub_Major]]
**** [[Class: iHRIS_ISCO_08_Minor (4.0.19) | iHRIS_ISCO_08_Minor]]
**** [[Class: iHRIS_ISCO_08_Unit (4.0.19) | iHRIS_ISCO_08_Unit]]
**** [[Class: iHRIS_ISCO_88_Major (4.0.19) | iHRIS_ISCO_88_Major]]
**** [[Class: iHRIS_ISCO_88_Sub_Major (4.0.19) | iHRIS_ISCO_88_Sub_Major]]
**** [[Class: iHRIS_ISCO_88_Minor (4.0.19) | iHRIS_ISCO_88_Minor]]
**** [[Class: iHRIS_ISCO_88_Unit (4.0.19) | iHRIS_ISCO_88_Unit]]
**** [[Class: iHRIS_Competency (4.0.19) | iHRIS_Competency]]
**** [[Class: iHRIS_Training_Course_Evaluation (4.0.19) | iHRIS_Training_Course_Evaluation]]
*** [[Class: iHRIS_UUID_Map (4.0.19) | iHRIS_UUID_Map]]
*** [[Class: iHRIS_Applicant (4.0.19) | iHRIS_Applicant]]
*** [[Class: iHRIS_PersonPosition (4.0.19) | iHRIS_PersonPosition]]
*** [[Class: iHRIS_Training (4.0.19) | iHRIS_Training]]
*** [[Class: iHRIS_ContinuingEducation (4.0.19) | iHRIS_ContinuingEducation]]
*** [[Class: iHRIS_Document (4.0.19) | iHRIS_Document]]
*** [[Class: I2CE_ListLink (4.0.19) | I2CE_ListLink]]
**** [[Class: I2CE_ListLink_List (4.0.19) | I2CE_ListLink_List]]
**** [[Class: I2CE_ListLink_String (4.0.19) | I2CE_ListLink_String]]
*** [[Class: iHRIS_Registration (4.0.19) | iHRIS_Registration]]
*** [[Class: iHRIS_Person (4.0.19) | iHRIS_Person]]
**** [[Class: iHRIS_ManagePerson (4.0.19) | iHRIS_ManagePerson]]
**** [[Class: iHRIS_QualifyPerson (4.0.19) | iHRIS_QualifyPerson]]
*** [[Class: iHRIS_Demographic (4.0.19) | iHRIS_Demographic]]
**** [[Class: iHRIS_ManageDemographic (4.0.19) | iHRIS_ManageDemographic]]
**** [[Class: iHRIS_QualifyDemographic (4.0.19) | iHRIS_QualifyDemographic]]
*** [[Class: iHRIS_Education (4.0.19) | iHRIS_Education]]
*** [[Class: iHRIS_Employment (4.0.19) | iHRIS_Employment]]
*** [[Class: iHRIS_PersonID (4.0.19) | iHRIS_PersonID]]
*** [[Class: iHRIS_PersonLanguage (4.0.19) | iHRIS_PersonLanguage]]
*** [[Class: iHRIS_Notes (4.0.19) | iHRIS_Notes]]
*** [[Class: iHRIS_Photo (4.0.19) | iHRIS_Photo]]
**** [[Class: iHRIS_Archive (4.0.19) | iHRIS_Archive]]
*** [[Class: I2CE_GeneratedDoc (4.0.19) | I2CE_GeneratedDoc]]
*** [[Class: iHRIS_Person_Record_Status (4.0.19) | iHRIS_Person_Record_Status]]
*** [[Class: iHRIS_RecordVerify (4.0.19) | iHRIS_RecordVerify]]
*** [[Class: iHRIS_Accident (4.0.19) | iHRIS_Accident]]
*** [[Class: iHRIS_Dependent (4.0.19) | iHRIS_Dependent]]
*** [[Class: iHRIS_DisciplinaryAction (4.0.19) | iHRIS_DisciplinaryAction]]
*** [[Class: iHRIS_PositionInterview (4.0.19) | iHRIS_PositionInterview]]
*** [[Class: iHRIS_PositionDecision (4.0.19) | iHRIS_PositionDecision]]
*** [[Class: iHRIS_Benefit (4.0.19) | iHRIS_Benefit]]
*** [[Class: iHRIS_Confirmation (4.0.19) | iHRIS_Confirmation]]
*** [[Class: iHRIS_Salary (4.0.19) | iHRIS_Salary]]
*** [[Class: iHRIS_Deployment (4.0.19) | iHRIS_Deployment]]
*** [[Class: iHRIS_SecondaryEducation (4.0.19) | iHRIS_SecondaryEducation]]
*** [[Class: iHRIS_Exam (4.0.19) | iHRIS_Exam]]
*** [[Class: iHRIS_FacilityInstitution (4.0.19) | iHRIS_FacilityInstitution]]
*** [[Class: iHRIS_FacilityInstitutionEditFacility (4.0.19) | iHRIS_FacilityInstitutionEditFacility]]
*** [[Class: iHRIS_FacilityInstitutionEditInstitution (4.0.19) | iHRIS_FacilityInstitutionEditInstitution]]
*** [[Class: iHRIS_InstitutionInspection (4.0.19) | iHRIS_InstitutionInspection]]
*** [[Class: iHRIS_License (4.0.19) | iHRIS_License]]
*** [[Class: iHRIS_OutMigration (4.0.19) | iHRIS_OutMigration]]
*** [[Class: iHRIS_PrivatePractice (4.0.19) | iHRIS_PrivatePractice]]
*** [[Class: iHRIS_TrainingDisrupt (4.0.19) | iHRIS_TrainingDisrupt]]
*** [[Class: iHRIS_PersonCompetency (4.0.19) | iHRIS_PersonCompetency]]
*** [[Class: iHRIS_Person_Scheduled_Training_Course (4.0.19) | iHRIS_Person_Scheduled_Training_Course]]
*** [[Class: iHRIS_Training_Course_Exam (4.0.19) | iHRIS_Training_Course_Exam]]
*** [[Class: iHRIS_Training_Course_Competency_Evaluation (4.0.19) | iHRIS_Training_Course_Competency_Evaluation]]
*Location: Part of the module [[I2CE Module List (4.0.19)#Fields|Fields]] in the package [https://launchpad.net/i2ce I2CE] 4.0.19-release
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.19-release/annotate/head:/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php#L33 modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php] on line 33
*Author: Carl Leitner <litlfred@ibiblio.org>
*Since: v4.0.6
@filesource Class I2CE_FieldContainer
==Variables==
===$name===
The name of this field container
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.19-release/annotate/head:/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php#L39 i2ce/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php] on line 39
*Type: protected [http://www.php.net/manual/en/language.types.string.php string ] $name

===$display_name===
The text name of this field container for display.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.19-release/annotate/head:/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php#L44 i2ce/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php] on line 44
*Type: protected [http://www.php.net/manual/en/language.types.string.php string ] $display_name

===$fields===
The list of fields with all the information about each field.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.19-release/annotate/head:/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php#L49 i2ce/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php] on line 49
*Type: protected [http://www.php.net/manual/en/language.types.array.php array ] $fields

===$attributes===
A list of attributes for this field container.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.19-release/annotate/head:/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php#L55 i2ce/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php] on line 55
*Type: protected [http://www.php.net/manual/en/language.types.array.php array ] $attributes

===$id===
The record id for this entry.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.19-release/annotate/head:/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php#L60 i2ce/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php] on line 60
*Type: protected [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $id

===$factory===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.19-release/annotate/head:/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php#L324 i2ce/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php] on line 324
*Type: protected [[Class: I2CE_FieldContainer_Factory (4.0.19) | I2CE_FieldContainer_Factory]] $factory

==Methods==
===__construct()===
Create a new instance of a I2CE_FieldContainer object.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.19-release/annotate/head:/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php#L299 i2ce/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php] on line 299
*Signature: public function __construct($factory,$name,$id)
*Parameters:
** [[Class: I2CE_FieldContainer_Factory (4.0.19) | I2CE_FieldContainer_Factory]] $factory
** [http://www.php.net/manual/en/language.types.string.php string ] $name <br/>The name of this field container
** integer $id
***Default Value: '0' 
===__get()===
Return the [[Class: I2CE_FormField (4.0.19) | field]] value from the [[#$fields | $fields]] array.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.19-release/annotate/head:/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php#L407 i2ce/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php] on line 407
*Signature: public function __get($key)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $key
*Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]
===__isset()===
Check to see if a [[Class: I2CE_FormField (4.0.19) | field]] value has been set.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.19-release/annotate/head:/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php#L435 i2ce/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php] on line 435
*Signature: public function __isset($key)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $key
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
===__set()===
Set the [[Class: I2CE_FormField (4.0.19) | field]] value in the [[#$fields | $fields]] array.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.19-release/annotate/head:/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php#L420 i2ce/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php] on line 420
*Signature: public function __set($key,$value)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $key
** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $value
===__unset()===
Unset a [[Class: I2CE_FormField (4.0.19) | field]].
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.19-release/annotate/head:/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php#L447 i2ce/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php] on line 447
*Signature: public function __unset($key)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $key
===addField()===
Adds a field to this form.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.19-release/annotate/head:/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php#L363 i2ce/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php] on line 363
*Signature: public function addField($name,$args)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $name
** [http://www.php.net/manual/en/language.types.array.php array ] $args <br/>The arguments for this field
*Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]<br/>I2CE_FormField or false on failure
===addFields()===
Adds fields to the field container as indicated by the data arra
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.19-release/annotate/head:/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php#L333 i2ce/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php] on line 333
*Signature: protected function addFields($data)
*Parameters:
** [http://www.php.net/manual/en/language.types.array.php array ] $data <br/>An array with keys the name of a field and values an array of defining data.
===cleanup()===
Clean up all the fields for this field container. This will unset all the fields associated with this field container.  This will remove all circular references to this field container so it can be cleaned up by the garbage collector. This should only be called when the field container is no longer needed.  Trying to access it after this may cause unexpected results or errors.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.19-release/annotate/head:/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php#L464 i2ce/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php] on line 464
*Signature: public function cleanup($remove_from_cache)
*Parameters:
** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $remove_from_cache <br/>Defaults to true in which case we remove it from the factory's field container cache as well
***Default Value: true
===clearFields()===
Remove fields from the container This is to be used when only certain fields of the container are being dealt with so the others can be removed to save processing.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.19-release/annotate/head:/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php#L483 i2ce/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php] on line 483
*Signature: public function clearFields($fields,$keep)
*Parameters:
** [http://www.php.net/manual/en/language.types.array.php array ] $fields <br/>The fields being worked with.
** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $keep <br/>A flag to determine if the given fields should be removed or all except the given fields.
***Default Value: true 
===current()===
Return the current value for the [[#$fields | $fields]] array for iterating through the  fields.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.19-release/annotate/head:/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php#L268 i2ce/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php] on line 268
*Signature: public function current()
*Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]
===getAttribute()===
Return the attribute value for a given attribute.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.19-release/annotate/head:/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php#L111 i2ce/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php] on line 111
*Signature: public function getAttribute($key)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $key
*Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]
===getAttributes()===
Returns the array of attributes for this container
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.19-release/annotate/head:/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php#L317 i2ce/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php] on line 317
*Signature: protected function getAttributes()
*Returns: [http://www.php.net/manual/en/language.types.array.php array ]
===getContainerType()===
Return the value for the type of this container
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.19-release/annotate/head:/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php#L180 i2ce/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php] on line 180
*Signature: public function getContainerType()
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]<br/>or null on failure
===getField()===
Return the I2CE_FormField for the given field name.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.19-release/annotate/head:/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php#L237 i2ce/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php] on line 237
*Signature: public function getField($field)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $field <br/>the field name or a form name:field name
*Returns: [[Class: I2CE_FormField (4.0.19) | I2CE_FormField]]
===getFieldNames()===
Get the names of all the fields added in this field container
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.19-release/annotate/head:/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php#L227 i2ce/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php] on line 227
*Signature: public function getFieldNames()
*Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>of string, the field names.
===getHTMLName()===
Return the value for the name attribute to be used for this form to be used as part of a request variable
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.19-release/annotate/head:/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php#L194 i2ce/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php] on line 194
*Signature: public function getHTMLName()
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]
===getHistory()===
Get the history of each field in this container.  May need to populate the history
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.19-release/annotate/head:/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php#L206 i2ce/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php] on line 206
*Signature: public function getHistory($as_array)
*Parameters:
** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $as_array <br/>Defaults to false in which case results are instances of I2CE_Entry, otherwise reusults are associative arrays
***Default Value: false
*Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>index by field names
===getId()===
Returns the id for this record.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.19-release/annotate/head:/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php#L74 i2ce/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php] on line 74
*Signature: public function getId()
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]
===getLoad()===
Get the request variable in the format expected from {load()}
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.19-release/annotate/head:/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php#L565 i2ce/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php] on line 565
*Signature: public function getLoad()
===getMeta()===
Return the meta attribute value for a given meta.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.19-release/annotate/head:/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php#L144 i2ce/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php] on line 144
*Signature: public function getMeta($key)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $key
*Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]
===getName()===
Return the name for this field container
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.19-release/annotate/head:/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php#L172 i2ce/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php] on line 172
*Signature: public function getName()
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]
===getNameId()===
Returns the name and id for this record.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.19-release/annotate/head:/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php#L66 i2ce/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php] on line 66
*Signature: public function getNameId()
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]<br/>of the form "$name|$id"
===getPost()===
Get the nested associative array that is used for post
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.19-release/annotate/head:/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php#L549 i2ce/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php] on line 549
*Signature: public function getPost($field_names,$skip_invalid,$include_id)
*Parameters:
** [http://www.php.net/manual/en/language.types.array.php array ] $field_names <br/>Array of string, the field names we wish to query.  Defaults to null in which we case we get all fields
***Default Value: null
** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $skip_invalid <br/>Defaults to true in which case we skip invalid values
***Default Value: true
** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $include_id <br/>defaults to true
***Default Value: true
*Returns: [http://www.php.net/manual/en/language.types.array.php array ]
===getQueryDisplay()===
Return the values of all the fields that are set.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.19-release/annotate/head:/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php#L686 i2ce/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php] on line 686
*Signature: public function getQueryDisplay($field_names,$skip_invalid)
*Parameters:
** [http://www.php.net/manual/en/language.types.array.php array ] $field_names <br/>Array of string, the field names we wish to query.  Defaults to null in which we case we get all fields
***Default Value: null
** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $skip_invalid <br/>Defaults to true in which case we skip invalid values
***Default Value: true
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]
===getQueryFields()===
Return all the fields as an associative array
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.19-release/annotate/head:/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php#L654 i2ce/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php] on line 654
*Signature: public function getQueryFields($field_names,$skip_invalid,$html_name)
*Parameters:
** [http://www.php.net/manual/en/language.types.array.php array ] $field_names <br/>Array of string, the field names we wish to query.  Defaults to null in which we case we get all fields
***Default Value: null
** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $skip_invalid <br/>Defaults to true in which case we skip invalid values
***Default Value: true
** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $html_name <br/>Use the html name as teh key in the returned array.  Defaults to true.  If false we use the field name
***Default Value: true
*Returns: [http://www.php.net/manual/en/language.types.array.php array ]
===getQueryString()===
Return all the fields as a query string to be sent to a URL
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.19-release/annotate/head:/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php#L624 i2ce/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php] on line 624
*Signature: public function getQueryString($field_names,$skip_invalid)
*Parameters:
** [http://www.php.net/manual/en/language.types.array.php array ] $field_names <br/>Array of string, the field names we wish to query.  Defaults to null in which we case we get all fields
***Default Value: null
** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $skip_invalid <br/>Defaults to true in which case we skip invalid values
***Default Value: true
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]
===hasAttribute()===
Return true if a given attribute exists for this field container.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.19-release/annotate/head:/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php#L124 i2ce/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php] on line 124
*Signature: public function hasAttribute($key)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $key
*Returns: boolean;
===hasInvalid()===
Checks to see if any fields of form has in invalid message
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.19-release/annotate/head:/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php#L734 i2ce/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php] on line 734
*Signature: public function hasInvalid()
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
===hasMeta()===
Return true if a given meta attribute exists for this field container.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.19-release/annotate/head:/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php#L153 i2ce/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php] on line 153
*Signature: public function hasMeta($key)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $key
*Returns: boolean;
===isValid()===
Check to see if the named field is valid
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.19-release/annotate/head:/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php#L749 i2ce/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php] on line 749
*Signature: public function isValid($field)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $field
*Returns: boolean;
===key()===
Return the current key for the [[#$fields | $fields]] array for iterating through the  fields.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.19-release/annotate/head:/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php#L275 i2ce/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php] on line 275
*Signature: public function key()
*Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]
===load()===
Load the member variables from an array
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.19-release/annotate/head:/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php#L588 i2ce/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php] on line 588
*Signature: public function load($post,$loadID,$populate_on_set_id)
*Parameters:
** [http://www.php.net/manual/en/language.types.array.php array ] $post <br/>The Post vairables.  Usually from an http request.
** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $loadID <br/>Defaults to true.  If true, and there is exactly one of  entry in the array $post[<<NAME>>][$this->name], we set the values of the containerss field, id and parent from that entry.  If false, we set the values from $post[<<TYPE>>][$this->name][$this->getID()]  if it is present
***Default Value: true
**$populate_on_set_id 
***Default Value: true
===next()===
Advance the internal pointer for the [[#$fields | $fields]] array for iterating through the fields.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.19-release/annotate/head:/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php#L281 i2ce/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php] on line 281
*Signature: public function next()
===removeField()===
Removes a field from this field container. @param array $args The arguments for this field
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.19-release/annotate/head:/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php#L390 i2ce/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php] on line 390
*Signature: public function removeField($name)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $name
===rewind()===
Rewind the internal pointer for the [[#$fields | $fields]] array for iterating through the  fields.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.19-release/annotate/head:/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php#L261 i2ce/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php] on line 261
*Signature: public function rewind()
===setAttribute()===
Set an attribute for this field container.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.19-release/annotate/head:/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php#L102 i2ce/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php] on line 102
*Signature: public function setAttribute($key,$value)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $key
** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $value
===setFromPost()===
Load the member variables from an array The array can contain the keys 'id', 'parent', 'fields'.  The later of which is an array indexed by field names and which contains the values of the field
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.19-release/annotate/head:/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php#L506 i2ce/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php] on line 506
*Signature: public function setFromPost($post,$populate_on_set_id)
*Parameters:
** [http://www.php.net/manual/en/language.types.array.php array ] $post
**$populate_on_set_id 
***Default Value: false
===setId()===
Set the id for this record.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.19-release/annotate/head:/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php#L83 i2ce/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php] on line 83
*Signature: public function setId($id)
*Parameters:
** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $id
===setMeta()===
Set a meta attribute for this field container.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.19-release/annotate/head:/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php#L135 i2ce/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php] on line 135
*Signature: public function setMeta($key,$value)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $key
** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $value
===setName()===
Set the name for this field container
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.19-release/annotate/head:/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php#L163 i2ce/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php] on line 163
*Signature: public function setName($name)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $name
===valid()===
Check to see if the current internal pointer for the [[#$fields | $fields]] array is valid.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.19-release/annotate/head:/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php#L288 i2ce/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php] on line 288
*Signature: public function valid()
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
===validate()===
Validate all fields that are marked as required or unique. This will check all the fields in this form and if they're required or unique it will perform the required checks
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.19-release/annotate/head:/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php#L721 i2ce/modules/Forms/modules/Fields/lib/I2CE_FieldContainer.php] on line 721
*Signature: public function validate()
==Inherited Methods==
===_hasMethod()===
This public method is inherited from [[Class: I2CE_Fuzzy (4.0.19)#_hasMethod() | I2CE_Fuzzy->_hasMethod()]]
==Inherited Fuzzy Methods==
===userMessage()===
This method is inherited from [[Class: I2CE_Fuzzy (4.0.19)#userMessage() | I2CE_Fuzzy->userMessage()]]


[[Category:Class Documentation (4.0.19)]]