VIII. The MU_Move_List Class
Introduction
The MU_Move_List class provides end-to-end services for creating a form consisting of any number of lists of items that the user can move among the lists. MU_Move_List also provides services for sorting the lists and harvesting changes.
Properties
These properties can be set by the developer after instantiating an MU_Move_List object.
title - The title of the form, often displayed at the top of the form.
instructions - a block of instructions, often displayed beneath the title.
These properties are set by the MU_Move_List class after form submission and/or validation.
validated - TRUE if the form was validated, FALSE otherwise
user_action - contains the name of the action that caused form submission. These actions are defined by the MU_Move_List::add_user_action() method.
Note: user_action will contain the name of the action even if form validation failed. Always test both user_action and validated before acting on form input.
Table of Contents
- MU_Move_List::MU_Move_List - constructor
- MU_Move_List::add_hidden - Add a hidden element to an MU_Move_List object
- MU_Move_List::add_list - Add a list to an MU_Move_List object
- MU_Move_List::add_user_action - Add a submit button to an MU_Move_List object
- MU_Move_List::reset - Reset a move list
- MU_Move_List::value - Retrieve a list's contents from a submitted move list
- MU_Move_List::original - Retrieve a list's original contents from a submitted move list
- MU_Move_List::added - Retrieve items added to a list after a move list was submitted
- MU_Move_List::removed - Retrieve items removed from a list after a move list was submitted