Download the PHP package doctrine/sql-formatter without Composer
On this page you can find all versions of the php package doctrine/sql-formatter. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download doctrine/sql-formatter
More information about doctrine/sql-formatter
Files in doctrine/sql-formatter
Package sql-formatter
Short Description a PHP SQL highlighting library
License MIT
Homepage https://github.com/doctrine/sql-formatter/
Informations about the package sql-formatter
SqlFormatter
A lightweight php package for formatting sql statements.
It can automatically indent and add line breaks in addition to syntax highlighting.
History
This package is a fork from https://github.com/jdorn/sql-formatter Here is what the original History section says:
I found myself having to debug auto-generated SQL statements all the time and wanted some way to easily output formatted HTML without having to include a huge library or copy and paste into online formatters.
I was originally planning to extract the formatting code from PhpMyAdmin, but that was 10,000+ lines of code and used global variables.
I saw that other people had the same problem and used Stack Overflow user losif's answer as a starting point. http://stackoverflow.com/a/3924147
― @jdorn
Usage
The SqlFormatter
class has a method format
which takes an SQL string as
input and returns a formatted block.
Sample usage:
Output:
When you run php under cli and instantiated SqlFormatter
without argument, highlighted with CliHighlighter
.
SqlFormatter constructor takes Highlighter
implementations. HtmlHighlighter
etc.
Formatting Only
If you don't want syntax highlighting and only want the indentations and
line breaks, pass in a NullHighlighter
instance as the second parameter.
This is useful for outputting to error logs or other non-html formats.
Output:
Syntax Highlighting Only
There is a separate method highlight
that preserves all original whitespace
and just adds syntax highlighting.
This is useful for sql that is already well formatted and just needs to be a little easier to read.
Output:
Compress Query
The compress
method removes all comments and compresses whitespace.
This is useful for outputting queries that can be copy pasted to the command line easily.
Output: