| 包 | system.web.widgets |
|---|---|
| 继承 | class CTextHighlighter » COutputProcessor » CFilterWidget » CWidget » CBaseController » CComponent |
| 实现 | IFilter |
| 源自 | 1.0 |
| 版本 | $Id: CTextHighlighter.php 3515 2011-12-28 12:29:24Z mDOMba $ |
| 源码 |
CTextHighlighter 使自己主体中的内容格式高亮。
通过language属性指定应用哪一种语言的格式。 CTextHighlighter目前支持下列语言格式： ABAP, CPP, CSS, DIFF, DTD, HTML, JAVA, JAVASCRIPT, MYSQL, PERL, PHP, Python, Ruby, SQL, XML。通过设置showLineNumbers 为true，高亮处理过的结果可以与行号一起显示。
通过language属性指定应用哪一种语言的格式。 CTextHighlighter目前支持下列语言格式： ABAP, CPP, CSS, DIFF, DTD, HTML, JAVA, JAVASCRIPT, MYSQL, PERL, PHP, Python, Ruby, SQL, XML。通过设置showLineNumbers 为true，高亮处理过的结果可以与行号一起显示。
公共属性
| 属性 | 类型 | 描述 | 定义在 |
|---|---|---|---|
| actionPrefix | string | actions的ID的前缀。 当微件在CController::actions中声明了 动作提供者，可以为其动作的ID指定前缀以区别 于别的微件或控制器。当微件用于控制器 的视图中时，必须配置同样的前缀。 | CWidget |
| containerOptions | array | 需要应用到HTML容器元素中的HTML属性。 高亮处理过的内容被包含在一个DIV元素中。 | CTextHighlighter |
| controller | CController | 返回此微件所属的控制器。 | CWidget |
| cssFile | mixed | 此微件使用的CSS文件。默认值是null，表示 使用包含在此微件中的默认CSS文件。 如果设置为false，则不使用CSS文件。其他情况下，指定的 CSS文件被包含到此微件中。 | CTextHighlighter |
| id | string | 返回此微件的ID。如果需要的话，将生产一个新的ID并将其返回。 | CWidget |
| isFilter | boolean | 这个widget是否作为一个过滤器使用。 | CFilterWidget |
| language | string | 使用哪一种语言的格式进行高亮处理。 有效的值是包含在“vendors/TextHighlighter/Text/Highlighter” 之中的文件的文件名（不包括扩展名）。目前，下列 语言是被支持的： ABAP, CPP, CSS, DIFF, DTD, HTML, JAVA, JAVASCRIPT, MYSQL, PERL, PHP, PYTHON, RUBY, SQL, XML 如果一个语言尚未被支持，它将被作为简单的普通文本显示。 语言的名字是大小写敏感的。 | CTextHighlighter |
| lineNumberStyle | string | 行号显示的风格。可以是“list”或“table”。默认值是“list”。 | CTextHighlighter |
| owner | CBaseController | 返回此微件的所有者或创建者。 | CWidget |
| showLineNumbers | boolean | 是否在高亮处理的结果中显示行号。默认值是false。 | CTextHighlighter |
| skin | mixed | 微件使用的皮肤的名称。默认为“default”。 如果此属性设置为false，微件将不会有皮肤被使用。 | CWidget |
| stopAction | boolean | 当这个widget用作一个过滤器时是否停止动作的执行。 此属性应当仅在CWidget::init方法中进行改变。 默认值是false，表示动作将会被执行。 | CFilterWidget |
| tabSize | integer | 制表符的宽度。默认值是4。 | CTextHighlighter |
| viewPath | string | 返回包含此微件所需的视图文件的路径。 | CWidget |
公共方法
| 方法 | 描述 | 定义在 |
|---|---|---|
| __call() | 如果类中没有调的方法名，则调用这个方法。 | CComponent |
| __construct() | 构造器。 | CFilterWidget |
| __get() | 返回一个属性值、一个事件处理程序列表或一个行为名称。 | CComponent |
| __isset() | 检查一个属性是否为null。 | CComponent |
| __set() | 设置一个组件的属性值。 | CComponent |
| __unset() | 设置一个组件的属性为null。 | CComponent |
| actions() | 返回此widget使用的动作的列表。 | CWidget |
| asa() | 返回这个名字的行为对象。 | CComponent |
| attachBehavior() | 附加一个行为到组件。 | CComponent |
| attachBehaviors() | 附加一个行为列表到组件。 | CComponent |
| attachEventHandler() | 为事件附加一个事件处理程序。 | CComponent |
| beginCache() | Begins fragment caching. | CBaseController |
| beginClip() | Begins recording a clip. | CBaseController |
| beginContent() | Begins the rendering of content that is to be decorated by the specified view. | CBaseController |
| beginWidget() | Creates a widget and executes it. | CBaseController |
| canGetProperty() | 确定属性是否可读。 | CComponent |
| canSetProperty() | 确定属性是否可写。 | CComponent |
| createWidget() | Creates a widget and initializes it. | CBaseController |
| detachBehavior() | 从组件中分离一个行为。 | CComponent |
| detachBehaviors() | 从组件中分离所有行为。 | CComponent |
| detachEventHandler() | 分离一个存在的事件处理程序。 | CComponent |
| disableBehavior() | 禁用一个附加行为。 | CComponent |
| disableBehaviors() | 禁用组件附加的所有行为。 | CComponent |
| enableBehavior() | 启用一个附加行为。 | CComponent |
| enableBehaviors() | 启用组件附加的所有行为。 | CComponent |
| endCache() | Ends fragment caching. | CBaseController |
| endClip() | Ends recording a clip. | CBaseController |
| endContent() | Ends the rendering of content. | CBaseController |
| endWidget() | Ends the execution of the named widget. | CBaseController |
| evaLuateExpression() | 计算一个PHP表达式，或根据组件上下文执行回调。 | CComponent |
| filter() | 执行过滤。 | CFilterWidget |
| getController() | 返回此微件所属的控制器。 | CWidget |
| getEventHandlers() | 返回一个事件的附加处理程序列表。 | CComponent |
| getId() | 返回此微件的ID。如果需要的话，将生产一个新的ID并将其返回。 | CWidget |
| getIsFilter() | 检查这个widget是否作为一个过滤器使用。 | CFilterWidget |
| getOwner() | 返回此微件的所有者或创建者。 | CWidget |
| getViewFile() | 根据视图名查找视图文件。 | CWidget |
| getViewPath() | 返回包含此微件所需的视图文件的路径。 | CWidget |
| hasEvent() | 确定一个事件是否定义。 | CComponent |
| hasEventHandler() | 检查事件是否有附加的处理程序。 | CComponent |
| hasProperty() | 确定属性是否被定义。 | CComponent |
| highlight() | 根据指定的语言的格式进行高亮处理。 | CTextHighlighter |
| init() | 初始化此小物件。 | COutputProcessor |
| onProcessOutput() | 当获取到输出时激发。 | COutputProcessor |
| processOutput() | 处理获取的输出。 | CTextHighlighter |
| raiseEvent() | 发起一个事件。 | CComponent |
| registerClientScript() | 注册必须的CSS和JavaScript。 | CTextHighlighter |
| registerCssFile() | 注册必须的CSS文件。 | CTextHighlighter |
| render() | 渲染一个视图。 | CWidget |
| renderFile() | Renders a view file. | CBaseController |
| renderInternal() | Renders a view file. | CBaseController |
| run() | 运行此小物件。 | COutputProcessor |
| setId() | 设置此微件的ID。 | CWidget |
| widget() | Creates a widget and executes it. | CBaseController |
事件
| 事件 | 描述 | 定义在 |
|---|---|---|
| onProcessOutput | 当获取到输出时激发。 | COutputProcessor |
属性详细
containerOptions
属性
public array $containerOptions;
需要应用到HTML容器元素中的HTML属性。 高亮处理过的内容被包含在一个DIV元素中。
cssFile
属性
public mixed $cssFile;
此微件使用的CSS文件。默认值是null，表示 使用包含在此微件中的默认CSS文件。 如果设置为false，则不使用CSS文件。其他情况下，指定的 CSS文件被包含到此微件中。
language
属性
public string $language;
使用哪一种语言的格式进行高亮处理。 有效的值是包含在“vendors/TextHighlighter/Text/Highlighter” 之中的文件的文件名（不包括扩展名）。目前，下列 语言是被支持的： ABAP, CPP, CSS, DIFF, DTD, HTML, JAVA, JAVASCRIPT, MYSQL, PERL, PHP, PYTHON, RUBY, SQL, XML 如果一个语言尚未被支持，它将被作为简单的普通文本显示。 语言的名字是大小写敏感的。
lineNumberStyle
属性
public string $lineNumberStyle;
行号显示的风格。可以是“list”或“table”。默认值是“list”。
参见
- showLineNumbers
showLineNumbers
属性
public boolean $showLineNumbers;
是否在高亮处理的结果中显示行号。默认值是false。
参见
- lineNumberStyle
tabSize
属性
public integer $tabSize;
制表符的宽度。默认值是4。
方法详细
highlight()
方法
|
public string highlight(string $content)
| ||
| $content | string | 需要进行高亮处理的内容 |
| {return} | string | 经过高亮处理的内容 |
public function highlight($content)
{
$this->registerClientScript();
$options['use_language']=true;
$options['tabsize']=$this->tabSize;
if($this->showLineNumbers)
$options['numbers']=($this->lineNumberStyle==='list')?HL_NUMBERS_LI:HL_NUMBERS_TABLE;
$highlighter=empty($this->language)?false:Text_Highlighter::factory($this->language);
if($highlighter===false)
$o='<pre>'.CHtml::encode($content).'</pre>';
else
{
$highlighter->setRenderer(new Text_Highlighter_Renderer_Html($options));
$o=preg_replace('/<span\s+[^>]*>(\s*)<\/span>/','\1',$highlighter->highlight($content));
}
return CHtml::tag('div',$this->containerOptions,$o);
}
根据指定的语言的格式进行高亮处理。
processOutput()
方法
|
public void processOutput(string $output)
| ||
| $output | string | 需要处理的获取的输出 |
public function processOutput($output)
{
$output=$this->highlight($output);
parent::processOutput($output);
}
处理获取的输出。 此方法根据language指定的语言的格式进行高亮处理
registerClientScript()
方法
|
public void registerClientScript()
|
public function registerClientScript()
{
if($this->cssFile!==false)
self::registerCssFile($this->cssFile);
}
注册必须的CSS和JavaScript。
registerCssFile()
方法
|
public static void registerCssFile(string $url=NULL)
| ||
| $url | string | CSS文件的URL。如果设置为null，将使用默认的CSS文件的URL。 |
public static function registerCssFile($url=null)
{
if($url===null)
$url=CHtml::asset(Yii::getPathOfAlias('system.vendors.TextHighlighter.highlight').'.css');
Yii::app()->getClientScript()->registerCssFile($url);
}
注册必须的CSS文件。