vlw/php-mysql
1
0
Fork 0
mirror of https://codeberg.org/vlw/php-mysql.git synced 2025-09-14 16:43:42 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Compare commits

base: vlw:master
Branches Tags
vlw:master
vlw:3.5.11
vlw:3.5.10
vlw:3.5.9
vlw:3.5.8
vlw:3.5.7
vlw:3.5.6
vlw:3.5.5
vlw:3.5.4
vlw:3.5.3
vlw:3.5.2
vlw:3.5.1
vlw:3.5.0
vlw:3.4.0
vlw:3.3.0
vlw:3.2.1
vlw:3.2.0
vlw:3.1.7
vlw:3.1.6
vlw:3.1.5
vlw:3.1.4
vlw:3.1.3
vlw:3.1.2
vlw:3.1.1
vlw:3.1.0
vlw:3.0.1
vlw:3.0.0
vlw:2.1.0
vlw:2.0.1
vlw:2.0.0
vlw:1.1.1
vlw:1.1.0
vlw:1.0.2
vlw:1.0.1
vlw:1.0.0
..
compare: vlw:3.0.1
Branches Tags
vlw:master
vlw:3.5.11
vlw:3.5.10
vlw:3.5.9
vlw:3.5.8
vlw:3.5.7
vlw:3.5.6
vlw:3.5.5
vlw:3.5.4
vlw:3.5.3
vlw:3.5.2
vlw:3.5.1
vlw:3.5.0
vlw:3.4.0
vlw:3.3.0
vlw:3.2.1
vlw:3.2.0
vlw:3.1.7
vlw:3.1.6
vlw:3.1.5
vlw:3.1.4
vlw:3.1.3
vlw:3.1.2
vlw:3.1.1
vlw:3.1.0
vlw:3.0.1
vlw:3.0.0
vlw:2.1.0
vlw:2.0.1
vlw:2.0.0
vlw:1.1.1
vlw:1.1.0
vlw:1.0.2
vlw:1.0.1
vlw:1.0.0

No commits in common. "master" and "3.0.1" have entirely different histories.
master ... 3.0.1

6 changed files with 257 additions and 369 deletions
Show stats Expand all files Collapse all files

182
README.md
View file

