syntax.php

<?php
/**
 * Info Plugin: Displays information about various DokuWiki internals
 *
 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
 * @author     Andreas Gohr <andi@splitbrain.org>
 */


if(!defined('DOKU_INC')) define('DOKU_INC',realpath(dirname(__FILE__).'/../../').'/');
if(!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN',DOKU_INC.'lib/plugins/');
require_once(DOKU_PLUGIN.'syntax.php');
require_once(DOKU_INC.'inc/search.php');

/**
 * All DokuWiki plugins to extend the parser/rendering mechanism
 * need to inherit from this class
 */
class syntax_plugin_nslist extends DokuWiki_Syntax_Plugin {

    /**
     * What kind of syntax are we?
     */
    function getType(){
        return 'substition';
    }

    /**
     * What about paragraphs?
     */
    function getPType(){
        return 'block';
    }

    /**
     * Where to sort in?
     */
    function getSort(){
        return 302;
    }


    /**
     * Connect pattern to lexer
     */
    function connectTo($mode) {
        $this->Lexer->addSpecialPattern('{{nslist>[^}]*}}',$mode,'plugin_nslist');
    }


    /**
     * Handle the match
     */
    function handle($match, $state, $pos, Doku_Handler $handler){
        global $ID;
        $match = substr($match,9,-2); //strip {{nslist> from start and }} from end

        $conf = array(
            'ns'    => getNS($ID),
            'depth' => 1,
            'date'  => 1,
            'dsort' => 1
            ,'liststyle' => 'default'
            );

        list($ns,$params) = explode(' ',$match,2);
        $ns = cleanID($ns);

        if(preg_match('/\bnodate\b/i',$params))  $conf['date'] = 0;
        if(preg_match('/\bnodsort\b/i',$params)) $conf['dsort'] = 0;
        if(preg_match('/\b(\d+)\b/i',$params,$m))   $conf['depth'] = $m[1];
        if($ns) $conf['ns'] = $ns;

        if(preg_match('/liststyle=([a-z\-]+)\&?/i',$params,$m)) $conf['liststyle'] = $m[1]; //parse parameter "liststyle"

        $conf['dir'] = str_replace(':','/',$conf['ns']);

        // prepare data
        return $conf; //conf will become data by function render later
    }

    /**
     * Create output
     */
    function render($format, Doku_Renderer $R, $data) {
        global $conf;
        global $lang;
        if($format != 'xhtml') return false;


        $opts = array(
            'depth'     => $data['depth'],
            'listfiles' => true,
            'listdirs'  => false,
            'pagesonly' => true,
            'meta'      => true
        );

        // read the directory
        $result = array();
        search($result,$conf['datadir'],'search_universal',$opts,$data['dir']);

        if($data['dsort']){
            usort($result,array($this,'_sort_date'));
        }else{
            usort($result,array($this,'_sort_page'));
        }

        $R->listu_open();
        foreach($result as $item){
            $R->listitem_open(1);
            $R->listcontent_open();
            
            //Different behaviour as of Liststyle- Param
            if($data['liststyle'] == 'default') {
                //no special parameter given, use default = empty
                $item['id_name'] = '';
            }elseif($data['liststyle'] == 'full')
            {
                $item['id_name'] = $item['id']; //full name of space
            }elseif($data['liststyle'] == 'relative')
            {
                $item['id_name'] = substr($item['id'],strlen($data['ns'])+1); //strip off given namespace + ':'
            };
            
            $R->internallink(':'.$item['id'],$item['id_name']);
            if($data['date']) $R->cdata(' '.dformat($item['mtime']));

            $R->listcontent_close();
            $R->listitem_close();
        }
        $R->listu_close();

        return true;
    }

    function _sort_page($a,$b){
        return strcmp($a['id'],$b['id']);
    }

    function _sort_date($a,$b){
        if($b['mtime'] < $a['mtime']){
            return -1;
        }elseif($b['mtime'] > $a['mtime']){
            return 1;
        }else{
            return strcmp($a['id'],$b['id']);
        }
    }

}

//Setup VIM: ex: et ts=4 enc=utf-8 :