|
|
| (34 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| This article desrcibes the class '''I2CE_PageFormLists'''which extends the class [[Class: I2CE_PageForm | I2CE_PageForm]]
| | #REDIRECT [[Class: I2CE_PageFormLists (4.1.7)]] |
| It is contained in the module [[iHRIS Module List#Lists|Lists]] 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/modules/Lists/lib/I2CE_PageFormLists.php modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php]
| |
| Manage editing of all the list databases used for drop down menus.
| |
| | |
| This page has the code for the {@link ListsPage} object and then it
| |
| creates an instance of this page object and calls the {@link ListsPage::display() display}
| |
| method.
| |
| @package I2CE
| |
| @subpackage Common
| |
| @access public
| |
| @author Luke Duncan <lduncan@intrahealth.org> / Carl leitner <litlfred@ibiblio.org>
| |
| @since v2.0.0
| |
| @version v2.0.0
| |
| Page object to handle the management of all the list databases used for drop down menus.
| |
| | |
| This page handles all the editing of the list database tables using the relevant
| |
| {@link I2CE_Form} interface objects. The base page lists all the types of data
| |
| that can be edited. From there you can add a new entry or edit an existing one.
| |
| | |
| This object overrides the default {@link save()} and {@link action()} methods since there are many
| |
| database objects to be edited.
| |
| @package I2CE
| |
| @subpackage Common
| |
| @access public
| |
| ==Variables==
| |
| ===$type===
| |
| The type of list object being edited. e.g. the form name
| |
| *Type: protected ng $type
| |
| | |
| ===$select_field===
| |
| The field, if any, for which we wish to select the list for.
| |
| *Type: protected ng $select_field
| |
| | |
| ===$id===
| |
| The record id number of the object being edited.
| |
| *Type: protected nteger $id
| |
| | |
| ==Methods==
| |
| ===__construct()===
| |
| Create a new instance of this page.
| |
| | |
| This will call the parent constructor and then setup the base
| |
| template pages for the {@link I2CE_Template template}. It also sets up the values
| |
| for the member variables.
| |
| @param string $title The title for this page.
| |
| @param string $defaultHTMLFile The default HTML file for this page.
| |
| @param mixed $access The role required to access this page.
| |
| @param array $files The list of template files to load for this page.
| |
| *Signature: public function __construct($args,$request_remainder,$get,$post)
| |
| Parameters:
| |
| *$args
| |
| *$request_remainder
| |
| *$get
| |
| **Default Value: null
| |
| *$post
| |
| **Default Value: null
| |
| ===action()===
| |
| Perform the actions of the page.
| |
| | |
| This handles some special actions because there are three versions of this page:
| |
| - The list page of all objects that can be edited.
| |
| - The add/update page for each list object.
| |
| - The edit form for each list object.
| |
| | |
| Only in the third case is the parent object action method called since that is the default setup
| |
| for editing objects used in most other {@link PageForm} objects.
| |
| *Signature: protected function action()
| |
| ===actionAllLists()===
| |
| Perform the action of the page to show all lists.
| |
| *Signature: protected function actionAllLists()
| |
| ===actionDisplayList_row()===
| |
| *Signature: protected function actionDisplayList_row($list)
| |
| Parameters:
| |
| *$list
| |
| ===actionExtra()===
| |
| Perform the action of the page with a select object
| |
| *Signature: protected function actionExtra($select_obj)
| |
| Parameters:
| |
| *$select_obj
| |
| ===actionSelectList()===
| |
| *Signature: protected function actionSelectList()
| |
| ===actionSelectMapped()===
| |
| *Signature: protected function actionSelectMapped()
| |
| ===displayControls()===
| |
| Display the save or confirm button templates as needed.
| |
| *Signature: protected function displayControls($save,$show_edit)
| |
| Parameters:
| |
| * [http://www.php.net/manual/en/language.types.boolean.php boolean] $save<br/>Flag to show the save button.
| |
| **Default Value: false
| |
| * [http://www.php.net/manual/en/language.types.boolean.php boolean] $show_edit<br/>(defaults to true)
| |
| **Default Value: true
| |
| ===getChildHTMLTemplate()===
| |
| Get the HTML templat for any child forms
| |
| @var string $child_form
| |
| *Signature: protected function getChildHTMLTemplate($child_form)
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string]
| |
| Parameters:
| |
| *$child_form
| |
| ===getPrimaryHTMLTemplate()===
| |
| Get the HTML template for the primary form
| |
| *Signature: protected function getPrimaryHTMLTemplate()
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string]
| |
| ===getViewPage()===
| |
| Return the view list page for this type of form.
| |
| If the page exists for view_$type it returns that, otherwise
| |
| it uses view_list.
| |
| *Signature: protected function getViewPage($type)
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string]
| |
| Parameters:
| |
| *$type
| |
| ===loadHTMLTemplates()===
| |
| Load the HTML template files for editing and confirming the list information.
| |
| | |
| Since this page has special versions, this method is only called when a particular list object
| |
| is being added or edited. All other pages are loaded within the {@link action}
| |
| *Signature: protected function loadHTMLTemplates()
| |
| ===loadObjects()===
| |
| Create and load data for the objects used for this form.
| |
| | |
| Create the list object and if this is a form submission load
| |
| the data from the form data. It determines the type based on the
| |
| {@link $type} member variable.
| |
| *Signature: protected function loadObjects()
| |
| ===save()===
| |
| Save the objects to the database.
| |
| | |
| Save the list object being edited and return to the appropriate admin page.
| |
| *Signature: protected function save()
| |
| ===setDisplayData()===
| |
| Set the data to be displayed for the outside of the form field elements.
| |
| | |
| Set up the static data to be displayed in the template. The default method
| |
| doesn't do anything, but sub-classes may need to override this method.
| |
| *
| |
| *Signature: protected function setDisplayData()
| |
| ===setMenus()===
| |
| Set the attributes for the left hand navigation menu to highlight the proper location.
| |
| *Signature: protected function setMenus()
| |
| ==Inherited Variables==
| |
| ===$$objects===
| |
| Theis protected variable is inherited from [[Class: I2CE_PageForm#$$objects | I2CE_PageForm->$$objects]]
| |
| ===$$node_ids===
| |
| Theis protected variable is inherited from [[Class: I2CE_PageForm#$$node_ids | I2CE_PageForm->$$node_ids]]
| |
| ===$$factory===
| |
| Theis protected variable is inherited from [[Class: I2CE_PageForm#$$factory | I2CE_PageForm->$$factory]]
| |
| ===$$usesConfimPage===
| |
| Theis protected variable is inherited from [[Class: I2CE_PageForm#$$usesConfimPage | I2CE_PageForm->$$usesConfimPage]]
| |
| ===$$formAttributes===
| |
| Theis protected variable is inherited from [[Class: I2CE_PageForm#$$formAttributes | I2CE_PageForm->$$formAttributes]]
| |
| ==Inherited Fuzzy Methods==
| |
| ===launchBackgroundProcess()===
| |
| This method is inherited from [[Class: I2CE_Page#launchBackgroundProcess() | I2CE_Page->launchBackgroundProcess()]]
| |
| ===launchBackgroundPHPScript()===
| |
| This method is inherited from [[Class: I2CE_Page#launchBackgroundPHPScript() | I2CE_Page->launchBackgroundPHPScript()]]
| |
| ===launchBackgroundPage()===
| |
| This method is inherited from [[Class: I2CE_Page#launchBackgroundPage() | I2CE_Page->launchBackgroundPage()]]
| |
| ===addColorPickerTriple()===
| |
| This method is inherited from [[Class: I2CE_Page#addColorPickerTriple() | I2CE_Page->addColorPickerTriple()]]
| |
| ===selectOptionsImmediate()===
| |
| This method is inherited from [[Class: I2CE_Page#selectOptionsImmediate() | I2CE_Page->selectOptionsImmediate()]]
| |
| ===setDisplayData()===
| |
| This method is inherited from [[Class: I2CE_Page#setDisplayData() | I2CE_Page->setDisplayData()]]
| |
| ===setDisplayDataImmediate()===
| |
| This method is inherited from [[Class: I2CE_Page#setDisplayDataImmediate() | I2CE_Page->setDisplayDataImmediate()]]
| |
| ===addFormWorm()===
| |
| This method is inherited from [[Class: I2CE_Page#addFormWorm() | I2CE_Page->addFormWorm()]]
| |
| ===getClassValue()===
| |
| This method is inherited from [[Class: I2CE_Page#getClassValue() | I2CE_Page->getClassValue()]]
| |
| ===loadClassValues()===
| |
| This method is inherited from [[Class: I2CE_Page#loadClassValues() | I2CE_Page->loadClassValues()]]
| |
| ===setClassValue()===
| |
| This method is inherited from [[Class: I2CE_Page#setClassValue() | I2CE_Page->setClassValue()]]
| |
| ===setClassValues()===
| |
| This method is inherited from [[Class: I2CE_Page#setClassValues() | I2CE_Page->setClassValues()]]
| |
| ===addOption()===
| |
| This method is inherited from [[Class: I2CE_Page#addOption() | I2CE_Page->addOption()]]
| |
| ===addOptions()===
| |
| This method is inherited from [[Class: I2CE_Page#addOptions() | I2CE_Page->addOptions()]]
| |
| ===addAutoCompleteInputTreeById()===
| |
| This method is inherited from [[Class: I2CE_Page#addAutoCompleteInputTreeById() | I2CE_Page->addAutoCompleteInputTreeById()]]
| |
| ===addAutoCompleteInputTree()===
| |
| This method is inherited from [[Class: I2CE_Page#addAutoCompleteInputTree() | I2CE_Page->addAutoCompleteInputTree()]]
| |
| ===setForm()===
| |
| This method is inherited from [[Class: I2CE_Page#setForm() | I2CE_Page->setForm()]]
| |
| ===getField()===
| |
| This method is inherited from [[Class: I2CE_Page#getField() | I2CE_Page->getField()]]
| |
| ===setReview()===
| |
| This method is inherited from [[Class: I2CE_Page#setReview() | I2CE_Page->setReview()]]
| |
| ===isReview()===
| |
| This method is inherited from [[Class: I2CE_Page#isReview() | I2CE_Page->isReview()]]
| |
| ===setShowForm()===
| |
| This method is inherited from [[Class: I2CE_Page#setShowForm() | I2CE_Page->setShowForm()]]
| |
| ===showForm()===
| |
| This method is inherited from [[Class: I2CE_Page#showForm() | I2CE_Page->showForm()]]
| |
| ===makeJumper()===
| |
| This method is inherited from [[Class: I2CE_Page#makeJumper() | I2CE_Page->makeJumper()]]
| |
| ===menuSelect()===
| |
| This method is inherited from [[Class: I2CE_Page#menuSelect() | I2CE_Page->menuSelect()]]
| |
| ===addUpdateSelect()===
| |
| This method is inherited from [[Class: I2CE_Page#addUpdateSelect() | I2CE_Page->addUpdateSelect()]]
| |
| ===addAjaxUpdate()===
| |
| This method is inherited from [[Class: I2CE_Page#addAjaxUpdate() | I2CE_Page->addAjaxUpdate()]]
| |
| ===addAjaxToggle()===
| |
| This method is inherited from [[Class: I2CE_Page#addAjaxToggle() | I2CE_Page->addAjaxToggle()]]
| |
| ===addAjaxRequestFunction()===
| |
| This method is inherited from [[Class: I2CE_Page#addAjaxRequestFunction() | I2CE_Page->addAjaxRequestFunction()]]
| |
| ===addAjaxCompleteFunction()===
| |
| This method is inherited from [[Class: I2CE_Page#addAjaxCompleteFunction() | I2CE_Page->addAjaxCompleteFunction()]]
| |
| ===addAjaxToggleOnFunction()===
| |
| This method is inherited from [[Class: I2CE_Page#addAjaxToggleOnFunction() | I2CE_Page->addAjaxToggleOnFunction()]]
| |
| ===addAjaxToggleOffFunction()===
| |
| This method is inherited from [[Class: I2CE_Page#addAjaxToggleOffFunction() | I2CE_Page->addAjaxToggleOffFunction()]]
| |
| ===hasAjax()===
| |
| This method is inherited from [[Class: I2CE_Page#hasAjax() | I2CE_Page->hasAjax()]]
| |
| ===setDataTypePriority()===
| |
| This method is inherited from [[Class: I2CE_Page#setDataTypePriority() | I2CE_Page->setDataTypePriority()]]
| |
| ===setData()===
| |
| This method is inherited from [[Class: I2CE_Page#setData() | I2CE_Page->setData()]]
| |
| ===getData()===
| |
| This method is inherited from [[Class: I2CE_Page#getData() | I2CE_Page->getData()]]
| |
| ===getDefaultData()===
| |
| This method is inherited from [[Class: I2CE_Page#getDefaultData() | I2CE_Page->getDefaultData()]]
| |
| ===removeData()===
| |
| This method is inherited from [[Class: I2CE_Page#removeData() | I2CE_Page->removeData()]]
| |
| ===getDataNames()===
| |
| This method is inherited from [[Class: I2CE_Page#getDataNames() | I2CE_Page->getDataNames()]]
| |
| ===ensureNode()===
| |
| This method is inherited from [[Class: I2CE_Page#ensureNode() | I2CE_Page->ensureNode()]]
| |
| | |
| | |
| [[Category:Class Documentation]]
| |
