https://github.com/esbenp/genie
A base repository class for Eloquent to abstract away persistence layer from your business code
https://github.com/esbenp/genie
Last synced: about 1 month ago
JSON representation
A base repository class for Eloquent to abstract away persistence layer from your business code
- Host: GitHub
- URL: https://github.com/esbenp/genie
- Owner: esbenp
- License: mit
- Created: 2015-11-04T11:55:20.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-12-28T13:00:17.000Z (over 1 year ago)
- Last Synced: 2025-04-25T05:38:02.552Z (about 2 months ago)
- Language: PHP
- Homepage: http://optimus.rocks/
- Size: 26.4 KB
- Stars: 25
- Watchers: 5
- Forks: 21
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Genie
[](https://github.com/esbenp/genie/releases)
[](LICENSE)
[](https://travis-ci.org/esbenp/genie)
[](https://coveralls.io/github/esbenp/genie)
[](https://packagist.org/packages/optimus/genie)
## Introduction
A base repository class for Eloquent with convenience methods that cover most queries. Useful to abstract away
your persistence layer from your business code.
**Dedicated to Genie**
Dedicated to the World's best (and only) Genie in a bottle. [Congrats on the freedom my man](https://www.youtube.com/watch?v=SUfP6IGQD00).
## Installation
For Laravel 5.4 and above
```bash
composer require optimus/genie ~2.0
```
For Laravel 5.3 and below
```bash
composer require optimus/genie ~1.0
```
## Implementation
The examples will use a hypothetical Eloquent model named `User`.
```php
'username', 'direction' => 'ASC']]`
filter_groups | array | See Bruno documentation
limit | int | Rows per page
page | int | The page to start from (use with limit)
*Note:* If you use the controller of Bruno it will automatically parse the request's
query string into the correct format.
## API
The examples will use a hypothetical Eloquent model named `User`.
### get (array $options = [])
Get all `User` rows
### getById ($id, array $options = [])
Get one `User` by primary key
### getRecent (array $options = [])
Get `User` rows ordered by `created_at` descending
### getRecentWhere (string $column, mixed $value, array $options = [])
Get `User` rows where `$column=$value`, ordered by `created_at` descending
### getWhere (string $column, mixed $value, array $options = [])
Get `User` rows where `$column=$value`
### getWhereArray (array $clauses, array $options = [])
Get `User` rows by multiple where clauses (`[$column1 => $value1, $column2 => $value2]`)
### getWhereIn (string $column, array $values, array $options = [])
Get `User` rows where `$column` can be any of the values given by `$values`
### getLatest (array $options = [])
Get the most recent `User`
### getLatestWhere (string $column, mixed $value, array $options = [])
Get the most recent `User` where `$column=$value`
### delete ($id)
Delete `User` rows by primary key
### deleteWhere ($column, $value)
Delete `User` rows where `$column=$value`
### deleteWhereArray (array $clauses)
Delete `User` rows by multiple where clauses (`[$column1 => $value1, $column2 => $value2]`)
## Standards
This package is compliant with [PSR-1], [PSR-2] and [PSR-4]. If you notice compliance oversights,
please send a patch via pull request.
[PSR-1]: https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-1-basic-coding-standard.md
[PSR-2]: https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md
[PSR-4]: https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-4-autoloader.md
## Testing
``` bash
$ phpunit
```
## Contributing
Please see [CONTRIBUTING](https://github.com/esbenp/genie/blob/master/CONTRIBUTING.md) for details.
## License
The MIT License (MIT). Please see [License File](https://github.com/esbenp/genie/blob/master/LICENSE) for more information.