Download the PHP package jdorn/sql-formatter without Composer

On this page you can find all versions of the php package jdorn/sql-formatter. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of jdorn/sql-formatter

Informations about the package sql-formatter

SqlFormatter

A lightweight php class for formatting sql statements.

It can automatically indent and add line breaks in addition to syntax highlighting.

History

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

Usage

The SqlFormatter class has a static method 'format' which takes a SQL string
as input and returns a formatted HTML block inside a pre tag.

Sample usage:

Output:

Formatting Only

If you don't want syntax highlighting and only want the indentations and line breaks, pass in false 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:

Remove Comments

If you want to keep all original whitespace formatting and just remove comments, you can use the removeComments method instead of compress.

Output:

Split SQL String into Queries

Another feature, which is unrelated to formatting, is the ability to break up a SQL string into multiple queries.

For Example:

Result:

  1. DROP TABLE IF EXISTS MyTable;
  2. CREATE TABLE MyTable ( id int );
  3. INSERT INTO MyTable (id) VALUES (1),(2),(3),(4);
  4. SELECT * FROM MyTable;

Why Not Regular Expressions?

Why not just use explode(';', $sql) or a regular expression?

The following example sql and others like it are impossible to split correctly using regular expressions, no matter how complex.

SqlFormatter breaks the string into tokens instead of using regular expressions and will correctly produce:

  1. SELECT ";";
  2. SELECT ";\"; a;";
  3. SELECT "; abc";
  4. SELECT a,b #comment; FROM test;

Please note, the splitQuery method will still fail in the following cases:

All versions of sql-formatter with dependencies

PHP Build Version
Package Version
Requires php Version >=5.2.4
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package jdorn/sql-formatter contains the following files

Loading the files please wait ....