|
|
| (14 intermediate revisions by one other user not shown) |
| Line 1: |
Line 1: |
| This article describes the class ''I2CE_Form''.
| | #REDIRECT [[Class: I2CE_Form (4.1.12)]] |
| *Extends the class: [[Class: I2CE_Fuzzy | I2CE_Fuzzy]].
| |
| *Implements the interface [http://www.php.net/manual/en/class.iterator.php Iterator ]
| |
| *Child Classes:
| |
| ** [[Class: I2CE_List | I2CE_List]]
| |
| *** [[Class: iHRIS_Contact | iHRIS_Contact]]
| |
| *** [[Class: iHRIS_Currency | iHRIS_Currency]]
| |
| *** [[Class: iHRIS_Country | iHRIS_Country]]
| |
| *** [[Class: I2CE_SimpleList | I2CE_SimpleList]]
| |
| *** [[Class: iHRIS_Job | iHRIS_Job]]
| |
| *** [[Class: iHRIS_Position | iHRIS_Position]]
| |
| *** [[Class: iHRIS_Cadre | iHRIS_Cadre]]
| |
| *** [[Class: iHRIS_TrainingProgram | iHRIS_TrainingProgram]]
| |
| *** [[Class: iHRIS_Competency | iHRIS_Competency]]
| |
| *** [[Class: iHRIS_Scheduled_Training_Course | iHRIS_Scheduled_Training_Course]]
| |
| *** [[Class: iHRIS_Training_Course | iHRIS_Training_Course]]
| |
| *** [[Class: iHRIS_ContinuingEducationCourse | iHRIS_ContinuingEducationCourse]]
| |
| *** [[Class: iHRIS_ListByCountry | iHRIS_ListByCountry]]
| |
| **** [[Class: iHRIS_Facility | iHRIS_Facility]]
| |
| ***** [[Class: iHRIS_HealthFacility | iHRIS_HealthFacility]]
| |
| **** [[Class: iHRIS_QualifyTrainingInstitution | iHRIS_QualifyTrainingInstitution]]
| |
| *** [[Class: iHRIS_County | iHRIS_County]]
| |
| *** [[Class: iHRIS_District | iHRIS_District]]
| |
| *** [[Class: iHRIS_Region | iHRIS_Region]]
| |
| *** [[Class: iHRIS_Degree | iHRIS_Degree]]
| |
| *** [[Class: I2CE_Role | I2CE_Role]]
| |
| *** [[Class: iHRIS_Classification | iHRIS_Classification]]
| |
| *** [[Class: iHRIS_SalaryGrade | iHRIS_SalaryGrade]]
| |
| *** [[Class: iHRIS_Department | iHRIS_Department]]
| |
| *** [[Class: iHRIS_Certificate | iHRIS_Certificate]]
| |
| *** [[Class: iHRIS_DisciplinaryActionReason | iHRIS_DisciplinaryActionReason]]
| |
| *** [[Class: iHRIS_TrainingDisruptionReason | iHRIS_TrainingDisruptionReason]]
| |
| *** [[Class: iHRIS_ISCO_08_Major | iHRIS_ISCO_08_Major]]
| |
| *** [[Class: iHRIS_ISCO_08_Sub_Major | iHRIS_ISCO_08_Sub_Major]]
| |
| *** [[Class: iHRIS_ISCO_88_Major | iHRIS_ISCO_88_Major]]
| |
| *** [[Class: iHRIS_ISCO_88_Sub_Major | iHRIS_ISCO_88_Sub_Major]]
| |
| *** [[Class: iHRIS_ISCO_88_Minor | iHRIS_ISCO_88_Minor]]
| |
| *** [[Class: iHRIS_ISCO_88_Unit | iHRIS_ISCO_88_Unit]]
| |
| *** [[Class: iHRIS_Training_Course_Evaluation | iHRIS_Training_Course_Evaluation]]
| |
| ** [[Class: iHRIS_Person | iHRIS_Person]]
| |
| *** [[Class: iHRIS_QualifyPerson | iHRIS_QualifyPerson]]
| |
| *** [[Class: iHRIS_ManagePerson | iHRIS_ManagePerson]]
| |
| ** [[Class: I2CE_User_Form | I2CE_User_Form]]
| |
| ** [[Class: iHRIS_Search | iHRIS_Search]]
| |
| ** [[Class: iHRIS_Applicant | iHRIS_Applicant]]
| |
| ** [[Class: iHRIS_Benefit | iHRIS_Benefit]]
| |
| ** [[Class: iHRIS_PersonPosition | iHRIS_PersonPosition]]
| |
| ** [[Class: iHRIS_DisciplinaryAction | iHRIS_DisciplinaryAction]]
| |
| ** [[Class: iHRIS_Exam | iHRIS_Exam]]
| |
| ** [[Class: iHRIS_License | iHRIS_License]]
| |
| ** [[Class: iHRIS_PrivatePractice | iHRIS_PrivatePractice]]
| |
| ** [[Class: iHRIS_Registration | iHRIS_Registration]]
| |
| ** [[Class: iHRIS_Training | iHRIS_Training]]
| |
| ** [[Class: iHRIS_TrainingDisrupt | iHRIS_TrainingDisrupt]]
| |
| ** [[Class: iHRIS_ContinuingEducation | iHRIS_ContinuingEducation]]
| |
| ** [[Class: iHRIS_Document | iHRIS_Document]]
| |
| ** [[Class: iHRIS_Demographic | iHRIS_Demographic]]
| |
| *** [[Class: iHRIS_ManageDemographic | iHRIS_ManageDemographic]]
| |
| *** [[Class: iHRIS_QualifyDemographic | iHRIS_QualifyDemographic]]
| |
| ** [[Class: iHRIS_Education | iHRIS_Education]]
| |
| ** [[Class: iHRIS_Employment | iHRIS_Employment]]
| |
| ** [[Class: iHRIS_PersonID | iHRIS_PersonID]]
| |
| ** [[Class: iHRIS_PersonLanguage | iHRIS_PersonLanguage]]
| |
| ** [[Class: iHRIS_Notes | iHRIS_Notes]]
| |
| ** [[Class: iHRIS_Photo | iHRIS_Photo]]
| |
| ** [[Class: iHRIS_RecordVerify | iHRIS_RecordVerify]]
| |
| ** [[Class: iHRIS_PositionInterview | iHRIS_PositionInterview]]
| |
| ** [[Class: iHRIS_PositionDecision | iHRIS_PositionDecision]]
| |
| ** [[Class: iHRIS_Salary | iHRIS_Salary]]
| |
| ** [[Class: iHRIS_Deployment | iHRIS_Deployment]]
| |
| ** [[Class: iHRIS_SecondaryEducation | iHRIS_SecondaryEducation]]
| |
| ** [[Class: iHRIS_FacilityInstitution | iHRIS_FacilityInstitution]]
| |
| ** [[Class: iHRIS_FacilityInstitutionEditFacility | iHRIS_FacilityInstitutionEditFacility]]
| |
| ** [[Class: iHRIS_FacilityInstitutionEditInstitution | iHRIS_FacilityInstitutionEditInstitution]]
| |
| ** [[Class: iHRIS_InstitutionInspection | iHRIS_InstitutionInspection]]
| |
| ** [[Class: iHRIS_OutMigration | iHRIS_OutMigration]]
| |
| ** [[Class: iHRIS_PersonCompetency | iHRIS_PersonCompetency]]
| |
| ** [[Class: iHRIS_Person_Scheduled_Training_Course | iHRIS_Person_Scheduled_Training_Course]]
| |
| ** [[Class: iHRIS_Training_Course_Competency_Evaluation | iHRIS_Training_Course_Competency_Evaluation]]
| |
| *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.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L36 modules/Forms/lib/I2CE_Form.php] on line 36
| |
| *Author: Luke Duncan <lduncan@intrahealth.org>
| |
| *Since: v1.0.0
| |
| *See: [[Class: I2CE_Template | I2CE_Template]]
| |
| Abstract class for objects using the [[Class: I2CE_Template | ]] class that interact with a database and HTML form. This class has a few default functions that are used when interacting with the template engine in setting up form values and displaying the data for objects that tie directly to database tables.
| |
| ==Variables==
| |
| ===$form_name===
| |
| The name of this form for the database.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L41 i2ce/modules/Forms/lib/I2CE_Form.php] on line 41
| |
| *Type: private [http://www.php.net/manual/en/language.types.string.php string ] $form_name
| |
| | |
| ===$display_name===
| |
| The text name of this form for display.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L46 i2ce/modules/Forms/lib/I2CE_Form.php] on line 46
| |
| *Type: private [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.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L51 i2ce/modules/Forms/lib/I2CE_Form.php] on line 51
| |
| *Type: protected [http://www.php.net/manual/en/language.types.array.php array ] $fields
| |
| | |
| ===$parent===
| |
| String or boolean (false) The form and id of the parent record for this form if there is one. Of the form "$form|$id"
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L56 i2ce/modules/Forms/lib/I2CE_Form.php] on line 56
| |
| *Type: protected [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $parent
| |
| | |
| ===$id===
| |
| The record id for this entry.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L61 i2ce/modules/Forms/lib/I2CE_Form.php] on line 61
| |
| *Type: protected [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $id
| |
| | |
| ===$children===
| |
| An array of children objects for this form. It is an array of arrays. The first being an associative array with the name of the form, the second level is a simple array of the objects.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L70 i2ce/modules/Forms/lib/I2CE_Form.php] on line 70
| |
| *Type: public [http://www.php.net/manual/en/language.types.array.php array ] $children
| |
| | |
| ===$attributes===
| |
| A list of attributes for this form.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L75 i2ce/modules/Forms/lib/I2CE_Form.php] on line 75
| |
| *Type: protected [http://www.php.net/manual/en/language.types.array.php array ] $attributes
| |
| | |
| ===$parent_forms===
| |
| parent_forms. The array with keys form names and values which are arrays of form names, the form names which the form's parent id can take values in
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L202 i2ce/modules/Forms/lib/I2CE_Form.php] on line 202
| |
| *Type: static protected [http://www.php.net/manual/en/language.types.array.php array ] $parent_forms
| |
| | |
| ==Methods==
| |
| ===__construct()===
| |
| Create a new instance of a I2CE_Form object.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L248 i2ce/modules/Forms/lib/I2CE_Form.php] on line 248
| |
| *Signature: public function __construct($form,$id)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $form <br/>The name of this form
| |
| ** integer $id
| |
| ***Default Value: '0'
| |
| ===__get()===
| |
| Return the [[Class: I2CE_FormField | form field]] value from the [[#$fields | $fields]] array.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L82 i2ce/modules/Forms/lib/I2CE_Form.php] on line 82
| |
| *Signature: protected 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 | form field]] value has been set.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L106 i2ce/modules/Forms/lib/I2CE_Form.php] on line 106
| |
| *Signature: protected 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 | form field]] value in the [[#$fields | $fields]] array.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L95 i2ce/modules/Forms/lib/I2CE_Form.php] on line 95
| |
| *Signature: protected 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 | form field]].
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L118 i2ce/modules/Forms/lib/I2CE_Form.php] on line 118
| |
| *Signature: protected function __unset($key)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $key
| |
| ===addChildForm()===
| |
| Add a child form object to this forms list of children.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L683 i2ce/modules/Forms/lib/I2CE_Form.php] on line 683
| |
| *Signature: public function addChildForm($child_form,$replace)
| |
| *Parameters:
| |
| ** [[Class: I2CE_Form | I2CE_Form]] $child_form <br/>The child form
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $replace <br/>Overwrite the child object if it already exists.
| |
| ***Default Value: false
| |
| ===addField()===
| |
| Adds a field to this form.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L426 i2ce/modules/Forms/lib/I2CE_Form.php] on line 426
| |
| *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
| |
| ===addFormFields()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L299 i2ce/modules/Forms/lib/I2CE_Form.php] on line 299
| |
| *Signature: protected function addFormFields($data)
| |
| *Parameters:
| |
| **$data
| |
| ===cleanup()===
| |
| Clean up all the fields for this form. This will unset all the fields associated with this form. This will remove all circular references to this form so it can be cleaned up by the garbage collector. This should only be called when the form 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.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L366 i2ce/modules/Forms/lib/I2CE_Form.php] on line 366
| |
| *Signature: public function cleanup()
| |
| ===clearFields()===
| |
| Remove fields from the form. This is to be used when only certain fields of the form are being dealt with so the others can be removed to save processing.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L734 i2ce/modules/Forms/lib/I2CE_Form.php] on line 734
| |
| *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 form fields.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L134 i2ce/modules/Forms/lib/I2CE_Form.php] on line 134
| |
| *Signature: public function current()
| |
| *Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]
| |
| ===displayField()===
| |
| Display the field in the given node.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L583 i2ce/modules/Forms/lib/I2CE_Form.php] on line 583
| |
| *Signature: public function displayField($node,$template,$args)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/class.domnode.php DOMNode ] $node
| |
| ** [[Class: I2CE_Template | I2CE_Template]] $template
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $args
| |
| ===form()===
| |
| Return the form name for this form.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L556 i2ce/modules/Forms/lib/I2CE_Form.php] on line 556
| |
| *Signature: public function form()
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]
| |
| ===getAllowedParentForms()===
| |
| Gets the allowed parent forms for a given form
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L213 i2ce/modules/Forms/lib/I2CE_Form.php] on line 213
| |
| *Signature: static public function getAllowedParentForms($form,$use_cache)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $form
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $use_cache <br/>Defaults to true in which case we cached result of finding parent forms
| |
| ***Default Value: true
| |
| *Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>of string, the form names.
| |
| ===getAttribute()===
| |
| Return the attribute value for a given attribute.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L941 i2ce/modules/Forms/lib/I2CE_Form.php] on line 941
| |
| *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 ]
| |
| ===getChildForms()===
| |
| Get the registered child forms for this form.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L162 i2ce/modules/Forms/lib/I2CE_Form.php] on line 162
| |
| *Signature: public function getChildForms()
| |
| *Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>The list of child form names registered for this form.
| |
| ===getChildFormsByForm()===
| |
| Get the registered child forms for the given form.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L171 i2ce/modules/Forms/lib/I2CE_Form.php] on line 171
| |
| *Signature: static public function getChildFormsByForm($form)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $form <br/>The form to get the children of.
| |
| *Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>The list of child form names registered for the form.
| |
| ===getChildren()===
| |
| Get the added children for this form
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L185 i2ce/modules/Forms/lib/I2CE_Form.php] on line 185
| |
| *Signature: public function getChildren($form)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $form <br/>Defaults to null, in which case we get all children. otherwise we get the popoluated children with the specified form
| |
| ***Default Value: null
| |
| *Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>If $form is null, it is an array with keys the form names and values array of the children of that form type. If $form is set, then it is an array of the forms of type $form
| |
| ===getDisplayName()===
| |
| Return the display name for this form object.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L572 i2ce/modules/Forms/lib/I2CE_Form.php] on line 572
| |
| *Signature: public function getDisplayName()
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]
| |
| ===getField()===
| |
| Return the I2CE_FormField for the given field name.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L704 i2ce/modules/Forms/lib/I2CE_Form.php] on line 704
| |
| *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 | I2CE_FormField]]
| |
| ===getFieldNames()===
| |
| Get the names of all the fields added in this form
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L239 i2ce/modules/Forms/lib/I2CE_Form.php] on line 239
| |
| *Signature: public function getFieldNames()
| |
| *Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>of string, the field names.
| |
| ===getFormFieldsData()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L273 i2ce/modules/Forms/lib/I2CE_Form.php] on line 273
| |
| *Signature: protected function getFormFieldsData($class,$data)
| |
| *Parameters:
| |
| **$class
| |
| **&$data
| |
| ===getFormId()===
| |
| Returns the form id for this record.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L387 i2ce/modules/Forms/lib/I2CE_Form.php] on line 387
| |
| *Signature: public function getFormId()
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]<br/>of the form "$form|$id"
| |
| ===getHTMLName()===
| |
| Return the value for the name attribute to be used for this field in a form.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L846 i2ce/modules/Forms/lib/I2CE_Form.php] on line 846
| |
| *Signature: public function getHTMLName()
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]
| |
| ===getId()===
| |
| Returns the id for this record.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L379 i2ce/modules/Forms/lib/I2CE_Form.php] on line 379
| |
| *Signature: public function getId()
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]
| |
| ===getParent()===
| |
| Return the parent id for this record. If there isn't a parent record set then return the id for this record.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L453 i2ce/modules/Forms/lib/I2CE_Form.php] on line 453
| |
| *Signature: public function getParent()
| |
| *Returns: mixed.<br/>false if there is no parent id or string a parent id of the form "$form|$id"
| |
| ===getParentForm()===
| |
| Return the name of the parent form for this record. If there isn't a parent record set then return the id for this record.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L481 i2ce/modules/Forms/lib/I2CE_Form.php] on line 481
| |
| *Signature: public function getParentForm()
| |
| *Returns: mixed.<br/>false if there is no parent the parent form
| |
| ===getParentID()===
| |
| Return the parent id for this record. If there isn't a parent record set then return the id for this record.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L463 i2ce/modules/Forms/lib/I2CE_Form.php] on line 463
| |
| *Signature: public function getParentID()
| |
| *Returns: mixed.<br/>false if there is no parent id or string a parent id
| |
| ===getQueryDisplay()===
| |
| Return the values of all the fields that are set.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L865 i2ce/modules/Forms/lib/I2CE_Form.php] on line 865
| |
| *Signature: public function getQueryDisplay()
| |
| *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.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L853 i2ce/modules/Forms/lib/I2CE_Form.php] on line 853
| |
| *Signature: public function getQueryFields()
| |
| *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.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L833 i2ce/modules/Forms/lib/I2CE_Form.php] on line 833
| |
| *Signature: public function getQueryString()
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]
| |
| ===hasAttribute()===
| |
| Return true if a given attribute exists for this form.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L954 i2ce/modules/Forms/lib/I2CE_Form.php] on line 954
| |
| *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.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L897 i2ce/modules/Forms/lib/I2CE_Form.php] on line 897
| |
| *Signature: public function hasInvalid()
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
| |
| ===key()===
| |
| Return the current key for the [[#$fields | $fields]] array for iterating through the form fields.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L141 i2ce/modules/Forms/lib/I2CE_Form.php] on line 141
| |
| *Signature: public function key()
| |
| *Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]
| |
| ===listFields()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L1012 i2ce/modules/Forms/lib/I2CE_Form.php] on line 1012
| |
| *Signature: static public function listFields($form,$fields,$where_data,$ordering,$limit)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $form <br/>The form name
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $fields <br/>of string. The fields we want returned
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $where_data <br/>Either I2CE_MagicDataNode or array. contains the where clause information about this form or a nested
| |
| ***Default Value: array()
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $ordering <br/>An array of fields to order by. Defaults to the empty array. Prepend a - to order by in descending order.
| |
| ***Default Value: array()
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $limit <br/>Defaults to false. It true, returns only one result. If an integer it is the numeber of records to limit to. If it is as an array of two integers, it is the offset and then number of results to limit to.
| |
| ***Default Value: false
| |
| *Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]<br/>an array with key id's and value and array of values. the array of values has as keys the fields with their corresponding value.
| |
| ===load()===
| |
| Load the member variables from an array
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L803 i2ce/modules/Forms/lib/I2CE_Form.php] on line 803
| |
| *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['forms'][$this->form_name], we set the values of the form's field, id and parent from that entry. If false, we set the values from $post['forms'][$this->form_name][$this->getID()] if it is present
| |
| ***Default Value: true
| |
| **$populate_on_set_id
| |
| ***Default Value: true
| |
| ===lookupArray()===
| |
| Lookup a given id in the given array.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L914 i2ce/modules/Forms/lib/I2CE_Form.php] on line 914
| |
| *Signature: static protected function lookupArray($id,$arr)
| |
| *Parameters:
| |
| ** integer $id <br/>The id to lookup.
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $arr <br/>The array to search through.
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]
| |
| ===next()===
| |
| Advance the internal pointer for the [[#$fields | $fields]] array for iterating through the form fields.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L147 i2ce/modules/Forms/lib/I2CE_Form.php] on line 147
| |
| *Signature: public function next()
| |
| ===processDOM()===
| |
| Process the DOM for this form.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L602 i2ce/modules/Forms/lib/I2CE_Form.php] on line 602
| |
| *Signature: public function processDOM($node,$template,$method,$args)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/class.domnode.php DOMNode ] $node
| |
| ** [[Class: I2CE_Template | I2CE_Template]] $template
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $method
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $args
| |
| ===removeField()===
| |
| Removes a field from this form. @param array $args The arguments for this field
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L414 i2ce/modules/Forms/lib/I2CE_Form.php] on line 414
| |
| *Signature: public function removeField($name)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $name
| |
| ===reset()===
| |
| Reset this object to its original state.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L672 i2ce/modules/Forms/lib/I2CE_Form.php] on line 672
| |
| *Signature: public function reset()
| |
| ===rewind()===
| |
| Rewind the internal pointer for the [[#$fields | $fields]] array for iterating through the form fields.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L127 i2ce/modules/Forms/lib/I2CE_Form.php] on line 127
| |
| *Signature: public function rewind()
| |
| ===search()===
| |
| @param mixed $limit. Defaults to false. It true, returns only one result. If an integer it is the numeber of records to limit to. If it is as an array of two integers, it is the offset and then number of results to limit to.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L973 i2ce/modules/Forms/lib/I2CE_Form.php] on line 973
| |
| *Signature: static public function search($form,$where_data,$ordering,$limit_one)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $form <br/>The form name.
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $where_data <br/>Either I2CE_MagicDataNode or array. contains the where clause information about this form or a nested
| |
| ***Default Value: array()
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $ordering <br/>An array of fields to order by. Defaults to the empty array. Prepend a - to order by in descending order.
| |
| ***Default Value: array()
| |
| **$limit_one
| |
| ***Default Value: false
| |
| *Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]<br/>an array of matching form ids. However, ff $limit_one is true or 1 or array ($offset,1) then then we return either the id or false, if none found or there was an error.
| |
| ===setAttribute()===
| |
| Set an attribute for this form.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L932 i2ce/modules/Forms/lib/I2CE_Form.php] on line 932
| |
| *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
| |
| ===setDisplayName()===
| |
| Set the display name for this form object.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L564 i2ce/modules/Forms/lib/I2CE_Form.php] on line 564
| |
| *Signature: final public function setDisplayName($display)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $display
| |
| ===setForm()===
| |
| Set the form name for this form object.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L548 i2ce/modules/Forms/lib/I2CE_Form.php] on line 548
| |
| *Signature: final public function setForm($name)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $name
| |
| ===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.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L755 i2ce/modules/Forms/lib/I2CE_Form.php] on line 755
| |
| *Signature: public function setFromPost($post,$populate_on_set_id)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $post <br/>The post object is passed as a reference
| |
| **$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.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L396 i2ce/modules/Forms/lib/I2CE_Form.php] on line 396
| |
| *Signature: public function setId($id)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $id
| |
| ===setParent()===
| |
| Set the parent id for this record
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L497 i2ce/modules/Forms/lib/I2CE_Form.php] on line 497
| |
| *Signature: public function setParent($parent,$set_id)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $parent <br/>string or I2CE_Form
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $set_id <br/>If the parent will only have one child object then you can set the id by setting this to true.
| |
| ***Default Value: false
| |
| ===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.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L154 i2ce/modules/Forms/lib/I2CE_Form.php] on line 154
| |
| *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.2-release/annotate/head:/modules/Forms/lib/I2CE_Form.php#L886 i2ce/modules/Forms/lib/I2CE_Form.php] on line 886
| |
| *Signature: public function validate()
| |
| ==Inherited Methods==
| |
| ===_hasMethod()===
| |
| This public method is inherited from [[Class: I2CE_Fuzzy#_hasMethod() | I2CE_Fuzzy->_hasMethod()]]
| |
| ==Inherited Fuzzy Methods==
| |
| ===userMessage()===
| |
| This method is inherited from [[Class: I2CE_Fuzzy#userMessage() | I2CE_Fuzzy->userMessage()]]
| |
| ==Fuzzy Methods==
| |
| ===isNumeric()===
| |
| This method is implemented by [[Class: I2CE_Module_CustomReports#isNumeric() | I2CE_Module_CustomReports->isNumeric() ]]
| |
| ===getLimitStyles()===
| |
| This method is implemented by [[Class: I2CE_Module_FormLimits#getLimitStyles() | I2CE_Module_FormLimits->getLimitStyles() ]]
| |
| ===checkLimit()===
| |
| This method is implemented by [[Class: I2CE_Module_FormLimits#checkLimit() | I2CE_Module_FormLimits->checkLimit() ]]
| |
| ===checkWhereClause()===
| |
| This method is implemented by [[Class: I2CE_Module_FormLimits#checkWhereClause() | I2CE_Module_FormLimits->checkWhereClause() ]]
| |
| ===createCheckFunction()===
| |
| This method is implemented by [[Class: I2CE_Module_FormLimits#createCheckFunction() | I2CE_Module_FormLimits->createCheckFunction() ]]
| |
| ===createCheckLimitString()===
| |
| This method is implemented by [[Class: I2CE_Module_FormLimits#createCheckLimitString() | I2CE_Module_FormLimits->createCheckLimitString() ]]
| |
| ===generateLimit()===
| |
| This method is implemented by [[Class: I2CE_Module_FormLimits#generateLimit() | I2CE_Module_FormLimits->generateLimit() ]]
| |
| ===generateWhereClause()===
| |
| This method is implemented by [[Class: I2CE_Module_FormLimits#generateWhereClause() | I2CE_Module_FormLimits->generateWhereClause() ]]
| |
| ===processLimit()===
| |
| This method is implemented by [[Class: I2CE_Module_FormLimits#processLimit() | I2CE_Module_FormLimits->processLimit() ]]
| |
| ===getDisplayedExistingLimit()===
| |
| This method is implemented by [[Class: I2CE_Module_FormLimits#getDisplayedExistingLimit() | I2CE_Module_FormLimits->getDisplayedExistingLimit() ]]
| |
| ===isComponentized()===
| |
| This method is implemented by [[Class: I2CE_FormStorage#isComponentizedForm() | I2CE_FormStorage->isComponentizedForm() ]]
| |
| ===addChild()===
| |
| This method is implemented by [[Class: I2CE_FormStorage#addChild() | I2CE_FormStorage->addChild() ]]
| |
| ===getChildIds()===
| |
| This method is implemented by [[Class: I2CE_FormStorage#getChildIds() | I2CE_FormStorage->getChildIds() ]]
| |
| ===getStorage()===
| |
| This method is implemented by [[Class: I2CE_FormStorage#getStorage() | I2CE_FormStorage->getStorage() ]]
| |
| ===isWritable()===
| |
| This method is implemented by [[Class: I2CE_FormStorage#isWritable() | I2CE_FormStorage->isWritable() ]]
| |
| ===populate()===
| |
| This method is implemented by [[Class: I2CE_FormStorage#populate() | I2CE_FormStorage->populate() ]]
| |
| ===populateChild()===
| |
| This method is implemented by [[Class: I2CE_FormStorage#populateChild() | I2CE_FormStorage->populateChild() ]]
| |
| ===populateChildren()===
| |
| This method is implemented by [[Class: I2CE_FormStorage#populateChildren() | I2CE_FormStorage->populateChildren() ]]
| |
| ===populateFirst()===
| |
| This method is implemented by [[Class: I2CE_FormStorage#populateFirst() | I2CE_FormStorage->populateFirst() ]]
| |
| ===populateHistory()===
| |
| This method is implemented by [[Class: I2CE_FormStorage#populateHistory() | I2CE_FormStorage->populateHistory() ]]
| |
| ===populateLast()===
| |
| This method is implemented by [[Class: I2CE_FormStorage#populateLast() | I2CE_FormStorage->populateLast() ]]
| |
| ===delete()===
| |
| This method is implemented by [[Class: I2CE_FormStorage#delete() | I2CE_FormStorage->delete() ]]
| |
| ===save()===
| |
| This method is implemented by [[Class: I2CE_FormStorage#save() | I2CE_FormStorage->save() ]]
| |
| ===setChangeType()===
| |
| This method is implemented by [[Class: I2CE_FormStorage#setChangeType() | I2CE_FormStorage->setChangeType() ]]
| |
| | |
| | |
| [[Category:Class Documentation]]
| |
