CMarkdown

Property Details

cssFile property

public mixed $cssFile;

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.

markdownParser property read-only

public CMarkdownParser getMarkdownParser()

Returns the markdown parser instance. This method calls createMarkdownParser to create the parser instance. Call this method multipe times will only return the same instance.

purifyOutput property

public boolean $purifyOutput;

whether to use CHtmlPurifier to purify the generated HTML code. Defaults to false.

Method Details

createMarkdownParser() method

protected CMarkdownParser createMarkdownParser()

protected function createMarkdownParser()
{
    return new CMarkdownParser;
}

Creates a markdown parser. By default, this method creates a CMarkdownParser instance.

getMarkdownParser() method

public CMarkdownParser getMarkdownParser()

public function getMarkdownParser()
{
    if($this->_parser===null)
        $this->_parser=$this->createMarkdownParser();
    return $this->_parser;
}

Returns the markdown parser instance. This method calls createMarkdownParser to create the parser instance. Call this method multipe times will only return the same instance.

processOutput() method

public void processOutput(string $output)

public function processOutput($output)
{
    $output=$this->transform($output);
    if($this->purifyOutput)
    {
        $purifier=new CHtmlPurifier;
        $output=$purifier->purify($output);
    }
    parent::processOutput($output);
}

Processes the captured output. This method converts the content in markdown syntax to HTML code. If purifyOutput is true, the HTML code will also be purified.

registerClientScript() method

public void registerClientScript()

public function registerClientScript()
{
    if($this->cssFile!==false)
        self::registerCssFile($this->cssFile);
}

Registers the needed CSS and JavaScript.

registerCssFile() method

public static void registerCssFile(string $url=NULL)

public static function registerCssFile($url=null)
{
    CTextHighlighter::registerCssFile($url);
}

Registers the needed CSS file.

transform() method

public string transform(string $output)

public function transform($output)
{
    $this->registerClientScript();
    return $this->getMarkdownParser()->transform($output);
}

Converts the content in markdown syntax to HTML code. This method uses CMarkdownParser to do the conversion.