danog/AsyncOrm
1
0
Fork 0
mirror of https://github.com/danog/AsyncOrm.git synced 2024-11-26 12:24:59 +01:00
Code Issues Packages Projects Releases Wiki Activity

Improve documentation

Browse Source
This commit is contained in:
Daniil Gentili 2024-04-06 13:13:50 +02:00
parent 9a5641d414
commit be9b7e1039
2 changed files with 12 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@ -26,7 +26,11 @@ There are two main ways to use the ORM: through automatic ORM properties, which
* [Automatic ORM properties example »](https://github.com/danog/AsyncOrm/blob/master/examples/1-automatic.php)
* [Manual example »](https://github.com/danog/AsyncOrm/blob/master/examples/2-manual.php)
The `DbArray` obtained through one of the methods above is an abstract array object that automatically stores and fetches elements of the specified type, from the specified database.
The `DbArray` obtained through one of the methods above is an abstract array object that automatically stores and fetches elements of the specified [type »](#value-types), from the specified database.
`DbArray`s of type `ValueType::OBJECT` can contain objects extending `DbObject`.
Classes extending `DbObject` have a special `save` method that can be used to persist object changes to the database, as can be seen in the [example](https://github.com/danog/AsyncOrm/blob/master/examples/2-manual.php).
### Settings
@ -79,35 +83,7 @@ For optimal performance, the specified types must be as strict as possible, here
One of the most important value types is `ValueType::OBJECT`, it is used to store entire objects extending the `DbObject` class to the database.
Objects extending `DbObject` have a special `save` method that can be used to persist object changes to the database.
```php
$fieldConfig = new DbArrayBuilder(
'tableName',
$settings,
KeyType::STRING,
ValueType::OBJECT
);
$db = $fieldConfig->build();
class MyObject extends DbObject
{
public function __construct(
public readonly string $value
) {
}
}
$db->set("a", new MyObject('v'));
$obj = $db->get("a");
var_dump($obj->value);
$obj->value = 'newValue';
$obj->save();
var_dump($db->get("a")->value); // newValue
```
Objects extending `DbObject` have a special `save` method that can be used to persist object changes to the database, as can be seen in the [example](https://github.com/danog/AsyncOrm/blob/master/examples/2-manual.php).
## API Documentation

7
examples/2-manual.php
View File

@ -50,11 +50,16 @@ $db = $fieldConfig->build();
class MyObject extends DbObject
{
public function __construct(
public readonly string $value
public string $value
) {
}
}
$db->set("a", new MyObject('v'));
$obj = $db->get("a");
var_dump($obj->value);
$obj->value = 'newValue';
$obj->save();
var_dump($db->get("a")->value); // newValue