xref: /plugin/struct/action/search.php (revision 4cd5cc28e2bf004aed676e9b1f46cc188a4b2240) 
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        foreach ($tables as $table) {
47            $schemadata = AccessTable::getPageAccess($table, $id);
48            $event->data['body'] .= $schemadata->getDataPseudoSyntax();
49        }
50    }
51
52    /**
53     * Adds the structured data to the page body to be snippeted
54     *
55     * @param Doku_Event $event event object by reference
56     * @param mixed $param [the parameters passed as fifth argument to register_hook() when this
57     *                           handler was registered]
58     * @return bool
59     */
60    public function handleSnippets(Doku_Event $event, $param)
61    {
62        $id = $event->data['id'];
63        $assignments = Assignments::getInstance();
64        $tables = $assignments->getPageAssignments($id);
65        if (!$tables) return;
66
67        foreach ($tables as $table) {
68            $schemadata = AccessTable::getPageAccess($table, $id);
69            $event->data['text'] .= $schemadata->getDataPseudoSyntax();
70        }
71    }
72}
73
74// vim:ts=4:sw=4:et:
75