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

fix(doc): namespace README

Browse source
This commit is contained in:
Victor Westerlund 2023-11-02 14:26:15 +01:00 • committed by GitHub
parent 0db93592d5
commit 2ceaa1358b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 24 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -6,10 +6,10 @@ This library retrievies and optionally resolves foreign keys in a MySQL/MariaDB
## Install with composer ## Install with composer
``` ```
composer require victorwesterlund/libinnodb-fk composer require victorwesterlund/innodb-fk
``` ```
```php ```php
use victorwesterlund\ForeignKeys\ForeignKeys use victorwesterlund\ForeignKeys
``` ```
# Example / Documentation # Example / Documentation
@ -25,7 +25,7 @@ Remember to pass the database name where InnoDB foreign keys are stored to the 4
## Initialize `ForeignKeys` ## Initialize `ForeignKeys`
```php ```php
use victorwesterlund\ForeignKeys\ForeignKeys use victorwesterlund\ForeignKeys
$fk = new ForeignKeys($host, $user, $pass, ForeignKeys::DATABASE_NAME); $fk = new ForeignKeys($host, $user, $pass, ForeignKeys::DATABASE_NAME);
``` ```
@ -55,8 +55,14 @@ Retrieve rows from your database and pass them to `resolve_all()` as an array of
```php ```php
$rows = [ $rows = [
[
"id" => 1, "id" => 1,
"fk" => 2 "fk" => 2
],
[
"id" => 2,
"fk" => 1
]
]; ];
$rows = $fk->for("test", "bar")->resolve_all($rows); $rows = $fk->for("test", "bar")->resolve_all($rows);
@ -64,10 +70,19 @@ $rows = $fk->for("test", "bar")->resolve_all($rows);
```php ```php
// $rows will become // $rows will become
[ [
[
"id" => 1, "id" => 1,
"fk" => [ "fk" => [
"id" => 2, "id" => 2,
"value" => "hello world" "value" => "lorem ipsum dolor sit amet"
]
],
[
"id" => 2,
"fk" => [
"id" => 1,
"value" => "consectetur adipiscing elit"
]
] ]
] ]
``` ```