PEAR2_Text_MarkdownPEAR2_Text_Markdown-0.1.0/php/PEAR2/Text/Markdown/Apidoc/ClassPage.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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
<?php
/**
 * 
 * Replaces class page links in source text with XHTML anchors.
 * 
 * Class page links are in this format ...
 * 
 *     [[Class]]
 *     [[Class]]es
 *     [[Class | display this instead]]
 *     [[Class::Page]]
 *     [[Class::$property]]
 *     [[Class::method()]]
 *     [[Class::CONSTANT]]
 * 
 * @category Solar
 * 
 * @package Markdown_Apidoc
 * 
 * @author Paul M. Jones <pmjones@solarphp.com>
 * 
 * @license http://opensource.org/licenses/bsd-license.php BSD
 * 
 * @version $Id: ClassPage.php 4600 2010-06-16 03:27:55Z pmjones $
 * 
 */
namespace PEAR2\Text;

class Markdown_Apidoc_ClassPage extends Markdown_Plugin
{
    /**
     * 
     * Default configuration values.
     * 
     * @config string constant A string template for the xml:id for 
     * "Constants" page links.
     * 
     * @config string overview A string template for the xml:id for 
     * "Overview" page links.
     * 
     * @config string method A string template for the xml:id for 
     * individual method page links.
     * 
     * @config string other A string template for the xml:id for 
     * all other types of page links.
     * 
     * @config string property A string template for the xml:id for 
     * "Properties" page links.
     * 
     * @config string package A string template for the xml:id for 
     * "Package" page links.
     * 
     * @var array
     * 
     */
    protected $_Markdown_Apidoc_ClassPage = array(
        'constant'  => 'class.{:class}.Constants.{:page}',
        'overview'  => 'class.{:class}.Overview',
        'method'    => 'class.{:class}.{:page}',
        'other'     => 'class.{:class}.{:page}',
        'property'  => 'class.{:class}.Properties.{:page}',
        'package'   => 'package.{:package}',
    );
    
    /**
     * 
     * This is a span plugin.
     * 
     * @var bool
     * 
     */
    protected $_is_span = true;
    
    /**
     * 
     * A list of classes recognized as being native to PHP.
     * 
     * @var array
     * 
     */
    protected $_php_classes = array('Exception');
    
    /**
     * 
     * Parses the source text for Class::Page links.
     * 
     * @param string $text The source text.
     * 
     * @return string The parsed text.
     * 
     */
    public function parse($text)
    {
        $regex = '/\[\[(.*?)(\|.*?)?\]\](\w*)?/';
        return preg_replace_callback(
            $regex,
            array($this, '_parse'),
            $text
        );
    }
    
    /**
     * 
     * Support callback for parsing class page links.
     * 
     * @param array $matches Matches from preg_replace_callback().
     * 
     * @return string The replacement text.
     * 
     */
    protected function _parse($matches)
    {
        $spec = $matches[1];
        
        // the display text
        if (empty($matches[2])) {
            // no pipe was specified, use the spec as the text
            $text = $spec;
        } else {
            // a pipe was specified; take it off, and trim the rest
            $text = trim(substr($matches[2], 1));
        }
        
        $atch = empty($matches[3]) ? null  : trim($matches[3]);
        
        if (strtolower(substr($spec, 0, 5)) == 'php::') {
            $func = substr($spec, 5);
            $link = $this->_getPhpFunctionLink($func, $text, $atch);
        } else {
            $link = $this->_getClassPageLink($spec, $text, $atch);
        }
        
        return $this->_toHtmlToken($link);
    }
    
