Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tomkyle/repository-persistence
Scaffold for Repository-and-Persistence design pattern
https://github.com/tomkyle/repository-persistence
Last synced: about 12 hours ago
JSON representation
Scaffold for Repository-and-Persistence design pattern
- Host: GitHub
- URL: https://github.com/tomkyle/repository-persistence
- Owner: tomkyle
- License: mit
- Created: 2024-02-11T14:16:09.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-08-28T18:10:33.000Z (2 months ago)
- Last Synced: 2024-08-28T19:50:51.875Z (2 months ago)
- Language: PHP
- Size: 244 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Repository · Persistence
[](https://packagist.org/packages/tomkyle/repository-persistence)
[](https://packagist.org/packages/tomkyle/repository-persistence)
[](https://github.com/tomkyle/repository-persistence/actions/workflows/php.yml)
[](LICENSE)
**Scaffold for Repository-and-Persistence design pattern.**
---
## Installation
```bash
$ composer require tomkyle/repository-persistence
```
## Setup
**The repository needs a persistence.**
```php
get('john-doe');
print_r($person);
}
catch (\OutOfBoundsException) {
// Not found
}
```
Output will be like:
```text
Array (
[age] => 30
[city] => New York
[name] => John Doe
)
```
**Find one item by criteria.** This method may return `null`.
```php
$repo->findOneBy([
'name' => 'John'
]);
```
**Get all items:**
```php
$repo->findAll();
```
**Find items by criteria**
```php
$repo->findBy([
'color' => 'blue'
]);
```
**Update item**
```php
$saved = $repo->save(['id' => 43, 'name' => 'John']));
```
**Delete item**
```php
$repo->delete(43);
```
**Create new item**
```php
$saved = $repo->save(['name' => 'Angie']));
```
If you need the new ID onbeforehand in your App controller, e.g. for redirecting the client to the new resource, you can obtain a new ID from the repo. It then looks exactly like updating, but the *Repository* implementation will figure out if the item has to be created or updated.
```php
$new_id = $repo->getNextId();
$repo->save(['id' => $new_id, 'name' => 'Angie']));
```
---
## Persistence
Inside a repository, the *Persistence* actually manages the data storage.
### Instantiation
```php
`?int` limit
`?int` offset | `iterable` | Some records |
| save | `array¦object` entity | | `bool` | |
| delete | `array¦object` entity | | `bool` | |
---
## Development
### Install requirements
```bash
$ composer install
$ npm install
```
### Watch source and run various tests
This will watch changes inside the **src/** and **tests/** directories and run a series of tests:
1. Find and run the according unit test with *PHPUnit*.
2. Find possible bugs and documentation isses using *phpstan*.
3. Analyse code style and give hints on newer syntax using *Rector*.
```bash
$ npm run watch
```
### Run all tests
Choose to your taste:
```bash
$ npm run phpunit
$ composer test
```