| [ Index ] |
|
Code source de DokuWiki 2006-11-06 |
[Code source] [Imprimer] [Statistiques]
DokuWiki Events
| Author: | Christopher Smith <chris@jalakai.co.uk> |
| License: | GPL 2 (http://www.gnu.org/licenses/gpl.html) |
| Poids: | 202 lignes (7 kb) |
| Inclus ou requis: | 4 fois |
| Référencé: | 0 fois |
| Nécessite: | 1 fichier inc/pluginutils.php |
Doku_Event:: (6 méthodes):
Doku_Event()
advise_before()
advise_after()
trigger()
stopPropagation()
preventDefault()
Doku_Event_Handler:: (4 méthodes):
Doku_Event_Handler()
register_hook()
process_event()
trigger_event()
Classe: Doku_Event - X-Ref
| Doku_Event($name, &$data) X-Ref |
| event constructor |
| advise_before($enablePreventDefault=true) X-Ref |
| advise functions advise all registered handlers of this event if these methods are used by functions outside of this object, they must properly handle correct processing of any default action and issue an advise_after() signal. e.g. $evt = new Doku_Event(name, data); if ($evt->advise_before(canPreventDefault) { // default action code block } $evt->advise_after(); unset($evt); return: results of processing the event, usually $this->_default |
| advise_after() X-Ref |
| Pas de description |
| trigger($action=NULL, $enablePrevent=true) X-Ref |
| trigger - advise all registered (<event>_BEFORE) handlers that this event is about to take place - carry out the default action using $this->data based on $enablePrevent and $this->_default, all of which may have been modified by the event handlers. - advise all registered (<event>_AFTER) handlers that the event has taken place return: $event->results |
| stopPropagation() X-Ref |
| stopPropagation stop any further processing of the event by event handlers this function does not prevent the default action taking place |
| preventDefault() X-Ref |
| preventDefault prevent the default action taking place |
Classe: Doku_Event_Handler - X-Ref
| Doku_Event_Handler() X-Ref |
| event_handler constructor, loads all action plugins and calls their register() method giving them an opportunity to register any hooks they require |
| register_hook($event, $advise, &$obj, $method, $param=NULL) X-Ref |
| register_hook register a hook for an event param: $event (string) name used by the event, (incl '_before' or '_after' for triggers) param: $obj (obj) object in whose scope method is to be executed, param: $method (function) event handler function param: $param (mixed) data passed to the event handler |
| process_event(&$event,$advise='') X-Ref |
| Pas de description |
| trigger_event($name, &$data, $action=NULL, $canPreventDefault=true) X-Ref |
| trigger_event function wrapper to process (create, trigger and destroy) an event param: $name (string) name for the event param: $data (mixed) event data param: $action (callback) (optional, default=NULL) default action, a php callback function param: $canPreventDefault (bool) (optional, default=true) can hooks prevent the default action return: (mixed) the event results value after all event processing is complete |
| Généré le : Tue Apr 3 20:47:31 2007 | par Balluche grâce à PHPXref 0.7 |