    /**
     * 
     * Builds a link to functions on php.net pages.
     * 
     * @param string $func The PHP function name.
     * 
     * @param string $text The displayed text for the link.
     * 
     * @param string $atch Additional non-linked text.
     * 
     * @return string The replacement text.
     * 
     */
    protected function _getPhpFunctionLink($func, $text, $atch)
    {
        $func = trim($func);
        
        if (! $text) {
            $text = $func;
        }
        
        if (substr($func, -2) == '()') {
            $func = substr($func, 0, -2);
        }
        
        $href = "http://php.net/$func";
        
        return '<link xlink:href="' . $this->_escape($href) . '">'
             . $this->_escape($text . $atch)
             . '</link>';
    }
    
    /**
     * 
     * Builds a link to classes on php.net pages.
     * 
     * @param string $class The PHP class.
     * 
     * @param string $page The page for that class, typically a method name.
     * 
     * @param string $text The displayed text for the link.
     * 
     * @param string $atch Additional non-linked text.
     * 
     * @return string The replacement text.
     * 
     */
    protected function _getPhpClassLink($class, $page, $text, $atch)
    {
        if (! $text) {
            $text = $page;
        }
        
        // massage page name
        $page = preg_replace('[^a-zA-Z0-9]', '', $page);
        
        // http://php.net/manual/en/exception.getmessage.php
        $href = "http://php.net/manual/en/"
              . strtolower($class) . '.'
              . strtolower($page) . '.php';
        
        return '<link xlink:href="' . $this->_escape($href) . '">'
             . $this->_escape($text . $atch)
             . '</link>';
    }
    
    /**
     * 
     * Builds a link for class API documentation pages.
     * 
     * @param string $spec The link specification.
     * 
     * @param string $text The displayed text for the link.
     * 
     * @param string $atch Additional non-linked text.
     * 
     * @return string The replacement text.
     * 
     */
    protected function _getClassPageLink($spec, $text, $atch)
    {
        $pos = strpos($spec, '::');
        if ($pos === false) {
            $class = $spec;
            $page  = null;
            if (! $text) {
                $text = $spec;
            }
        } else {
            $class = trim(substr($spec, 0, $pos));
            $page  = trim(substr($spec, $pos + 2));
            if (! $text) {
                $text = $page;
            }
        }
        
        // is it a recognized PHP class?
        if (in_array($class, $this->_php_classes)) {
            return $this->_getPhpClassLink($class, $page, $text, $atch);
        }
        
        // is it a package link?
        if ($class == 'Package') {
            return $this->_getPackageLink($page, $text, $atch);
        }
        
        // what kind of link to build?
        $is_property = false;
        if (! $page) {
            // no page specified
            $tmpl = $this->_config['overview'];
        } elseif (substr($page, 0, 1) == '$') {
            // $property
            $tmpl = $this->_config['property'];
            $page = substr($page, 1);
            $is_property = true;
        } elseif (substr($page, -2) == '()') {
            // method()
            $tmpl = $this->_config['method'];
            $page = substr($page, 0, -2);
        } elseif (strtoupper($page) === $page) {
            // CONSTANT
            $tmpl = $this->_config['constant'];
        } else {
            // other
            $tmpl = $this->_config['other'];
        }
        
        // interpolate values into link template placeholders
        $keys = array('{:class}', '{:page}');
        $vals = array($class, $page);
        $link = str_replace($keys, $vals, $tmpl);
        
        return '<link linkend="' .$this->_escape($link) . '">'
             . $this->_escape($text . $atch)
             . '</link>';
    }
    
    /**
     * 
     * Builds a link to a package page.
     * 
     * @param string $package The package name.
     * 
     * @param string $text The displayed text for the link.
     * 
     * @param string $atch Additional non-linked text.
     * 
     * @return string The replacement text.
     * 
     */
    protected function _getPackageLink($package, $text, $atch)
    {
        $tmpl = $this->_config['package'];
        $keys = array('{:package}');
        $vals = array($package);
        $link = str_replace($keys, $vals, $tmpl);
        
        if (! $text) {
            $text = $package;
        }
        
        return '<link linkend="' .$this->_escape($link) . '">'
             . $this->_escape($text . $atch)
             . '</link>';
    }
}
EOF