xref: /plugin/struct/action/search.php (revision dfe3ae67e2cbc66413b67e0194e82ef51f46af29) 
1<?php
2
3/**
4 * DokuWiki Plugin struct (Action Component)
5 *
6 * @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html
7 * @author  Andreas Gohr, Michael Große <dokuwiki@cosmocode.de>
8 */
9
10use dokuwiki\plugin\struct\meta\AccessTable;
11use dokuwiki\plugin\struct\meta\Assignments;
12
13/**
14 * Inject struct data into indexed pages and search result snippets
15 */
16class action_plugin_struct_search extends DokuWiki_Action_Plugin
17{
18
19    /**
20     * Registers a callback function for a given event
21     *
22     * @param Doku_Event_Handler $controller DokuWiki's event controller object
23     * @return void
24     */
25    public function register(Doku_Event_Handler $controller)
26    {
27        $controller->register_hook('INDEXER_PAGE_ADD', 'BEFORE', $this, 'handleIndexing');
28        $controller->register_hook('FULLTEXT_SNIPPET_CREATE', 'BEFORE', $this, 'handleSnippets');
29    }
30
31    /**
32     * Adds the structured data to the page body to be indexed
33     *
34     * @param Doku_Event $event event object by reference
35     * @param mixed $param [the parameters passed as fifth argument to register_hook() when this
36     *                           handler was registered]
37     * @return bool
38     */
39    public function handleIndexing(Doku_Event $event, $param)
40    {
41        $id = $event->data['page'];
42        $assignments = Assignments::getInstance();
43        $tables = $assignments->getPageAssignments($id);
44        if (!$tables) return;
45
46        $now = time();
47        foreach ($tables as $table) {
48            $schemadata = AccessTable::byTableName($table, $id, $now);
49            $event->data['body'] .= $schemadata->getDataPseudoSyntax();
50        }
51    }
52
53    /**
54     * Adds the structured data to the page body to be snippeted
55     *
56     * @param Doku_Event $event event object by reference
57     * @param mixed $param [the parameters passed as fifth argument to register_hook() when this
58     *                           handler was registered]
59     * @return bool
60     */
61    public function handleSnippets(Doku_Event $event, $param)
62    {
63        $id = $event->data['id'];
64        $assignments = Assignments::getInstance();
65        $tables = $assignments->getPageAssignments($id);
66        if (!$tables) return;
67
68        $now = time();
69        foreach ($tables as $table) {
70            $schemadata = AccessTable::byTableName($table, $id, $now);
71            $event->data['text'] .= $schemadata->getDataPseudoSyntax();
72        }
73    }
74}
75
76// vim:ts=4:sw=4:et:
77