Merge pull request #399 from perftools/render-method

perftools · Dec 23, 2020 · 2c6db92 · 2c6db92
2 parents dafc4e2 + 59a78f0
commit 2c6db92
Show file tree

Hide file tree

Showing 11 changed files with 73 additions and 115 deletions.
diff --git a/src/AbstractController.php b/src/AbstractController.php
@@ -2,20 +2,12 @@
 
 namespace XHGui;
 
+use Slim\Http\Response;
 use Slim\Slim as App;
+use Slim\Views\Twig;
 
 abstract class AbstractController
 {
-    /**
-     * @var array
-     */
-    protected $_templateVars = [];
-
-    /**
-     * @var string|null
-     */
-    protected $_template = null;
-
     /**
      * @var App
      */
@@ -26,31 +18,16 @@ public function __construct(App $app)
         $this->app = $app;
     }
 
-    public function set($vars)
+    protected function render(string $template, array $data = [])
     {
-        $this->_templateVars = array_merge($this->_templateVars, $vars);
-    }
-
-    public function templateVars()
-    {
-        return $this->_templateVars;
-    }
-
-    public function render()
-    {
-        // We want to render the specified Twig template to the output buffer.
-        // The simplest way to do that is Slim::render, but that is not allowed
-        // in middleware, because it uses Slim\View::display which prints
-        // directly to the native PHP output buffer.
-        // Doing that is problematic, because the HTTP headers set via $app->response()
-        // must be output first, which won't happen until after the middleware
-        // is completed. Output of headers and body is done by the Slim::run entry point.
-
-        // The below is copied from Slim::render (slim/slim@2.6.3).
-        // Modified to use View::fetch + Response::write, instead of View::display.
-        $this->app->view->appendData($this->_templateVars);
-        $body = $this->app->view->fetch($this->_template);
-        $this->app->response->write($body);
+        /** @var Response $response */
+        $response = $this->app->response;
+        /** @var Twig $renderer */
+        $renderer = $this->app->view;
+
+        $renderer->appendData($data);
+        $body = $renderer->fetch($template);
+        $response->write($body);
     }
 
     protected function config(string $key)

diff --git a/src/Controller/CustomController.php b/src/Controller/CustomController.php
@@ -23,7 +23,7 @@ public function __construct(App $app, SearcherInterface $searcher)
 
     public function get()
     {
-        $this->_template = 'custom/create.twig';
+        $this->render('custom/create.twig');
     }
 
     public function help(Request $request)
@@ -33,8 +33,7 @@ public function help(Request $request)
         } else {
             $res = $this->searcher->latest();
         }
-        $this->_template = 'custom/help.twig';
-        $this->set([
+        $this->render('custom/help.twig', [
             'data' => print_r($res->toArray(), 1),
         ]);
     }

diff --git a/src/Controller/RunController.php b/src/Controller/RunController.php
@@ -71,14 +71,13 @@ public function index(Request $request, Response $response)
             'direction' => $result['direction'],
         ];
 
-        $this->_template = 'runs/list.twig';
-        $this->set([
+        $this->render('runs/list.twig', [
             'paging' => $paging,
             'base_url' => 'home',
             'runs' => $result['results'],
             'date_format' => $this->config('date.format'),
             'search' => $search,
-            'has_search' => strlen(implode('', $search)) > 0,
+            'has_search' => implode('', $search) !== '',
             'title' => $title,
         ]);
     }
@@ -120,8 +119,7 @@ public function view(Request $request, Response $response)
             $profile = $result->sort('ewt', $result->getProfile());
         }
 
