ont/laravel-telekinesis

Universal REST route with Eloquent-like API for javascript.

0.0.3-alpha 2015-12-03 07:08 UTC

Requires

• php: >=5.4.0
• illuminate/config: ~5.0
• illuminate/support: ~5.0

Requires (Dev)

• phpunit/phpunit: ~4.0

MIT

• ont.rif

• orm
• admin
• rest
• javascript
• laravel
• eloquent

README

Universal REST controller with Eloquent-like calls in javascript for retrieving data from server.

Installation

• install package with `composer require ont/laravel-telekinesis`
• add service provider to `config/app.php`

   <?php
       'providers' => array(
           ...
           'Ont\Telekinesis\ServiceProvider',
           ...
       ),
   ?>
  

• publish package assets via `php artisan vendor:publish`

Usage

Include jquery and telekinesis.js at the bottom of the page:

    ...
    <script src="//ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js"></script>
    <script src="{{asset('ont/telekinesis/telekinesis.js')}}" type="text/javascript" charset="utf-8"></script>
</body>

Finally you can request data in js via usual eloquent calls:

T('\\App\\Resume').whereHas('vacancies', function(q){
    q.where('views', '>', 100);
}).get(function(resumes){
    console.log(resumes);
});

Here we request server to return such resumes which have related vacancies with "views" field greater than 100. Function `get()` do async call to server and accept callback as paramenter.

Notes

In laravel 5 CSRF protection enabled by default. This component use special `XSRF-TOKENcookie sended by laravel 5 and resends it back inX-XSRF-TOKEN` header.

TODO

• security checks
  • available models (classes)
  • available method calls
  • available arguments
  • possible data fields returned back from server
  • ACL-based permissions
• more eloquent methods in telekinesis.js
• tests

Enjoy eloquent in javascript!