Skip to content
This repository was archived by the owner on Dec 14, 2022. It is now read-only.

Commit 8efedba

Browse files
impleriimpleri
committed
Make way for the toolbox way
1 parent 6d24d26 commit 8efedba

14 files changed

+584
-72
lines changed

‎composer.json

+12-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{
22
"name": "impleri/laravel-resource",
33
"type": "library",
4-
"description": "Alternative RESTful resource implementation for Laravel.",
4+
"description": "Alternative API-only RESTful resource implementation for Laravel.",
55
"license": "BSD-2-Clause",
6-
"keywords": ["laravel", "laravel 4", "rest"],
6+
"keywords": ["laravel", "laravel 4", "rest", "json"],
77
"authors": [
88
{
99
"name": "Christopher Roussel",
@@ -12,7 +12,16 @@
1212
],
1313
"require": {
1414
"php": ">=5.4.0",
15-
"illuminate/support": "~4.0"
15+
"illuminate/support": "4.1.*",
16+
"illuminate/database": "4.1.*",
17+
"impleri/laravel-toolbox": "~1.0"
18+
},
19+
"require-dev": {
20+
"mockery/mockery": "0.8.0",
21+
"phpunit/phpunit": "3.7.*"
22+
},
23+
"suggests": {
24+
"laravelbook/ardent": ""
1625
},
1726
"autoload": {
1827
"psr-4": {

‎readme.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
laravel-resource
2-
================
1+
Laravel REST API Library
2+
========================
33

4-
Alternative RESTful resource implementation for Laravel 4
4+
Alternative RESTful resource implementation for Laravel 4. This package provides
5+
a more extensive REST API interface than the stock resource controller generator.
6+
Out of the box, the package allows others to generate routes and controllers so
7+
that developers simply plug in a model and overload methods when needed.

‎src/Interfaces/Collection.php ‎src/Contracts/CollectionInterface.php

+12-2
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
<?php namespace Impleri\Resource\Interfaces;
1+
<?php namespace Impleri\Resource\Contracts;
22

33
/**
44
* Collection Resource Interface
55
*
66
* Define required methods for handling collections RESTfully.
77
*/
8-
interface Collection
8+
interface CollectionInterface
99
{
1010
/**
1111
* Get Collection
@@ -16,6 +16,16 @@ interface Collection
1616
*/
1717
public function getCollection();
1818

19+
/**
20+
* Post Collection
21+
*
22+
* Processes input to create an individual item within the collection.
23+
* Corresponds to the RESTful POST action for the collection.
24+
* This definition is mirrored in ElementInterface.
25+
* @return \Illuminate\Http\Response Laravel response
26+
*/
27+
public function postCollection();
28+
1929
/**
2030
* Put Collection
2131
*

‎src/Contracts/ElementInterface.php

+61
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
<?php namespace Impleri\Resource\Contracts;
2+
3+
use Illuminate\Database\Eloquent\Model;
4+
5+
/**
6+
* Element Resource Interface
7+
*
8+
* Define required methods for handling elements RESTfully.
9+
*/
10+
interface ElementInterface
11+
{
12+
/**
13+
* Get Element
14+
*
15+
* Processes input to retrieve an individual item within the collection.
16+
* Corresponds to the RESTful GET action for the element/item.
17+
* @param \Illuminate\Database\Eloquent\Model $model Eloquent Model to autoload
18+
* @return \Illuminate\Http\Response Laravel response
19+
*/
20+
public function getElement(Model $model);
21+
22+
/**
23+
* Post Collection
24+
*
25+
* Processes input to create an individual item within the collection.
26+
* Corresponds to the RESTful POST action for the collection.
27+
* This definition is mirrored in CollectionInterface.
28+
* @return \Illuminate\Http\Response Laravel response
29+
*/
30+
public function postCollection();
31+
32+
/**
33+
* Put Element
34+
*
35+
* Processes input to replace or create an individual item within the collection.
36+
* Corresponds to the RESTful PUT action for the element/item.
37+
* @param \Illuminate\Database\Eloquent\Model $model Eloquent Model to autoload
38+
* @return \Illuminate\Http\Response Laravel response
39+
*/
40+
public function putElement(Model $model = null);
41+
42+
/**
43+
* Patch Element
44+
*
45+
* Processes input to update an individual item within the collection.
46+
* Corresponds to the RESTful PATCH action for the element/item.
47+
* @param \Illuminate\Database\Eloquent\Model $model Eloquent Model to autoload
48+
* @return \Illuminate\Http\Response Laravel response
49+
*/
50+
public function patchElement(Model $model);
51+
52+
/**
53+
* Delete Item
54+
*
55+
* Processes input to remove an individual item from the collection.
56+
* Corresponds to the RESTful DELETE action for the element/item.
57+
* @param \Illuminate\Database\Eloquent\Model $model Eloquent Model to autoload
58+
* @return \Illuminate\Http\Response Laravel response
59+
*/
60+
public function deleteElement(Model $model);
61+
}

‎src/Controllers/Base.php

+87
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
<?php namespace Impleri\Resource\Controllers;
2+
3+
use Illuminate\Support\Str;
4+
use Impleri\Resource\ResourceTrait;
5+
6+
/**
7+
* Base REST Controller
8+
*
9+
* Provides common functionality for REST resource controllers.
10+
*/
11+
class Base
12+
{
13+
/**
14+
* Consume the Resource trait
15+
*/
16+
use ResourceTrait;
17+
18+
/**
19+
* Name of the element to use.
20+
* @var string
21+
*/
22+
protected $elementName = 'item';
23+
24+
/**
25+
* Name of the collection to use.
26+
* @var string
27+
*/
28+
protected $collectionName = 'items';
29+
30+
/**
31+
* Name of the related model to use.
32+
* @var string
33+
*/
34+
protected $model = 'Model';
35+
36+
/**
37+
* Constructor
38+
*/
39+
public function __construct($elementName = 'item', $collectionName = '')
40+
{
41+
// Set the element name (singular) first
42+
$this->elementName = $elementName;
43+
44+
// Pluralise the element name if a collection name is not given
45+
if (empty($collectionName)) {
46+
$collectionName = Str::plural($this->elementName);
47+
}
48+
49+
// Set the collection name (plural)
50+
$this->collectionName = $collectionName;
51+
52+
$this->data['success'] = false;
53+
$this->data['json'] = [];
54+
$this->data['errors'] = [];
55+
}
56+
57+
/**
58+
* Set Response
59+
*
60+
* Common method to set response data.
61+
* @param string $key Key name
62+
* @param mixed $value Value
63+
* @param boolean $toJson Also save for JSON
64+
*/
65+
protected function setResponse($key, $value, $toJson = true)
66+
{
67+
$this->data[$key] = $value;
68+
if ($toJson) {
69+
$this->data['json'][$key] = (method_exists($value, 'toArray'))
70+
? $value->toArray()
71+
: $value;
72+
}
73+
}
74+
75+
/**
76+
* Make Response
77+
*
78+
* Common method to generate a response.
79+
* @param string $action Response action (for view name)
80+
* @return \Illuminate\Http\Response The response object
81+
*/
82+
protected function makeResponse($action)
83+
{
84+
$view = $this->elementName . '.' . $action;
85+
return $this->respond($this->data, $view);
86+
}
87+
}

‎src/Controllers/Collection.php

+96
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
<?php namespace Impleri\Resource\Controllers;
2+
3+
use Impleri\Resource\Contracts\CollectionInterface;
4+
5+
/**
6+
* Collection Resource
7+
*
8+
* This controller handles CRUD actions for generic element resources.
9+
*/
10+
class Collection extends Base implements CollectionInterface
11+
{
12+
/**
13+
* Paginate
14+
*
15+
* Number of items to include in pagination (0 = no pagination).
16+
* @var integer
17+
*/
18+
protected $paginate = 0;
19+
20+
/**
21+
* Constructor
22+
*/
23+
public function __construct($elementName = 'item', $collectionName = '')
24+
{
25+
parent::__construct($elementName, $collectionName);
26+
27+
// Ensure the collection variable always exists for views
28+
$this->data[$this->collectionName] = [];
29+
}
30+
31+
/**
32+
* Get Collection
33+
*
34+
* Processes input to return a paginated collection of matched items.
35+
* Corresponds to the RESTful GET action for the collection.
36+
* @return \Illuminate\Http\Response Laravel response
37+
*/
38+
public function getCollection()
39+
{
40+
$model = $this->model;
41+
$items = ($this->paginate > 0) ? $model::paginate($this->paginate) : $model::query()->get();
42+
43+
if (!$items->isEmpty()) {
44+
$this->setResponse($this->collectionName, $items);
45+
}
46+
47+
return $this->makeResponse('browse');
48+
}
49+
50+
/**
51+
* Post Collection
52+
*
53+
* Processes input to create an individual item within the collection.
54+
* Corresponds to the RESTful POST action for the collection.
55+
* @return \Illuminate\Http\Response Laravel response
56+
*/
57+
public function postCollection()
58+
{
59+
$item = new $this->model;
60+
61+
// We expect Ardent to handle validation
62+
$this->data['success'] = $item->save();
63+
64+
if ($this->data['success']) {
65+
$this->setResponse($this->elementName, $item);
66+
}
67+
68+
return $this->makeResponse('add');
69+
}
70+
71+
/**
72+
* Put Collection
73+
*
74+
* Processes input to overwrite the entire collection. Corresponds to the
75+
* RESTful PUT action for the collection.
76+
* @return \Illuminate\Http\Response Laravel response
77+
*/
78+
public function putCollection()
79+
{
80+
// Disable by default
81+
return $this->notSupported();
82+
}
83+
84+
/**
85+
* Delete Collection
86+
*
87+
* Processes input to delete the entire collection. Corresponds to the
88+
* RESTful DELETE action for the collection.
89+
* @return \Illuminate\Http\Response Laravel response
90+
*/
91+
public function deleteCollection()
92+
{
93+
// Disable by default
94+
return $this->notSupported();
95+
}
96+
}

‎src/Controllers/CollectionElement.php

+75
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
<?php namespace Impleri\Resource\Controllers;
2+
3+
use Impleri\Resource\Contracts\CollectionInterface;
4+
5+
/**
6+
* Element Resource
7+
*
8+
* This controller handles CRUD actions for generic element resources.
9+
*/
10+
class CollectionElement extends Element implements CollectionInterface
11+
{
12+
/**
13+
* Paginate
14+
*
15+
* Number of items to include in pagination (0 = no pagination).
16+
* @var integer
17+
*/
18+
protected $paginate = 0;
19+
20+
/**
21+
* Constructor
22+
*/
23+
public function __construct($elementName = 'item', $collectionName = '')
24+
{
25+
parent::__construct($elementName, $collectionName);
26+
27+
// Ensure the collection variable always exists for views
28+
$this->data[$this->collectionName] = [];
29+
}
30+
31+
/**
32+
* Get Collection
33+
*
34+
* Processes input to return a paginated collection of matched items.
35+
* Corresponds to the RESTful GET action for the collection.
36+
* @return \Illuminate\Http\Response Laravel response
37+
*/
38+
public function getCollection()
39+
{
40+
$model = $this->model;
41+
$items = ($this->paginate > 0) ? $model::paginate($this->paginate) : $model::query()->get();
42+
43+
if (!$items->isEmpty()) {
44+
$this->setResponse($this->collectionName, $items);
45+
}
46+
47+
return $this->makeResponse('browse');
48+
}
49+
50+
/**
51+
* Put Collection
52+
*
53+
* Processes input to overwrite the entire collection. Corresponds to the
54+
* RESTful PUT action for the collection.
55+
* @return \Illuminate\Http\Response Laravel response
56+
*/
57+
public function putCollection()
58+
{
59+
// Disable by default
60+
return $this->notSupported();
61+
}
62+
63+
/**
64+
* Delete Collection
65+
*
66+
* Processes input to delete the entire collection. Corresponds to the
67+
* RESTful DELETE action for the collection.
68+
* @return \Illuminate\Http\Response Laravel response
69+
*/
70+
public function deleteCollection()
71+
{
72+
// Disable by default
73+
return $this->notSupported();
74+
}
75+
}

0 commit comments

Comments
 (0)