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
|
<?php
/**
* TTextHighlighter class file
*
* @author Wei Zhuo<weizhuo[at]gmail[dot]com>
* @link http://www.pradosoft.com/
* @copyright Copyright © 2005-2014 PradoSoft
* @license http://www.pradosoft.com/license/
* @package Prado\Web\UI\WebControls
*/
namespace Prado\Web\UI\WebControls;
use Prado\TPropertyValue;
use Prado\Prado;
// BC trick : only define constants if Text/Highlighter.php
// is not yet included
if (!defined('HL_NUMBERS_LI')) {
/**#@+
* Constant for use with $options['numbers']
*/
/**
* use numbered list, deprecated, use HL_NUMBERS_OL instaed
* @deprecated
*/
define ('HL_NUMBERS_LI' , 1);
/**
* Use 2-column table with line numbers in left column and code in right column.
*/
define ('HL_NUMBERS_TABLE' , 2);
/**#@-*/
}
/**
* TTextHighlighter class.
*
* TTextHighlighter does syntax highlighting its body content, including
* static text and rendering results of child controls.
* You can set {@link setLanguage Language} to specify what kind of syntax
* the body content is. Currently, TTextHighlighter supports the following
* languages: ABAP, CPP, CSS, DIFF, DTD, HTML, JAVA, JAVASCRIPT, MYSQL, PERL,
* PHP, PYTHON, RUBY, SQL, XML and PRADO, where PRADO refers to PRADO template
* syntax. By setting {@link setShowLineNumbers ShowLineNumbers}
* to true, the highlighted result may be shown with line numbers.
*
* Note, TTextHighlighter requires {@link THead} to be placed on the page template
* because it needs to insert some CSS styles.
*
* @author Wei Zhuo<weizhuo[at]gmail[dot]com>
* @package Prado\Web\UI\WebControls
* @since 3.0
*/
class TTextHighlighter extends TTextProcessor
{
private static $_lineNumberStyle=array(TTextHighlighterLineNumberStyle::Li => HL_NUMBERS_LI, TTextHighlighterLineNumberStyle::Table => HL_NUMBERS_TABLE);
/**
* @return string tag name of the panel
*/
protected function getTagName()
{
return 'div';
}
/**
* @return string language whose syntax is to be used for highlighting. Defaults to 'php'.
*/
public function getLanguage()
{
return $this->getViewState('Language', 'php');
}
/**
* @param string language (case-insensitive) whose syntax is to be used for highlighting.
* Valid values are those file names (without suffix) that are contained
* in 'Vendor/TextHighlighter/Text/Highlighter'. Currently, the following languages are supported:
* ABAP, CPP, CSS, DIFF, DTD, HTML, JAVA, JAVASCRIPT,
* MYSQL, PERL, PHP, PRADO, PYTHON, RUBY, SQL, XML
* If a language is not supported, it will be displayed as plain text.
*/
public function setLanguage($value)
{
$this->setViewState('Language', $value, 'php');
}
/**
* @return boolean whether to show line numbers in the highlighted result.
*/
public function getShowLineNumbers()
{
return $this->getViewState('ShowLineNumbers', false);
}
/**
* @param boolean whether to show line numbers in the highlighted result.
*/
public function setShowLineNumbers($value)
{
$this->setViewState('ShowLineNumbers', TPropertyValue::ensureBoolean($value), false);
}
/**
* @return boolean true will show "Copy Code" link. Defaults to false.
*/
public function getEnableCopyCode()
{
return $this->getViewState('CopyCode', false);
}
/**
* @param boolean true to show the "Copy Code" link.
*/
public function setEnableCopyCode($value)
{
$this->setViewState('CopyCode', TPropertyValue::ensureBoolean($value), false);
}
/**
* @return TTextHighlighterLineNumberStyle style of row number, Table by default
*/
public function getLineNumberStyle()
{
return $this->getViewState('LineNumberStyle', TTextHighlighterLineNumberStyle::Table);
}
/**
* @param TTextHighlighterLineNumberStyle style of row number
*/
public function setLineNumberStyle($value)
{
$this->setViewState('LineNumberStyle', TPropertyValue::ensureEnum($value,'TTextHighlighterLineNumberStyle'));
}
/**
* @return integer tab size. Defaults to 4.
*/
public function getTabSize()
{
return $this->getViewState('TabSize', 4);
}
/**
* @param integer tab size
*/
public function setTabSize($value)
{
$this->setViewState('TabSize', TPropertyValue::ensureInteger($value));
}
/**
* Registers css style for the highlighted result.
* This method overrides parent implementation.
* @param THtmlWriter writer
*/
public function onPreRender($writer)
{
parent::onPreRender($writer);
$this->registerStyleSheet();
}
/**
* Registers the stylesheet for presentation.
*/
protected function registerStyleSheet()
{
$cs=$this->getPage()->getClientScript();
$cssFile=Prado::getPathOfNamespace('Prado\\Vendor\\TextHighlighter\\highlight','.css');
$cssKey='prado:TTextHighlighter:'.$cssFile;
if(!$cs->isStyleSheetFileRegistered($cssKey))
$cs->registerStyleSheetFile($cssKey, $this->publishFilePath($cssFile));
}
/**
* Processes a text string.
* This method is required by the parent class.
* @param string text string to be processed
* @return string the processed text result
*/
public function processText($text)
{
try
{
$highlighter=\Prado\Vendor\TextHighlighter\Text\Highlighter::factory($this->getLanguage());
}
catch(\Exception $e)
{
$highlighter=false;
}
if($highlighter===false)
return ('<pre>'.htmlentities(trim($text)).'</pre>');
$options["use_language"]=true;
$options["tabsize"] = $this->getTabSize();
if ($this->getShowLineNumbers())
$options["numbers"] = self::$_lineNumberStyle[$this->getLineNumberStyle()];
$highlighter->setRenderer(new Text_Highlighter_Renderer_Html($options));
return $highlighter->highlight(trim($text));
}
/**
* @return string header template with "Copy code" link.
*/
protected function getHeaderTemplate()
{
$id = $this->getClientID();
return TJavaScript::renderScriptBlock("new Prado.WebUI.TTextHighlighter('{$id}');");
}
public function render($writer)
{
$this->getPage()->getClientScript()->registerPradoScript('prado');
parent::render($writer);
}
}
|
