xref: /plugin/struct/helper/db.php (revision 549a0837397243f9208e2e78aa6597d7d762443d) 
1<?php
2/**
3 * DokuWiki Plugin struct (Helper 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
9// must be run within Dokuwiki
10if(!defined('DOKU_INC')) die();
11
12class helper_plugin_struct_db extends DokuWiki_Plugin {
13
14    /**
15     * Return info about supported methods in this Helper Plugin
16     *
17     * @return array of public methods
18     */
19    public function getMethods() {
20        return array(
21            array(
22                'name'   => 'getThreads',
23                'desc'   => 'returns pages with discussion sections, sorted by recent comments',
24                'params' => array(
25                    'namespace'         => 'string',
26                    'number (optional)' => 'integer'
27                ),
28                'return' => array('pages' => 'array')
29            ),
30            array(
31                // and more supported methods...
32            )
33        );
34    }
35
36}
37
38// vim:ts=4:sw=4:et:
39