xref: /plugin/structnotification/action/notification.php (revision a1f4c7baa04e96102443b7a454acf5628158f094)
1*a1f4c7baSSzymon Olewniczak<?php
2*a1f4c7baSSzymon Olewniczak/**
3*a1f4c7baSSzymon Olewniczak * DokuWiki Plugin structnotification (Action Component)
4*a1f4c7baSSzymon Olewniczak *
5*a1f4c7baSSzymon Olewniczak * @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html
6*a1f4c7baSSzymon Olewniczak * @author  Szymon Olewniczak <it@rid.pl>
7*a1f4c7baSSzymon Olewniczak */
8*a1f4c7baSSzymon Olewniczak
9*a1f4c7baSSzymon Olewniczak// must be run within Dokuwiki
10*a1f4c7baSSzymon Olewniczakif (!defined('DOKU_INC')) {
11*a1f4c7baSSzymon Olewniczak    die();
12*a1f4c7baSSzymon Olewniczak}
13*a1f4c7baSSzymon Olewniczak
14*a1f4c7baSSzymon Olewniczakclass action_plugin_structnotification_notification extends DokuWiki_Action_Plugin
15*a1f4c7baSSzymon Olewniczak{
16*a1f4c7baSSzymon Olewniczak
17*a1f4c7baSSzymon Olewniczak    /**
18*a1f4c7baSSzymon Olewniczak     * Registers a callback function for a given event
19*a1f4c7baSSzymon Olewniczak     *
20*a1f4c7baSSzymon Olewniczak     * @param Doku_Event_Handler $controller DokuWiki's event controller object
21*a1f4c7baSSzymon Olewniczak     *
22*a1f4c7baSSzymon Olewniczak     * @return void
23*a1f4c7baSSzymon Olewniczak     */
24*a1f4c7baSSzymon Olewniczak    public function register(Doku_Event_Handler $controller)
25*a1f4c7baSSzymon Olewniczak    {
26*a1f4c7baSSzymon Olewniczak        $controller->register_hook('PLUGIN_NOTIFICATION_REGISTER_SOURCE', 'FIXME', $this, 'handle_plugin_notification_register_source');        $controller->register_hook('PLUGIN_NOTIFICATION_GATHER', 'FIXME', $this, 'handle_plugin_notification_gather');        $controller->register_hook('PLUGIN_NOTIFICATION_CACHE_DEPENDENCIES', 'FIXME', $this, 'handle_plugin_notification_cache_dependencies');
27*a1f4c7baSSzymon Olewniczak
28*a1f4c7baSSzymon Olewniczak    }
29*a1f4c7baSSzymon Olewniczak
30*a1f4c7baSSzymon Olewniczak    /**
31*a1f4c7baSSzymon Olewniczak     * [Custom event handler which performs action]
32*a1f4c7baSSzymon Olewniczak     *
33*a1f4c7baSSzymon Olewniczak     * Called for event:
34*a1f4c7baSSzymon Olewniczak     *
35*a1f4c7baSSzymon Olewniczak     * @param Doku_Event $event  event object by reference
36*a1f4c7baSSzymon Olewniczak     * @param mixed      $param  [the parameters passed as fifth argument to register_hook() when this
37*a1f4c7baSSzymon Olewniczak     *                           handler was registered]
38*a1f4c7baSSzymon Olewniczak     *
39*a1f4c7baSSzymon Olewniczak     * @return void
40*a1f4c7baSSzymon Olewniczak     */
41*a1f4c7baSSzymon Olewniczak    public function handle_plugin_notification_register_source(Doku_Event $event, $param)
42*a1f4c7baSSzymon Olewniczak    {
43*a1f4c7baSSzymon Olewniczak    }
44*a1f4c7baSSzymon Olewniczak    public function handle_plugin_notification_gather(Doku_Event $event, $param)
45*a1f4c7baSSzymon Olewniczak    {
46*a1f4c7baSSzymon Olewniczak    }
47*a1f4c7baSSzymon Olewniczak    public function handle_plugin_notification_cache_dependencies(Doku_Event $event, $param)
48*a1f4c7baSSzymon Olewniczak    {
49*a1f4c7baSSzymon Olewniczak    }
50*a1f4c7baSSzymon Olewniczak
51*a1f4c7baSSzymon Olewniczak}
52*a1f4c7baSSzymon Olewniczak
53