Added phpcs ruleset. Ran phpcbf to fix any phpcs errors.

Author: dave83649

README.md

@@ -3,7 +3,7 @@
 This repository contains the firewall engine of Patchstack.
 It can be implemented inside of other content management systems to provide firewall functionality.
 
-## How do I get set up? ##
+## How do I get it set up? ##
 
 Since the firewall engine depends on the opis/closure and laravel/serializable-closure packages which both require different PHP versions, sticking to one PHP version is tricky.
 
@@ -15,7 +15,8 @@ Therefore, in order to use this package, the composer install command must be ex
 - ✅ First initial concept and implementation
 - ⬜️ Unit tests
 - ⬜️ Test on many different environments and combinations with other plugins
-- ⬜️ Attach PHP CS Fixer
+- ✅ Attach PHP CS ruleset
+- ⬜️ Write proper readme instructions
 
 ## Who do I talk to? ##
 

phpcs.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ruleset name="Patchstack CS" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="Patchstack">
+    <arg name="colors"/>
+    <arg name="extensions" value="php"/>
+    <file>./src</file>
+    <file>./tests</file>
+    <exclude-pattern>*/vendor/*</exclude-pattern>
+    <rule ref="PSR12">
+        <exclude name="Generic.Files.LineLength.TooLong" />
+        <exclude name="Generic.Files.LowercasedFilename.NotFound" />
+        <exclude name="PSR1.Classes.ClassDeclaration.MissingNamespace" />
+    </rule>
+</ruleset>

src/Extensions/ExtensionInterface.php

@@ -10,57 +10,57 @@ interface ExtensionInterface
 {
     /**
      * Log the request, this can be of type BLOCK, LOG or REDIRECT.
-     * 
-     * @param int $ruleId
-     * @param string $bodyData
-     * @param string $blockType
+     *
+     * @param  int    $ruleId
+     * @param  string $bodyData
+     * @param  string $blockType
      * @return void
      */
     public function logRequest($ruleId, $bodyData, $blockType);
 
     /**
      * Determine if the current visitor can bypass the firewall.
-     * 
+     *
      * @return bool
      */
     public function canBypass();
 
     /**
      * Determine if the visitor is blocked from the website.
-     * 
-     * @param int $minutes
-     * @param int $blockTime
-     * @param int $attempts
+     *
+     * @param  int $minutes
+     * @param  int $blockTime
+     * @param  int $attempts
      * @return bool
      */
     public function isBlocked($minutes, $blockTime, $attempts);
 
     /**
      * Force exit the page when a request has been blocked.
-     * 
-     * @param int $ruleId
+     *
+     * @param  int $ruleId
      * @return void
      */
     public function forceExit($ruleId);
 
     /**
      * Get the IP address of the request.
-     * 
+     *
      * @return string
      */
     public function getIpAddress();
 
     /**
      * Determine if the request should be passed without going through the firewall.
-     * 
+     *
      * @param array $whitelistRules
      * @param array $request
      */
     public function isWhitelisted($whitelistRules, $request);
 
     /**
      * Determine if the current request is a file upload request.
-     * 
+     *
      * @return boolean
      */
     public function isFileUploadRequest();

src/Extensions/Test/Extension.php

@@ -8,10 +8,10 @@ class Extension implements ExtensionInterface
 {
     /**
      * Log the request, this can be of type BLOCK, LOG or REDIRECT.
-     * 
-     * @param int $ruleId
-     * @param string $bodyData
-     * @param string $blockType
+     *
+     * @param  int    $ruleId
+     * @param  string $bodyData
+     * @param  string $blockType
      * @return void
      */
     public function logRequest($ruleId, $bodyData, $blockType)
@@ -21,7 +21,7 @@ public function logRequest($ruleId, $bodyData, $blockType)
 
     /**
      * Determine if the current visitor can bypass the firewall.
-     * 
+     *
      * @return bool
      */
     public function canBypass()
@@ -31,10 +31,10 @@ public function canBypass()
 
     /**
      * Determine if the visitor is blocked from the website.
-     * 
-     * @param int $minutes
-     * @param int $blockTime
-     * @param int $attempts
+     *
+     * @param  int $minutes
+     * @param  int $blockTime
+     * @param  int $attempts
      * @return bool
      */
     public function isBlocked($minutes, $blockTime, $attempts)
@@ -44,8 +44,8 @@ public function isBlocked($minutes, $blockTime, $attempts)
 
     /**
      * Force exit the page when a request has been blocked.
-     * 
-     * @param int $ruleId
+     *
+     * @param  int $ruleId
      * @return void
      */
     public function forceExit($ruleId)
@@ -55,7 +55,7 @@ public function forceExit($ruleId)
 
     /**
      * Get the IP address of the request.
-     * 
+     *
      * @return string
      */
     public function getIpAddress()
@@ -65,7 +65,7 @@ public function getIpAddress()
 
     /**
      * Determine if the request should not go through the firewall.
-     * 
+     *
      * @param array $whitelistRules
      * @param array $request
      */
@@ -76,11 +76,11 @@ public function isWhitelisted($whitelistRules, $request)
 
     /**
      * Determine if the current request is a file upload request.
-     * 
+     *
      * @return boolean
      */
     public function isFileUploadRequest()
     {
         return false;
     }
-}
+}