Download the PHP package arthurnumen/genie without Composer
On this page you can find all versions of the php package arthurnumen/genie. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package genie
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.
Installation
Implementation
The examples will use a hypothetical Eloquent model named User
.
Options
Genie is already integrated with Optimus\Bruno.
See Bruno documentation for more information.
The $options
key given by all get-methods takes the following format:
Parameter | Value type | Description |
---|---|---|
includes | array | Array of relationships to eager load |
sort | array | Array of sorting rules, e.g. [['key' => '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
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.
Testing
Contributing
Please see CONTRIBUTING for details.
License
The MIT License (MIT). Please see License File for more information.