Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tacone/backenator
ORM (Object Relational Mapper) build on top of Eloquent that maps REST resources
https://github.com/tacone/backenator
Last synced: 7 days ago
JSON representation
ORM (Object Relational Mapper) build on top of Eloquent that maps REST resources
- Host: GitHub
- URL: https://github.com/tacone/backenator
- Owner: tacone
- License: other
- Created: 2016-11-30T11:13:53.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2013-10-19T15:12:04.000Z (about 11 years ago)
- Last Synced: 2023-03-12T09:54:38.760Z (over 1 year ago)
- Language: PHP
- Homepage:
- Size: 134 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: MIT-LICENSE.txt
Awesome Lists containing this project
README
# Backenator
ORM (Object Relational Mapper) build on top of Eloquent that maps REST resources.
### Status
[](https://travis-ci.org/ellipsesynergie/backenator)
[](https://packagist.org/packages/ellipsesynergie/backenator)
[](https://packagist.org/packages/ellipsesynergie/backenator)
## Documentation
##Installation
Begin by installing this package through Composer. Edit your project's `composer.json` file to require `ellipsesynergie/backenator`.
```javascript
{
"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.
```php
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.
```bash
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
```php
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
```php
$user = self::find(1); // GET http://api.example.com/users/1
```
### Querying
```php
$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
```php
$user = new User;
$user->firstname = 'John';
$user->lastname = 'Doe';
$user->save(); // POST http://api.example.com/users
```
### Updating
```php
$user = User::find(1);
$user->firstname = 'Johnny';
$user->save(); // PUT http://api.example.com/users/1
```
### Deleting
```php
$this->segment(1)->delete(); // DELETE http://api.example.com/users/1
```
### Get the request URL
```php
$model = new User;
$users = $model->segment('newest')->get();
echo $model->getRequestUrl(); // http://api.example.com/users/newest
```
### Request status
```php
$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
```php
$model = new User;
$users = $model->segment('newest')->get();
$request = $model->getResponse(); // Buzz\Message\Response
```
### Client object
You can get the client `Buzz\Browser`
```php
$model = new User;
$users = $model->segment('newest')->get();
$client = $model->getClient(); // Buzz\Browser
```
### Retrieving errors
```php
$model = new User;
$users = $model->segment('newest')->get();
$errors = $model->errors();
```
## Authors
[@ellipsesynergie](http://github.com/ellipsesynergie)
## License
MIT