PHP Classes

File: README.md

Recommend this page to a friend!
  Classes of adeniyi ibraheem  >  Potato ORM  >  README.md  >  Download  
File: README.md
Role: Documentation
Content type: text/markdown
Description: Documentation
Class: Potato ORM
Store and retrieve objects in databases using ORM
Author: By
Last change:
Date: 4 years ago
Size: 3,749 bytes
 

Contents

Class file image Download

Potato-ORM

Build Status License Quality Score Scruitinizer Code Code Climate Test Coverage

Potato-ORM is a package that manages the CRUD operation of database. Potato-ORM currently supports MYSQL, POSTGRES and SQLITE Database.

Installation

PHP 5.5+ and Composer are required.

Via Composer

$ composer require ibonly/potato-orm

$ composer install

Usage

App Namespace

    namespace Ibonly\PotatoORM

Create a Class that correspond to the singular form of the table name in the database. i.e.

<?php
    namespace Ibonly\PotatoORM;

    class User extends Model
    {

    }
?>

The Model class contains getAll(), where($field, $value), find($value), save() and detroy($id) methods.

getAll()

<?php
    use Ibonly\PotatoORM\User;

    $sugar = new User();
    echo $sugar->getAll();
?>

Return type = JSON

where($field, $value)

<?php
    use Ibonly\PotatoORM\User;

    $sugar = new User();
    echo $sugar->where($field, $value);
?>

Return type = JSON

find($value)

<?php
    use Ibonly\PotatoORM\User;

    $insert = User::find(1);
    $insert->password = "password";
    echo $insert->save()
?>

To return custom message, wrap the `save()` method in an `if statement`

Return type = Boolean

save()

<?php
    use Ibonly\PotatoORM\User;

    $insert = new User();
    $insert->id = NULL;
    $insert->username = "username";
    $insert->email = "example@example.com";
    $insert->password = "password";
    echo $insert->save();
?>

To return custom message, wrap the `save()` method in an `if statement`

Return type = Boolean

detroy($value)

<?php
    use Ibonly\PotatoORM\User;

    $insert = User::destroy(2);
    die($insert);
?>

Return type = Boolean

Create Database Table

Its is also possible to create Database Table with the Schema class. The table name will be specified in the createTable($name) method.

<?php
    use Ibonly\PotatoORM\Schema;

    $user = new Schema;
    $user->field('increments', 'id');
    $user->field('strings', 'username');
    $user->field('strings', 'name', 50);
    $user->field('integer', 'age');
    $user->field('primaryKey', 'id');

    echo $table->createTable('players');
?>
Return type = Boolean

Database Constraint

Foreign Key

```
    $user->field('foreignKey', 'id', 'users_id');
```

The reference table `(users)` and field `(id)` will be written as `(users_id)`

Unique

```
    $user->field('unique', 'email')
```

Testing

$ vendor/bin/phpunit test

Contributing

To contribute and extend the scope of this package, Please check out CONTRIBUTING file for detailed contribution guidelines.

Credits

Potato-ORM is created and maintained by Ibraheem ADENIYI.


For more information send a message to info at phpclasses dot org.