delimiter.php 3.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495
  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: delimiter.php,v 1.3 2004/01/31 15:52:08 pmjones Exp $
  20. /**
  21. *
  22. * This class implements a Text_Wiki_Rule to find instances of the delimiter
  23. * character already embedded in the source text; it extracts them and replaces
  24. * them with a delimited token, then renders them as the delimiter itself
  25. * when the target format is XHTML.
  26. *
  27. * @author Paul M. Jones <pmjones@ciaweb.net>
  28. *
  29. * @package Text_Wiki
  30. *
  31. */
  32. class Text_Wiki_Rule_delimiter extends Text_Wiki_Rule {
  33. /**
  34. *
  35. * Constructor. Overrides the Text_Wiki_Rule constructor so that we
  36. * can set the $regex property dynamically (we need to include the
  37. * Text_Wiki $delim character.
  38. *
  39. * @param object &$obj The calling "parent" Text_Wiki object.
  40. *
  41. * @param string $name The token name to use for this rule.
  42. *
  43. */
  44. function Text_Wiki_Rule_delimiter(&$obj, $name)
  45. {
  46. parent::Text_Wiki_Rule($obj, $name);
  47. $this->regex = '/' . $this->_wiki->delim . '/';
  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 A delimited token number to be used as a placeholder in
  60. * the source text.
  61. *
  62. */
  63. function process(&$matches)
  64. {
  65. return $this->addToken();
  66. }
  67. /**
  68. *
  69. * Renders a token into text matching the requested format.
  70. *
  71. * @access public
  72. *
  73. * @param array $options The "options" portion of the token (second
  74. * element).
  75. *
  76. * @return string The text rendered from the token options.
  77. *
  78. */
  79. function renderXhtml($options)
  80. {
  81. return $this->_wiki->delim;
  82. }
  83. }
  84. ?>