home *** CD-ROM | disk | FTP | other *** search
/ Cricao de Sites - 650 Layouts Prontos / WebMasters.iso / Servidores / xampp-win32-1.6.7-installer.exe / php / PEAR / Text / Wiki / Parse / Default / Freelink.php < prev    next >
Encoding:
PHP Script  |  2008-07-02  |  4.3 KB  |  135 lines
  1. <?php
  2.  
  3. /**
  4. * 
  5. * Parses for wiki freelink text.
  6. * 
  7. * @category Text
  8. * 
  9. * @package Text_Wiki
  10. * 
  11. * @author Paul M. Jones <pmjones@php.net>
  12. * 
  13. * @license LGPL
  14. * 
  15. * @version $Id: Freelink.php,v 1.8 2006/12/08 08:23:51 justinpatrin Exp $
  16. * 
  17. */
  18.  
  19. /**
  20. * 
  21. * Parses for freelinked page links.
  22. * 
  23. * This class implements a Text_Wiki_Parse to find source text marked as a
  24. * wiki freelink, and automatically create a link to that page.
  25. * 
  26. * A freelink is any page name not conforming to the standard
  27. * StudlyCapsStyle for a wiki page name.  For example, a page normally
  28. * named MyHomePage can be renamed and referred to as ((My Home Page)) --
  29. * note the spaces in the page name.  You can also make a "nice-looking"
  30. * link without renaming the target page; e.g., ((MyHomePage|My Home
  31. * Page)).  Finally, you can use named anchors on the target page:
  32. * ((MyHomePage|My Home Page#Section1)).
  33. *
  34. * @category Text
  35. * 
  36. * @package Text_Wiki
  37. * 
  38. * @author Paul M. Jones <pmjones@php.net>
  39. * 
  40. */
  41.  
  42. class Text_Wiki_Parse_Freelink extends Text_Wiki_Parse {
  43.     
  44.     var $conf = array (
  45.                        'utf-8' => false
  46.     );
  47.     
  48.     /**
  49.     * 
  50.     * Constructor.  We override the Text_Wiki_Parse constructor so we can
  51.     * explicitly comment each part of the $regex property.
  52.     * 
  53.     * @access public
  54.     * 
  55.     * @param object &$obj The calling "parent" Text_Wiki object.
  56.     * 
  57.     */
  58.     
  59.     function Text_Wiki_Parse_Freelink(&$obj)
  60.     {
  61.         parent::Text_Wiki_Parse($obj);
  62.         if ($this->getConf('utf-8')) {
  63.             $any = '\p{L}';
  64.         } else {
  65.             $any = '';
  66.         }
  67.         $this->regex =
  68.             '/' .                                                   // START regex
  69.             "\\(\\(" .                                               // double open-parens
  70.             "(" .                                                   // START freelink page patter
  71.             "[-A-Za-z0-9 _+\\/.,;:!?'\"\\[\\]\\{\\}&".$any."\xc0-\xff]+" . // 1 or more of just about any character
  72.             ")" .                                                   // END  freelink page pattern
  73.             "(" .                                                   // START display-name
  74.             "\|" .                                                   // a pipe to start the display name
  75.             "[-A-Za-z0-9 _+\\/.,;:!?'\"\\[\\]\\{\\}&".$any."\xc0-\xff]+" . // 1 or more of just about any character
  76.             ")?" .                                                   // END display-name pattern 0 or 1
  77.             "(" .                                                   // START pattern for named anchors
  78.             "\#" .                                                   // a hash mark
  79.             "[A-Za-z]" .                                           // 1 alpha
  80.             "[-A-Za-z0-9_:.]*" .                                   // 0 or more alpha, digit, underscore
  81.             ")?" .                                                   // END named anchors pattern 0 or 1
  82.             "()\\)\\)" .                                           // double close-parens
  83.             '/'.($this->getConf('utf-8') ? 'u' : '');              // END regex
  84.     }
  85.     
  86.     
  87.     /**
  88.     * 
  89.     * Generates a replacement for the matched text.  Token options are:
  90.     * 
  91.     * 'page' => the wiki page name (e.g., HomePage).
  92.     * 
  93.     * 'text' => alternative text to be displayed in place of the wiki
  94.     * page name.
  95.     * 
  96.     * 'anchor' => a named anchor on the target wiki page
  97.     * 
  98.     * @access public
  99.     *
  100.     * @param array &$matches The array of matches from parse().
  101.     *
  102.     * @return A delimited token to be used as a placeholder in
  103.     * the source text, plus any text priot to the match.
  104.     *
  105.     */
  106.     
  107.     function process(&$matches)
  108.     {
  109.         // use nice variable names
  110.         $page = $matches[1];
  111.         $text = $matches[2];
  112.         $anchor = $matches[3];
  113.         
  114.         // is the page given a new text appearance?
  115.         if (trim($text) == '') {
  116.             // no
  117.             $text = $page;
  118.         } else {
  119.             // yes, strip the leading | character
  120.             $text = substr($text, 1);
  121.         }
  122.         
  123.         // set the options
  124.         $options = array(
  125.             'page'   => $page,
  126.             'text'   => $text,
  127.             'anchor' => $anchor
  128.         );
  129.         
  130.         // return a token placeholder
  131.         return $this->wiki->addToken($this->rule, $options);
  132.     }
  133. }
  134. ?>
  135.