PEAR2_Text_MarkdownPEAR2_Text_Markdown-0.1.0/php/PEAR2/Text/Markdown/Apidoc/Section.php

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
<?php
/**
 * 
 * Block plugin to convert Markdown headers into DocBook sections.
 * 
 * @category Solar
 * 
 * @package Markdown_Apidoc
 * 
 * @author John Gruber <http://daringfireball.net/projects/markdown/>
 * 
 * @author Michel Fortin <http://www.michelf.com/projects/php-markdown/>
 * 
 * @author Paul M. Jones <pmjones@solarphp.com>
 * 
 * @license http://opensource.org/licenses/bsd-license.php BSD
 * 
 * @version $Id: Section.php 4600 2010-06-16 03:27:55Z pmjones $
 * 
 */
namespace PEAR2\Text;

class Markdown_Apidoc_Section extends Markdown_Plugin
{
    /**
     * 
     * This is a block plugin.
     * 
     * @var bool
     * 
     */
    protected $_is_block = true;
    
    /**
     * 
     * These should be encoded as special Markdown characters.
     * 
     * @var string
     * 
     */
    protected $_chars = '-=';
    
    /**
     * 
     * Turns setext-style headers into Docbook section tags.
     * 
     * @param string $text Portion of the Markdown source text.
     * 
     * @return string The transformed XHTML.
     * 
     * @todo WORK IN TWO PASSES. Do sect3 first, then sect2.
     * 
     */
    public function parse($text)
    {
        // do innermost sections first, then outermost ones
        $text = $this->_parseSections($text, '-');
        $text = $this->_parseSections($text, '=');
        return $text;
    }
    
    /**
     * 
     * Parses the sections in a block of text.
     * 
     * @param string $text The text to parse.
     * 
     * @param string $char The underline character to use ('-' or '=').
     * 
     * @return string The parsed text.
     * 
     */
    protected function _parseSections($text, $char)
    {
        $title = '^(.+?)(\{\#(.+)\})?[ \t]*'; // the section title and optional {#xmlid}
        $under = '\n(' . $char . '+)[ \t]*\n+'; // this section (either = or -)
        $sect  = $title . $under; // title and underline
        $body  = "([\w\W]*?)?"; // the section body
        $next  = $title . '\n(=+|-+)[ \t]*\n+'; // next section (both = and -)
        $regex = "/($sect)($body)(($next)|(\z))/m";
        
        // find each section block in turn and tokenize it
        while (true) {
            
            // look for a section block
            $found = preg_match($regex, $text, $matches);
            if (! $found) {
                break;
            }
            
            // the section title
            $title = $matches[2];
            
            // the section id, if any
            $xmlid = $matches[4];
            
            // the title underline
            $under = $matches[5];
            
            // section body
            $body  = $matches[6];
            
            // the next section title/xmlid/underline, or end of text
            $tail  = $matches[8];
            
            // what section tag should we use?
            $tag = 'section';
            
            if ($xmlid) {
                $xmlid = ' xml:id="' . $this->_escape($xmlid) . '"';
            }
            
            // the opening section tag
            $open = "<$tag$xmlid>\n"
                  . "<title>"
                  . $this->_processSpans($title)
                  . "</title>";
            
            // the closing section tag
            $close = "</$tag>";
            
            // replacement text is a tokenized opening tag,
            // the body, a tokenized closing tag, and the tail.
            $repl = $this->_toHtmlToken($open)
                  . "\n\n" . trim($body) . "\n\n"
                  . $this->_toHtmlToken($close)
                  . "\n\n" . trim($tail) . "\n\n";
            
            // replace the whole found text with the replacement text
            $text = str_replace($matches[0], $repl, $text);
        }
        
        // done!
        return $text;
    }
}
EOF