lib/plugins/pagelist/syntax.php

   1 <?php
   2 /**
   3  * Pagelist Plugin: lists pages
   4  *
   5  * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
   6  * @author     Esther Brunner <wikidesign@gmail.com>
   7  */
   8 // must be run within Dokuwiki
   9 if (!defined('DOKU_INC')) die();
  10
  11 if (!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN', DOKU_INC.'lib/plugins/');
  12 require_once(DOKU_PLUGIN.'syntax.php');
  13
  14 class syntax_plugin_pagelist extends DokuWiki_Syntax_Plugin {
  15
  16     function getType() { return 'substition';}
  17     function getPType() { return 'block';}
  18     function getSort() { return 168; }
  19
  20     /**
  21      * Connect pattern to lexer
  22      */
  23     function connectTo($mode) {
  24         $this->Lexer->addSpecialPattern('<pagelist.+?</pagelist>', $mode, 'plugin_pagelist');
  25     }
  26
  27     /**
  28      * Handle the match
  29      */
  30     function handle($match, $state, $pos, &$handler) {
  31         global $ID;
  32
  33         $match = substr($match, 9, -11);  // strip markup
  34         list($flags, $match) = explode('>', $match, 2);
  35         $flags = explode('&', substr($flags, 1));
  36         $items = explode('*', $match);
  37
  38         $pages = array();
  39         $c = count($items);
  40         for ($i = 0; $i < $c; $i++) {
  41             if (!preg_match('/\[\[(.+?)\]\]/', $items[$i], $match)) continue;
  42             list($id, $title) = explode('|', $match[1], 2);
  43             list($id, $section) = explode('#', $id, 2);
  44             if (!$id) $id = $ID;
  45             resolve_pageid(getNS($ID), $id, $exists);
  46
  47             // page has an image title
  48             if (($title) && (preg_match('/\{\{(.+?)\}\}/', $title, $match))) {
  49                 list($image, $title) = explode('|', $match[1], 2);
  50                 list($ext, $mime) = mimetype($image);
  51                 if (!substr($mime, 0, 5) == 'image') $image = '';
  52                 $pages[] = array(
  53                         'id'      => $id,
  54                         'section' => cleanID($section),
  55                         'title'   => trim($title),
  56                         'image'   => trim($image),
  57                         'exists'  => $exists,
  58                         );
  59
  60             // text title (if any)
  61             } else {
  62                 $pages[] = array(
  63                         'id'      => $id,
  64                         'section' => cleanID($section),
  65                         'title'   => trim($title),
  66                         'exists'  => $exists,
  67                         );
  68             }
  69         }
  70         return array($flags, $pages);
  71     }
  72
  73     /**
  74      * Create output
  75      */
  76     function render($mode, &$renderer, $data) {
  77         list($flags, $pages) = $data;
  78
  79         // for XHTML output
  80         if ($mode == 'xhtml') {
  81             if (!$my =& plugin_load('helper', 'pagelist')) return false;
  82             $my->setFlags($flags);
  83             $my->startList();
  84             foreach($pages as $page) {
  85                 $my->addPage($page);
  86             }
  87             $renderer->doc .= $my->finishList();
  88             return true;
  89
  90         // for metadata renderer
  91         } elseif ($mode == 'metadata') {
  92             foreach ($pages as $page) {
  93                 $renderer->meta['relation']['references'][$page['id']] = $page['exists'];
  94             }
  95             return true;
  96         }
  97         return false;
  98     }
  99 }
 100 // vim:ts=4:sw=4:et:enc=utf-8: