theodordiaconu/geshi-bundle

This package is abandoned and no longer maintained. No replacement package was suggested.

Symfony GeshiBundle

dev-master 2013-03-29 12:54 UTC

Requires

• theodordiaconu/geshi: dev-master

MIT

• Theodor Diaconu

• highlight
• highlighter
• geshi
• syntax highlight

README

Add in the composer

requires: {
    // ...
    "theodordiaconu/geshi-bundle" : "dev-master",
}

In the app/AppKernel.php file

$bundles = array(
    // ...
    new DT\Bundle\GeshiBundle\DTGeshiBundle(),
);

How to use

After you have plugged it in your Symfony2 Application you have several ways to use this:

Twig

{{ block_of_code|geshi_highlight('javascript') }}

{{ geshi_highlight(block_of_code, 'javascript') }}

PHP

To get the highlighter

$highlighter = $this->get('dt_geshi.highlighter');

Simple highlighting

$highlighted = $highlighter->highlight('<h1>Please highlight me!</h1>', 'html');

To create a response that highlights everything automatically for you

public function indexAction()
{
    // ...
    return $highlighter->createResponse('<h1>Hello</h1>', 'html');
    return $highlighter->createResponse('<h1>This is the line with the error</h1>', 'html', 500);
}

Also, for bad ass people I have also plugged in another method:

$response = $highlighter->createJSONResponse(array('hello' => 'there'));

If you want flexibility in configuring the output, you've got it.

$highlighted = $highlighter->highlight(
    '<h1>Please highlight me!</h1>',
    'html',
    function(\GeSHi\GeSHi $geshi){
        $geshi->set_header_type(GESHI_HEADER_NONE);
    }
);

How to set default options to GeSHi

$highlighter->setDefaultOptions(function($geshi){
    /** @var $geshi \GeSHi\GeSHi */
    $geshi->set_header_type(GESHI_HEADER_NONE);
});

// the highlighting will proceed using the settings from the Default Options
$highlighted = $highlighter->highlight('<h1>Please highlight me!</h1>', 'html');
// or
$highlighter->createResponse('<h1>Hello</h1>', 'html');