xref: /plugin/ireadit/action/cache.php (revision d2cf7c78adce1664925be1a0be19ea4fc1239030)
1ce9be9e9SSzymon Olewniczak<?php
2ce9be9e9SSzymon Olewniczak/**
3ce9be9e9SSzymon Olewniczak * DokuWiki Plugin notification (Action Component)
4ce9be9e9SSzymon Olewniczak *
5ce9be9e9SSzymon Olewniczak * @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html
6ce9be9e9SSzymon Olewniczak * @author  Szymon Olewniczak <it@rid.pl>
7ce9be9e9SSzymon Olewniczak */
8ce9be9e9SSzymon Olewniczak
9ce9be9e9SSzymon Olewniczak// must be run within Dokuwiki
10ce9be9e9SSzymon Olewniczakif (!defined('DOKU_INC')) {
11ce9be9e9SSzymon Olewniczak    die();
12ce9be9e9SSzymon Olewniczak}
13ce9be9e9SSzymon Olewniczak
14ce9be9e9SSzymon Olewniczakclass action_plugin_ireadit_cache extends DokuWiki_Action_Plugin
15ce9be9e9SSzymon Olewniczak{
16ce9be9e9SSzymon Olewniczak
17ce9be9e9SSzymon Olewniczak    /**
18ce9be9e9SSzymon Olewniczak     * Registers a callback function for a given event
19ce9be9e9SSzymon Olewniczak     *
20ce9be9e9SSzymon Olewniczak     * @param Doku_Event_Handler $controller DokuWiki's event controller object
21ce9be9e9SSzymon Olewniczak     *
22ce9be9e9SSzymon Olewniczak     * @return void
23ce9be9e9SSzymon Olewniczak     */
24ce9be9e9SSzymon Olewniczak    public function register(Doku_Event_Handler $controller)
25ce9be9e9SSzymon Olewniczak    {
26*d2cf7c78SSzymon Olewniczak        $controller->register_hook('PARSER_CACHE_USE', 'AFTER', $this, 'handle_parser_cache_use');
27ce9be9e9SSzymon Olewniczak    }
28ce9be9e9SSzymon Olewniczak
29ce9be9e9SSzymon Olewniczak    /**
30ce9be9e9SSzymon Olewniczak     * @param Doku_Event $event event object by reference
31ce9be9e9SSzymon Olewniczak     * @param mixed $param [the parameters passed as fifth argument to register_hook() when this
32ce9be9e9SSzymon Olewniczak     *                           handler was registered]
33ce9be9e9SSzymon Olewniczak     *
34ce9be9e9SSzymon Olewniczak     * @return void
35ce9be9e9SSzymon Olewniczak     */
36ce9be9e9SSzymon Olewniczak    public function handle_parser_cache_use(Doku_Event $event, $param)
37ce9be9e9SSzymon Olewniczak    {
38*d2cf7c78SSzymon Olewniczak        /** @var \dokuwiki\Cache\CacheParser $cache */
39ce9be9e9SSzymon Olewniczak        $cache = $event->data;
40*d2cf7c78SSzymon Olewniczak        if ($cache->mode != 'xhtml') return true;
41*d2cf7c78SSzymon Olewniczak        if (!$cache->page) return true; // not a page cache
42ce9be9e9SSzymon Olewniczak
43ce9be9e9SSzymon Olewniczak        //Check if it is plugins
44*d2cf7c78SSzymon Olewniczak        if (p_get_metadata($cache->page, 'plugin_ireadit_list')) {
45*d2cf7c78SSzymon Olewniczak            $event->result = false;
46*d2cf7c78SSzymon Olewniczak            return true;
47692a1450SSzymon Olewniczak        }
48*d2cf7c78SSzymon Olewniczak        return true;
49ce9be9e9SSzymon Olewniczak    }
50ce9be9e9SSzymon Olewniczak}
51