vundi/potato-orm

An ORM package that allows you to perform basic CRUD operations on any database

POTATO ORM

![Software License][ico-license], _(*1)

POTATO ORM is a custom ORM that allows you to perform all CRUD operations on a table when working with any database, _(*2)

Install

Installation via Composer, _(*3)

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

## Usage
#### Configuration SQL databases
**NOTE:** Load you connection variables from the `.env` file in the root folder. If you do not have a `.env` file in your root folder or don't know about it, please read this [phpdotenv project](https://github.com/vlucas/phpdotenv).

Provide `Database host`, `database user`, `database password` and the `type` in the .env file. Once you provide the right values a Database connection will be established.

``` php

// Load the `.env` variables for the project
// Check the `.env.example` file in the root of the project to see the environment variables needed.
$dotenv = new Dotenv\Dotenv(__DIR__);
$dotenv->load();

Once we have a connection, we create a model class which extends Model. Inside the model class set the entity table name ``` php require 'vendor/autoload.php';, <sub>(*5)</sub>

use Vundi\Potato\Model; use Vundi\Potato\Exceptions\NonExistentID; use Vundi\Potato\Exceptions\IDShouldBeNumber;, <sub>(*6)</sub>

class User extends Model { protected static $entity_table = 'Person'; }, <sub>(*7)</sub>

Database interactions
``` php
// create a new user
$user = new User;
$user->name = "Kevin Karugu";
$user->age = 23;
$user->company = "Andela";
$user->save();

Get all users from the users table, <sub>(*8)</sub>

$users = User::findAll(); // Returns an array of the users found in the db

Get a single user from the users table, <sub>(*9)</sub>

$user = User::find(2); // will return user with an ID of 2

Edit an existing user, <sub>(*10)</sub>

$user = User::find(2);
$user->name = "Devy Kerr";
$user->company = "Suyabay";
$user->update();

Delete a user, <sub>(*11)</sub>

//Will remove a user from the database table
User::remove(2); // 2 represents the id of the user to be removed

Credits

• Christopher Vundi

License

The MIT License (MIT). Please see License File for more information., <sub>(*12)</sub>