baddum/sql418

A library for extensible SQL requests

SQL418

, _(*1)

SQL418 is a small PHP library for extensible SQL requests., _(*2)

This library allows you to modify an existing SQL statement, by overriding some parts of it., _(*3)

1. Features
2. Use cases
3. How to Install
4. How to Contribute
5. Author & Community

Features

Use the extend() method to complete a request.
An example to add a WHERE clause to a SELECT request:, _(*4)

$request = new Baddum\SQL418\Request('SELECT * from table');
echo $request->extend('WHERE id = 39');
// SELECT * FROM table WHERE id = 39;

You can override a defined part of a request.
An example to change the selected fields:, _(*5)

echo $request->extend('SELECT name');
// SELECT name FROM table WHERE id = 39;

Use the & keyword to extend a part of a request.
An example to add a field to select:, _(*6)

echo $request->extend('SELECT &, id');
// SELECT name, id FROM table WHERE id = 39;

You can change the type of a request.
An example to change a SELECT request to a DELETE one:, _(*7)

echo $request->extend('DELETE');
// DELETE FROM table WHERE id = 39;

You can also use all the features together:, _(*8)

$sql->extend('UPDATE SET name = "Albert" WHERE & AND right <> admin"');
echo $sql;
// UPDATE table SET name = "Albert" WHERE id = 39 AND right <> admin;

Use cases

Use case: DRYer requests

In the following example, the fetchById and deleteById requests share a common pattern:, _(*9)

class UserModel {
  protected $SQLFetchById = 'SELECT * from user WHERE user.id=?';
  protected $SQLDeleteById = '';
  public function __construct() {
    $request = new Request($this->SQLFetchById);
    $this->SQLDeleteById = $request->extend('DELETE');
  }
}

Use case: extensible applications

In the following example, we extend the UserModel to do a soft delete:, _(*10)

class UserModelSoftDelete extends UserModel {
  public function __construct() {
    $request = new Request($this->SQLFetchById);
    $this->SQLFetchById = $request->extend('WHERE & AND user.deleted = 0');
    $this->SQLDeleteById = $request->extend('UPDATE & SET user.deleted = 1');
  }
}

How to Install

This library package requires PHP 5.4 or later.
Install Composer and run the following command to get the latest version:, _(*11)

composer require baddum/sql418:~1.2

How to Contribute

1. Star the project!
2. Tweet and blog about SQL418 and Let me know about it.
3. Report a bug that you find
4. Pull requests are highly appreciated. Please review the guidelines for contributing to go further.

Author & Community

SQL418 is under MIT License.
It was created & is maintained by Thomas ZILLIOX., _(*12)