xref: /plugin/struct/action/search.php (revision a14cf85d0dc6d9c91c1c733090beb24cfe2e1aa3) !
176ad0db2SAndreas Gohr<?php
276ad0db2SAndreas Gohr/**
376ad0db2SAndreas Gohr * DokuWiki Plugin struct (Action Component)
476ad0db2SAndreas Gohr *
576ad0db2SAndreas Gohr * @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html
676ad0db2SAndreas Gohr * @author  Andreas Gohr, Michael Große <dokuwiki@cosmocode.de>
776ad0db2SAndreas Gohr */
876ad0db2SAndreas Gohr
9f411d872SAndreas Gohruse dokuwiki\plugin\struct\meta\AccessTable;
10ba766201SAndreas Gohruse dokuwiki\plugin\struct\meta\Assignments;
1176ad0db2SAndreas Gohr
12*a14cf85dSAnna Dabrowska/**
13*a14cf85dSAnna Dabrowska * Inject struct data into indexed pages and search result snippets
14*a14cf85dSAnna Dabrowska */
1576ad0db2SAndreas Gohrclass action_plugin_struct_search extends DokuWiki_Action_Plugin {
1676ad0db2SAndreas Gohr
1776ad0db2SAndreas Gohr    /**
1876ad0db2SAndreas Gohr     * Registers a callback function for a given event
1976ad0db2SAndreas Gohr     *
2076ad0db2SAndreas Gohr     * @param Doku_Event_Handler $controller DokuWiki's event controller object
2176ad0db2SAndreas Gohr     * @return void
2276ad0db2SAndreas Gohr     */
2376ad0db2SAndreas Gohr    public function register(Doku_Event_Handler $controller) {
2476ad0db2SAndreas Gohr        $controller->register_hook('INDEXER_PAGE_ADD', 'BEFORE', $this, 'handle_indexing');
2576ad0db2SAndreas Gohr        $controller->register_hook('FULLTEXT_SNIPPET_CREATE', 'BEFORE', $this, 'handle_snippets');
2676ad0db2SAndreas Gohr    }
2776ad0db2SAndreas Gohr
2876ad0db2SAndreas Gohr    /**
2976ad0db2SAndreas Gohr     * Adds the structured data to the page body to be indexed
3076ad0db2SAndreas Gohr     *
3176ad0db2SAndreas Gohr     * @param Doku_Event $event event object by reference
3276ad0db2SAndreas Gohr     * @param mixed $param [the parameters passed as fifth argument to register_hook() when this
3376ad0db2SAndreas Gohr     *                           handler was registered]
3476ad0db2SAndreas Gohr     * @return bool
3576ad0db2SAndreas Gohr     */
3676ad0db2SAndreas Gohr    public function handle_indexing(Doku_Event $event, $param) {
3776ad0db2SAndreas Gohr        $id = $event->data['page'];
38025cb9daSAndreas Gohr        $assignments = Assignments::getInstance();
3976ad0db2SAndreas Gohr        $tables = $assignments->getPageAssignments($id);
4076ad0db2SAndreas Gohr        if(!$tables) return;
4176ad0db2SAndreas Gohr
42*a14cf85dSAnna Dabrowska        $now = time();
4376ad0db2SAndreas Gohr        foreach($tables as $table) {
44*a14cf85dSAnna Dabrowska            $schemadata = AccessTable::byTableName($table, $id, $now);
4576ad0db2SAndreas Gohr            $event->data['body'] .= $schemadata->getDataPseudoSyntax();
4676ad0db2SAndreas Gohr        }
4776ad0db2SAndreas Gohr    }
4876ad0db2SAndreas Gohr
4976ad0db2SAndreas Gohr    /**
5076ad0db2SAndreas Gohr     * Adds the structured data to the page body to be snippeted
5176ad0db2SAndreas Gohr     *
5276ad0db2SAndreas Gohr     * @param Doku_Event $event event object by reference
5376ad0db2SAndreas Gohr     * @param mixed $param [the parameters passed as fifth argument to register_hook() when this
5476ad0db2SAndreas Gohr     *                           handler was registered]
5576ad0db2SAndreas Gohr     * @return bool
5676ad0db2SAndreas Gohr     */
5776ad0db2SAndreas Gohr    public function handle_snippets(Doku_Event $event, $param) {
5876ad0db2SAndreas Gohr        $id = $event->data['id'];
59025cb9daSAndreas Gohr        $assignments = Assignments::getInstance();
6076ad0db2SAndreas Gohr        $tables = $assignments->getPageAssignments($id);
6176ad0db2SAndreas Gohr        if(!$tables) return;
6276ad0db2SAndreas Gohr
63*a14cf85dSAnna Dabrowska        $now = time();
6476ad0db2SAndreas Gohr        foreach($tables as $table) {
65*a14cf85dSAnna Dabrowska            $schemadata = AccessTable::byTableName($table, $id, $now);
6676ad0db2SAndreas Gohr            $event->data['text'] .= $schemadata->getDataPseudoSyntax();
6776ad0db2SAndreas Gohr        }
6876ad0db2SAndreas Gohr    }
6976ad0db2SAndreas Gohr}
7076ad0db2SAndreas Gohr
7176ad0db2SAndreas Gohr// vim:ts=4:sw=4:et:
72