SPOSTEventHandler Class Reference
[Event Handling]
Create and handle SEvent object(s) from user POST data.
More...
Inheritance diagram for SPOSTEventHandler:
Public Member Functions | |
| doc () | |
| Return a documentation string about this class. | |
| getSWAT () | |
| Get the global SWAT object. | |
| handleEvents () | |
| Create and handle events implicit in the POST data. | |
| setEventHandler ($eh) | |
| Set the event handler to be used with this object. | |
| setSWAT ($swat) | |
| Set our link to the SWAT object. | |
Protected Attributes | |
| $eventHandler | |
| The event handler to be used to handle POST events. | |
| $swat | |
| A link to the global SWAT object. | |
Detailed Description
Create and handle SEvent object(s) from user POST data.Create SEvent object(s) from the user's POST data. Then call on an event handler (either a custom event handler that has been set on the object, or a new instance of SEventHandler) to handle the event objects.
- Date:
- updated 11/28/07
updated 7/2/07
Member Function Documentation
| SPOSTEventHandler::getSWAT | ( | ) |
Get the global SWAT object.
- Returns:
- [SWAT]: The global SWAT object
| SPOSTEventHandler::handleEvents | ( | ) |
Create and handle events implicit in the POST data.
Do the POST event handling! This function first generates an event object(s) from the POST input, then calls the class event handler on the event(s) using the callEventHandler() function.
- Returns:
- [bool]: True if all events were handled without error, false if there were errors
| SPOSTEventHandler::setEventHandler | ( | $ | eh | ) |
Set the event handler to be used with this object.
Store an instance or subclass instance of SEventHandler to be used to handle POST events generated by this class when handleEvents() is called.
- Parameters:
-
$eh [SEventHandler]: An instance or subclass instance of SEventHandler
| SPOSTEventHandler::setSWAT | ( | $ | swat | ) |
Set our link to the SWAT object.
- Parameters:
-
$swat [SWAT]: The global SWAT object
The documentation for this class was generated from the following file:
- SWAT/event/SPOSTEventHandler.php5
