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

Source for file horiz.php

Documentation is available at horiz.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: horiz.php,v 1.1 2004/01/04 01:35:23 pmjones Exp $
  20.  
  21.  
  22. /**
  23. * This class implements a Text_Wiki_Rule to find source text marked to
  24. * be a horizontal rule, as defined by four dashed on their own line.
  25. *
  26. @author Paul M. Jones <pmjones@ciaweb.net>
  27. *
  28. @package Text_Wiki
  29. *
  30. */
  31.  
  32.     
  33.     
  34.     /**
  35.     * 
  36.     * The regular expression used to parse the source text and find
  37.     * matches conforming to this rule.  Used by the parse() method.
  38.     * 
  39.     * @access public
  40.     * 
  41.     * @var string 
  42.     * 
  43.     * @see parse()
  44.     * 
  45.     */
  46.     
  47.     var $regex = '/^([-]{4,})$/m';
  48.     
  49.     
  50.     /**
  51.     * 
  52.     * Generates a replacement token for the matched text.
  53.     * 
  54.     * @access public
  55.     *
  56.     * @param array &$matches The array of matches from parse().
  57.     *
  58.     * @return string A token marking the horizontal rule.
  59.     *
  60.     */
  61.     
  62.     function process(&$matches)
  63.     {    
  64.         return $this->addToken();
  65.     }
  66.     
  67.     
  68.     /**
  69.     * 
  70.     * Renders a token into text matching the requested format.
  71.     * 
  72.     * @access public
  73.     * 
  74.     * @param array $options The "options" portion of the token (second
  75.     *  element).
  76.     * 
  77.     * @return string The text rendered from the token options.
  78.     * 
  79.     */
  80.     
  81.     function renderXhtml($options)
  82.     {
  83.         return "<hr />\n";
  84.     }
  85. }
  86. ?>

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