add phpcs.xml.dist

Author: mtak3

composer.json

@@ -37,7 +37,9 @@
         }
     },
     "scripts": {
-        "test": "phpunit"
+        "test": "phpunit",
+        "cs-check": "phpcs src/ tests/",
+        "cs-fix": "phpcbf src/ tests/"
     },
     "extra": {
         "branch-alias": {

phpcs.xml.dist

@@ -0,0 +1,11 @@
+<?xml version="1.0"?>
+<ruleset name="CustomCakePHPCodeSniffer">
+
+    <exclude-pattern>tests/bootstrap.php</exclude-pattern>
+
+    <rule ref="vendor/cakephp/cakephp-codesniffer/CakePHP">
+        <exclude name="CakePHP.Commenting"/>
+    </rule>
+
+</ruleset>
+

src/Controller/Component/ApiPaginationComponent.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 namespace BryanCrowe\ApiPagination\Controller\Component;
 
 use Cake\Controller\Component;
@@ -19,7 +21,7 @@ class ApiPaginationComponent extends Component
     protected $_defaultConfig = [
         'key' => 'pagination',
         'aliases' => [],
-        'visible' => []
+        'visible' => [],
     ];
 
     /**
@@ -98,7 +100,8 @@ protected function setVisibility()
      */
     protected function isPaginatedApiRequest()
     {
-        if ($this->getController()->getRequest()->getAttribute('paging') 
+        if (
+            $this->getController()->getRequest()->getAttribute('paging')
             && $this->getController()->getRequest()->is(['json', 'xml'])
         ) {
             return true;

tests/Fixture/ArticlesFixture.php

@@ -11,7 +11,7 @@ class ArticlesFixture extends TestFixture
         'id' => ['type' => 'integer'],
         'title' => ['type' => 'string', 'null' => false],
         'body' => 'text',
-        '_constraints' => ['primary' => ['type' => 'primary', 'columns' => ['id']]]
+        '_constraints' => ['primary' => ['type' => 'primary', 'columns' => ['id']]],
     ];
 
     public $records = [
@@ -37,6 +37,6 @@ class ArticlesFixture extends TestFixture
         ['title' => 'Post #20', 'body' => 'This is the article body.'],
         ['title' => 'Post #21', 'body' => 'This is the article body.'],
         ['title' => 'Post #22', 'body' => 'This is the article body.'],
-        ['title' => 'Post #23', 'body' => 'This is the article body.']
+        ['title' => 'Post #23', 'body' => 'This is the article body.'],
     ];
 }

tests/TestCase/Controller/Component/ApiPaginationComponentTest.php

@@ -1,11 +1,12 @@
 <?php
+declare(strict_types=1);
+
 namespace BryanCrowe\ApiPagination\Test;
 
 use BryanCrowe\ApiPagination\Controller\Component\ApiPaginationComponent;
 use BryanCrowe\ApiPagination\TestApp\Controller\ArticlesController;
 use Cake\Event\Event;
 use Cake\Http\ServerRequest as Request;
-use Cake\Http\Response;
 use Cake\ORM\TableRegistry;
 use Cake\TestSuite\TestCase;
 
@@ -108,15 +109,16 @@ public function testVisibilitySettings()
         );
         $this->controller->set('data', $this->controller->paginate($this->Articles));
         $apiPaginationComponent = new ApiPaginationComponent(
-            $this->controller->components(), [
+            $this->controller->components(),
+            [
             'visible' => [
                 'page',
                 'current',
                 'count',
                 'prevPage',
                 'nextPage',
-                'pageCount'
-            ]
+                'pageCount',
+            ],
             ]
         );
         $event = new Event('Controller.beforeRender', $this->controller);
@@ -147,12 +149,13 @@ public function testAliasSettings()
         );
         $this->controller->set('data', $this->controller->paginate($this->Articles));
         $apiPaginationComponent = new ApiPaginationComponent(
-            $this->controller->components(), [
+            $this->controller->components(),
+            [
             'aliases' => [
                 'page' => 'curPage',
                 'current' => 'currentCount',
                 'count' => 'totalCount',
-            ]
+            ],
             ]
         );
         $event = new Event('Controller.beforeRender', $this->controller);
@@ -195,8 +198,9 @@ public function testKeySetting()
         );
         $this->controller->set('data', $this->controller->paginate($this->Articles));
         $apiPaginationComponent = new ApiPaginationComponent(
-            $this->controller->components(), [
-            'key' => 'paging'
+            $this->controller->components(),
+            [
+            'key' => 'paging',
             ]
         );
         $event = new Event('Controller.beforeRender', $this->controller);
@@ -239,20 +243,21 @@ public function testAllSettings()
         );
         $this->controller->set('data', $this->controller->paginate($this->Articles));
         $apiPaginationComponent = new ApiPaginationComponent(
-            $this->controller->components(), [
+            $this->controller->components(),
+            [
             'key' => 'fun',
             'aliases' => [
                 'page' => 'currentPage',
                 'count' => 'totalCount',
-                'limit' => 'unusedAlias'
+                'limit' => 'unusedAlias',
             ],
             'visible' => [
                 'currentPage',
                 'totalCount',
                 'limit',
                 'prevPage',
-                'nextPage'
-            ]
+                'nextPage',
+            ],
             ]
         );
         $event = new Event('Controller.beforeRender', $this->controller);

tests/bootstrap.php

@@ -13,7 +13,7 @@
 unset($findRoot);
 chdir($root);
 if (file_exists($root . '/config/bootstrap.php')) {
-    include $root . '/config/bootstrap.php';
+    require $root . '/config/bootstrap.php';
     return;
 }
 require $root . '/vendor/cakephp/cakephp/tests/bootstrap.php';

tests/test_app/TestApp/Controller/ArticlesController.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 namespace BryanCrowe\ApiPagination\TestApp\Controller;
 
 use Cake\Controller\Controller;