Class: I2CE Module Lists

This article desrcibes the class I2CE_Module_Lists which extends the class I2CE_Module It is contained in the module Lists in the package I2CE

The class is defined in the file: modules/Forms/modules/Lists/lib/I2CE_Module_Lists.php

@subpackage Core @filesource Class I2CE_Module_Lists

• Author: Carl Leitner <litlfred@ibiblio.org>
• Since: v3.2.3

Methods

action_initialize()

Method called when the module is enabled for the first time. @param boolean -- returns true on success. false on error.

• Signature: public function action_initialize()

deleteMappedValues()

Deletes id's of a list with field matchin a given value. Intended to be called after rempaFields has been succesfully called. are the values we lookup on the form name

• Signature: static public function deleteMappedValues($list,$evals,$lookup_field)
• Returns: voolean. true on success

Parameters:

• string $list
  the list form.
• array $evals
  an array when keys the new id you want the value to be. the values
• string $lookup_field
  the name of the list field to lookup on. Defaults to 'name'
  • Default Value: 'name'

getHooks()

• Signature: static public function getHooks()

remapFields()

Remaps the list values of the given list based on the field to lookup on for the form are the values we lookup on the form name. If a list instance with the new id does not exist it creates it. in which case we do not try to update any form. @param string $mapped_field. the mapped field of $form. The Defaults to null in which case then mapped field that is used is the $list

• Signature: static public function remapFields($list,$evals,$forms,$lookup_field)
• Returns: boolean. true on success

Parameters:

• string $list
  the list form.
• array $evals
  an array when keys the new id you want the value to be. the values
• array $forms
  an array of string keys are forms values are mapped fields. Defulats to false
  • Default Value: false
• string $lookup_field
  the name of the list field to lookup on. Defaults to 'name'
  • Default Value: 'name'

upgrade()

Upgrade module method

• Signature: public function upgrade($old_vers,$new_vers)

Parameters:

• $old_vers
• $new_vers

validate_formfield()

Hooked Function to check if a field is unique

• Signature: public function validate_formfield($field_obj)
• Returns: boolean

Parameters:

• I2CE_FormField $field_obj

Inherited Fuzzy Methods

launchBackgroundProcess()

This method is inherited from I2CE_Module->launchBackgroundProcess()

launchBackgroundPHPScript()

This method is inherited from I2CE_Module->launchBackgroundPHPScript()

launchBackgroundPage()

This method is inherited from I2CE_Module->launchBackgroundPage()

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()