Backenator

ORM (Object Relational Mapper) build on top of Eloquent that maps REST resources.

Status

Documentation

##Installation

Begin by installing this package through Composer. Edit your project's composer.json file to require ellipsesynergie/backenator.

{
    "require": {
        "ellipsesynergie/backenator": "dev-master"
    }
}

Update your packages with composer update or install with composer install.

Once this operation completes, you need to add the service provider. Open app/config/app.php, and add a new item to the providers array.

EllipseSynergie\Backenator\BackenatorServiceProvider

##Configurations

To configure the package to meet your needs, you must publish the configuration in your application before you can modify them. Run this artisan command.

php artisan config:publish ellipsesynergie/backenator

The configuration files could now be found in app/config/packages/ellipsesynergie/backenator. Read the description for each configurations to know what you can override!

Model

class User extends Backenator {

    /**
     * Model's URI
     *
     * @var string
     */
    protected static $table = 'users';

    /**
     * The attributes that are mass assignable.
     *
     * @var array
     */
    protected $fillable = array();

}

Retrieving A Record By Primary Key

$user = self::find(1); // GET http://api.example.com/users/1

Querying

$users = $this->segment('newest')->get(); // GET http://api.example.com/users/newest
$users = $this->segment('newest')->where('limit', 10)->get(); // GET http://api.example.com/users/newest?limit=10
$user = $this->segment(1)->first(); // GET http://api.example.com/users/1

Creating

$user = new User;
$user->firstname = 'John';
$user->lastname = 'Doe';
$user->save(); // POST http://api.example.com/users

Updating

$user = User::find(1);
$user->firstname = 'Johnny';
$user->save(); // PUT http://api.example.com/users/1

Deleting

$this->segment(1)->delete(); // DELETE http://api.example.com/users/1

Get the request URL

$model = new User;
$users = $model->segment('newest')->get();
echo $model->getRequestUrl();  // http://api.example.com/users/newest

Request status

$model = new User;
$users = $model->segment('newest')->get();

$model->success();  // TRUE if the request success
$model->fail();  // TRUE if the request fail

Response object

You can get the Buzz\Message\Response object after a request

$model = new User;
$users = $model->segment('newest')->get();
$request = $model->getResponse(); // Buzz\Message\Response

Client object

You can get the client Buzz\Browser

$model = new User;
$users = $model->segment('newest')->get();
$client = $model->getClient(); // Buzz\Browser

Retrieving errors

$model = new User;
$users = $model->segment('newest')->get();
$errors = $model->errors();

Authors

@ellipsesynergie

License

MIT

tacone / backenator