README

This repository is a query builder — a tool that allows you to create database queries programmatically using methods and functions instead of writing raw SQL. This makes the code more readable, secure, flexible, and easier to maintain, almost like assembling building blocks to construct statements such as SELECT, WHERE, and ORDER BY in an intuitive way.

The development of this component has been a major learning experience. I'm improving my programming logic, adopting better practices, and gaining a deeper understanding of software architecture, testing, and security.

This project is not an ORM and does not manage entities or persistence.

Installation

Requirements

PHP 8.0+
Composer
PostgreSQL
Dotenv library (vlucas/phpdotenv)

1. Via Composer

composer require soophiiaaa/query-builder

2. Environment configuration

Copy the example env file and fill in your values:

cp .env.example .env

Edit .env and set database credentials, etc:

DB_HOST=localhost
DB_PORT=5432
DB_USER=root
DB_PASSWORD=your_password
DB_NAME=your_database

How to Use

Here’s a simple example showing how to build a SQL query using this Query Builder:

The get() method returns the generated SQL string. It does NOT execute the query.

Select

$query = new QueryBuilder();

$sql = $query->select(['id', 'name'])
    ->from('students')
    ->where('age', '>', 18)
    ->limit(10)
    ->get();

echo $sql . "\n";

Insert

$query = new QueryBuilder();

$sql = $query->insert()
    ->into('students')
    ->values(['name' => 'John Doe', 'age' => 20, 'country' => 'Brazil'])
    ->get();

echo $sql . "\n";

Update

$query = new QueryBuilder();

$sql = $query->update('students')
    ->set('course', 'Systems Development')
    ->where('id', '=', '2')
    ->get();

echo $sql . "\n";

Delete

$query = new QueryBuilder();

$sql = $query->delete()
    ->from('students')
    ->where('active', '=', false)
    ->get();

echo $sql . "\n";

Advanced Filtering (AND / OR)

By default, all conditions added with the where method are combined using the AND operator.

$query = new QueryBuilder();

$sql = $query->select()
      ->from('students')
      ->where('age', '>', 18)
      ->where('active', '=', true);

To use the OR operator, you must pass the logical argument to the where method. The use of Named Arguments (a feature of PHP 8) is recommended for better readability and clarity.

$query = new QueryBuilder();

$sql = $query->select('id')
      ->from('users')
      ->where('age', '>', 18)
      ->where(
          variable: 'name',
          operator: 'LIKE',
          value: 'A%',
          logical: 'OR' // <--- Defines the logical operator for this condition
      )
      ->get();

Important: Query Execution

This Query Builder does NOT execute SQL queries.

Its sole responsibility is to build SQL strings in a safe, readable, and structured way using a fluent interface.

The actual execution of the query is always handled externally, typically by a PDO connection.

Example:

$query = new QueryBuilder();
$pdo = Connection::connect();

$sql = $query->select('id')
      ->from('users')
      ->where('age', '>', 18)
      ->where('name', 'LIKE', 'A%', 'OR')
      ->get();

$result = $pdo->query($sql);

Credits

It was truly a challenge to begin building this query builder, as I didn’t even know where to start. I found an excellent book that helped me a lot and became my guide throughout the entire process:

“PHP Programando com Orientação a Objetos” by Pablo Dall'Oglio

The only note is that I read the 2nd Edition, which was written for PHP 5. Even so, it was interesting to adapt the code to a more modern version of the language.

soophiiaaa / query-builder

Maintainers

Package info

Statistics

Security