Class: I2CE FormFactory (4.1.12)

For other versions, see Class: I2CE_FormFactory (versions) .

This article describes the class I2CE_FormFactory .

• Extends the class: I2CE_FieldContainer_Factory.
• Location: Part of the module forms in the package I2CE 4.1.12-release
• Source: Defined in the file modules/Forms/lib/I2CE_FormFactory.php on line 30
• Author: Luke Duncan <lduncan@intrahealth.org>
• Since: v1.0.0

This factory is used to create instances of I2CE_Form objects from the form name.

Variables

$instance

The single instance of this class. //maybe not needed when updating to php 5.3

• Defined in i2ce/modules/Forms/lib/I2CE_FormFactory.php on line 44
• Type: static protected I2CE_FormFactory $instance

$classes

The classes that have been registered with the factory.

• Defined in i2ce/modules/Forms/lib/I2CE_FormFactory.php on line 60
• Type: protected array $classes

Methods

__construct()

• Defined in i2ce/modules/Forms/lib/I2CE_FormFactory.php on line 63
• Signature: public function __construct()

_createContainer()

Worker method to create an instance of an I2CE_Form from the factory.

• Defined in i2ce/modules/Forms/lib/I2CE_FormFactory.php on line 251
• Signature: protected function _createContainer($factory,$form,$id)
• Parameters:
  • I2CE_FieldContainer_Factory $factory
  • string $form
    The form of the field container
  • string $id
    The id of the field container. Defaults to null
    • Default Value: '0'
• Returns: I2CE_FieldContainer
  or null on failure

_getFieldData()

Get data needed to create all the fields in this field container

• Defined in i2ce/modules/Forms/lib/I2CE_FormFactory.php on line 156
• Signature: protected function _getFieldData($name)
• Parameters:
  • $name
• Returns: array.

_loadMetaAttributes()

Returns the array of attributes for this container

• Defined in i2ce/modules/Forms/lib/I2CE_FormFactory.php on line 203
• Signature: protected function _loadMetaAttributes($name)
• Parameters:
  • string $name
• Returns: array

callStatic()

Call a static function in the form's class object.

• Defined in i2ce/modules/Forms/lib/I2CE_FormFactory.php on line 283
• Signature: public function callStatic($form,$func,$args)
• Parameters:
  • string $form
    The name of the form.
  • string $func
    The function to be called.
  • array $args
    The arguments to pass to the function.
    • Default Value: array()

createForm()

Return an instance of a I2CE_Form from the factory.

• Defined in i2ce/modules/Forms/lib/I2CE_FormFactory.php on line 239
• Signature: public function createForm($nameId,$no_cache)
• Parameters:
  • mixed $nameId
    The a string which is either the name of the field container, the name and id in the form of "$name|$id" or an array with two elements, the first is a name and the second is an id
  • boolean $no_cache
    Defaults to false. If true then we don't check the cache when the id is non-zero
    • Default Value: false
• Returns: I2CE_From
  or null on failure

exists()

Checks to see if the given form has been registered.

• Defined in i2ce/modules/Forms/lib/I2CE_FormFactory.php on line 76
• Signature: public function exists($form)
• Parameters:
  • string $form
    The name of the form.
• Returns: boolean

getAttributeData()

Recursive method to rraverse the class hierarchy to get the meta data for the form magic data @param array &$data array

• Defined in i2ce/modules/Forms/lib/I2CE_FormFactory.php on line 216
• Signature: protected function getAttributeData($class,$attr)
• Parameters:
  • string $class
    the form class
  • &$attr

getClassHierarchy()

Get the class hierarchy associated to a class.

• Defined in i2ce/modules/Forms/lib/I2CE_FormFactory.php on line 106
• Signature: public function getClassHierarchy($form)
• Parameters:
  • $form
• Returns: 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.

getClassName()

• Defined in i2ce/modules/Forms/lib/I2CE_FormFactory.php on line 134
• Signature: public function getClassName($form)
• Parameters:
  • $form

getConst()

Shortcut to retrieving a constant value from a form's class object.

• Defined in i2ce/modules/Forms/lib/I2CE_FormFactory.php on line 318
• Signature: public function getConst($form,$var)
• Parameters:
  • string $form
    The name of the form.
  • string $var
    The name of the constant.

