|
|
| (29 intermediate revisions by one other user not shown) |
| Line 1: |
Line 1: |
| This article desrcibes the class '''I2CE_FormFactory'''which extends the class [[Class: I2CE_Fuzzy | I2CE_Fuzzy]]
| | #REDIRECT [[Class: I2CE_FormFactory (4.1.12)]] |
| It is contained in the module [[iHRIS Module List#forms|forms]] in the package [https://launchpad.net/i2ce I2CE]
| |
| The class is defined in the file: [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.0-release/files/head:modules/Forms/lib/I2CE_FormFactory.php modules/Forms/lib/I2CE_FormFactory.php]
| |
| @author Luke Duncan <lduncan@intrahealth.org>
| |
| @since v1.0.0
| |
| @version v2.0.0
| |
| This factory is used to create instances of I2CE_Form objects from the form name.
| |
| @package I2CE
| |
| @access public
| |
| ==Variables==
| |
| ===$instance===
| |
| The single instance of this class.
| |
| *Type: static private [[Class: I2CE_FormFactory | I2CE_FormFactory]] $instance
| |
| | |
| ===$classes===
| |
| The classes that have been registered with the factory.
| |
| *Type: private y $classes
| |
| | |
| ==Methods==
| |
| ===__construct()===
| |
| *Signature: public function __construct()
| |
| ===callStatic()===
| |
| Call a static function in the form's class object.
| |
| *Signature: public function callStatic($form,$func,$args)
| |
| Parameters:
| |
| * [http://www.php.net/manual/en/language.types.string.php string] $form<br/>The name of the form.
| |
| * [http://www.php.net/manual/en/language.types.string.php string] $func<br/>The function to be called.
| |
| * [http://www.php.net/manual/en/language.types.array.php array] $args<br/>The arguments to pass to the function.
| |
| **Default Value: array()
| |
| ===createForm()===
| |
| Return an instance of a I2CE_Form from the factory.
| |
| *Signature: public function createForm($formId)
| |
| *Returns: [[Class: I2CE_Form | I2CE_Form]] or null on failure
| |
| Parameters:
| |
| * [http://www.php.net/manual/en/language.types.string.php string] $formId<br/>The name of the form possible with an id
| |
| ===exists()===
| |
| Checks to see if the given form has been registered.
| |
| *Signature: public function exists($form)
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean]
| |
| Parameters:
| |
| * [http://www.php.net/manual/en/language.types.string.php string] $form<br/>The name of the form.
| |
| ===getClassHierarchy()===
| |
| Get the class hierarchy associated to a class.
| |
| *Signature: public function getClassHierarchy($form)
| |
| *Returns: [http://www.php.net/manual/en/language.types.array.php array] The keys of the array range from 0 to N. The value of key 0 is the class associated to the form. The last key is has value 'I2CE_Form'.
| |
| Returns null in error.
| |
| Parameters:
| |
| *$form
| |
| ===getClassName()===
| |
| *Signature: public function getClassName($form)
| |
| Parameters:
| |
| *$form
| |
| ===getConst()===
| |
| Shortcut to retrieving a constant value from a form's class object.
| |
| *Signature: public function getConst($form,$var)
| |
| Parameters:
| |
| * [http://www.php.net/manual/en/language.types.string.php string] $form<br/>The name of the form.
| |
| * [http://www.php.net/manual/en/language.types.string.php string] $var<br/>The name of the constant.
| |
| ===getFieldNames()===
| |
| Get the fields for a given form via what is stored in magic data.
| |
| @param mixed $restict. Defaults to null which means there are no restrictions. Otherwise it should
| |
| be an array consisting of any numbder of the following keys 'in_db', 'required', and 'unique' the values
| |
| associated to each key should be true or false. We then only return fields who match the given value
| |
| *Signature: public function getFieldNames($form,$restrictions)
| |
| *Returns: associative array of string. key is the field the value is the form class
| |
| Parameters:
| |
| * [http://www.php.net/manual/en/language.types.string.php string] $form<br/>the short name of a form
| |
| *$restrictions
| |
| **Default Value: array()
| |
| ===getForms()===
| |
| get the available forms.
| |
| *Signature: public function getForms()
| |
| *Returns: [http://www.php.net/manual/en/language.types.array.php array] with values the form name
| |
| ===getStatic()===
| |
| Return a static variable from the form's class object.
| |
| *Signature: public function getStatic($form,$var,$const)
| |
| Parameters:
| |
| * [http://www.php.net/manual/en/language.types.string.php string] $form<br/>The name of the form.
| |
| * [http://www.php.net/manual/en/language.types.string.php string] $var<br/>The name of the variable.
| |
| * [http://www.php.net/manual/en/language.types.boolean.php boolean] $const<br/>Set to true to get a constant instead of a variable
| |
| **Default Value: false
| |
| ===instance()===
| |
| Return the instance of this factory and create it if it doesn't exist.
| |
| *Signature: static public function instance()
| |
| ==Inherited Fuzzy Methods==
| |
| ===userMessage()===
| |
| This method is inherited from [[Class: I2CE_Fuzzy#userMessage() | I2CE_Fuzzy->userMessage()]]
| |
| ==Fuzzy Methods==
| |
| ===getRecords()===
| |
| This method is implemented by [[Class: I2CE_FormStorage#getRecords() | I2CE_FormStorage->getRecords() ]]
| |
| | |
| | |
| [[Category:Class Documentation]]
| |
