PEAR2_Text_MarkdownPEAR2_Text_Markdown-0.1.0/php/PEAR2/Text/Markdown/Plugin.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
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
<?php
/**
 * 
 * Abstract class for Markdown plugins.
 * 
 * @category Solar
 * 
 * @package Markdown
 * 
 * @author Paul M. Jones <pmjones@solarphp.com>
 * 
 * @license http://opensource.org/licenses/bsd-license.php BSD
 * 
 * @version $Id: Plugin.php 3988 2009-09-04 13:51:51Z pmjones $
 * 
 */
namespace PEAR2\Text;

abstract class Markdown_Plugin {
    
    /**
     * 
     * Default configuration values.
     * 
     * @config Markdown markdown The "parent" Markdown object.
     * 
     * @var array
     * 
     */
    protected $_Markdown_Plugin = array(
        'markdown' => null,
    );
    
    /**
     * 
     * The "parent" Markdown object.
     * 
     * @var Markdown
     * 
     */
    protected $_markdown;
    
    /**
     * 
     * The characters this plugin uses for parsing, which should be
     * encoded by other other plugins.
     * 
     * @var string
     * 
     */
    protected $_chars = '';
    
    /**
     * 
     * The max depth for nested brackets.
     * 
     * @var int
     * 
     */
    protected $_nested_brackets_depth = 6;
    
    /**
     * 
     * The regular expression for nested brackets.
     * 
     * Built by the constructor  based on $_nested_brackets_depth.
     * 
     * @var string
     * 
     */
    protected $_nested_brackets = '';
    
    /**
     * 
     * Do **not** run this plugin during the "prepare" phase.
     * 
     * @var bool
     * 
     */
    protected $_is_prepare = false;
    
    /**
     * 
     * This is **not** a block plugin.
     * 
     * @var bool
     * 
     */
    protected $_is_block = false;
    
    /**
     * 
     * This is **not** a span plugin.
     * 
     * @var bool
     * 
     */
    protected $_is_span = false;
    
    /**
     * 
     * Do **not** run this plugin during the "cleanup" phase.
     * 
     * @var bool
     * 
     */
    protected $_is_cleanup = false;
    
    /**
     * 
     * Post-construction tasks to complete object construction.
     * 
     * @return void
     * 
     */
    function __construct()
    {
        $this->_nested_brackets = 
            str_repeat('(?>[^\[\]]+|\[', $this->_nested_brackets_depth).
            str_repeat('\])*', $this->_nested_brackets_depth);
        
        if (! empty($this->_config['markdown'])) {
            $this->setMarkdown($this->_config['markdown']);
        }
    }
    
    /**
     * 
     * Sets the "parent" Markdown object.
     * 
     * @param Markdown $markdown The "parent" Markdown object.
     * 
     * @return void
     * 
     */
    public function setMarkdown($markdown)
    {
        $this->_markdown = $markdown;
    }
    
    /**
     * 
     * Run this plugin during the "prepare" phase?
     * 
     * @return bool
     * 
     */
    public function isPrepare()
    {
        return (bool) $this->_is_prepare;
    }
    
    /**
     * 
     * Is this a block-level plugin?
     * 
     * Reports the value of $this->_is_block.
     * 
     * @return bool
     * 
     */
    public function isBlock()
    {
        return (bool) $this->_is_block;
    }
    
    /**
     * 
     * Is this a span-level plugin?
     * 
     * Reports the value of $this->_is_span.
     * 
     * @return bool
     * 
     */
    public function isSpan()
    {
        return (bool) $this->_is_span;
    }
    
    /**
     * 
     * Run this plugin during the "cleanup" phase?
     * 
     * @return bool
     * 
     */
    public function isCleanup()
    {
        return (bool) $this->_is_cleanup;
    }
    
    /**
     * 
     * Get the list of characters this plugin uses for parsing.
     * 
     * @return string
     * 
     */
    public function getChars()
    {
        return $this->_chars;
    }
    
