Class AlphaHighlightProviderGeshi

Wraps Geshi in the standard API defined in AlphaHighlightProviderInterface, for use in the Alpha CMS module. Note that Geshi is not included in Alpha, so you will need to download it from here:

http://qbnz.com/highlighter/

Once downloaded, place in the [application]/lib/geshi directory which is where this class will attempt to load it from.

AlphaHighlightProviderGeshi implements AlphaHighlightProviderInterface

Package: alpha::util::codehighlight
Copyright: Copyright (c) 2012, John Collins (founder of Alpha Framework). All rights reserved.

Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the
following conditions are met:

* Redistributions of source code must retain the above
  copyright notice, this list of conditions and the
  following disclaimer.
* Redistributions in binary form must reproduce the above
  copyright notice, this list of conditions and the
  following disclaimer in the documentation and/or other
  materials provided with the distribution.
* Neither the name of the Alpha Framework nor the names
  of its contributors may be used to endorse or promote
  products derived from this software without specific
  prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

License: The BSD License
Author: John Collins <dev@alphaframework.org>
Version: $Id: AlphaHighlightProviderGeshi.inc 1496 2012-02-12 20:32:21Z alphadev $
Since: 1.2
Located at util/codehighlight/AlphaHighlightProviderGeshi.inc

Methods summary
`public string`	# `highlight( string $source, string $language )` (non-PHPdoc) (non-PHPdoc) Parameters `$source` `string` $source The source code string. `$language` `string` $language The language identifier that will be passed as-is to the implementing class. Returns `string` The colour-highlighted code. Since 1.2 See alpha/util/codehighlight/AlphaHighlightProviderInterface::highlight() Implementation of `AlphaHighlightProviderInterface::highlight()`

Packages

Classes

Interfaces

Class AlphaHighlightProviderGeshi

Parameters

Returns

Since

See

Implementation of