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