    /**
     * 
     * Resets this plugin to its original state (for multiple parsings).
     * 
     * @return void
     * 
     */
    public function reset()
    {
    }
    
    /**
     * 
     * Prepares the source text before any parsing occurs.
     * 
     * Returns the text as-is.
     * 
     * @param string $text The source text.
     * 
     * @return string $text The text after being filtered.
     * 
     */
    public function prepare($text)
    {
        return $text;
    }
    
    /**
     * 
     * Parses the source text and replaces with HTML or tokens.
     * 
     * Returns the text as-is.
     * 
     * @param string $text The source text.
     * 
     * @return string The text after parsing.
     * 
     */
    public function parse($text)
    {
        return $text;
    }
     
    /**
     * 
     * Cleans up the source text after all parsing occurs.
     * 
     * Returns the text as-is.
     * 
     * @param string $text The source text.
     * 
     * @return string $text The text after being filtered.
     * 
     */
    public function cleanup($text)
    {
        return $text;
    }
    
    /**
     * 
     * Removes one level of leading tabs or space from a text block.
     * 
     * For example, if a block of text is indented by 3 tabs, it will be
     * returned as indented with only 2 tabs.
     * 
     * @param string $text A block of text.
     * 
     * @return string The same text out-dented by one level of tabs
     * or spaces.
     * 
     */
    protected function _outdent($text)
    {
        $tab_width = $this->_getTabWidth();
        return preg_replace(
            "/^(\\t|[ ]{1,$tab_width})/m",
            "",
            $text
        );
    }
    
    /**
     * 
     * Escapes HTML in source text.
     * 
     * @param string $text Source text.
     * 
     * @param int $quotes A PHP entities constant, default ENT_COMPAT.
     * 
     * @return string The escaped text.
     * 
     */
    protected function _escape($text, $quotes = ENT_COMPAT)
    {
        return $this->_markdown->escape($text, $quotes);
    }
    
    /**
     * 
     * Encodes special Markdown characters to they are not parsed by
     * plugins.
     * 
     * @param string $text Source text.
     * 
     * @param bool $only_backslash Only encode backslashed characters.
     * 
     * @return string The encoded text.
     * 
     */
    protected function _encode($text, $only_backslash = false)
    {
        return $this->_markdown->encode($text, $only_backslash);
    }
    
    /**
     * 
     * Processes the text using block-type plugins.
     * 
     * Good for finding blocks within blocks.
     * 
     * @param string $text Source text.
     * 
     * @return string The source text after block parsing.
     * 
     */
    protected function _processBlocks($text)
    {
        return $this->_markdown->processBlocks($text);
    }
    
    /**
     * 
     * Processes the text using span-type plugins.
     * 
     * @param string $text Source text.
     * 
     * @return string The source text after span parsing.
     * 
     */
    protected function _processSpans($text)
    {
        return $this->_markdown->processSpans($text);
    }
    
    
    /**
     * 
     * Returns the number of spaces per tab.
     * 
     * @return int
     * 
     */
    protected function _getTabWidth()
    {
        return $this->_markdown->getTabWidth();
    }
    
    /**
     * 
     * Converts a piece of text to a delimited HTML token.
     * 
     * @param string $text The text to save as an HTML token.
     * 
     * @return string A delimited HTML token.
     * 
     */
    protected function _toHtmlToken($text)
    {
        return $this->_markdown->toHtmlToken($text);
    }
    
    /**
     * 
     * Is a piece of text a delimited HTML token?
     * 
     * @param string $text The text to check as an HTML token.
     * 
     * @return bool True if a token, false if not.
     * 
     */
    protected function _isHtmlToken($text)
    {
        return $this->_markdown->isHtmlToken($text);
    }
    
    /**
     * 
     * Converts all delimited HTML tokens back into HTML.
     * 
     * @param string $text The text to un-tokenize.
     * 
     * @return string The text with HTML tokens replaced.
     * 
     */
    protected function _unHtmlToken($text)
    {
        return $this->_markdown->unHtmlToken($text);
    }
}
EOF