CTextHighlighter

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

containerOptions свойство

public array $containerOptions;

атрибуты HTML, которые нужно применить к контейнерному элементу. Подчеркнутое содержимое находится в элементе DIV.

cssFile свойство

public mixed $cssFile;

файл CSS, используемый для виджета. По умолчанию равен null, что означает использование файла CSS по умолчанию, включенного вместе с виджетом. Если false, файл CSS не будет использоваться. В противном случае указанный файл CSS будет включён при использовании этого виджета.

language свойство

public string $language;

язык, синтаксис которого должен использоваться для подсветки. Допустимые значения — имена файлов (без расширения), содержащиеся в 'vendors/TextHighlighter/Text/Highlighter'. В настоящее время поддерживаются следующие языки: ABAP, CPP, CSS, DIFF, DTD, HTML, JAVA, JAVASCRIPT, MYSQL, PERL, PHP, PYTHON, RUBY, SQL, XML. Если язык не поддерживается, он будет отображаться как обычный текст. Имена языков нечувствительны к регистру.

lineNumberStyle свойство

public string $lineNumberStyle;

стиль отображения номеров строк. Может быть 'list' или 'table'. По умолчанию 'list'.

showLineNumbers свойство

public boolean $showLineNumbers;

отображать ли номера строк в результатах подсветки. По умолчанию false.

tabSize свойство

public integer $tabSize;

размер табуляции. По умолчанию 4.

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

highlight() метод

public string highlight(string $content)

public function highlight($content)
{
    $this->registerClientScript();

    $options['use_language']=true;
    $options['tabsize']=$this->tabSize;
    if($this->showLineNumbers)
        $options['numbers']=($this->lineNumberStyle==='list')?HL_NUMBERS_LI:HL_NUMBERS_TABLE;

    $highlighter=empty($this->language)?false:Text_Highlighter::factory($this->language);
    if($highlighter===false)
        $o='<pre>'.CHtml::encode($content).'</pre>';
    else
    {
        $highlighter->setRenderer(new Text_Highlighter_Renderer_Html($options));
        $o=preg_replace('/<span\s+[^>]*>(\s*)<\/span>/','\1',$highlighter->highlight($content));
    }

    return CHtml::tag('div',$this->containerOptions,$o);
}

Подсвечивает содержимое по синтаксису указанного языка.

processOutput() метод

public void processOutput(string $output)

public function processOutput($output)
{
    $output=$this->highlight($output);
    parent::processOutput($output);
}

Обрабатывает полученный вывод. Этот метод подсвечивает вывод в соответствии с синтаксисом указанного языка.

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)
{
    if($url===null)
        $url=CHtml::asset(Yii::getPathOfAlias('system.vendors.TextHighlighter.highlight').'.css');
    Yii::app()->getClientScript()->registerCssFile($url);
}

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