Brings the Eloquent ORM from the Laravel framework to the browser.

Full documentation for the package can be found at the parsnick.github.io/eloquentjs.

composer require parsnick/eloquentjs

and add the service provider

// config/app.php
'providers' => [
    // ...
    
    // before your RouteServiceProvider, add
    EloquentJs\EloquentJsServiceProvider::class,
    
    // ...
],

1. Use the trait EloquentJs\Model\EloquentJsQueries in your models

   use EloquentJs\Model\EloquentJsQueries;
   
   class Post extends Model {
       use EloquentJsQueries;
       // ...
   }

2. Add routes to respond to queries coming in via the client-side library

   (a) Use Route::eloquent($url, $modelClass) to register a set of RESTful routes similar to Route::resource($url, $controllerClass) provided by native Laravel.

   // app/Http/routes.php
   Route::eloquent('api/posts', App\Post::class);

   or (b) for complete control over which methods are permitted, use your own controller logic:

   // app/Http/routes.php
   Route::get('api/posts', function () {
       return App\Post::eloquentJs('where(id|body) orderBy(body|rating|created_at)')
           ->take(50)
           ->get();
   });

3. Create a javascript build customised for your specific models

   php artisan eloquentjs:generate [--models=*] [--output=public/eloquent.js]
   

4. Load eloquent.js on a page and start using Eloquent in the browser!

   var Post = Eloquent.Post;
   
   // The API is the same as the Eloquent you already know, as far as practical
   // with a few obvious limitations. Most notably, database operations are 
   // inevitably asynchronous so any method that executes a query will
   // always return a Promise.
   
   var post = new Post({ title: 'My first post!' });
   
   post.save().then(function (post) {
       // carry on...
   });
   
   Post.create({ title: 'My second post!' }).then(function (post) {
       
       console.log(post.exists); // true
       console.log(post.title); // My second post!
       console.log(post.blahblahblah); // undefined
       console.log(post.created_at.getFullYear()); // 2016
       console.log(post.getKey()); // 2    
       console.log(post.getAttributes()); // plain data object with no behaviour
       
       post.title = 'Updated';
   
       console.log(post.getDirty()); // { title: 'Updated' }
   
       post.update({ title: 'Hello!' }).then(function (post) {
           console.log('Saved at: ' + post.updated_at);
       });
   });
   
   Post.whereNotNull('published_at').get().then(function (results) {
       // results.forEach(...);
       // ...
   });
   
   Post.published().latest().get(); // assumes a scopePublished() method on the server
   
   Post.saving(function (post) {
       return !! post.title; // prevent posting without a title
   });

• Support relations property set in eloquentjs.php config file.

• Added an optional eloquentjs.php config file to replace interactive prompts for unknown info during php artisan eloquentjs:generate.
• Extracted 'update all' and 'delete all' to their own routes: now handles PUT and DELETE to /resource respectively.

As a new project, no formal contribution guide exists but feel free to open issues and pull requests. For anything related to the companion javascript library, please use parsnick/eloquentjs-client.

MIT