| 包 | system.web.widgets |
|---|---|
| 继承 | class CMarkdown » COutputProcessor » CFilterWidget » CWidget » CBaseController » CComponent |
| 实现 | IFilter |
| 源自 | 1.0 |
| 版本 | $Id: CMarkdown.php 3515 2011-12-28 12:29:24Z mdomba $ |
| 源码 |
CMarkdown 将获取的内容从markdown格式转换为HTML代码。
CMarkdown 可以作为小物件或过滤器使用。它是CMarkdownParser的一个包装。 CMarkdown 增加了一个附加选项purifyOutput，此选项设置为true可以 以使转换过的HTML代码在被显示之前首先被净化。
参见以下内容以了解更多关于markdown格式的信息：
CMarkdown 可以作为小物件或过滤器使用。它是CMarkdownParser的一个包装。 CMarkdown 增加了一个附加选项purifyOutput，此选项设置为true可以 以使转换过的HTML代码在被显示之前首先被净化。
参见以下内容以了解更多关于markdown格式的信息：
公共属性
| 属性 | 类型 | 描述 | 定义在 |
|---|---|---|---|
| actionPrefix | string | actions的ID的前缀。 当微件在CController::actions中声明了 动作提供者，可以为其动作的ID指定前缀以区别 于别的微件或控制器。当微件用于控制器 的视图中时，必须配置同样的前缀。 | CWidget |
| controller | CController | 返回此微件所属的控制器。 | CWidget |
| cssFile | mixed | 此小物件所使用的CSS文件。默认值是null，表示 使用与此小物件捆绑的默认CSS文件。 如果设置为false，将不使用CSS文件。其他情况下，指定的CSS 文件将被此小物件包含进来。 | CMarkdown |
| id | string | 返回此微件的ID。如果需要的话，将生产一个新的ID并将其返回。 | CWidget |
| isFilter | boolean | 这个widget是否作为一个过滤器使用。 | CFilterWidget |
| markdownParser | CMarkdownParser | 返回markdown解析器实例。 | CMarkdown |
| owner | CBaseController | 返回此微件的所有者或创建者。 | CWidget |
| purifyOutput | boolean | 是否使用CHtmlPurifier来净化产生的HTML代码。默认值是false。 | CMarkdown |
| skin | mixed | 微件使用的皮肤的名称。默认为“default”。 如果此属性设置为false，微件将不会有皮肤被使用。 | CWidget |
| stopAction | boolean | 当这个widget用作一个过滤器时是否停止动作的执行。 此属性应当仅在CWidget::init方法中进行改变。 默认值是false，表示动作将会被执行。 | CFilterWidget |
| viewPath | string | 返回包含此微件所需的视图文件的路径。 | CWidget |
公共方法
受保护方法
| 方法 | 描述 | 定义在 |
|---|---|---|
| createMarkdownParser() | 创建一个markdown解析器。 | CMarkdown |
事件
| 事件 | 描述 | 定义在 |
|---|---|---|
| onProcessOutput | 当获取到输出时激发。 | COutputProcessor |
属性详细
cssFile
属性
public mixed $cssFile;
此小物件所使用的CSS文件。默认值是null，表示 使用与此小物件捆绑的默认CSS文件。 如果设置为false，将不使用CSS文件。其他情况下，指定的CSS 文件将被此小物件包含进来。
markdownParser
属性
只读
public CMarkdownParser getMarkdownParser()
返回markdown解析器实例。 此方法调用createMarkdownParser来创建解析器实例。 多次调用此方法也只会返回单一的实例。
purifyOutput
属性
public boolean $purifyOutput;
是否使用CHtmlPurifier来净化产生的HTML代码。默认值是false。
方法详细
createMarkdownParser()
方法
|
protected CMarkdownParser createMarkdownParser()
| ||
| {return} | CMarkdownParser | markdown解析器 |
protected function createMarkdownParser()
{
return new CMarkdownParser;
}
创建一个markdown解析器。 默认情况下，此方法创建一个CMarkdownParser实例。
getMarkdownParser()
方法
|
public CMarkdownParser getMarkdownParser()
| ||
| {return} | CMarkdownParser | 解析器实例 |
public function getMarkdownParser()
{
if($this->_parser===null)
$this->_parser=$this->createMarkdownParser();
return $this->_parser;
}
返回markdown解析器实例。 此方法调用createMarkdownParser来创建解析器实例。 多次调用此方法也只会返回单一的实例。
processOutput()
方法
|
public void processOutput(string $output)
| ||
| $output | string | 需要处理的获取的输出。 |
public function processOutput($output)
{
$output=$this->transform($output);
if($this->purifyOutput)
{
$purifier=new CHtmlPurifier;
$output=$purifier->purify($output);
}
parent::processOutput($output);
}
处理获取的输出。 此方法将markdown格式的内容转换为HTML代码。 如果purifyOutput设置为true，转换的HTML代码将被净化。
参见
- convert
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)
{
CTextHighlighter::registerCssFile($url);
}
注册必须的CSS文件。
transform()
方法
|
public string transform(string $output)
| ||
| $output | string | 需要转换的内容 |
| {return} | string | 已转换的内容 |
public function transform($output)
{
$this->registerClientScript();
return $this->getMarkdownParser()->transform($output);
}
将markdown格式的内容转换为HTML代码。 此方法使用CMarkdownParser来进行转换。