README

#Potato ORM Potato ORM is a lightweight ORM based on concepts borrowed from the laravel framework

#Testing The phpunit framework for testing is used to perform unit test on the classes. The TDD principle has been employed to make the application robust

Run this in your terminal to execute the tests

/vendor/bin/phpunit

#Install

• To install this package, PHP 5.5+ and Composer are required

composer require dara/potato

#Environment variables

In order to use this package, you need to create a .env file with the following details provided

P_DRIVER = 'mysql';
P_HOST   = 'localhost';
P_DBNAME = 'db_name';
P_USER   = 'db_username';
P_PASS   = 'db_password';

#usage

• Save a new record

$user = new User();
$user->username = "drsumo";
$user->password = "ppkksdjs";
$user->email = "mail@mail.com";
$user->save();

• Find one record

$user = User::find($id);

• Find all records

$allUsers = User::getAll();

• Update an existing record

$user = User::find($id);
$user->email = "newemail@mail.com";
$user->username = "rockefeller";
$user->save();

• Delete an existing record

$delete = User::destroy($id):

Change log

Please check out CHANGELOG file for information on what has changed recently.

Contributing

Please check out CONTRIBUTING file for detailed contribution guidelines.

Credits

Potato-ORM is maintained by Dara Oladosu.

License

Potato-ORM is released under the MIT Licence. See the bundled LICENSE file for more details.