@ -1,36 +1,33 @@
# php-mysql # php-libmysqldriver
This is a simple abstraction library for MySQL DML operations. This library provides abstraction methods for common operations on MySQL-like databases like `SELECT`, `UPDATE`, and `INSERT` using method chaining for the various MySQL features.
For example: For example:
```php ```php
MySQL->from(string $table) $db->for(string $table)
->where(?array ...$conditions) ->with(array $model)
->order(?array $order_by) ->where(array $filters)
->limit(?int $limit = null, ?int $offset = null) ->order(array $order_by)
->select(string|array|null $columns = null): mysqli_result|bool; ->limit(1)
->select(array $columns): array|bool;
``` ```
which would be equivalent to the following in MySQL: which would be equivalent to the following in MySQL:
```sql ```sql
SELECT `columns` FROM `table` WHERE `filter` ORDER BY `order_by` LIMIT `limit`; SELECT $columns FROM $table WHERE $filter ORDER BY $order_by LIMIT $limit;
``` ```
- All methods can be chained in any order (even multiple times) after a [`from()`](#from) as long as a [`select()`](#select), [`insert()`](#insert), [`update()`](#update), or [`delete()`](#delete) is the last method. This library is built on top of the PHP [`MySQL Improved`](https://www.php.net/manual/en/book.mysqli.php) extension.
- Chaining the same method more than once will override its previous value. Passing `null` to any method that accepts it will unset its value completely.
## Install from composer ## Install from composer
``` ```
composer require vlw/mysql composer require victorwesterlund/libmysqldriver
``` ```
```php ```php
use vlw\MySQL\MySQL; use libmysqldriver/MySQL;
``` ```
> [!IMPORTANT]
> This library requires the [`MySQL Improved`](https://www.php.net/manual/en/book.mysqli.php) extension and PHP 8.0 or newer.
# Example / Documentation # Example / Documentation
Available statements Available statements
@ -39,12 +36,11 @@ Statement|Method
`SELECT`|[`select()`](#select) `SELECT`|[`select()`](#select)
`UPDATE`|[`update()`](#update) `UPDATE`|[`update()`](#update)
`INSERT`|[`insert()`](#insert) `INSERT`|[`insert()`](#insert)
`DELETE`|[`delete()`](#delete)
`WHERE`|[`where()`](#where) `WHERE`|[`where()`](#where)
`ORDER BY`|[`order()`](#order-by) `ORDER BY`|[`order()`](#order-by)
`LIMIT`|[`limit()`](#limit) `LIMIT`|[`limit()`](#limit)
---- ---
`Example table name: beverages` `Example table name: beverages`
id|beverage_type|beverage_name|beverage_size id|beverage_type|beverage_name|beverage_size
@ -55,46 +51,30 @@ id|beverage_type|beverage_name|beverage_size
3|tea|black|15 3|tea|black|15
```php ```php
use vlw\MySQL\MySQL; use libmysqldriver\MySQL;
// Pass through: https://www.php.net/manual/en/mysqli.construct.php // Pass through: https://www.php.net/manual/en/mysqli.construct.php
$db = new MySQL($host, $user, $pass, $db); $db = new MySQL($host, $user, $pass, $db);
``` ```
All executor methods [`select()`](#select), [`update()`](#update), and [`insert()`](#insert) will return a [`mysqli_result`](https://www.php.net/manual/en/class.mysqli-result.php) object or boolean.
# FROM
```php
MySQL->from(
string $table
): self;
```
All queries start by chaining the `from(string $table)` method. This will define which database table the current query should be executed on.
*Example:*
```php
MySQL->from("beverages")->select("beverage_type");
```
# SELECT # SELECT
Chain `MySQL->select()` anywhere after a [`MySQL->from()`](#from) to retrieve columns from a database table. Use `MySQL->select()` to retrieve columns from a database table
Pass an associative array of strings, CSV string, or null to this method to filter columns.
```php ```php
MySQL->select( $db->select(
string|array|null $columns // Sequential array of string with column names to retrieve
): mysqli_result|bool; // Or null to retrieve a bool if rows were matched
?array $columns
): array|bool;
// Returns array of arrays for each row, or bool if no columns were defined
``` ```
In most cases you probably want to select with a constraint. Chain the [`where()`](#where) method before `select()` to filter the query In most cases you probably want to select with a constraint. Chain the [`where()`](#where) method before `select()` to filter the query
### Example ### Example
```php ```php
$`beverages` = MySQL->from("beverages")->select(["beverage_name", "beverage_size"]); // SELECT `beverage_name`, `beverage_size` FROM beverages $beverages = $db->for("beverages")->select(["beverage_name", "beverage_size"]); // SELECT beverage_name, beverage_size FROM beverages
``` ```
``` ```
[ [
@ -112,12 +92,10 @@ $`beverages` = MySQL->from("beverages")->select(["beverage_name", "beverage_size
# INSERT # INSERT
Chain `MySQL->insert()` anywhere after a [`MySQL->from()`](#from) to append a new row to a database table. Use `MySQL->insert()` to append a new row to a database table
Passing a sequential array to `insert()` will assume that you wish to insert data for all defined columns in the table. Pass an associative array of `[column_name => value]` to INSERT data for specific columns (assuming the other columns have a [DEFAULT](https://dev.mysql.com/doc/refman/8.0/en/data-type-defaults.html) value defined).
```php ```php
MySQL->insert( $db->insert(
// Array of values to INSERT // Array of values to INSERT
array $values array $values
): bool ): bool
@ -127,38 +105,13 @@ MySQL->insert(
#### Example #### Example
```php ```php
MySQL->from("beverages")->insert([ $db->for("beverages")->insert([
null, null,
"coffee", "coffee",
"latte", "latte",
10 10
]); ]);
// INSERT INTO `beverages` VALUES (null, "coffee", "latte", 10); // INSERT INTO beverages VALUES (null, "coffee", "latte", 10);
```
```
true
```
# DELETE
Chain `MySQL->delete()` anywhere after a [`MySQL->from()`](#from) to remove a row or rows from the a database table.
```php
MySQL->delete(
array ...$conditions
): bool
// Returns true if at least one row was deleted
```
This method takes at least one [`MySQL->where()`](#where)-syntaxed argument to determine which row or rows to delete. Refer to the [`MySQL->where()`](#where) section for more information.
#### Example
```php
MySQL->from("beverages")->delete([
"beverage_name" => "coffee",
]);
// DELETE FROM `beverages` WHERE `beverage_name` = "coffee";
``` ```
``` ```
true true
@ -166,42 +119,34 @@ true
# UPDATE # UPDATE
Chain `MySQL->update()` anywhere after a [`MySQL->from()`](#from) to modify existing rows in a database table. Modify existing rows with `MySQL->update()`
```php ```php
MySQL->update( $db->get(
// Key, value array of column names and values to update // Key, value array of column names and values to update
array $fields, array $fields,
): mysqli_result|bool; ): bool;
// Returns true if at least 1 row was changed // Returns true if at least 1 row was changed
``` ```
### Example ### Example
```php ```php
MySQL->from("beverages")->update(["beverage_size" => 10]); // UPDATE `beverages` SET `beverage_size` = 10 $db->for("beverages")->update(["beverage_size" => 10]); // UPDATE beverages SET beverage_size = 10
``` ```
```php ```php
true true
``` ```
In most cases you probably want to UPDATE against a constaint. Chain a [`where()`](#where) method before [`MySQL->update()`](#update) to set constraints In most cases you probably want to UPDATE against a constaint. Chain a [`where()`](#where) method before `update()` to set constraints
# WHERE # WHERE
Filter a [`MySQL->select()`](#select) or [`MySQL->update()`](#update) method by chaining the `MySQL->where()` method anywhere before it. The [`MySQL->delete()`](#delete) executor method also uses the same syntax for its arguments. Filter a `select()` or `update()` method by chaining the `MySQL->where()` method anywhere before it.
Each key, value pair will be `AND` constrained against each other.
```php
MySQL->where(
?array ...$conditions
): self;
```
### Example ### Example
```php ```php
$coffee = MySQL->from("beverages")->where(["beverage_type" => "coffee"])->select(["beverage_name", "beverage_size"]); // SELECT `beverage_name`, `beverage_size` FROM `beverages` WHERE (`beverage_type` = "coffee"); $coffee = $db->for("beverages")->where(["beverage_type" => "coffee"])->select(["beverage_name", "beverage_size"]); // SELECT beverage_name, beverage_size FROM beverages WHERE (beverage_type = "coffee");
``` ```
```php ```php
[ [
@ -216,7 +161,9 @@ $coffee = MySQL->from("beverages")->where(["beverage_type" => "coffee"])->select
] ]
``` ```
## Capture groups ## Advanced filtering
You can do more detailed filtering by passing more constraints into the same array, or even futher by passing multiple arrays each with filters.
### AND ### AND
@ -229,7 +176,7 @@ MySQL->where([
]); ]);
``` ```
```sql ```sql
WHERE (`beverage_type` = 'coffee' AND `beverage_size` = 15) WHERE (beverage_type = 'coffee' AND beverage_size = 15)
``` ```
### OR ### OR
@ -250,41 +197,16 @@ $filter2 = [
MySQL->where($filter1, $filter2, ...); MySQL->where($filter1, $filter2, ...);
``` ```
```sql ```sql
WHERE (`beverage_type` = 'coffee' AND `beverage_size` = 15) OR (`beverage_type` = 'tea' AND `beverage_name` = 'black') WHERE (beverage_type = 'coffee' AND beverage_size = 15) OR (beverage_type = 'tea' AND beverage_name = 'black')
``` ```
## Define custom operators
By default, all values in an the assoc array passed to `where()` will be treated as an `EQUALS` (=) operator.
```php
MySQL->where(["column" => "euqals_this_value"]);
```
Setting the value of any key to another assoc array will allow for more "advanced" filtering by defining your own [`Operators`](https://github.com/VictorWesterlund/php-libmysqldriver/blob/master/src/Operators.php).
The key of this subarray can be any MySQL operator string, or the **->value** of any case in the [`Operators`](https://github.com/VictorWesterlund/php-libmysqldriver/blob/master/src/Operators.php) enum.
```php
MySQL->where([
"beverage_name" => [
Operators::LIKE->value => "%wildcard_contains%"
]
]);
```
# ORDER BY # ORDER BY
Chain the `MySQL->order()` method before a [`MySQL->select()`](#select) statement to order by a specific column Chain the `order()` method before a `select()` statement to order by a specific column
```php ```php
MySQL->order( $coffee = $db->for("beverages")->order(["beverage_name" => "ASC"])->select(["beverage_name", "beverage_size"]); // SELECT beverage_name, beverage_size FROM beverages ORDER BY beverage_name ASC
?array $order_by
): self;
```
```php
$coffee = MySQL->from("beverages")->order(["beverage_name" => "ASC"])->select(["beverage_name", "beverage_size"]); // SELECT `beverage_name`, `beverage_size` FROM `beverages` ORDER BY `beverage_name` ASC
``` ```
```php ```php
[ [
@ -296,41 +218,35 @@ $coffee = MySQL->from("beverages")->order(["beverage_name" => "ASC"])->select(["
"beverage_name" => "tea", "beverage_name" => "tea",
"beverage_size" => 15 "beverage_size" => 15
], ],
// ...etc for "`beverage_name` = coffee" // ...etc for "beverage_name = coffee"
] ]
``` ```
# LIMIT # LIMIT
Chain the `limit()` method before a [`MySQL->select()`](#select) statement to limit the amount of columns returned Chain the `limit()` method before a `select()` statement to limit the amount of columns returned
```php > **Note**
MySQL->limit( > Passing (int) `1` will flatten the returned array from a `select()` statement to two dimensions (k => v)
?int $limit,
?int $offset = null
): self;
```
## Passing a single integer argument ## Passing an integer to LIMIT
This will simply `LIMIT` the results returned to the integer passed This will simply `LIMIT` the results returned to the integer passed
```php ```php
$coffee = MySQL->from("beverages")->limit(1)->select(["beverage_name", "beverage_size"]); // SELECT `beverage_name`, `beverage_size` FROM `beverages` WHERE `beverage_type` = "coffee" LIMIT 1 $coffee = $db->for("beverages")->limit(1)->select(["beverage_name", "beverage_size"]); // SELECT beverage_name, beverage_size FROM beverages WHERE beverage_type = "coffee" LIMIT 1
``` ```
```php ```php
[ [
[
"beverage_name" => "cappuccino", "beverage_name" => "cappuccino",
"beverage_size" => 10 "beverage_size" => 10
]
] ]
``` ```
## Passing two integer arguments ## Passing an associative array to LIMIT
This will `OFFSET` and `LIMIT` the results returned. The first argument will be the `LIMIT` and the second argument will be its `OFFSET`. This will `OFFSET` and `LIMIT` the results returned from the first key of the array as `OFFSET` and the value of that key as `LIMIT`
```php ```php
$coffee = MySQL->from("beverages")->limit(3, 2)->select(["beverage_name", "beverage_size"]); // SELECT `beverage_name`, `beverage_size` FROM `beverages` LIMIT 3 OFFSET 2 $coffee = $db->for("beverages")->limit([3 => 2])->select(["beverage_name", "beverage_size"]); // SELECT beverage_name, beverage_size FROM beverages LIMIT 3 OFFSET 2
``` ```
```php ```php
[ [

10
composer.json
View file

@ -1,18 +1,18 @@
{ {
"name": "vlw/mysql", "name": "victorwesterlund/libmysqldriver",
"description": "Abstraction library for common MySQL/MariaDB DML operations with php-mysqli", "description": "Abstraction library for common mysqli features",
"type": "library", "type": "library",
"license": "GPL-3.0-or-later", "license": "GPL-3.0-only",
"authors": [ "authors": [
{ {
"name": "Victor Westerlund", "name": "Victor Westerlund",
"email": "victor@vlw.se" "email": "victor.vesterlund@gmail.com"
} }
], ],
"minimum-stability": "dev", "minimum-stability": "dev",
"autoload": { "autoload": {
"psr-4": { "psr-4": {
"vlw\\MySQL\\": "src/" "libmysqldriver\\": "src/"
} }
}, },
"require": {} "require": {}

98
src/DatabaseDriver.php Normal file
View file

@ -0,0 +1,98 @@
<?php
namespace libmysqldriver\Driver;
use \mysqli;
use \mysqli_stmt;
use \mysqli_result;
// MySQL query builder and executer abstractions
class DatabaseDriver extends mysqli {
// Passing arguments to https://www.php.net/manual/en/mysqli.construct.php
function __construct() {
parent::__construct(...func_get_args());
}
// Bind SQL statements
private function bind_params(mysqli_stmt &$stmt, mixed $params): bool {
// Convert single value parameter to array
$params = is_array($params) ? $params : [$params];
if (empty($params)) {
return true;
}
// Concatenated string with types for each parameter
$types = "";
// Convert PHP primitves to SQL primitives
foreach ($params as $param) {
switch (gettype($param)) {
case "integer":
case "double":
case "boolean":
$types .= "i";
break;
case "string":
case "array":
case "object":
$types .= "s";
break;
default:
$types .= "b";
break;
}
}
return $stmt->bind_param($types, ...$params);
}
// Execute an SQL query with a prepared statement
private function run_query(string $sql, mixed $params = null): mysqli_result|bool {
$stmt = $this->prepare($sql);
// Bind parameters if provided
if ($params !== null) {
$this->bind_params($stmt, $params);
}
// Execute statement and get retrieve changes
$query = $stmt->execute();
$res = $stmt->get_result();
// Return true if an INSERT, UPDATE or DELETE was sucessful (no rows returned)
if (!empty($query) && empty($res)) {
return true;
}
// Return mysqli_result object
return $res;
}
/* ---- */
// Execute SQL query with optional prepared statement and return array of affected rows
public function exec(string $sql, mixed $params = null): array {
$query = $this->run_query($sql, $params);
$res = [];
// Fetch rows into sequential array
while ($row = $query->fetch_assoc()) {
$res[] = $row;
}
return $res;
}
// Execute SQL query with optional prepared statement and return true if query was successful
public function exec_bool(string $sql, mixed $params = null): bool {
$query = $this->run_query($sql, $params);
return gettype($query) === "boolean"
// Type is already a bool, so return it as is
? $query
// Return true if rows were matched
: $query->num_rows > 0;
}
}

266
src/MySQL.php
View file

@ -1,100 +1,71 @@
<?php <?php
namespace vlw\MySQL; namespace libmysqldriver;
use Exception; use \Exception;
use \victorwesterlund\xEnum;
use mysqli; use libmysqldriver\Driver\DatabaseDriver;
use mysqli_stmt;
use mysqli_result;
use vlw\MySQL\Order; require_once "DatabaseDriver.php";
use vlw\MySQL\Operators;
require_once "Order.php";
require_once "Operators.php";
// Interface for MySQL_Driver with abstractions for data manipulation // Interface for MySQL_Driver with abstractions for data manipulation
class MySQL extends mysqli { class MySQL extends DatabaseDriver {
public ?array $columns = null; private string $table;
private ?array $model = null;
protected string $table; private ?string $order_by = null;
protected ?string $limit = null; private ?string $filter_sql = null;
protected ?string $order_by = null; private array $filter_values = [];
protected array $filter_columns = []; private int|string|null $limit = null;
protected array $filter_values = [];
protected ?string $filter_sql = null;
// Pass constructor arguments to driver // Pass constructor arguments to driver
function __construct() { function __construct(string $table) {
parent::__construct(...func_get_args()); parent::__construct(...func_get_args());
} }
/*
# Helper methods
*/
private function throw_if_no_table() { private function throw_if_no_table() {
if (!isset($this->table)) { if (!$this->table) {
throw new Exception("No table name defined"); throw new Exception("No table name defined");
} }
} }
// Coerce input to single dimensional array // Return value(s) that exist in $this->model
private static function to_list_array(mixed $input): array { private function in_model(string|array $columns): ?array {
return array_values(is_array($input) ? $input : [$input]); // Place string into array
$columns = is_array($columns) ? $columns : [$columns];
// Return columns that exist in table model
return array_filter($columns, fn($col): string => in_array($col, $this->model));
} }
// Convert value to MySQL tinyint /* ---- */
private static function filter_boolean(mixed $value): int {
return (int) filter_var($value, FILTER_VALIDATE_BOOLEAN);
}
// Convert all boolean type values to tinyints in array
private static function filter_booleans(array $values): array {
return array_map(fn(mixed $v): mixed => gettype($v) === "boolean" ? self::filter_boolean($v) : $v, $values);
}
private static function array_wrap_accents(array $input): array {
return array_map(fn(mixed $v): string => "`{$v}`", $input);
}
/*
# Definers
These methods are used to build an SQL query by chaining methods together.
Defined parameters will then be executed by an Executer method.
*/
// Use the following table name // Use the following table name
public function from(string $table): self { public function for(string $table): self {
// Reset all definers when a new query begins
$this->where();
$this->limit();
$this->order();
$this->table = $table; $this->table = $table;
return $this; return $this;
} }
#[\Deprecated( // Restrict query to array of column names
message: "use MySQL->from() instead", public function with(array $model): self {
since: "3.5.7", // Reset table model
)] $this->model = [];
public function for(string $table): self {
return $this->from($table); foreach ($model as $k => $v) {
// Column values must be strings
if (!is_string($v)) {
throw new Exception("Key {$k} must have a value of type string");
} }
// Create a WHERE statement from filters // Append column to model
public function where(?array ...$conditions): self { $this->model[] = $v;
// Unset filters if null was passed }
if ($conditions === null) {
$this->filter_sql = null;
$this->filter_columns = null;
$this->filter_values = null;
return $this; return $this;
} }
// Create a WHERE statement from filters
public function where(?array ...$conditions): self {
$values = []; $values = [];
$filters = []; $filters = [];
@ -102,51 +73,22 @@
foreach ($conditions as $condition) { foreach ($conditions as $condition) {
$filter = []; $filter = [];
// Move along if the condition is empty
if (empty($condition)) {
continue;
}
// Create SQL string and append values to array for prepared statement // Create SQL string and append values to array for prepared statement
foreach ($condition as $col => $operation) { foreach ($condition as $col => $value) {
$this->filter_columns[] = $col; if ($this->model && !$this->in_model($col)) {
// Assume we want an equals comparison if value is not an array
if (!is_array($operation)) {
$operation = [Operators::EQUALS->value => $operation];
}
// Resolve all operator enum values in inner array
foreach ($operation as $operator => $value) {
// Null values have special syntax
if (is_null($value)) {
// Treat anything that isn't an equals operator as falsy
if ($operator !== Operators::EQUALS->value) {
$filter[] = "`{$col}` IS NOT NULL";
continue;
}
$filter[] = "`{$col}` IS NULL";
continue; continue;
} }
// Create SQL for prepared statement // Create SQL for prepared statement
$filter[] = "`{$col}` {$operator} ?"; $filter[] = "`{$col}` = ?";
// Append value to array with all other values // Append value to array with all other values
$values[] = $value; $values[] = $value;
} }
}
// AND together all conditions into a group // AND together all conditions into a group
$filters[] = "(" . implode(" AND ", $filter) . ")"; $filters[] = "(" . implode(" AND ", $filter) . ")";
} }
// Do nothing if no filters were set
if (empty($filters)) {
return $this;
}
// OR all filter groups // OR all filter groups
$this->filter_sql = implode(" OR ", $filters); $this->filter_sql = implode(" OR ", $filters);
// Set values property // Set values property
@ -155,53 +97,48 @@
return $this; return $this;
} }
// SQL LIMIT string // Return SQL LIMIT string from integer or array of [offset => limit]
public function limit(?int $limit = null, ?int $offset = null): self { public function limit(int|array $limit): self {
// Unset row limit if null was passed // Set LIMIT without range directly as integer
if ($limit === null) { if (is_int($limit)) {
$this->limit = null; $this->limit = $limit;
return $this; return $this;
} }
// Coerce offset to zero if no offset is defined // Use array key as LIMIT range start value
$offset = $offset ?? 0; $offset = (int) array_keys($limit)[0];
// Use array value as LIMIT range end value
$limit = (int) array_values($limit)[0];
// Set limit and offset as SQL CSV // Set limit as SQL CSV
$this->limit = "{$offset},{$limit}"; $this->limit = "{$offset},{$limit}";
return $this; return $this;
} }
// Return SQL SORT BY string from assoc array of columns and direction // Return SQL SORT BY string from assoc array of columns and direction
public function order(?array $order_by = null): self { public function order(array $order_by): self {
// Unset row order by if null was passed // Create CSV from columns
if ($order_by === null) { $sql = implode(",", array_keys($order_by));
$this->order_by = null; // Create pipe DSV from values
$sql .= " " . implode("|", array_values($order_by));
$this->order_by = $sql;
return $this; return $this;
} }
// Assign Order Enum entries from array of arrays<Order|string> /* ---- */
$orders = array_map(fn(Order|string $order): Order => $order instanceof Order ? $order : Order::tryFrom($order), array_values($order_by));
// Create CSV string with Prepared Statement abbreviations from length of fields array.
$sql = array_map(fn(string $column, Order|string $order): string => "`{$column}` " . $order->value, array_keys($order_by), $orders);
$this->order_by = implode(",", $sql);
return $this;
}
/*
# Executors
These methods execute various statements that each return a mysqli_result
*/
// Create Prepared Statament for SELECT with optional WHERE filters // Create Prepared Statament for SELECT with optional WHERE filters
public function select(array|string|null $columns = null): mysqli_result|bool { public function select(?array $columns = null): array|bool {
$this->throw_if_no_table(); $this->throw_if_no_table();
// Create array of columns from CSV // Filter columns that aren't in the model if defiend
$this->columns = is_array($columns) || is_null($columns) ? $columns : explode(",", $columns); if ($columns && $this->model) {
$columns = $this->in_model($columns);
}
// Create CSV from columns or default to SQL NULL as a string // Create CSV from columns or default to SQL NULL as a string
$columns_sql = $this->columns ? implode(",", self::array_wrap_accents($this->columns)) : "NULL"; $columns_sql = $columns ? implode(",", $columns) : "NULL";
// Create LIMIT statement if argument is defined // Create LIMIT statement if argument is defined
$limit_sql = !is_null($this->limit) ? " LIMIT {$this->limit}" : ""; $limit_sql = !is_null($this->limit) ? " LIMIT {$this->limit}" : "";
@ -213,74 +150,65 @@
$filter_sql = !is_null($this->filter_sql) ? " WHERE {$this->filter_sql}" : ""; $filter_sql = !is_null($this->filter_sql) ? " WHERE {$this->filter_sql}" : "";
// Interpolate components into an SQL SELECT statmenet and execute // Interpolate components into an SQL SELECT statmenet and execute
$sql = "SELECT {$columns_sql} FROM `{$this->table}`{$filter_sql}{$order_by_sql}{$limit_sql}"; $sql = "SELECT {$columns_sql} FROM {$this->table}{$filter_sql}{$order_by_sql}{$limit_sql}";
// Return mysqli_response of matched rows
return $this->execute_query($sql, self::to_list_array($this->filter_values)); // No columns were specified, return true if query matched rows
if (!$columns) {
return $this->exec_bool($sql, $this->filter_values);
}
// Return array of matched rows
$exec = $this->exec($sql, $this->filter_values);
// Flatten array if LIMIT is 1
return empty($exec) || $this->limit !== 1 ? $exec : $exec[0];
} }
// Create Prepared Statement for UPDATE using PRIMARY KEY as anchor // Create Prepared Statement for UPDATE using PRIMARY KEY as anchor
public function update(array $entity): mysqli_result|bool { public function update(array $entity): bool {
$this->throw_if_no_table(); $this->throw_if_no_table();
// Make constraint for table model if defined
if ($this->model) {
foreach (array_keys($entity) as $col) {
// Throw if column in entity does not exist in defiend table model
if (!in_array($col, $this->model)) {
throw new Exception("Column key '{$col}' does not exist in table model");
}
}
}
// Create CSV string with Prepared Statement abbreviations from length of fields array. // Create CSV string with Prepared Statement abbreviations from length of fields array.
$changes = array_map(fn($column) => "`{$column}` = ?", array_keys($entity)); $changes = array_map(fn($column) => "{$column} = ?", array_keys($entity));
$changes = implode(",", $changes); $changes = implode(",", $changes);
// Get array of SQL WHERE string and filter values // Get array of SQL WHERE string and filter values
$filter_sql = !is_null($this->filter_sql) ? " WHERE {$this->filter_sql}" : ""; $filter_sql = !is_null($this->filter_sql) ? " WHERE {$this->filter_sql}" : "";
// Get values from entity and convert booleans to tinyint $values = array_values($entity);
$values = self::filter_booleans(array_values($entity)); // Append filter values if defined
// Append values to filter property if where() was chained
if ($this->filter_values) { if ($this->filter_values) {
array_push($values, ...$this->filter_values); array_push($values, ...$this->filter_values);
} }
// Interpolate components into an SQL UPDATE statement and execute // Interpolate components into an SQL UPDATE statement and execute
$sql = "UPDATE `{$this->table}` SET {$changes} {$filter_sql}"; $sql = "UPDATE {$this->table} SET {$changes} {$filter_sql}";
return $this->execute_query($sql, self::to_list_array($values)); return $this->exec_bool($sql, $values);
} }
// Create Prepared Statemt for INSERT // Create Prepared Statemt for INSERT
public function insert(array $values): mysqli_result|bool { public function insert(array $values): bool {
$this->throw_if_no_table(); $this->throw_if_no_table();
/* // A value for each column in table model must be provided
Use array keys from $values as columns to insert if array is associative. if ($this->model && count($values) !== count($this->model)) {
Treat statement as an all-columns INSERT if the $values array is sequential. throw new Exception("Values length does not match columns in model");
*/ }
$columns = !array_is_list($values) ? "(" . implode(",", array_keys($values)) . ")" : "";
// Convert booleans to tinyint
$values = self::filter_booleans($values);
// Create CSV string with Prepared Statement abbreviatons from length of fields array. // Create CSV string with Prepared Statement abbreviatons from length of fields array.
$values_stmt = implode(",", array_fill(0, count($values), "?")); $values_stmt = implode(",", array_fill(0, count($values), "?"));
// Interpolate components into an SQL INSERT statement and execute // Interpolate components into an SQL INSERT statement and execute
$sql = "INSERT INTO `{$this->table}` {$columns} VALUES ({$values_stmt})"; $sql = "INSERT INTO {$this->table} VALUES ({$values_stmt})";
return $this->execute_query($sql, self::to_list_array($values)); return $this->exec_bool($sql, $values);
}
// Create Prepared Statemente for DELETE with WHERE condition(s)
public function delete(array ...$conditions): mysqli_result|bool {
$this->throw_if_no_table();
// Set DELETE WHERE conditions from arguments
if ($conditions) {
$this->where(...$conditions);
}
// Get array of SQL WHERE string and filter values
$filter_sql = !is_null($this->filter_sql) ? " WHERE {$this->filter_sql}" : "";
$sql = "DELETE FROM `{$this->table}`{$filter_sql}";
return $this->execute_query($sql, self::to_list_array($this->filter_values));
}
// Execute SQL query with optional prepared statement and return mysqli_result
public function exec(string $sql, mixed $params = null): mysqli_result {
return $this->execute_query($sql, self::to_list_array($params));
} }
} }

46
src/Operators.php
View file

@ -1,46 +0,0 @@
<?php
namespace vlw\MySQL;
enum Operators: string {
// Logical
case ALL = "ALL";
case AND = "AND";
case ANY = "ANY";
case BETWEEN = "BETWEEN";
case EXISTS = "EXISTS";
case IN = "IN";
case LIKE = "LIKE";
case NOT = "NOT";
case OR = "OR";
case SOME = "SOME";
// Comparison
case EQUALS = "=";
case GT = ">";
case LT = "<";
case GTE = ">=";
case LTE = "<=";
case NOTE = "<>";
// Arithmetic
case ADD = "+";
case SUBTRACT = "-";
case MULTIPLY = "*";
case DIVIDE = "/";
case MODULO = "%";
// Bitwise
case BS_AND = "&";
case BS_OR = "|";
case BS_XOR = "^";
// Compound
case ADDE = "+=";
case SUBE = "-=";
case DIVE = "/=";
case MODE = "%=";
case BS_ANDE = "&=";
case BS_ORE = "|*=";
case BS_XORE = "^-=";
}

8
src/Order.php
View file

@ -1,8 +0,0 @@
<?php
namespace vlw\MySQL;
enum Order: string {
case ASC = "ASC";
case DESC = "DESC";
}