Text_Wiki
[ class tree: Text_Wiki ] [ index: Text_Wiki ] [ all elements ]

Source for file raw.php

Documentation is available at raw.php

  1. <?php
  2. /* vim: set expandtab tabstop=4 shiftwidth=4: */
  3. // +----------------------------------------------------------------------+
  4. // | PHP version 4                                                        |
  5. // +----------------------------------------------------------------------+
  6. // | Copyright (c) 1997-2003 The PHP Group                                |
  7. // +----------------------------------------------------------------------+
  8. // | This source file is subject to version 2.0 of the PHP license,       |
  9. // | that is bundled with this package in the file LICENSE, and is        |
  10. // | available through the world-wide-web at                              |
  11. // | http://www.php.net/license/2_02.txt.                                 |
  12. // | If you did not receive a copy of the PHP license and are unable to   |
  13. // | obtain it through the world-wide-web, please send a note to          |
  14. // | license@php.net so we can mail you a copy immediately.               |
  15. // +----------------------------------------------------------------------+
  16. // | Authors: Paul M. Jones <pmjones@ciaweb.net>                          |
  17. // +----------------------------------------------------------------------+
  18. //
  19. // $Id: raw.php,v 1.2 2004/03/10 22:24:58 pmjones Exp $
  20.  
  21.  
  22. /**
  23. * This class implements a Text_Wiki rule to find sections of the source
  24. * text that are not to be processed by Text_Wiki.  These blocks of "raw"
  25. * text will be rendered as they were found.
  26. *
  27. @author Paul M. Jones <pmjones@ciaweb.net>
  28. *
  29. @package Text_Wiki
  30. *
  31. */
  32.  
  33.     
  34.     
  35.     /**
  36.     * 
  37.     * The regular expression used to find source text matching this
  38.     * rule.
  39.     * 
  40.     * @access public
  41.     * 
  42.     * @var string 
  43.     * 
  44.     */
  45.     
  46.     var $regex = "/``(.*)``/U";
  47.     
  48.     
  49.     /**
  50.     * 
  51.     * Generates a token entry for the matched text.  Token options are:
  52.     * 
  53.     * 'text' => The full matched text.
  54.     * 
  55.     * @access public
  56.     *
  57.     * @param array &$matches The array of matches from parse().
  58.     *
  59.     * @return delimited token number to be used as a placeholder in
  60.     *  the source text.
  61.     *
  62.     */
  63.     
  64.     function process(&$matches)
  65.     {
  66.         $options = array('text' => $matches[1]);
  67.         return $this->addToken($options);
  68.     }
  69.     
  70.     
  71.     /**
  72.     * 
  73.     * Renders a token into text matching the requested format.
  74.     * 
  75.     * @access public
  76.     * 
  77.     * @param array $options The "options" portion of the token (second
  78.     *  element).
  79.     * 
  80.     * @return string The text rendered from the token options.
  81.     * 
  82.     */
  83.     
  84.     function renderXhtml($options)
  85.     {
  86.         return $options['text'];
  87.     }
  88. }
  89. ?>

Documentation generated on Mon, 11 Mar 2019 10:14:14 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.