getContainerType()

Return type of container this factory makes

• Defined in i2ce/modules/Forms/lib/I2CE_FormFactory.php on line 37
• Signature: public function getContainerType()
• Returns: string

getDisplayName()

• Defined in i2ce/modules/Forms/lib/I2CE_FormFactory.php on line 142
• Signature: public function getDisplayName($form)
• Parameters:
  • $form

getFormFieldsData()

Recursive method to rraverse the class hierarchy to get the field data from magic data

• Defined in i2ce/modules/Forms/lib/I2CE_FormFactory.php on line 170
• Signature: protected function getFormFieldsData($class,$data)
• Parameters:
  • string $class
    the form class
  • array &$data
    array indexed by field names where data on the fields are stored

getForms()

get the available forms.

• Defined in i2ce/modules/Forms/lib/I2CE_FormFactory.php on line 93
• Signature: public function getForms()
• Returns: array
  with values the form name

getNames()

get the available forms.

• Defined in i2ce/modules/Forms/lib/I2CE_FormFactory.php on line 84
• Signature: public function getNames()
• Returns: array
  with values the form name

getStatic()

Return a static variable from the form's class object.

• Defined in i2ce/modules/Forms/lib/I2CE_FormFactory.php on line 302
• Signature: public function getStatic($form,$var,$const)
• Parameters:
  • string $form
    The name of the form.
  • string $var
    The name of the variable.
  • boolean $const
    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.

• Defined in i2ce/modules/Forms/lib/I2CE_FormFactory.php on line 49
• Signature: static public function instance()

Inherited Methods

cleanup()

This public method is inherited from I2CE_FieldContainer_Factory->cleanup()

clearFieldData()

This public method is inherited from I2CE_FieldContainer_Factory->clearFieldData()

createContainer()

This public method is inherited from I2CE_FieldContainer_Factory->createContainer()

createContainersFromPost()

This public method is inherited from I2CE_FieldContainer_Factory->createContainersFromPost()

getContainerIndex()

This public method is inherited from I2CE_FieldContainer_Factory->getContainerIndex()

getFieldData()

This public method is inherited from I2CE_FieldContainer_Factory->getFieldData()

getFieldNames()

This public method is inherited from I2CE_FieldContainer_Factory->getFieldNames()

getHTMLName()

This public method is inherited from I2CE_FieldContainer_Factory->getHTMLName()

getMetaAttribute()

This public method is inherited from I2CE_FieldContainer_Factory->getMetaAttribute()

hasMetaAttribute()

This public method is inherited from I2CE_FieldContainer_Factory->hasMetaAttribute()

loadMetaAttributes()

This public method is inherited from I2CE_FieldContainer_Factory->loadMetaAttributes()

removeFromCache()

This public method is inherited from I2CE_FieldContainer_Factory->removeFromCache()

setMetaAttribute()

This public method is inherited from I2CE_FieldContainer_Factory->setMetaAttribute()

_hasMethod()

This public method is inherited from I2CE_Fuzzy->_hasMethod()

Inherited Variables

$instance

Theis protected variable is inherited from I2CE_FieldContainer_Factory->$instance

$meta

Theis protected variable is inherited from I2CE_FieldContainer_Factory->$meta

$fieldData

Theis protected variable is inherited from I2CE_FieldContainer_Factory->$fieldData

$containerCache

Theis protected variable is inherited from I2CE_FieldContainer_Factory->$containerCache

Inherited Fuzzy Methods

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()

Fuzzy Methods

setTask()

This method is implemented by I2CE_Module_TaskLog_FormStorage->setTask()

setTaskID()

This method is implemented by I2CE_Module_TaskLog_FormStorage->setTaskID()

getTask()

This method is implemented by I2CE_Module_TaskLog_FormStorage->getTask()

getTaskID()

This method is implemented by I2CE_Module_TaskLog_FormStorage->getTaskID()

pauseTaskLog()

This method is implemented by I2CE_Module_TaskLog_FormStorage->pauseTaskLog()

resumeTaskLog()

This method is implemented by I2CE_Module_TaskLog_FormStorage->resumeTaskLog()

getRecords()

This method is implemented by I2CE_FormStorage->getRecords()

hasRecord()

This method is implemented by I2CE_FormStorage->hasRecord()