3f/pygmentize

Pygmentize is a wrapper to `pygmentize`, the command line interface provided by Pygments, a python syntax highlighter.

, _(*1)

Pygmentize

Pygmentize is a wrapper to pygmentize, the command line interface provided by Pygments, a Python syntax highlighter. Pygmentize is smart enough to raise an exception in case Pygments returns an error., _(*2)

Composer Installation

To install Pygmentize, you first need to install Composer, a Package Manager for PHP, following those few steps:, _(*3)

curl -s https://getcomposer.org/installer | php

You can run this command to easily access composer from anywhere on your system:, _(*4)

sudo mv composer.phar /usr/local/bin/composer

Pygmentize Installation

Once you have installed Composer, it's easy install Pygmentize., _(*5)

1. Edit your composer.json file, adding Pygmentize to the require section:

{
    "require": {
        "3f/pygmentize": "dev-master"
    },
}

1. Run the following command in your project root dir:

composer update

Usage

Pygmentize is really easy to use, having only one static method. You just call highlight() like follows:, _(*6)

Pygmentize::highlight($code, $language);

Methods

Pygmentize::highlight()

public static function highlight(
    $source,
    $language,
    $encoding = "utf-8",
    $formatter = "html",
    $style = "borland"
)

Formats the provided source code using the specified formatter and style., _(*7)

Parameters, _(*8)

• source, _(*9)

  The source code., _(*10)

• language, _(*11)

  The programming language name of the source code., _(*12)

• encoding, _(*13)

  The file input and output encodings., _(*14)

• formatter, _(*15)

  The output will be created using the provided formatter., _(*16)

• style, _(*17)

  The style used by the formatter., _(*18)

Returns, _(*19)

Returns the highlighted source code., _(*20)

Exceptions, _(*21)

• RuntimeException, _(*22)

  Cannot execute the pygmentize command., _(*23)

• RuntimeException, _(*24)

  Cannot create the temporary file with the source code., _(*25)

Documentation

The documentation can be generated using Doxygen. A Doxyfile is provided for your convenience., _(*26)

Requirements

• PHP 5.4.0 or above.
• Pygments 1.6 or above.

Authors

Filippo F. Fadda - filippo.fadda@programmazione.it - http://www.linkedin.com/in/filippofadda, _(*27)

License

Pygmentize is licensed under the Apache License, Version 2.0 - see the LICENSE file for details., _(*28)