CMarkdown

Подробное описание свойств

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()

protected function createMarkdownParser()
{
    return new CMarkdownParser;
}

Создаёт парсер разметки Markdown. По умолчанию этот метод создаёт экземпляр CMarkdownParser.

getMarkdownParser() метод

public CMarkdownParser getMarkdownParser()

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

Возвращает экземпляр парсера Markdown. Этот метод вызывает createMarkdownParser для создания экземпляра парсера. Вызов этого метода несколько раз вернёт только один и тот же экземпляр.

processOutput() метод

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);
}

Обрабатывает полученный результат. Этот метод преобразует содержимое в формате Markdown в HTML-код. Если purifyOutput имеет значение true, HTML-код также будет очищен.

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)

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

Регистрирует необходимый CSS-файл.

transform() метод

public string transform(string $output)

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

Преобразует содержимое в формате Markdown в HTML-код. Этот метод использует CMarkdownParser для преобразования.