CTextHighlighter

Property Details

containerOptions property

public array $containerOptions;

the HTML attributes to be applied to the container element. The highlighted content is contained in a DIV element.

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.

language property

public string $language;

the language whose syntax is to be used for highlighting. Valid values are those file names (without suffix) that are contained in 'vendors/TextHighlighter/Text/Highlighter'. Currently, the following languages are supported: ABAP, CPP, CSS, DIFF, DTD, HTML, JAVA, JAVASCRIPT, MYSQL, PERL, PHP, PYTHON, RUBY, SQL, XML If a language is not supported, it will be displayed as plain text. Language names are case-insensitive.

lineNumberStyle property

public string $lineNumberStyle;

the style of line number display. It can be either 'list' or 'table'. Defaults to 'list'.

showLineNumbers property

public boolean $showLineNumbers;

whether to show line numbers in the highlighted result. Defaults to false.

tabSize property

public integer $tabSize;

tab size. Defaults to 4.

Method Details

highlight() method

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

Highlights the content by the syntax of the specified language.

processOutput() method

public void processOutput(string $output)

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

Processes the captured output. This method highlights the output according to the syntax of the specified language.

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

Registers the needed CSS file.