sirolad/potato-orm

A basic CRUD Object Relational Mapper

PotatoORM

, _(*1)

This package performs basic CRUD operation using Object Relational Mapping(ORM) :, _(*2)

DIRECTORY STRUCTURE

src/           core package code
   |DB         database connection class
   |Entities   samples class to test the model class
   |Exceptions custom exception classes
   |Libraries  helper classes
tests/         tests of the core package

Installation

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

Via Composer, _(*4)

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

or
``` composer.json
"require": {
        "sirolad/potato-orm": "dev-master"
    }

Usage

Extend Potato class like so ``` php class Goat extends Potato { }, <sub>(*6)</sub>

The following method can be used to access the classes

## getAll
``` php
   $goat = Goat::getAll();
   print_r($goat);

This should print out all the ​goats ​in the ​goats ​table of Goat class., <sub>(*7)</sub>

find

``` php $goat = Goat::find(1); $goat->password = "ewure"; echo $goat->save();, <sub>(*8)</sub>

This should find the ​goat ​with `id=1` in the goats table and change the password to `ewure`.

## save
```php
    $goat = new Goat();
    $goat->name = "billy";
    $goat->age  = 25;
    $goat->job  = "developer";
    $goat->save();

This should insert a record for goat billy in the goats table., <sub>(*9)</sub>

Update

    $goat = Goat::where('name', 'JackBauer');
    $goat->password = "wetina";
    $goat->save();

Change log

Please check out CHANGELOG file for information on what has changed recently., <sub>(*10)</sub>

Testing

``` bash $ vendor/bin/phpunit test, <sub>(*11)</sub>

``` composer
$ composer test

Contributing

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

Credits

PotatoORM is developed and maintained by Surajudeen Akande., <sub>(*13)</sub>

License

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

Supported Databases

bash MySQL PGSQL, <sub>(*15)</sub>