Merge tag 'v1.0.2'

Minimum tability

Author: webtack

README.md

@@ -0,0 +1,183 @@
+# Generic Controllers
+
+Generic Controllers is a extension system for your [Laravel](https://laravel.com) application.<br>
+Generic Controllers includes a set of generic representations that are ideally suited for solving a number of routine tasks.
+
+# Installation
+
+Install using composer:
+
+```
+composer require webtack/generic-controller
+```
+
+# Simple examples
+
+Use Generic as the parent classes. You can specify these classes as the parent for your custom view class and override the attribute values in the body of your class
+
+## TemplateController
+Suitable for displaying static pages that do not receive data from the database.
+
+```php
+
+use Webtack\GenericController\TemplateController;
+
+class AboutController extends TemplateController {
+	
+	/**
+	 * Init templateName property from view
+	 *
+	 * @return string
+	 */
+	function templateName() {
+		return "generic-about";
+	}
+}
+
+```
+Create a router and call the method in it @asView
+
+```php
+Route::get(/about', ['uses' => 'AboutController@asView']);
+
+```
+
+## DetailController
+It should be used when you want to get one model for a given key
+
+```php
+
+use App\Models\Article;
+use Webtack\GenericController\DetailController;
+
+class ArticlePageController extends DetailController {
+	
+	/**
+	 * Init Model from Query
+	 *
+	 * @return \Illuminate\Database\Eloquent\Model
+	 */
+	function model() {
+		return new Article();
+	}
+}
+
+```
+Create a router and call the method in it @asView
+
+```php
+Route::get(/article/{id}', ['uses' => 'ArticlePageController@asView']);
+
+```
+
+### Context data
+
+```php
+    protected function getContextData($request, $column = []){}
+```
+The method responsible for obtaining data from the database. <br>
+By default, there will be an attempt to get the model by the parameter ** id ** from the route
+
+But you can override this behavior by overloading this method. It must return an array with a context name key and an object of the model.
+
+```php
+protected function getContextData($request, $column = []) {
+    $article = $this->model();
+    $data = $article->where(['name' => 'Jhoon'])->first();
+    
+    return ['article' => $data];
+}
+
+```
+
+Or override get method
+
+```php
+
+		public function get($request, $name) {
+				$context = $this->getContextData($request, ['name' => $name]);
+				return $this->renderToResponse($context);
+		}
+```
+Supported methods correspond to request types.
+
+```php
+
+    public function get($request);
+    public function post($request);
+    public function put($request);
+    public function delete($request);
+    public function path($request);
+    public function options($request);
+
+```
+All methods accept the first object **\Illuminate\Http\Request $request**
+The following parameters can be those that you defined in your routes.
+
+### View Name
+
+By default, DetailController will search for a view with the name of the "art-page-class" class new, and you will also be able to override it in the **templateName** method
+
+Note the auxiliary methods **templatePrefix** and **templateSuffix**. <br>
+If you define them, the data will be appended to the name of the view returned by the method **templateName**
+
+### Context name
+
+The name of the access variable in the view will be taken from the name of the model class starting with a small letter.
+
+```php
+{{ $article->title }}
+
+```
+
+Of course you can override this in method **contextObjectName**
+
+```php
+protected function contextObjectName() {
+    return "foobar";
+}
+
+```
+
+## ListController
+Use to display the list of entities
+
+```php
+
+use Webtack\GenericController\ListController;
+
+class BlogPageController extends ListController {
+	
+	/**
+	 * @return \Illuminate\Database\Eloquent\Model
+	 */
+	public function model() {
+		return new Blog();
+	}
+	
+	/**
+	 * Init templateName from view
+	 *
+	 * @return string
+	 */
+	public function templateName() {
+		return 'blog';
+	}
+	
+	protected function templatePrefix() {
+		return 'blog.';
+	}
+}
+
+```
+Create a router and call the method in it @asView
+
+```php
+Route::get(/blog', ['uses' => 'BlogPageController@asView']);
+
+```
+
+By default, the name of the view will be appended with the suffix **- list**, but you can undo or override this behavior in the corresponding method, of course.
+
+## P.S.
+This is a small set of possibilities. But I think in the future I will expand it if necessary.

composer.json

@@ -3,7 +3,7 @@
     "license": "MIT",
     "type": "library",
     "version": "dev-master",
-    "keywords": ["laravel", "controller"],
+    "keywords": ["laravel", "controller", "generic", "webtack"],
     "authors": [
         {
             "name": "Ruslan Bilyshko",

src/GenericBaseController.php renamed to src/Controllers/BaseController.php

@@ -1,28 +1,31 @@
 <?php namespace Webtack\GenericController;
 
-use Illuminate\Routing\Controller as BaseController;
+use Illuminate\Routing\Controller as BaseRoutingController;
 use Illuminate\Http\Request;
 use Symfony\Component\Routing\Exception\MethodNotAllowedException;
 
 /**
- * Class GenericBaseController
+ * Class BaseController
  * --------------------------------------------------
  * Intentionally simple parent class for all views.
  * Only implements dispatch-by-method and simple sanity checking.
  *
  * @package Webtack\GenericView
  */
-class GenericBaseController extends BaseController {
+abstract class BaseController extends BaseRoutingController {
+	
 	/**
 	 * Allowed methods
+	 *
 	 * @var array
 	 */
 	protected $httpMethodNames = [
-			'GET',
-			'POST',
-			'PUT',
-			'PATCH',
-			'DELETE',
+		'GET',
+		'POST',
+		'PUT',
+		'PATCH',
+		'DELETE',
+		'OPTIONS',
 	];
 
 	/**
@@ -32,19 +35,19 @@ class GenericBaseController extends BaseController {
 	 *
 	 * @param \Illuminate\Http\Request $request
 	 *
-	 * @param array                    $parameters
-	 *
 	 * @return mixed
+	 * @internal param array $parameters
+	 *
 	 */
-	public function dispatch(Request $request, array $parameters) {
-		$method_name = $request->method();
+	public function dispatch($request) {
+		$method_name = $request->method();		
 
 		if (in_array($method_name, $this->httpMethodNames)) {
 
-			array_unshift($parameters, $request);			
-			return $this->callAction($method_name, $parameters);
+			return $this->callAction($method_name, $this->getRequestParameters($request));
 		}
 		else {
+			
 			$this->httpMethodNotAllowed($method_name);
 		}
 	}
@@ -57,17 +60,35 @@ public function dispatch(Request $request, array $parameters) {
 	 * @return \Illuminate\Http\Response
 	 */
 	public function asView(Request $request) {
-		$parameters = $request->route()->parameters;
-		$parameters = array_values($parameters);
-		return $this->dispatch($request, $parameters);
+		
+		return $this->dispatch($request);
 	}
 
+	/**
+	 * If the view was called with an unsupported HTTP method, this method will be called
+	 *
+	 * @param string $method_name
+	 */
 	protected function httpMethodNotAllowed(string $method_name) {
 		$class_name = __CLASS__;
-		
 		$message = "Method: [{$method_name}] Not Allowed in property " . "[\$httpMethodNames] on class [{$class_name}]";
 
 		throw new MethodNotAllowedException($this->httpMethodNames, $message);
 	}
 
+	/**
+	 * Passes parameters to the called method.
+	 * the rest are defined in your route
+	 *
+	 * @param \Illuminate\Http\Request $request
+	 *
+	 * @return array
+	 */
+	final protected function getRequestParameters($request) {
+		$parameters = $request->route()->parameters;
+		array_unshift($parameters, $request);
+		
+		return $parameters;
+	}
+	
 }

src/Controllers/DetailController.php

@@ -0,0 +1,23 @@
+<?php namespace Webtack\GenericController;
+
+
+use Webtack\GenericController\Traits\BaseTrait;
+use Webtack\GenericController\Traits\ContextTrait;
+use Webtack\GenericController\Traits\ModifierNameTrait;
+use Webtack\GenericController\Traits\SingleObjectContextTrait;
+use Webtack\GenericController\Traits\SingleObjectTemplateTrait;
+
+abstract class DetailController extends BaseController {
+		
+		use BaseTrait;
+		use ModifierNameTrait;
+		use SingleObjectTemplateTrait;
+		use SingleObjectContextTrait;
+		
+		
+		public function get($request) {
+				$context = $this->getContextData($request);
+				return $this->renderToResponse($context);
+		}
+		
+}

src/Controllers/ListController.php

@@ -0,0 +1,22 @@
+<?php namespace Webtack\GenericController;
+
+use Webtack\GenericController\Traits\BaseTrait;
+use Webtack\GenericController\Traits\ModifierNameTrait;
+use Webtack\GenericController\Traits\MultipleObjectContextTrait;
+use Webtack\GenericController\Traits\MultipleObjectTemplateTrait;
+
+
+abstract class ListController extends BaseController {
+	
+	use BaseTrait;
+	use ModifierNameTrait;
+	use MultipleObjectContextTrait;
+	use MultipleObjectTemplateTrait;
+	
+	public function get($request) {
+		$context = $this->getContextData($request);
+		return $this->renderToResponse($context);
+	}
+		
+		
+}

src/Controllers/TemplateController.php

@@ -0,0 +1,29 @@
+<?php namespace Webtack\GenericController;
+
+use Webtack\GenericController\Traits\BaseTrait;
+use Webtack\GenericController\Traits\TemplateTrait;
+
+
+/**
+ * Class TemplateController
+ * Processes the specified template using a context that contains parameters from the URL.
+ *
+ * @package Webtack\GenericController
+ */
+abstract class TemplateController extends BaseController {
+	
+	use BaseTrait;
+	use TemplateTrait;
+	
+	
+	public function get() {
+		return $this->renderToResponse();
+	}
+	
+	/**
+	 * Init templateName property from view
+	 *
+	 * @return string
+	 */
+	abstract function templateName();
+}

src/Traits/BaseTrait.php

@@ -0,0 +1,10 @@
+<?php namespace Webtack\GenericController\Traits;
+
+
+trait BaseTrait {
+		
+		public function __get($name) {
+				return call_user_func_array([$this, $name], []);
+		}
+		
+}