Download the PHP package jpi/query without Composer

Query

A simple and lightweight SQL query builder library to make querying a database easier. It works as a middleman between your application and the database.

This has been kept very simple stupid (KISS), with minimal validation (PHP type errors only) to reduce complexity in the library and maximize performance for consumer developers. Therefore, please make sure to add your own validation if using user inputs in these queries.

Features

• Fluent, chainable query builder with simple, expressive syntax
• Support for SELECT, INSERT, UPDATE, and DELETE queries
• Support for columns, joins (INNER, LEFT, and RIGHT), where clauses, ordering, limiting, and paging
• Returns convenient collections for SELECT queries

Dependencies

• PHP 8.0+
• Composer
• PHP PDO
• MySQL 5+
• jpi/database v2

Installation

Use Composer

Usage

To create an instance, you will need an instance of \JPI\Database (which is an extension of PDO - you can find out more here) which is the first parameter, and the database table name as the second parameter. The same instance can be used multiple times as long as it's for the same database.

Action Methods:

These are the methods to call to end with select, count, insert, update & delete, all are pretty self-explanatory.

Builder methods

These are all fluent methods, so you can chain them together.

table

If you want to change to another table or didn't set when creating the instance.

column

To select a particular column. Call this method multiple times to select multiple columns. This method is also used to add aggregate functions. If not called, all columns will be selected.

join

By default will be a INNER join, use rightJoin or leftJoin methods instead if you want those.

where

Adds an expression to the WHERE clause. This method is very flexible and supports multiple calling patterns:

Note: By default, multiple where() calls on the builder are combined with AND logic. Also note parameters will be keyed by the column, so if you use the same column for 2 different values, it will use the last value added.

Raw expression: Pass a complete expression as the first parameter only

Column, operator, value: Pass column name, operator, and value separately (recommended for security as it uses parameterised queries)

Supported operators: =, !=, <>, <, >, <=, >=, LIKE, IN, NOT IN, BETWEEN

Note: All values (except raw SQL expressions) are automatically parameterised to prevent SQL injection.

IN/NOT IN:

Note: If there is just one value, it will automatically optimise and switch to = or <> operator.

BETWEEN operator: Pass an array with exactly 2 values for the BETWEEN operator

IS NULL / IS NOT NULL: For checking NULL values, use special two-parameter syntax

Subqueries: Pass a Builder instance as the value to use a subquery

orderBy

limit

Add a limit to the query, and optionally set the page at the same time - this sets the OFFSET.

page

Used to change the offset, only used if limit set.

Complex WHERE Conditions

For more complex WHERE clauses that require OR logic or nested conditions, you can use AndCondition and OrCondition classes.

AndCondition

AndCondition groups multiple conditions together with AND logic. Create one using $queryBuilder->newAndCondition().

OrCondition

OrCondition groups multiple conditions together with OR logic. Create one using $queryBuilder->newOrCondition().

Combining AND and OR Conditions

You can nest AndCondition and OrCondition to create complex logic:

Examples

Assuming a \JPI\Database\Query\Builder instance has been created for the users database table and set to a variable named $queryBuilder.

select

This has 4 return types depending on how you use it:

• if you've set limit of 1 this will return an instance of \JPI\Database\Query\Result\Row or null if not found. The Row class can be used as an associative array of key (column) value pairs
• if paged/limited and the withPagination param (first param) isn't false then \JPI\Database\Query\Result\PaginatedCollection
• else \JPI\Database\Query\Result\Collection

PaginatedCollection & Collection work like a normal array just with some extra methods, see https://github.com/jahidulpabelislam/utils?tab=readme-ov-file#collection for more details. Both of these contain multiple instances of Row. PaginatedCollection has meta data on the limit used, page number and total count if not limited, and the collection is immutable.

count

As the name implies this method will just return the count as an integer. By default it will do COUNT(*), but you can pass a column name or expression as the first parameter to count non-NULL values in a specific column or use expressions like DISTINCT.

For obvious reasons only the table, join & where builder methods are supported for this action.

insert

This method supports inserting one or more rows into the table.

Single Row Insert: When inserting a single row successfully, the method returns the last inserted ID, or null if it fails.

Multi-Row Insert: When inserting multiple rows, the method returns the number of rows affected.

Only the table builder method is supported for this action.

update

This method will return the count of how many rows have been updated by the query.

column, join & page builder methods aren't supported for this action.

delete

This method will return the count of how many rows have been deleted by the query.

column, join & page builder methods aren't supported for this action.

Support

If you found this library interesting or useful please spread the word about this library: share on your socials, star on GitHub, etc.

If you find any issues or have any feature requests, you can open an issue or email me @ jahidulpabelislam.com :smirk:.

Authors

• Jahidul Pabel Islam [email protected]

Licence

This module is licensed under the General Public Licence - see the licence file for details.