kola/potato-orm

This is an ORM package that manages the persistence of database CRUD operations.

potato-orm

, _(*1)

This is an ORM package that manages the persistence of simple database CRUD operations., _(*2)

Installation

PHP 5.5+ and Composer are required., _(*3)

Via Composer, _(*4)

``` bash $ composer require kola/potato-orm, <sub>(*5)</sub>

``` bash
$ composer install

Usage

Create a class with the name of the corresponding table in the database. Extend the class to the base class Model under the namespace Kola\PotatoOrm., <sub>(*6)</sub>

For instance, a class for dogs or Dogs or dog or Dog table should look like this:, <sub>(*7)</sub>

``` php namespace Kola\PotatoOrm;, <sub>(*8)</sub>

class Dog extends Model { }, <sub>(*9)</sub>

* Create and save a record to database

``` php
$dog = new Dog();
$dog->name = "Rex";
$dog->breed= "Alsatian";
$dog->origin = "Germany";
$dog->save();

• Find and update a record in database

``` php $dog = Dog::find(4); $dog->name = "Bruno"; $dog->save();, <sub>(*10)</sub>

OR

``` php
$dog = Dog::where('name', 'Rex');
$dog->breed = "Rottweiler";
$dog->save();

• Delete a record

``` php $dog = Dog::destroy(2);, <sub>(*11)</sub>

Feel free to name the class as the singular of the name of the database table. For instance, `User` class for `users` table.

`Note: Plurals of irregular nouns are not supported`

For instance, a class `Fish` should map to a table `fish` or `fishs`, not `fishes`. And a class `Child` should map to a table `child` or `childs`, not `children`.

## Supported database

Currently, only MYSQL and PostgreSQL are supported.

Work towards the support for other popular databases is in progress.

## Change log

Please check out [CHANGELOG](CHANGELOG.md) file for information on what has changed recently.

## Testing

``` bash
$ vendor/bin/phpunit test

Contributing

Please check out CONTRIBUTING file for detailed contribution guidelines., <sub>(*12)</sub>

Credits

potato-orm is maintained by Kolawole ERINOSO., <sub>(*13)</sub>

License

potato-orm is released under the MIT Licence. See the bundled LICENSE file for details., <sub>(*14)</sub>