UNB Components Code Reference

UnbFormHandler class

Handles HTML form requests and provides centralised request validating and XML conversion support.

Public methods

   GetNewMessage Gets the newly created message instance.
   GetNewMessageRevision Gets the newly created message revision instance.
   GetNewTag Gets the newly created tag instance.
   GetNewUser Gets the newly created user instance.
   HandleForm Handles a submitted HTML form and performs all requested actions.
S ValidateRequest Validates the request.

Private methods

   GetKeys Gets the list of user IDs from a multiline text field in the HTML form.
   GetMessage Gets the message object from either the message ID in the HTML form or the temporary variables from earlier actions.
   GetMessageRevision Gets the message revision object from either the message ID and revision number in the HTML form or the temporary variables from earlier actions.
   GetTag Gets the tag object from either the tag ID in the HTML form or the temporary variables from earlier actions.
   GetUser Gets the user object from either the user ID in the HTML form or the temporary variables from earlier actions.
   HandleFormAction Handles a specific HTML form action.
   IsActionRequested Gets a value indicating whether an action was requested and is not yet discarded.
   SkipAction Marks an action to be skipped in further processing.
S SortActions Internal sorting function that ensures that actions are processed in the correct order.

Private fields

newMessage  –  default: null
Newly created message instance, if the action was performed
newMessageRevision  –  default: null
Newly created message revision instance, if the action was performed
newTag  –  default: null
Newly created tag instance, if the action was performed
newUser  –  default: null
Newly created user instance, if the action was performed
requestedActions
List of requested actions
skipActions  –  default: array()
Actions to skip

Constants

VerboseErrors false Generate more verbose error messages that include a call stack and function arguments. DO NOT enable this in a production environment as it may leak sensitive information! File: formhandler.class.php, line 22

Implementation file: formhandler.class.php, line 18

© 2010 Yves Goergen. UNB Components Homepage. Reference generated on 2010-03-07.