-        $this->_template = 'runs/view.twig';
-        $this->set([
+        $this->render('runs/view.twig', [
             'profile' => $profile,
             'result' => $result,
             'wall_time' => $timeChart,
@@ -157,8 +155,7 @@ public function deleteForm(Request $request)
         // Get details
         $result = $this->searcher->get($id);
 
-        $this->_template = 'runs/delete-form.twig';
-        $this->set([
+        $this->render('runs/delete-form.twig', [
             'run_id' => $id,
             'result' => $result,
         ]);
@@ -185,7 +182,7 @@ public function deleteSubmit(Request $request)
 
     public function deleteAllForm()
     {
-        $this->_template = 'runs/delete-all-form.twig';
+        $this->render('runs/delete-all-form.twig');
     }
 
     public function deleteAllSubmit()
@@ -239,8 +236,7 @@ public function url(Request $request)
             'direction' => $runs['direction'],
         ];
 
-        $this->_template = 'runs/url.twig';
-        $this->set([
+        $this->render('runs/url.twig', [
             'paging' => $paging,
             'base_url' => 'url.view',
             'runs' => $runs['results'],
@@ -288,8 +284,7 @@ public function compare(Request $request)
             $comparison = $baseRun->compare($headRun);
         }
 
-        $this->_template = 'runs/compare.twig';
-        $this->set([
+        $this->render('runs/compare.twig', [
             'base_url' => 'run.compare',
             'base_run' => $baseRun,
             'head_run' => $headRun,
@@ -314,8 +309,7 @@ public function symbol(Request $request)
         $profile->calculateSelf();
         list($parents, $current, $children) = $profile->getRelatives($symbol);
 
-        $this->_template = 'runs/symbol.twig';
-        $this->set([
+        $this->render('runs/symbol.twig', [
             'symbol' => $symbol,
             'id' => $id,
             'main' => $profile->get('main()'),
@@ -336,8 +330,7 @@ public function symbolShort(Request $request)
         $profile->calculateSelf();
         list($parents, $current, $children) = $profile->getRelatives($symbol, $metric, $threshold);
 
-        $this->_template = 'runs/symbol-short.twig';
-        $this->set([
+        $this->render('runs/symbol-short.twig', [
             'symbol' => $symbol,
             'id' => $id,
             'main' => $profile->get('main()'),
@@ -351,8 +344,7 @@ public function callgraph(Request $request)
     {
         $profile = $this->searcher->get($request->get('id'));
 
-        $this->_template = 'runs/callgraph.twig';
-        $this->set([
+        $this->render('runs/callgraph.twig', [
             'profile' => $profile,
             'date_format' => $this->config('date.format'),
         ]);

diff --git a/src/Controller/WatchController.php b/src/Controller/WatchController.php
@@ -24,8 +24,7 @@ public function get()
     {
         $watched = $this->searcher->getAllWatches();
 
-        $this->_template = 'watch/list.twig';
-        $this->set(['watched' => $watched]);
+        $this->render('watch/list.twig', ['watched' => $watched]);
     }
 
     public function post(Request $request)

diff --git a/src/Controller/WaterfallController.php b/src/Controller/WaterfallController.php
@@ -47,8 +47,7 @@ public function index()
             'direction' => $result['direction'],
         ];
 
-        $this->_template = 'waterfall/list.twig';
-        $this->set([
+        $this->render('waterfall/list.twig', [
             'runs' => $result['results'],
             'search' => $search,
             'paging' => $paging,

diff --git a/src/Middleware/RenderMiddleware.php b/src/Middleware/RenderMiddleware.php
diff --git a/src/ServiceContainer.php b/src/ServiceContainer.php
@@ -13,7 +13,6 @@
 use Slim\Slim as App;
 use Slim\Views\Twig;
 use XHGui\Db\PdoRepository;
-use XHGui\Middleware\RenderMiddleware;
 use XHGui\Saver\NormalizingSaver;
 use XHGui\Searcher\MongoSearcher;
 use XHGui\Searcher\PdoSearcher;
@@ -99,9 +98,6 @@ protected function _slimApp()
                 'httponly' => true,
             ]));
 
-            // Add renderer.
-            $app->add(new RenderMiddleware());
-
             $view = $c['view'];
             $view->parserExtensions = [
                 new TwigExtension($app),

diff --git a/src/ServiceProvider/RouteProvider.php b/src/ServiceProvider/RouteProvider.php
@@ -27,9 +27,6 @@ private function registerRoutes(Container $di, App $app)
                 new TwigExtension($app),
             ];
 
-            // Remove the controller so we don't render it.
-            unset($app->controller);
-
             $app->view($view);
             $app->render('error/view.twig', [
                 'message' => $e->getMessage(),
@@ -40,7 +37,7 @@ private function registerRoutes(Container $di, App $app)
         // Profile Runs routes
         $app->get('/', static function () use ($di, $app) {
             /** @var Controller\RunController $controller */
-            $controller = $app->controller = $di['runController'];
+            $controller = $di['runController'];
             $request = $app->request();
             $response = $app->response();
 
@@ -49,7 +46,7 @@ private function registerRoutes(Container $di, App $app)
 
         $app->get('/run/view', static function () use ($di, $app) {
             /** @var Controller\RunController $controller */
-            $controller = $app->controller = $di['runController'];
+            $controller = $di['runController'];
             $request = $app->request();
             $response = $app->response();
 
@@ -58,7 +55,7 @@ private function registerRoutes(Container $di, App $app)
 
         $app->get('/run/delete', static function () use ($di, $app) {
             /** @var Controller\RunController $controller */
-            $controller = $app->controller = $di['runController'];
+            $controller = $di['runController'];
             $request = $app->request();
 
             $controller->deleteForm($request);
@@ -72,9 +69,9 @@ private function registerRoutes(Container $di, App $app)
             $controller->deleteSubmit($request);
         })->setName('run.delete.submit');
 
-        $app->get('/run/delete_all', static function () use ($di, $app) {
+        $app->get('/run/delete_all', static function () use ($di) {
             /** @var Controller\RunController $controller */
-            $controller = $app->controller = $di['runController'];
+            $controller = $di['runController'];
             $controller->deleteAllForm();
         })->setName('run.deleteAll.form');
 
@@ -86,39 +83,39 @@ private function registerRoutes(Container $di, App $app)
 
         $app->get('/url/view', static function () use ($di, $app) {
             /** @var Controller\RunController $controller */
-            $controller = $app->controller = $di['runController'];
+            $controller = $di['runController'];
             $request = $app->request();
 
             $controller->url($request);
         })->setName('url.view');
 
         $app->get('/run/compare', static function () use ($di, $app) {
             /** @var Controller\RunController $controller */
-            $controller = $app->controller = $di['runController'];
+            $controller = $di['runController'];
             $request = $app->request();
 
             $controller->compare($request);
         })->setName('run.compare');
 
         $app->get('/run/symbol', static function () use ($di, $app) {
             /** @var Controller\RunController $controller */
-            $controller = $app->controller = $di['runController'];
+            $controller = $di['runController'];
             $request = $app->request();
 
             $controller->symbol($request);
         })->setName('run.symbol');
 
         $app->get('/run/symbol/short', static function () use ($di, $app) {
             /** @var Controller\RunController $controller */
-            $controller = $app->controller = $di['runController'];
+            $controller = $di['runController'];
             $request = $app->request();
 
             $controller->symbolShort($request);
         })->setName('run.symbol-short');
 
         $app->get('/run/callgraph', static function () use ($di, $app) {
             /** @var Controller\RunController $controller */
-            $controller = $app->controller = $di['runController'];
+            $controller = $di['runController'];
             $request = $app->request();
 
             $controller->callgraph($request);
@@ -153,9 +150,9 @@ private function registerRoutes(Container $di, App $app)
         })->setName('run.import');
 
         // Watch function routes.
-        $app->get('/watch', static function () use ($di, $app) {
+        $app->get('/watch', static function () use ($di) {
             /** @var Controller\WatchController $controller */
-            $controller = $app->controller = $di['watchController'];
+            $controller = $di['watchController'];
             $controller->get();
         })->setName('watch.list');
 
@@ -168,15 +165,15 @@ private function registerRoutes(Container $di, App $app)
         })->setName('watch.save');
 
         // Custom report routes.
-        $app->get('/custom', static function () use ($di, $app) {
+        $app->get('/custom', static function () use ($di) {
             /** @var Controller\CustomController $controller */
-            $controller = $app->controller = $di['customController'];
+            $controller = $di['customController'];
             $controller->get();
         })->setName('custom.view');
 
         $app->get('/custom/help', static function () use ($di, $app) {
             /** @var Controller\CustomController $controller */
-            $controller = $app->controller = $di['customController'];
+            $controller = $di['customController'];
             $request = $app->request();
 
             $controller->help($request);
@@ -192,9 +189,9 @@ private function registerRoutes(Container $di, App $app)
         })->setName('custom.query');
 
         // Waterfall routes
-        $app->get('/waterfall', static function () use ($di, $app) {
+        $app->get('/waterfall', static function () use ($di) {
             /** @var Controller\WaterfallController $controller */
-            $controller = $app->controller = $di['waterfallController'];
+            $controller = $di['waterfallController'];
             $controller->index();
         })->setName('waterfall.list');