demola/potato-orm

A package that perform basic CRUD (create, read, update and delete) operations in your Database.

Potato ORM

Potato-ORM is based on concepts borrowed from the Laravel framework. It is a package that can perform the basic CRUD (create, read, update and delete) operations., _(*1)

Installation

To install this package, PHP 5.5+ and Composer are required, _(*2)

$ composer require demola/potato-orm, _(*3)

Usage

To use this package, what you need to do is to simply extend the base class. The base class is an abstract class called "DataBaseModel". Take for instance, you wish to perform the CRUD operations on the users table. Create a corresponding users class which should look like this:, _(*4)

use Demo;

class User extends DataBaseModel
{
}

• Saving a new record to the table, _(*5)

   $user               = new User();
   $user->name         = "Prosper Otemuyiwa";
   $user->sex          = "m";   
   $user->occupation   = "Trainer";
   $user->organisation = "Andela";
   $user->year         = 2009;
   $user->save();  

• Read all record from the table, _(*6)

   $users = User::getAll();
   print_r($users);

• Read from a particular record in the table, _(*7)

  $user = User::findById(3);
  print_r($user->getById());

• Update a record in the table. For example, update the name of the tenth record in the users table:, _(*8)

  $user       = User::findById(10);
  $user->name = "Gbolohan Kuti";
  $user->save();

• Delete a record in the table. For example, delete the eighth record in the users table:, _(*9)

  $users = User::destroy(8);

• Exception Handling, _(*10)

To make this package degrade gracefully, It has to be wrapped under try and catch in order for all exceptions to be caught., _(*11)

• Catching exception on save new record:, _(*12)

   try {
       $user               = new User();
       $user->name         = "Prosper Otemuyiwa";
       $user->sex          = "m";   
       $user->occupation   = "Trainer";
       $user->organisation = "Andela";
       $user->year         = 2009;
       $user->save(); 
       } catch(Exception $e) {
           print($e->getMessage());
       } 

• Catching exception on reading from the table:, _(*13)

      /**
       * Read all record
       * / 
      try {
          $users = User::getAll();
          print_r($users);
      } catch(Exception $e) {
          print($e->getMessage());
      } 
  
      /**
       * Read from a particular record
       * / 
      try {
          $user = User::findById(3);
          print_r($user->getById());
      } catch(Exception $e) {
          print($e->getMessage());
      } 

• Catching exception on updating the table:, _(*14)

      try {
          $user       = User::findById(10);
          $user->name = "Gbolohan Kuti";
          $user->save();
       } catch(Exception $e) {
          print($e->getMessage());
       } 

• Catching exception on deleting from the table:, _(*15)

       try {
           $users = User::destroy(8);
       } catch(Exception $e) {
           print($e->getMessage());
       } 

Testing

Run the following command in the potato-orm directory:, _(*16)

~ phpunit tests

Change log

Please check out CHANGELOG file for information on what has changed recently., _(*17)

Contributing

Please check out CONTRIBUTING file for detailed contribution guidelines., _(*18)

Security

If you discover any issue, kindly contact ademola.raimi@andela.com, _(*19)

Credits

Potato-ORM is maintained by Raimi Ademola., _(*20)

License

Potato-ORM is released under the MIT Licence. See the bundled LICENSE file for more details., _(*21)