xref: /plugin/struct/action/search.php (revision 5e29103a15bd9873f422f66a6a5239b6aec4651e)
176ad0db2SAndreas Gohr<?php
2d6d97f60SAnna Dabrowska
376ad0db2SAndreas Gohr/**
476ad0db2SAndreas Gohr * DokuWiki Plugin struct (Action Component)
576ad0db2SAndreas Gohr *
676ad0db2SAndreas Gohr * @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html
776ad0db2SAndreas Gohr * @author  Andreas Gohr, Michael Große <dokuwiki@cosmocode.de>
876ad0db2SAndreas Gohr */
976ad0db2SAndreas Gohr
107234bfb1Ssplitbrainuse dokuwiki\Extension\ActionPlugin;
117234bfb1Ssplitbrainuse dokuwiki\Extension\EventHandler;
127234bfb1Ssplitbrainuse dokuwiki\Extension\Event;
13f411d872SAndreas Gohruse dokuwiki\plugin\struct\meta\AccessTable;
14ba766201SAndreas Gohruse dokuwiki\plugin\struct\meta\Assignments;
1576ad0db2SAndreas Gohr
16a14cf85dSAnna Dabrowska/**
17a14cf85dSAnna Dabrowska * Inject struct data into indexed pages and search result snippets
18a14cf85dSAnna Dabrowska */
197234bfb1Ssplitbrainclass action_plugin_struct_search extends ActionPlugin
20d6d97f60SAnna Dabrowska{
2176ad0db2SAndreas Gohr    /**
2276ad0db2SAndreas Gohr     * Registers a callback function for a given event
2376ad0db2SAndreas Gohr     *
24*5e29103aSannda     * @param EventHandler $controller DokuWiki's event controller object
2576ad0db2SAndreas Gohr     * @return void
2676ad0db2SAndreas Gohr     */
277234bfb1Ssplitbrain    public function register(EventHandler $controller)
28d6d97f60SAnna Dabrowska    {
29748e747fSAnna Dabrowska        $controller->register_hook('INDEXER_PAGE_ADD', 'BEFORE', $this, 'handleIndexing');
30748e747fSAnna Dabrowska        $controller->register_hook('FULLTEXT_SNIPPET_CREATE', 'BEFORE', $this, 'handleSnippets');
3176ad0db2SAndreas Gohr    }
3276ad0db2SAndreas Gohr
3376ad0db2SAndreas Gohr    /**
3476ad0db2SAndreas Gohr     * Adds the structured data to the page body to be indexed
3576ad0db2SAndreas Gohr     *
36*5e29103aSannda     * @param Event $event event object by reference
3776ad0db2SAndreas Gohr     * @param mixed $param [the parameters passed as fifth argument to register_hook() when this
3876ad0db2SAndreas Gohr     *                           handler was registered]
3976ad0db2SAndreas Gohr     * @return bool
4076ad0db2SAndreas Gohr     */
417234bfb1Ssplitbrain    public function handleIndexing(Event $event, $param)
42d6d97f60SAnna Dabrowska    {
4376ad0db2SAndreas Gohr        $id = $event->data['page'];
44025cb9daSAndreas Gohr        $assignments = Assignments::getInstance();
4576ad0db2SAndreas Gohr        $tables = $assignments->getPageAssignments($id);
4676ad0db2SAndreas Gohr        if (!$tables) return;
4776ad0db2SAndreas Gohr
4876ad0db2SAndreas Gohr        foreach ($tables as $table) {
494cd5cc28SAnna Dabrowska            $schemadata = AccessTable::getPageAccess($table, $id);
5076ad0db2SAndreas Gohr            $event->data['body'] .= $schemadata->getDataPseudoSyntax();
5176ad0db2SAndreas Gohr        }
5276ad0db2SAndreas Gohr    }
5376ad0db2SAndreas Gohr
5476ad0db2SAndreas Gohr    /**
5576ad0db2SAndreas Gohr     * Adds the structured data to the page body to be snippeted
5676ad0db2SAndreas Gohr     *
57*5e29103aSannda     * @param Event $event event object by reference
5876ad0db2SAndreas Gohr     * @param mixed $param [the parameters passed as fifth argument to register_hook() when this
5976ad0db2SAndreas Gohr     *                           handler was registered]
6076ad0db2SAndreas Gohr     * @return bool
6176ad0db2SAndreas Gohr     */
627234bfb1Ssplitbrain    public function handleSnippets(Event $event, $param)
63d6d97f60SAnna Dabrowska    {
6476ad0db2SAndreas Gohr        $id = $event->data['id'];
65025cb9daSAndreas Gohr        $assignments = Assignments::getInstance();
6676ad0db2SAndreas Gohr        $tables = $assignments->getPageAssignments($id);
6776ad0db2SAndreas Gohr        if (!$tables) return;
6876ad0db2SAndreas Gohr
6976ad0db2SAndreas Gohr        foreach ($tables as $table) {
704cd5cc28SAnna Dabrowska            $schemadata = AccessTable::getPageAccess($table, $id);
7176ad0db2SAndreas Gohr            $event->data['text'] .= $schemadata->getDataPseudoSyntax();
7276ad0db2SAndreas Gohr        }
7376ad0db2SAndreas Gohr    }
7476ad0db2SAndreas Gohr}
7576ad0db2SAndreas Gohr
7676ad0db2SAndreas Gohr// vim:ts=4:sw=4:et:
77