Update PHPDoc

riverside · Jul 8, 2023 · 2f09bd7 · 2f09bd7
1 parent fe990a6
commit 2f09bd7
Show file tree

Hide file tree

Showing 6 changed files with 30 additions and 4 deletions.
diff --git a/src/BaseFilter.php b/src/BaseFilter.php
@@ -9,11 +9,15 @@
 abstract class BaseFilter
 {
     /**
+     * Payloads
+     *
      * @var array
      */
     protected $payloads = array();
 
     /**
+     * Payload filename
+     *
      * @var string
      */
     protected $payloads_file = "";

diff --git a/src/Filter/CRLF.php b/src/Filter/CRLF.php
@@ -11,6 +11,8 @@
 class CRLF extends BaseFilter
 {
     /**
+     * Payload filename
+     *
      * @var string
      */
     protected $payloads_file = "crlf.txt";

diff --git a/src/Filter/SQL.php b/src/Filter/SQL.php
@@ -11,6 +11,8 @@
 class SQL extends BaseFilter
 {
     /**
+     * Payload filename
+     *
      * @var string
      */
     protected $payloads_file = "sql.txt";

diff --git a/src/Filter/XML.php b/src/Filter/XML.php
@@ -11,6 +11,8 @@
 class XML extends BaseFilter
 {
     /**
+     * Payload filename
+     *
      * @var string
      */
     protected $payloads_file = "xml.txt";

diff --git a/src/Filter/XSS.php b/src/Filter/XSS.php
@@ -11,6 +11,8 @@
 class XSS extends BaseFilter
 {
     /**
+     * Payload filename
+     *
      * @var string
      */
     protected $payloads_file = "xss.txt";

diff --git a/src/Firewall.php b/src/Firewall.php
@@ -186,6 +186,7 @@ public function disable(string $filter): Firewall
      * @param string $value
      * @param string $filter
      * @return Firewall
+     * @throws \Exception
      */
     public function handle(string $value, string $filter): Firewall
     {
@@ -212,21 +213,34 @@ public function handle(string $value, string $filter): Firewall
     }
 
     /**
-     * Runs a given filter
+     * Get filter's instance
      *
      * @param string $filter
-     * @return Firewall
+     * @return BaseFilter
      * @throws \Exception
      */
-    public function runFilter(string $filter): Firewall
+    public function getFilterInstance(string $filter): BaseFilter
     {
         if (!array_key_exists($filter, $this->getFilters()))
         {
             throw new \Exception("Unknown filter {$filter}.");
         }
 
         $class = "PhpWaf\\Filter\\$filter";
-        $instance = new $class;
+
+        return new $class;
+    }
+
+    /**
+     * Runs a given filter
+     *
+     * @param string $filter
+     * @return Firewall
+     * @throws \Exception
+     */
+    public function runFilter(string $filter): Firewall
+    {
+        $instance = $this->getFilterInstance($filter);
 
         foreach ($_GET as $key => $val)
         {