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

feat: add flatten() method (#13)

Browse source 
* feat: add flatten() method

* feat(doc): add flatten() to README
This commit is contained in:
Victor Westerlund 2023-11-02 10:36:01 +01:00 • committed by GitHub
parent 8ff61b7275
commit 5b78cc2ba2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 32 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
README.md
View file

@ -90,6 +90,24 @@ $beverages = $db->for("beverages")->select(["beverage_name", "beverage_size"]);
] ]
``` ```
## Flatten array to single dimension
If you don't want an array of arrays and would instead like to access each key value pair directly. Chain the `MySQL->flatten()` anywhere before `MySQL->select()`.
This will return the key value pairs of the first entry directly.
> **Note**
> 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
$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
```
```php
[
"beverage_name" => "cappuccino",
"beverage_size" => 10
]
```
# INSERT # INSERT
Use `MySQL->insert()` to append a new row to a database table Use `MySQL->insert()` to append a new row to a database table
@ -227,7 +245,7 @@ $coffee = $db->for("beverages")->order(["beverage_name" => "ASC"])->select(["bev
Chain the `limit()` method before a `select()` statement to limit the amount of columns returned Chain the `limit()` method before a `select()` statement to limit the amount of columns returned
> **Note** > **Note**
> Passing (int) `1` will flatten the returned array from a `select()` statement to two dimensions (k => v) > You can also flatten to a single dimensional array from the first entity by chaining [`MySQL->flatten()`](#flatten-array-to-single-dimension)
## Passing an integer to LIMIT ## 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
@ -237,8 +255,10 @@ $coffee = $db->for("beverages")->limit(1)->select(["beverage_name", "beverage_si
``` ```
```php ```php
[ [
"beverage_name" => "cappuccino", [
"beverage_size" => 10 "beverage_name" => "cappuccino",
"beverage_size" => 10
]
] ]
``` ```

11
src/MySQL.php
View file

@ -14,6 +14,7 @@
private string $table; private string $table;
private ?array $model = null; private ?array $model = null;
private bool $flatten = false;
private ?string $order_by = null; private ?string $order_by = null;
private ?string $filter_sql = null; private ?string $filter_sql = null;
private array $filter_values = []; private array $filter_values = [];
@ -115,6 +116,12 @@
return $this; return $this;
} }
// Flatten returned array to first entity if set
public function flatten(bool $flag = true): self {
$this->flatten = $flag;
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): self { public function order(array $order_by): self {
// Create CSV from columns // Create CSV from columns
@ -159,8 +166,8 @@
// Return array of matched rows // Return array of matched rows
$exec = $this->exec($sql, $this->filter_values); $exec = $this->exec($sql, $this->filter_values);
// Flatten array if LIMIT is 1 // Return array if exec was successful. Return as flattened array if flag is set
return empty($exec) || $this->limit !== 1 ? $exec : $exec[0]; return empty($exec) || !$this->flatten ? $exec : $exec[0];
} }
// Create Prepared Statement for UPDATE using PRIMARY KEY as anchor // Create Prepared Statement for UPDATE using PRIMARY KEY as anchor