| 包 | 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格式的信息：
- markdown格式的官方网站
- markdown扩展格式
- 语法高亮的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 |
公共方法
| 方法 | 描述 | 定义在 |
|---|---|---|
| __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 |
| getMarkdownParser() | 返回markdown解析器实例。 | CMarkdown |
| getOwner() | 返回此微件的所有者或创建者。 | CWidget |
| getViewFile() | 根据视图名查找视图文件。 | CWidget |
| getViewPath() | 返回包含此微件所需的视图文件的路径。 | CWidget |
| hasEvent() | 确定一个事件是否定义。 | CComponent |
| hasEventHandler() | 检查事件是否有附加的处理程序。 | CComponent |
| hasProperty() | 确定属性是否被定义。 | CComponent |
| init() | 初始化此小物件。 | COutputProcessor |
| onProcessOutput() | 当获取到输出时激发。 | COutputProcessor |
| processOutput() | 处理获取的输出。 | CMarkdown |
| raiseEvent() | 发起一个事件。 | CComponent |
| registerClientScript() | 注册必须的CSS和JavaScript。 | CMarkdown |
| registerCssFile() | 注册必须的CSS文件。 | CMarkdown |
| render() | 渲染一个视图。 | CWidget |
| renderFile() | Renders a view file. | CBaseController |
| renderInternal() | Renders a view file. | CBaseController |
| run() | 运行此小物件。 | COutputProcessor |
| setId() | 设置此微件的ID。 | CWidget |
| transform() | 将markdown格式的内容转换为HTML代码。 | CMarkdown |
| widget() | Creates a widget and executes it. | CBaseController |
受保护方法
| 方法 | 描述 | 定义在 |
|---|---|---|
| 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来进行转换。