antonioribeiro / firewall

src/Firewall.php

Doc Comments +6 added lines, -6 removed lines

@@ -130,7 +130,7 @@ 
     /**
      * Clear firewall table.
      *
-     * @return mixed
+     * @return integer
      */
     public function clear()
     {
@@ -238,7 +238,7 @@ 
     /**
      * Get the list of all IP addresses stored.
      *
-     * @return mixed
+     * @return \Illuminate\Support\Collection
      */
     public function report()
     {
@@ -274,7 +274,7 @@ 
      *
      * @param $ip
      *
-     * @return bool|string
+     * @return null|string
      */
     public function whichList($ip)
     {
@@ -323,7 +323,7 @@ 
     /**
      * Get a response to the attack.
      *
-     * @return \Illuminate\Http\Response|\Illuminate\Http\RedirectResponse|null
+     * @return null|\Illuminate\Http\Response
      */
     public function responseToAttack()
     {
@@ -335,7 +335,7 @@ 
      *
      * @param $ip
      *
-     * @return bool|string
+     * @return string|null
      */
     public function getCountryFromIp($ip)
     {
@@ -357,7 +357,7 @@ 
     /**
      * Get the GeoIP instance.
      *
-     * @return object
+     * @return \PragmaRX\Support\GeoIp\GeoIp
      */
     public function getGeoIp()
     {

src/Listeners/NotifyAdmins.php

Unused Use Statements -1 removed lines

@@ -2,7 +2,6 @@
 
 namespace PragmaRX\Firewall\Listeners;
 
-use ErrorException;
 use Exception;
 use Notification as IlluminateNotification;
 use PragmaRX\Firewall\Events\AttackDetected;

src/Repositories/Cache/Cache.php

Doc Comments +3 added lines, -3 removed lines

@@ -47,7 +47,7 @@ 
     /**
      * Check if cache has key.
      *
-     * @param $key
+     * @param string $key
      *
      * @return bool
      */
@@ -63,9 +63,9 @@ 
     /**
      * Get a value from the cache.
      *
-     * @param $key
+     * @param string|null $key
      *
-     * @return mixed|null
+     * @return \Illuminate\Contracts\Cache\Repository|null
      */
     public function get($key)
     {

src/Repositories/IpList.php

Doc Comments +9 added lines, -9 removed lines

@@ -64,7 +64,7 @@ 
     /**
      * Remove the ip address from an array list.
      *
-     * @param $type
+     * @param string $type
      * @param $ip
      *
      * @return bool
@@ -91,7 +91,7 @@ 
      *
      * @param \Illuminate\Database\Eloquent\Model $ip
      *
-     * @return bool
+     * @return boolean|null
      */
     private function removeFromDatabaseList($ip)
     {
@@ -137,7 +137,7 @@ 
     /**
      * Read a file contents.
      *
-     * @param $file
+     * @param string $file
      *
      * @return array
      */
@@ -246,8 +246,8 @@ 
     /**
      * Merge IP lists.
      *
-     * @param $database_ips
-     * @param $config_ips
+     * @param \Illuminate\Support\Collection $database_ips
+     * @param \Illuminate\Support\Collection $config_ips
      *
      * @return \Illuminate\Support\Collection
      */
@@ -367,7 +367,7 @@ 
      * Add ip or range to array list.
      *
      * @param $whitelist
-     * @param $ip
+     * @param string $ip
      *
      * @return array|mixed
      */
@@ -476,7 +476,7 @@ 
     /**
      * Find ip address in all lists.
      *
-     * @param $ip
+     * @param string $ip
      *
      * @return \Illuminate\Database\Eloquent\Model|null|static
      */
@@ -496,7 +496,7 @@ 
      *
      * @param $ip
      *
-     * @return \Illuminate\Database\Eloquent\Model
+     * @return FirewallModel|null
      */
     private function nonDatabaseFind($ip)
     {
@@ -511,7 +511,7 @@ 
      * Add ip or range to database.
      *
      * @param $whitelist
-     * @param $ip
+     * @param string $ip
      *
      * @return \Illuminate\Database\Eloquent\Model
      */

Spacing +5 added lines, -7 removed lines

@@ -34,13 +34,13 @@ 
     private function getNonDatabaseIps()
     {
         return array_merge_recursive(
-            array_map(function ($ip) {
+            array_map(function($ip) {
                 $ip['whitelisted'] = true;
 
                 return $ip;
             }, $this->formatIpArray($this->config()->get('whitelist'))),
 
-            array_map(function ($ip) {
+            array_map(function($ip) {
                 $ip['whitelisted'] = false;
 
                 return $ip;
@@ -161,7 +161,7 @@ 
      */
     private function formatIpArray($list)
     {
-        return array_map(function ($ip) {
+        return array_map(function($ip) {
             return ['ip_address' => $ip];
         }, $this->makeArrayOfIps($list));
     }
@@ -426,8 +426,7 @@ 
     public function addToProperList($whitelist, $ip)
     {
         $this->config()->get('use_database') ?
-            $this->addToDatabaseList($whitelist, $ip) :
-            $this->addToArrayList($whitelist, $ip);
+            $this->addToDatabaseList($whitelist, $ip) : $this->addToArrayList($whitelist, $ip);
     }
 
     /**
@@ -440,8 +439,7 @@ 
     public function delete($ip)
     {
         $this->config()->get('use_database') ?
-            $this->removeFromDatabaseList($ip) :
-            $this->removeFromArrayList($ip);
+            $this->removeFromDatabaseList($ip) : $this->removeFromArrayList($ip);
     }
 
     /**

src/Support/IpAddress.php

Doc Comments +1 added lines, -1 removed lines

@@ -60,7 +60,7 @@
     /**
      * Check if an ip v4 is valid.
      *
-     * @param $item
+     * @param string $item
      *
      * @return bool
      */

Unused Use Statements -1 removed lines

@@ -2,7 +2,6 @@
 
 namespace PragmaRX\Firewall\Support;
 
-use Exception;
 use PragmaRX\Support\IpAddress as SupportIpAddress;
 
 class IpAddress