xref: /plugin/struct/action/entry.php (revision 549a0837397243f9208e2e78aa6597d7d762443d)
1*549a0837SAndreas Gohr<?php
2*549a0837SAndreas Gohr/**
3*549a0837SAndreas Gohr * DokuWiki Plugin struct (Action Component)
4*549a0837SAndreas Gohr *
5*549a0837SAndreas Gohr * @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html
6*549a0837SAndreas Gohr * @author  Andreas Gohr, Michael Große <dokuwiki@cosmocode.de>
7*549a0837SAndreas Gohr */
8*549a0837SAndreas Gohr
9*549a0837SAndreas Gohr// must be run within Dokuwiki
10*549a0837SAndreas Gohrif(!defined('DOKU_INC')) die();
11*549a0837SAndreas Gohr
12*549a0837SAndreas Gohrclass action_plugin_struct_entry extends DokuWiki_Action_Plugin {
13*549a0837SAndreas Gohr
14*549a0837SAndreas Gohr    /**
15*549a0837SAndreas Gohr     * Registers a callback function for a given event
16*549a0837SAndreas Gohr     *
17*549a0837SAndreas Gohr     * @param Doku_Event_Handler $controller DokuWiki's event controller object
18*549a0837SAndreas Gohr     * @return void
19*549a0837SAndreas Gohr     */
20*549a0837SAndreas Gohr    public function register(Doku_Event_Handler $controller) {
21*549a0837SAndreas Gohr
22*549a0837SAndreas Gohr       $controller->register_hook('FIXME', 'FIXME', $this, 'handle_fixme');
23*549a0837SAndreas Gohr
24*549a0837SAndreas Gohr    }
25*549a0837SAndreas Gohr
26*549a0837SAndreas Gohr    /**
27*549a0837SAndreas Gohr     * [Custom event handler which performs action]
28*549a0837SAndreas Gohr     *
29*549a0837SAndreas Gohr     * @param Doku_Event $event  event object by reference
30*549a0837SAndreas Gohr     * @param mixed      $param  [the parameters passed as fifth argument to register_hook() when this
31*549a0837SAndreas Gohr     *                           handler was registered]
32*549a0837SAndreas Gohr     * @return void
33*549a0837SAndreas Gohr     */
34*549a0837SAndreas Gohr
35*549a0837SAndreas Gohr    public function handle_fixme(Doku_Event &$event, $param) {
36*549a0837SAndreas Gohr    }
37*549a0837SAndreas Gohr
38*549a0837SAndreas Gohr}
39*549a0837SAndreas Gohr
40*549a0837SAndreas Gohr// vim:ts=4:sw=4:et:
41