Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

CakePHP plugin that provides a Helper for use with Geshi Syntax highlighter.

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 Test
Octocat-spinner-32 Vendor
Octocat-spinner-32 View
Octocat-spinner-32 .gitignore
Octocat-spinner-32 .travis.yml
Octocat-spinner-32 README.textile
Octocat-spinner-32 VERSION.txt
Octocat-spinner-32 composer.json
README.textile

Geshi Helper Plugin

This plugin provides a simple helper for adding GeSHi syntax highlighting to
your application.

Installation

Either clone the repository or download a package and place it in a Geshi
directory in one of your plugin paths. For example app/Plugin/Geshi.

Don’t forget that starting with CakePHP 2.0, you must load plugins manually
in app/Config/bootstrap.php. For example, CakePlugin::loadAll()

Include the helper in your controller

The GeSHi helper offers three different ways to set GeSHi’s features, which
affects how you will include the helper in your controller.

If you want to use a geshi.php configuration file, or you want to set the
features from within your view later, make sure to include without
pre-configuration. Otherwise if you want to include the features’ settings
in your helper declaration, include with pre-configuration, both explained
next.

Include without pre-configuration

To use the helper, include the helper in your controller:

public $helpers = array('Geshi.Geshi');

You will have to include a geshi.php configuration file or simply set the
features later from your view.

Include with pre-configuration

To use the helper and specify specific GeSHi features, use the options form
of including helpers:

public $helpers = array('Geshi.Geshi' => array('set_header_type' => array('GESHI_FANCY_LINE_NUMBERS',5)));

Where the passed-in key is a GeSHi function name, and the passed-in values
is an array of values for the function. Note that because GeSHi’s own
constants are out of scope at this point, you must quote named constants as
shown above. GeshiHelper will resolve them for you.

Methods

highlight($html)

This method will scan HTML for <pre> blocks with a known lang attribute. This
method is good for highlighting code samples in blog posts or wiki pages.

You can indicate the language of the text in a <pre> block by setting the lang
attribute. For example:

	<?php
	echo hi

Will be highlighted as php code.

highlightText($text, $language)

This method will highlight $text in $language. Use this method to
highlight text in any language GeSHI supports.

highlightText($text, $language, $withStylesheet)

This is the same method as above, but if you specify true for the optional,
third parameter then the helper will include the GeSHi-generated inline style
sheet.

Configuration

As mentioned earlier there are three ways to set GeSHI’s feature options.

Configure in your controller

Above “Include with pre-configuration” details how to do this. If you pre-configure
in your controller, it’s still possible to override these initial settings by
configuring in your views.

Configure in your views

You can configure GeSHI’s features from within your views
by accessing the $features variable so: $this->Geshi->features = array(...), for example:

$this->Geshi->features = array('geshi_function_name' => array('geshi_parameter', list, values);

Note that GeSHI’s constants are in scope here, and so quoting parameter
values is optional from within views.

Setting the features in your views gives you great flexibility to use GeSHi with (for example)
multiple languages served by the same controller.

Configure via a configuration file

You can configure the GeSHi instance by creating a geshi.php file in your
app/Config directory. This file should contain the code/method calls to
configure the $geshi object. An example can be found in
Test/geshi.php

Note that the configuration file will be ignored completely if you have pre-configured
the GeSHi instance in your $helpers or have set $this->Geshi->features in your view.

License

This code is licensed under the MIT License.
GeSHI is licensed under the GPLv2 License.

Something went wrong with that request. Please try again.