xref: /dokuwiki/inc/Cache/CacheParser.php (revision dccd6b2bba7367e4d1d2d7aa84c9f9d15584b593) 
1<?php
2
3namespace dokuwiki\Cache;
4
5/**
6 * Parser caching
7 */
8class CacheParser extends Cache
9{
10
11    public $file = '';       // source file for cache
12    public $mode = '';       // input mode (represents the processing the input file will undergo)
13    public $page = '';
14
15    /**
16     *
17     * @param string $id page id
18     * @param string $file source file for cache
19     * @param string $mode input mode
20     */
21    public function __construct($id, $file, $mode)
22    {
23        global $INPUT;
24
25        if ($id) {
26            $this->page = $id;
27        }
28        $this->file = $file;
29        $this->mode = $mode;
30
31        $this->setEvent('PARSER_CACHE_USE');
32        parent::__construct($file . $INPUT->server->str('HTTP_HOST') . $INPUT->server->str('SERVER_PORT'), '.' . $mode);
33    }
34
35    /**
36     * method contains cache use decision logic
37     *
38     * @return bool see useCache()
39     */
40    public function makeDefaultCacheDecision()
41    {
42        if (!file_exists($this->file)) {
43            // source doesn't exist
44            return false;
45        }
46        return parent::makeDefaultCacheDecision();
47    }
48
49    protected function addDependencies()
50    {
51        // parser cache file dependencies ...
52        $files = [
53            $this->file, // source
54            DOKU_INC . 'inc/Parsing/Parser.php', // parser
55            DOKU_INC . 'inc/parser/handler.php', // handler
56        ];
57        $files = array_merge($files, getConfigFiles('main')); // wiki settings
58
59        $this->depends['files'] = empty($this->depends['files']) ?
60            $files :
61            array_merge($files, $this->depends['files']);
62        parent::addDependencies();
63    }
64}
65