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

fix(doc): example nitpicks in README (#30)

Browse source
This commit is contained in:
Victor Westerlund 2024-01-11 04:14:22 +01:00 • committed by GitHub
parent 4779b8b824
commit 111bd5c822
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
README.md
View file

@ -4,12 +4,12 @@ This library provides abstraction methods for common operations on MySQL-like da
For example: For example:
```php ```php
$db->for(string $table) MySQL->for(string $table)
->with(array $model) ->with(array $model)
->where(array $filters) ->where(array $filters)
->order(array $order_by) ->order(array $order_by)
->limit(int|array $limit) ->limit(int|array $limit)
->select(array $columns): array|bool; ->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
@ -67,7 +67,7 @@ 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. Pass an associative array of strings, CSV string, or null to this method to filter columns.
```php ```php
$db->select( MySQL->select(
array|string|null $columns array|string|null $columns
): mysqli_result|bool; ): mysqli_result|bool;
``` ```
@ -76,8 +76,7 @@ In most cases you probably want to select with a constraint. Chain the [`where()
### Example ### Example
```php ```php
$beverages = $db->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
$beverages = $db->for("beverages")->select("beverage_name, beverage_size"); // SELECT beverage_name, beverage_size FROM beverages
``` ```
``` ```
[ [
@ -102,7 +101,7 @@ This will return the key value pairs of the first entry directly.
> This method will not set `LIMIT 1` for you. It is recommended to chain `MySQL->limit(1)` anywhere before `MySQL->select()`. [You can read more about it here](https://github.com/VictorWesterlund/php-libmysqldriver/issues/14) > This method will not set `LIMIT 1` for you. It is recommended to chain `MySQL->limit(1)` anywhere before `MySQL->select()`. [You can read more about it here](https://github.com/VictorWesterlund/php-libmysqldriver/issues/14)
```php ```php
$coffee = $db->for("beverages")->limit(1)->flatten()->select(["beverage_name", "beverage_size"]); // SELECT beverage_name, beverage_size FROM beverages WHERE beverage_type = "coffee" LIMIT 1 $coffee = MySQL->for("beverages")->limit(1)->flatten()->select(["beverage_name", "beverage_size"]); // SELECT beverage_name, beverage_size FROM beverages WHERE beverage_type = "coffee" LIMIT 1
``` ```
```php ```php
[ [
@ -116,7 +115,7 @@ $coffee = $db->for("beverages")->limit(1)->flatten()->select(["beverage_name", "
Use `MySQL->insert()` to append a new row to a database table Use `MySQL->insert()` to append a new row to a database table
```php ```php
$db->insert( MySQL->insert(
// Array of values to INSERT // Array of values to INSERT
array $values array $values
): mysqli_result|bool ): mysqli_result|bool
@ -126,7 +125,7 @@ $db->insert(
#### Example #### Example
```php ```php
$db->for("beverages")->insert([ MySQL->for("beverages")->insert([
null, null,
"coffee", "coffee",
"latte", "latte",
@ -143,7 +142,7 @@ true
Modify existing rows with `MySQL->update()` Modify existing rows with `MySQL->update()`
```php ```php
$db->get( MySQL->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; ): mysqli_result|bool;
@ -152,7 +151,7 @@ $db->get(
### Example ### Example
```php ```php
$db->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 ```php
true true
@ -167,7 +166,7 @@ Filter a `select()` or `update()` method by chaining the `MySQL->where()` method
### Example ### Example
```php ```php
$coffee = $db->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 ```php
[ [
@ -227,7 +226,7 @@ WHERE (beverage_type = 'coffee' AND beverage_size = 15) OR (beverage_type = 'tea
Chain the `order()` method before a `select()` statement to order by a specific column Chain the `order()` method before a `select()` statement to order by a specific column
```php ```php
$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 $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 ```php
[ [
@ -254,7 +253,7 @@ Chain the `limit()` method before a `select()` statement to limit the amount of
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 = $db->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 ```php
[ [
@ -269,7 +268,7 @@ $coffee = $db->for("beverages")->limit(1)->select(["beverage_name", "beverage_si
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` 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 = $db->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 ```php
[ [