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

Merge branch 'master' into refactor/table-from

Browse source
This commit is contained in:
Victor Westerlund 2025-06-08 11:59:11 +02:00
commit 11e0f5a9f6
Signed by: vlw
GPG key ID: D0AD730E1057DFC6
1 changed files with 24 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

48
README.md
View file

@ -7,16 +7,16 @@ For example:
MySQL->from(string $table) MySQL->from(string $table)
->where(?array ...$conditions) ->where(?array ...$conditions)
->order(?array $order_by) ->order(?array $order_by)
->limit(int|array|null $limit) ->limit(?int $limit = null, ?int $offset = null)
->select(array $columns): array|bool; ->select(string|array|null $columns = null): mysqli_result|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`;
``` ```
> [!IMPORTANT] - All methods can be chained in any order (even multiple times) after a [`for()`](#for) as long as a [`select()`](#select), [`insert()`](#insert), [`update()`](#update), or [`delete()`](#delete) is the last method.
> This library requires the [`MySQL Improved`](https://www.php.net/manual/en/book.mysqli.php) extension and requires PHP 8.0 or newer. - 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
@ -28,6 +28,9 @@ composer require vlw/mysql
use vlw\MySQL\MySQL; use vlw\MySQL\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
@ -83,7 +86,7 @@ Pass an associative array of strings, CSV string, or null to this method to filt
```php ```php
MySQL->select( MySQL->select(
array|string|null $columns string|array|null $columns
): mysqli_result|bool; ): mysqli_result|bool;
``` ```
@ -91,7 +94,7 @@ In most cases you probably want to select with a constraint. Chain the [`where()
### Example ### Example
```php ```php
$beverages = MySQL->from("beverages")->select(["beverage_name", "beverage_size"]); // SELECT beverage_name, beverage_size FROM beverages $`beverages` = MySQL->from("beverages")->select(["beverage_name", "beverage_size"]); // SELECT `beverage_name`, `beverage_size` FROM beverages
``` ```
``` ```
[ [
@ -117,7 +120,7 @@ Passing a sequential array to `insert()` will assume that you wish to insert dat
MySQL->insert( MySQL->insert(
// Array of values to INSERT // Array of values to INSERT
array $values array $values
): mysqli_result|bool ): bool
// Returns true if row was inserted // Returns true if row was inserted
``` ```
@ -130,7 +133,7 @@ MySQL->from("beverages")->insert([
"latte", "latte",
10 10
]); ]);
// INSERT INTO beverages VALUES (null, "coffee", "latte", 10); // INSERT INTO `beverages` VALUES (null, "coffee", "latte", 10);
``` ```
``` ```
true true
@ -143,7 +146,7 @@ Chain `MySQL->delete()` anywhere after a [`MySQL->from()`](#from) to remove a ro
```php ```php
MySQL->delete( MySQL->delete(
array ...$conditions array ...$conditions
): mysqli_result|bool ): bool
// Returns true if at least one row was deleted // Returns true if at least one row was deleted
``` ```
@ -152,13 +155,10 @@ This method takes at least one [`MySQL->where()`](#where)-syntaxed argument to d
#### Example #### Example
```php ```php
MySQL->from("beverages")->insert([ MySQL->from("beverages")->delete([
null, "beverage_name" => "coffee",
"coffee",
"latte",
10
]); ]);
// INSERT INTO beverages VALUES (null, "coffee", "latte", 10); // DELETE FROM `beverages` WHERE `beverage_name` = "coffee";
``` ```
``` ```
true true
@ -178,7 +178,7 @@ MySQL->update(
### Example ### Example
```php ```php
MySQL->from("beverages")->update(["beverage_size" => 10]); // UPDATE beverages SET beverage_size = 10 MySQL->from("beverages")->update(["beverage_size" => 10]); // UPDATE `beverages` SET `beverage_size` = 10
``` ```
```php ```php
true true
@ -201,7 +201,7 @@ MySQL->where(
### 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 = MySQL->from("beverages")->where(["beverage_type" => "coffee"])->select(["beverage_name", "beverage_size"]); // SELECT `beverage_name`, `beverage_size` FROM `beverages` WHERE (`beverage_type` = "coffee");
``` ```
```php ```php
[ [
@ -229,7 +229,7 @@ MySQL->where([
]); ]);
``` ```
```sql ```sql
WHERE (beverage_type = 'coffee' AND beverage_size = 15) WHERE (`beverage_type` = 'coffee' AND `beverage_size` = 15)
``` ```
### OR ### OR
@ -250,7 +250,7 @@ $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 ## Define custom operators
@ -284,7 +284,7 @@ MySQL->order(
``` ```
```php ```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 $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,7 +296,7 @@ $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"
] ]
``` ```
@ -315,7 +315,7 @@ MySQL->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 = MySQL->from("beverages")->limit(1)->select(["beverage_name", "beverage_size"]); // SELECT `beverage_name`, `beverage_size` FROM `beverages` WHERE `beverage_type` = "coffee" LIMIT 1
``` ```
```php ```php
[ [
@ -330,7 +330,7 @@ $coffee = MySQL->from("beverages")->limit(1)->select(["beverage_name", "beverage
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. The first argument will be the `LIMIT` and the second argument will be its `OFFSET`.
```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 = MySQL->from("beverages")->limit(3, 2)->select(["beverage_name", "beverage_size"]); // SELECT `beverage_name`, `beverage_size` FROM `beverages` LIMIT 3 OFFSET 2
``` ```
```php ```php
[ [