mirror of
https://github.com/yiisoft/yii.git
synced 2026-03-06 08:14:21 +01:00
89 lines
2.7 KiB
PHP
89 lines
2.7 KiB
PHP
<?php
|
|
/**
|
|
* CMarkdown class file.
|
|
*
|
|
* @author Qiang Xue <qiang.xue@gmail.com>
|
|
* @link http://www.yiiframework.com/
|
|
* @copyright Copyright © 2008 Yii Software LLC
|
|
* @license http://www.yiiframework.com/license/
|
|
*/
|
|
|
|
/**
|
|
* CMarkdown converts the captured content from markdown syntax to HTML code.
|
|
*
|
|
* CMarkdown can be used as either a widget or a filter. It is a wrapper of {@link CMarkdownParser}.
|
|
* CMarkdown adds an additional option {@link purifyOutput} which can be set true
|
|
* so that the converted HTML code is purified before being displayed.
|
|
*
|
|
* For details about the markdown syntax, please check the following:
|
|
* <ul>
|
|
* <li>{@link http://daringfireball.net/projects/markdown/syntax official markdown syntax}</li>
|
|
* <li>{@link http://michelf.com/projects/php-markdown/extra/ markdown extra syntax}</li>
|
|
* <li>{@link CMarkdownParser markdown with syntax highlighting}</li>
|
|
* </ul>
|
|
*
|
|
* @author Qiang Xue <qiang.xue@gmail.com>
|
|
* @version $Id$
|
|
* @package system.web.widgets
|
|
* @since 1.0
|
|
*/
|
|
class CMarkdown extends COutputProcessor
|
|
{
|
|
/**
|
|
* @var mixed the CSS file used for the widget. Defaults to null, meaning
|
|
* using the default CSS file included together with the widget.
|
|
* If false, no CSS file will be used. Otherwise, the specified CSS file
|
|
* will be included when using this widget.
|
|
*/
|
|
public $cssFile;
|
|
/**
|
|
* @var boolean whether to use {@link CHtmlPurifier} to purify the generated HTML code. Defaults to false.
|
|
*/
|
|
public $purifyOutput=false;
|
|
|
|
/**
|
|
* Processes the captured output.
|
|
* This method converts the content in markdown syntax to HTML code.
|
|
* If {@link purifyOutput} is true, the HTML code will also be purified.
|
|
* @param string the captured output to be processed
|
|
* @see convert
|
|
*/
|
|
public function processOutput($output)
|
|
{
|
|
$output=$this->transform($output);
|
|
if($this->purifyOutput)
|
|
{
|
|
$purifier=new CHtmlPurifier;
|
|
$output=$purifier->purify($output);
|
|
}
|
|
parent::processOutput($output);
|
|
}
|
|
|
|
/**
|
|
* Converts the content in markdown syntax to HTML code.
|
|
* This method uses {@link CMarkdownParser} to do the conversion.
|
|
* @param string the content to be converted
|
|
* @return string the converted content
|
|
*/
|
|
public function transform($output)
|
|
{
|
|
$cs=Yii::app()->getClientScript();
|
|
$parser=$this->createMarkdownParser();
|
|
if($this->cssFile===null)
|
|
$cs->registerCssFile(CHtml::asset($parser->getDefaultCssFile()));
|
|
else if($this->cssFile!==false)
|
|
$cs->registerCssFile($this->cssFile);
|
|
return $parser->transform($output);
|
|
}
|
|
|
|
/**
|
|
* Creates a markdown parser.
|
|
* By default, this method creates a {@link CMarkdownParser} instance.
|
|
* @return CMarkdownParser the markdown parser.
|
|
*/
|
|
protected function createMarkdownParser()
|
|
{
|
|
return new CMarkdownParser;
|
|
}
|
|
}
|