Download the PHP package 3f/pygmentize without Composer
On this page you can find all versions of the php package 3f/pygmentize. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download 3f/pygmentize
More information about 3f/pygmentize
Files in 3f/pygmentize
Package pygmentize
Short Description Pygmentize is a wrapper to `pygmentize`, the command line interface provided by Pygments, a python syntax highlighter.
License Apache-2.0
Homepage https://github.com/dedalozzo/pygmentize
Informations about the package pygmentize
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.
Composer Installation
To install Pygmentize, you first need to install Composer, a Package Manager for PHP, following those few steps:
You can run this command to easily access composer from anywhere on your system:
Pygmentize Installation
Once you have installed Composer, it's easy install Pygmentize.
-
Edit your
composer.json
file, adding Pygmentize to the require section: - Run the following command in your project root dir:
Usage
Pygmentize is really easy to use, having only one static method. You just call highlight()
like follows:
Methods
Pygmentize::highlight()
Formats the provided source code using the specified formatter and style.
Parameters
-
source
The source code.
-
language
The programming language name of the source code.
-
encoding
The file input and output encodings.
-
formatter
The output will be created using the provided formatter.
-
style
The style used by the formatter.
Returns
Returns the highlighted source code.
Exceptions
-
RuntimeException
Cannot execute the
pygmentize
command. -
RuntimeException
Cannot create the temporary file with the source code.
Documentation
The documentation can be generated using Doxygen. A Doxyfile
is provided for your convenience.
Requirements
- PHP 5.4.0 or above.
- Pygments 1.6 or above.
Authors
Filippo F. Fadda - http://www.linkedin.com/in/filippofadda
License
Pygmentize is licensed under the Apache License, Version 2.0 - see the LICENSE file for details.