diff --git a/README.md b/README.md index f4b76c5..4615ee2 100644 --- a/README.md +++ b/README.md @@ -7,16 +7,16 @@ For example: MySQL->for(string $table) ->where(?array ...$conditions) ->order(?array $order_by) - ->limit(int|array|null $limit) - ->select(array $columns): array|bool; + ->limit(?int $limit = null, ?int $offset = null) + ->select(string|array|null $columns = null): mysqli_result|bool; ``` which would be equivalent to the following in MySQL: ```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] -> This library requires the [`MySQL Improved`](https://www.php.net/manual/en/book.mysqli.php) extension and requires PHP 8.0 or newer. +- 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. +- 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 @@ -28,6 +28,9 @@ composer require vlw/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 Available statements @@ -83,7 +86,7 @@ Pass an associative array of strings, CSV string, or null to this method to filt ```php MySQL->select( - array|string|null $columns + string|array|null $columns ): mysqli_result|bool; ``` @@ -91,7 +94,7 @@ In most cases you probably want to select with a constraint. Chain the [`where() ### Example ```php -$beverages = MySQL->for("beverages")->select(["beverage_name", "beverage_size"]); // SELECT beverage_name, beverage_size FROM beverages +$`beverages` = MySQL->for("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( // Array of values to INSERT array $values -): mysqli_result|bool +): bool // Returns true if row was inserted ``` @@ -130,7 +133,7 @@ MySQL->for("beverages")->insert([ "latte", 10 ]); -// INSERT INTO beverages VALUES (null, "coffee", "latte", 10); +// INSERT INTO `beverages` VALUES (null, "coffee", "latte", 10); ``` ``` true @@ -143,7 +146,7 @@ Chain `MySQL->delete()` anywhere after a [`MySQL->for()`](#for) to remove a row ```php MySQL->delete( array ...$conditions -): mysqli_result|bool +): bool // 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 ```php -MySQL->for("beverages")->insert([ - null, - "coffee", - "latte", - 10 +MySQL->for("beverages")->delete([ + "beverage_name" => "coffee", ]); -// INSERT INTO beverages VALUES (null, "coffee", "latte", 10); +// DELETE FROM `beverages` WHERE `beverage_name` = "coffee"; ``` ``` true @@ -178,7 +178,7 @@ MySQL->update( ### Example ```php -MySQL->for("beverages")->update(["beverage_size" => 10]); // UPDATE beverages SET beverage_size = 10 +MySQL->for("beverages")->update(["beverage_size" => 10]); // UPDATE `beverages` SET `beverage_size` = 10 ``` ```php true @@ -201,7 +201,7 @@ MySQL->where( ### Example ```php -$coffee = MySQL->for("beverages")->where(["beverage_type" => "coffee"])->select(["beverage_name", "beverage_size"]); // SELECT beverage_name, beverage_size FROM beverages WHERE (beverage_type = "coffee"); +$coffee = MySQL->for("beverages")->where(["beverage_type" => "coffee"])->select(["beverage_name", "beverage_size"]); // SELECT `beverage_name`, `beverage_size` FROM `beverages` WHERE (`beverage_type` = "coffee"); ``` ```php [ @@ -229,7 +229,7 @@ MySQL->where([ ]); ``` ```sql -WHERE (beverage_type = 'coffee' AND beverage_size = 15) +WHERE (`beverage_type` = 'coffee' AND `beverage_size` = 15) ``` ### OR @@ -250,7 +250,7 @@ $filter2 = [ MySQL->where($filter1, $filter2, ...); ``` ```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 @@ -284,7 +284,7 @@ MySQL->order( ``` ```php -$coffee = MySQL->for("beverages")->order(["beverage_name" => "ASC"])->select(["beverage_name", "beverage_size"]); // SELECT beverage_name, beverage_size FROM beverages ORDER BY beverage_name ASC +$coffee = MySQL->for("beverages")->order(["beverage_name" => "ASC"])->select(["beverage_name", "beverage_size"]); // SELECT `beverage_name`, `beverage_size` FROM `beverages` ORDER BY `beverage_name` ASC ``` ```php [ @@ -296,7 +296,7 @@ $coffee = MySQL->for("beverages")->order(["beverage_name" => "ASC"])->select(["b "beverage_name" => "tea", "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 ```php -$coffee = MySQL->for("beverages")->limit(1)->select(["beverage_name", "beverage_size"]); // SELECT beverage_name, beverage_size FROM beverages WHERE beverage_type = "coffee" LIMIT 1 +$coffee = MySQL->for("beverages")->limit(1)->select(["beverage_name", "beverage_size"]); // SELECT `beverage_name`, `beverage_size` FROM `beverages` WHERE `beverage_type` = "coffee" LIMIT 1 ``` ```php [ @@ -330,7 +330,7 @@ $coffee = MySQL->for("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`. ```php -$coffee = MySQL->for("beverages")->limit(3, 2)->select(["beverage_name", "beverage_size"]); // SELECT beverage_name, beverage_size FROM beverages LIMIT 3 OFFSET 2 +$coffee = MySQL->for("beverages")->limit(3, 2)->select(["beverage_name", "beverage_size"]); // SELECT `beverage_name`, `beverage_size` FROM `beverages` LIMIT 3 OFFSET 2 ``` ```php [