Add Presentation service for better usage of view engine.

Author: Marco Bunge

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Hawkbit Presentation Changelog
 
+## 1.1.0
+
+### Added
+
+ - Add Hawkbit controller constructor injection support for presentation
+ - Add presentation service for extensible engine configuration and encapsulated view logic
+
 ## 1.0.1
 
 ### Added

README.md

@@ -7,7 +7,7 @@
 [![Coverage Status][ico-coveralls]][link-coveralls]
 
 Presentation layer for Hawkbit PSR-7 Micro PHP framework.
-Hawkbit Persitence uses factories of `dasprid/container-interop-doctrine` and wraps them with in a PresentationService
+Hawkbit Presentation uses [`league/plates`](http://platesphp.com/) as view engine and wraps it with in a PresentationService
 
 ## Install
 
@@ -70,23 +70,13 @@ $app->register(new PresentationServiceProvider([
 ]));
 ```
 
-### Full configuration
-
-A full configuration is available on [DASPRiD/container-interop-doctrine/example/full-config.php](https://github.com/DASPRiD/container-interop-doctrine/blob/master/example/full-config.php). 
-Refer to [container-interop-doctrine Documentation](https://github.com/DASPRiD/container-interop-doctrine) for further instructions on factories.
-
 ### Presentation from Hawbit Application
 
 ```php
 <?php
 
-/** @var \Hawkbit\Presentation\PresentationServiceInterface $Presentation */
-$Presentation = $app[\Hawkbit\Presentation\PresentationServiceInterface::class];
-
-$em = $Presentation->getEntityManager();
-
-// or with from specific connection
-$em = $Presentation->getEntityManager('connectionname');
+/** @var \Hawkbit\Presentation\PresentationService $Presentation */
+$service = $app[\Hawkbit\Presentation\PresentationService::class];
 
 ```
 
@@ -97,28 +87,58 @@ Access Presentation service in controller. Hawbit is inject classes to controlle
 ```php
 <?php
 
-use \Hawkbit\Presentation\PresentationServiceInterface;
+use \Hawkbit\Presentation\PresentationService;
+use Psr\Http\Message\ServerRequestInterface;
+use Psr\Http\Message\ResponseInterface;
 
-class MyController{
-    
+class MyController
+{
     /**
-     * @var \Hawkbit\Presentation\PresentationServiceInterface 
+     * @var PresentationService
      */
-    private $Presentation = null;
-    
-    public function __construct(PresentationServiceInterface $Presentation){
-        $this->Presentation = $Presentation;
+    private $presentationService;
+
+    /**
+     * TestInjectableController constructor.
+     * @param PresentationService $presentation
+     */
+    public function __construct(PresentationService $presentation)
+    {
+        $this->presentationService = $presentation;
     }
-    
-    public function index(){
-        $em = $this->Presentation->getEntityManager();
-        
-        // or with from specific connection
-        $em = $this->Presentation->getEntityManager('connectionname');
+
+    public function getIndex(ServerRequestInterface $request, ResponseInterface $response, array $args = [])
+    {
+        $response->getBody()->write($this->presentationService->render('index', ['world' => 'World']));
+        return $response;
     }
 }
 ```
 
+### Access and extend engine
+
+In most cases you would like to extend or access plates. We recommend to extend plates
+in a central point of your application like bootstrap or even better in your project service provider.
+
+```php
+<?php
+
+use Hawkbit\Presentation\PresentationService;
+
+/** @var PresentationService $service */
+$service = $app->getContainer()->get(PresentationService::class);
+$service->getEngine()
+    ->addFolder('acme', __DIR__ . '/templates/acme')
+    ->registerFunction('uppercase', function ($string) {
+        return strtoupper($string);
+    });
+
+```
+
+### Plates
+
+Please refer to [plates documentation](http://platesphp.com) for more details.
+
 ## Change log
 
 Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
@@ -140,6 +160,7 @@ If you discover any security related issues, please email <[email protected]> instead
 ## Credits
 
 - [Marco Bunge](https://github.com/mbunge)
+- [Jonathan Reinik (Plates)](https://github.com/reinink)
 - [All contributors](https://github.com/hawkbit/Presentation/graphs/contributors)
 
 ## License

src/PresentationService.php

@@ -0,0 +1,104 @@
+<?php
+/**
+ * Created by PhpStorm.
+ * User: marco.bunge
+ * Date: 02.01.2017
+ * Time: 11:16
+ */
+
+namespace Hawkbit\Presentation;
+
+
+use Hawkbit\Configuration;
+use League\Plates\Engine;
+use League\Plates\Template\Template;
+
+class PresentationService
+{
+
+    /** @var Engine */
+    private $engine;
+
+    /**
+     * EngineFactory constructor.
+     * @param array|Configuration $templates
+     */
+    public function __construct($templates)
+    {
+        // normalize template config to array
+        if($templates instanceof Configuration){
+            $templates = $templates->toArray();
+        }
+
+        // determine default
+        if(isset($templates['default'])){
+            $default = $templates['default'];
+            unset($templates['default']);
+        }else{
+            $default = array_shift($templates);
+        }
+
+        // build engine
+        $engine = new Engine($default);
+        foreach ($templates as $name => $template) {
+            $engine->addFolder($name, $template, false);
+        }
+
+        $this->engine = $engine;
+    }
+
+    public function getEngine(){
+        return $this->engine;
+    }
+
+    /**
+     * Add preassigned template data.
+     * @param  array             $data;
+     * @param  null|string|array $templates;
+     * @return $this
+     */
+    public function addData(array $data, $templates = null){
+        $this->engine->addData($data, $templates);
+        return $this;
+    }
+
+    /**
+     * Get all preassigned template data.
+     * @param  null|string $template;
+     * @return array
+     */
+    public function getData($template){
+        return $this->engine->getData($template);
+    }
+
+    /**
+     * Check if a template exists.
+     * @param  string  $name
+     * @return boolean
+     */
+    public function exists($name)
+    {
+        return $this->engine->exists($name);
+    }
+
+    /**
+     * Create a new template.
+     * @param  string   $name
+     * @return Template
+     */
+    public function make($name)
+    {
+        return $this->engine->make($name);
+    }
+
+    /**
+     * Create a new template and render it.
+     * @param  string $name
+     * @param  array  $data
+     * @return string
+     */
+    public function render($name, array $data = array())
+    {
+        return $this->engine->render($name, $data);
+    }
+}

src/PresentationServiceProvider.php

@@ -9,23 +9,22 @@
 namespace Hawkbit\Presentation;
 
 
+use Hawkbit\Configuration;
 use League\Container\ServiceProvider\AbstractServiceProvider;
+use League\Container\ServiceProvider\BootableServiceProviderInterface;
 use League\Plates\Engine;
 
-class PresentationServiceProvider extends AbstractServiceProvider
+class PresentationServiceProvider extends AbstractServiceProvider implements BootableServiceProviderInterface
 {
 
-    protected $provides = [
-        Engine::class
-    ];
     /**
-     * @var array
+     * @var
      */
     private $templates;
 
     /**
      * PresentationServiceProvider constructor.
-     * @param array $templates
+     * @param $templates
      */
     public function __construct($templates)
     {
@@ -41,26 +40,19 @@ public function __construct($templates)
      */
     public function register()
     {
-        $this->registerTemplateEngine();
+
     }
 
     /**
-     * Register template engine
+     * Method will be invoked on registration of a service provider implementing
+     * this interface. Provides ability for eager loading of Service Providers.
      *
-     * @return $this
+     * @return void
      */
-    protected function registerTemplateEngine()
+    public function boot()
     {
         $container = $this->getContainer();
-        $this->getContainer()->add(Engine::class, function () use ($container) {
-            $templates = $this->templates;
-            $default = isset($templates['default']) ? $templates['default'] : reset($templates);
-            $engine = new Engine($default);
-            foreach ($templates as $name => $template) {
-                $engine->addFolder($name, $template, false);
-            }
-            return $engine;
-        });
-        return $this;
+        $container->share(PresentationService::class)
+            ->withArgument($this->templates);
     }
 }

tests/IntegrationTest.php

@@ -12,11 +12,14 @@
 use ContainerInteropDoctrine\EntityManagerFactory;
 use Doctrine\ORM\EntityManagerInterface;
 use Hawkbit\Application;
+use Hawkbit\Presentation\Presentation;
 use Hawkbit\Presentation\PresentationService;
 use Hawkbit\Presentation\PresentationServiceInterface;
 use Hawkbit\Presentation\PresentationServiceProvider;
+use Hawkbit\Presentation\Tests\Mocks\InjectableController;
 use League\Plates\Engine;
 use org\bovigo\vfs\vfsStream;
+use Zend\Diactoros\ServerRequestFactory;
 
 class IntegrationTest extends \PHPUnit_Framework_TestCase
 {
@@ -26,10 +29,42 @@ public function testIntegration()
         $app = new Application(require __DIR__ . '/assets/config.php');
         $app->register(new PresentationServiceProvider($app->getConfig('templates')));
 
-        $engine = $app[Engine::class];
+        $engine = $app[PresentationService::class];
         $result = $engine->render('index', ['world' => 'World']);
 
-        $this->assertInstanceOf(Engine::class, $engine);
+        $this->assertInstanceOf(PresentationService::class, $engine);
         $this->assertEquals('Hello World', $result);
     }
+
+    public function testInjectableIntegration()
+    {
+        $app = new Application(require __DIR__ . '/assets/config.php');
+        $app->register(new PresentationServiceProvider($app->getConfig('templates')));
+
+        $app->get('/', [InjectableController::class, 'getIndex']);
+
+        $response = $app->handle(ServerRequestFactory::fromGlobals());
+
+        $this->assertEquals('Hello World', $response->getBody()->__toString());
+    }
+
+    public function testExtendEngine()
+    {
+        $app = new Application(require __DIR__ . '/assets/config.php');
+        $app->register(new PresentationServiceProvider($app->getConfig('templates')));
+
+        /** @var PresentationService $service */
+        $service = $app[PresentationService::class];
+        $service->getEngine()
+            ->addFolder('acme', __DIR__ . '/templates/acme')
+            ->registerFunction('uppercase', function ($string) {
+                return strtoupper($string);
+            });
+
+        $app->get('/', [InjectableController::class, 'getAcme']);
+        $response = $app->handle(ServerRequestFactory::fromGlobals());
+        $this->assertEquals('FOO BAR', $response->getBody()->__toString());
+    }
+
+
 }