Merge pull request #122 from FriendsOfCake/plugin-class

Move plugin bootstrapping and routes setting within Plugin class
FriendsOfCake · Dec 21, 2019 · 500bfa2 · 500bfa2
2 parents f1d8565 + b9eb3b6
commit 500bfa2
Show file tree

Hide file tree

Showing 4 changed files with 50 additions and 34 deletions.
diff --git a/config/bootstrap.php b/config/bootstrap.php
diff --git a/config/routes.php b/config/routes.php
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -24,6 +24,9 @@
     <filter>
         <whitelist>
             <directory suffix=".php">src/</directory>
+            <exclude>
+                <file>src/Plugin.php</file>
+            </exclude>
         </whitelist>
     </filter>
 

diff --git a/src/Plugin.php b/src/Plugin.php
@@ -4,6 +4,12 @@
 namespace CsvView;
 
 use Cake\Core\BasePlugin;
+use Cake\Core\PluginApplicationInterface;
+use Cake\Event\EventInterface;
+use Cake\Event\EventManager;
+use Cake\Http\ServerRequest;
+use Cake\Routing\RouteBuilder;
+use Cake\Routing\Router;
 
 class Plugin extends BasePlugin
 {
@@ -13,4 +19,45 @@ class Plugin extends BasePlugin
      * @var string
      */
     protected $name = 'CsvView';
+
+    /**
+     * @inheritDoc
+     */
+    public function bootstrap(PluginApplicationInterface $app): void
+    {
+        /**
+         * Add CsvView to View class map through RequestHandler, if available, on Controller initialisation
+         *
+         * @link https://book.cakephp.org/4/en/controllers/components/request-handling.html#using-custom-viewclasses
+         */
+        EventManager::instance()->on('Controller.initialize', function (EventInterface $event) {
+            $controller = $event->getSubject();
+            if ($controller->components()->has('RequestHandler')) {
+                $controller->RequestHandler->setConfig('viewClassMap.csv', 'CsvView.Csv');
+            }
+        });
+
+        /**
+         * Add a request detector named "csv" to check whether the request was for a CSV,
+         * either through accept header or file extension
+         *
+         * @link https://book.cakephp.org/4/en/controllers/request-response.html#checking-request-conditions
+         */
+        ServerRequest::addDetector(
+            'csv',
+            [
+                'accept' => ['text/csv'],
+                'param' => '_ext',
+                'value' => 'csv',
+            ]
+        );
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function routes(RouteBuilder $routes): void
+    {
+        Router::extensions('csv');
+    }
 }