Commit 6871ad23 authored by endi's avatar endi

Update Readme.md

parent e865fb96
## RESTful format response for Laravel ## RESTful format response for Laravel
### For Laravel 4, please use the [v1.x branch](https://github.com/teepluss/laravel-restable/tree/v1.x)!
Restable is a useful to create RESTful API response format that support multiple format, such as Json, XML Restable is a useful to create RESTful API response format that support multiple format, such as Json, XML
Serialized, PHP. Serialized, PHP.
### Installation ### Installation
- [Restable on Packagist](https://packagist.org/packages/teepluss/restable)
- [Restable on GitHub](https://github.com/teepluss/laravel-restable)
To get the lastest version of Theme simply require it in your `composer.json` file. To get the lastest version of Theme simply require it in your `composer.json` file.
~~~ ~~~
"teepluss/restable": "dev-master" "terranet/restable": "dev-master"
~~~ ~~~
You'll then need to run `composer install` to download it and have the autoloader updated. You'll then need to run `composer install` to download it and have the autoloader updated.
Once Theme is installed you need to register the service provider with the application. Open up `config/app.php` and find the `providers` key. Once Package is installed you need to register the service provider with the application. Open up `config/app.php` and find the `providers` key.
~~~ ~~~
'providers' => array( 'providers' => array(
'Teepluss\Restable\RestableServiceProvider' 'Terranet\Restable\RestableServiceProvider'
) )
~~~ ~~~
...@@ -33,7 +28,7 @@ Restable also ships with a facade which provides the static syntax for creating ...@@ -33,7 +28,7 @@ Restable also ships with a facade which provides the static syntax for creating
~~~ ~~~
'aliases' => array( 'aliases' => array(
'Restable' => 'Teepluss\Restable\Facades\Restable' 'Restable' => 'Terranet\Restable\Facades\Restable'
) )
~~~ ~~~
...@@ -61,7 +56,7 @@ class ApiBlogsController extends BaseController { ...@@ -61,7 +56,7 @@ class ApiBlogsController extends BaseController {
{ {
if ( ! Input::get('secret') == '12345') if ( ! Input::get('secret') == '12345')
{ {
return Restable::unauthorized()->render(); return Restable::unauthorized();
} }
} }
...@@ -79,7 +74,7 @@ class ApiBlogsController extends BaseController { ...@@ -79,7 +74,7 @@ class ApiBlogsController extends BaseController {
//return Restable::listing(Blog::paginate())->to('xml'); //return Restable::listing(Blog::paginate())->to('xml');
//return Restable::listing(Blog::paginate())->toXML(); //return Restable::listing(Blog::paginate())->toXML();
return Restable::listing(Blog::paginate())->render(); return Restable::listing(Blog::paginate());
} }
/** /**
...@@ -108,7 +103,7 @@ class ApiBlogsController extends BaseController { ...@@ -108,7 +103,7 @@ class ApiBlogsController extends BaseController {
if ($validator->fails()) if ($validator->fails())
{ {
return Restable::unprocess($validator)->render(); return Restable::unprocess($validator);
} }
$blog->title = Input::get('title'); $blog->title = Input::get('title');
...@@ -116,7 +111,7 @@ class ApiBlogsController extends BaseController { ...@@ -116,7 +111,7 @@ class ApiBlogsController extends BaseController {
$blog->save(); $blog->save();
return Restable::created($blog)->render(); return Restable::created($blog);
} }
/** /**
...@@ -131,10 +126,10 @@ class ApiBlogsController extends BaseController { ...@@ -131,10 +126,10 @@ class ApiBlogsController extends BaseController {
if ( ! $blog) if ( ! $blog)
{ {
return Restable::missing()->render(); return Restable::missing()
} }
return Restable::single($blog)->render(); return Restable::single($blog);
} }
/** /**
...@@ -149,7 +144,7 @@ class ApiBlogsController extends BaseController { ...@@ -149,7 +144,7 @@ class ApiBlogsController extends BaseController {
if ( ! $blog) if ( ! $blog)
{ {
return Restable::missing()->render(); return Restable::missing();
} }
return View::make('api.blogs.edit', compact('blog')); return View::make('api.blogs.edit', compact('blog'));
...@@ -167,7 +162,7 @@ class ApiBlogsController extends BaseController { ...@@ -167,7 +162,7 @@ class ApiBlogsController extends BaseController {
if ( ! $blog) if ( ! $blog)
{ {
return Restable::missing()->render(); return Restable::missing();
} }
$validator = Validator::make(Input::all(), array( $validator = Validator::make(Input::all(), array(
...@@ -177,7 +172,7 @@ class ApiBlogsController extends BaseController { ...@@ -177,7 +172,7 @@ class ApiBlogsController extends BaseController {
if ($validator->fails()) if ($validator->fails())
{ {
return Restable::unprocess($validator)->render(); return Restable::unprocess($validator);
} }
$blog->title = Input::get('title'); $blog->title = Input::get('title');
...@@ -185,7 +180,7 @@ class ApiBlogsController extends BaseController { ...@@ -185,7 +180,7 @@ class ApiBlogsController extends BaseController {
$blog->save(); $blog->save();
return Restable::updated($blog)->render(); return Restable::updated($blog);
} }
/** /**
...@@ -200,12 +195,12 @@ class ApiBlogsController extends BaseController { ...@@ -200,12 +195,12 @@ class ApiBlogsController extends BaseController {
if ( ! $blog) if ( ! $blog)
{ {
return Restable::missing()->render(); return Restable::missing();
} }
$blog->delete(); $blog->delete();
return Restable::deleted()->render(); return Restable::deleted();
} }
} }
...@@ -214,54 +209,27 @@ class ApiBlogsController extends BaseController { ...@@ -214,54 +209,27 @@ class ApiBlogsController extends BaseController {
Error cases. Error cases.
~~~php ~~~php
// Unauthorized. // Unauthorized.
Restable::unauthorized()->render(); Restable::unauthorized();
// Bad request. // Bad request.
Restable::bad()->render(); Restable::bad();
// Missing, Not found. // Missing, Not found.
Restable::missing()->render(); Restable::missing();
// Unprocess, Validation Failed. // Unprocess, Validation Failed.
Restable::unprocess()->render(); Restable::unprocess();
// Custom. // Custom.
Restable::error(null, 429)->render(); Restable::error(null, 429);
~~~ ~~~
Another success cases. Another success cases.
~~~php ~~~php
return Restable::success()->render(); return Restable::success();
~~~ ~~~
Changing error code. Changing error code.
~~~php ~~~php
return Restable::code(9001)->bad('message')->render(); return Restable::code(9001)->bad('message');
~~~ ~~~
\ No newline at end of file
Render to another format.
~~~php
// XML
return Restable::single($data)->render('xml');
// Serialized
return Restable::single($data)->render('serialized');
// PHP
return Restable::single($data)->render('php');
// JSON
return Restable::single($data)->render('json');
// JSONP
return Restable::single($data)->render('json', Input::get('callback'));
// OR
return Restable::single($data)->toJson(Input::get('callback'));
~~~
## Support or Contact
If you have some problem, Contact teepluss@gmail.com
[![Support via PayPal](https://rawgithub.com/chris---/Donation-Badges/master/paypal.jpeg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=9GEC8J7FAG6JA)
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment