refactor: change visibility of Request properties to private

guanguans · guanguans · commit b7e3dd544947 · 2024-05-07T15:48:45.000+08:00
- Changed visibility of Request properties in several classes from protected to private
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -5,11 +5,6 @@ parameters:
 			count: 1
 			path: src/Channels/MailChannel.php
 
-		-
-			message: "#^Method Guanguans\\\\LaravelExceptionNotify\\\\Channels\\\\NotifyChannel\\:\\:report\\(\\) should return Guanguans\\\\Notify\\\\Foundation\\\\Response but returns Psr\\\\Http\\\\Message\\\\ResponseInterface\\.$#"
-			count: 1
-			path: src/Channels/NotifyChannel.php
-
 		-
 			message: "#^Property Guanguans\\\\LaravelExceptionNotify\\\\Collectors\\\\ApplicationCollector\\:\\:\\$container \\(Illuminate\\\\Foundation\\\\Application\\) does not accept Illuminate\\\\Container\\\\Container\\.$#"
 			count: 1
@@ -26,9 +21,9 @@ parameters:
 			path: src/Collectors/RequestHeaderCollector.php
 
 		-
-			message: "#^Access to protected property Guanguans\\\\LaravelExceptionNotify\\\\Macros\\\\StringableMacro\\:\\:\\$value\\.$#"
-			count: 2
-			path: src/Macros/StringableMacro.php
+			message: "#^Method Guanguans\\\\LaravelExceptionNotify\\\\DefaultClientExtender\\:\\:__invoke\\(\\) should return Guanguans\\\\Notify\\\\Foundation\\\\Client but returns Guanguans\\\\Notify\\\\Foundation\\\\Concerns\\\\HasHttpClient\\.$#"
+			count: 1
+			path: src/DefaultClientExtender.php
 
 		-
 			message: "#^Call to an undefined static method Illuminate\\\\Support\\\\Str\\:\\:lcfirst\\(\\)\\.$#"
@@ -45,6 +40,11 @@ parameters:
 			count: 1
 			path: src/Rectors/ToInternalExceptionRector.php
 
+		-
+			message: "#^Method Guanguans\\\\LaravelExceptionNotify\\\\Support\\\\ExceptionContext\\:\\:getEval\\(\\) never returns void so it can be removed from the return type\\.$#"
+			count: 1
+			path: src/Support/ExceptionContext.php
+
 		-
 			message: "#^Result of && is always false\\.$#"
 			count: 1
diff --git a/phpstan.neon b/phpstan.neon
@@ -31,4 +31,6 @@ parameters:
 #        switchConditionsMatchingType: false
 #        noVariableVariables: false
     ignoreErrors:
+        - "#^Access to protected property Guanguans\\\\LaravelExceptionNotify\\\\Macros\\\\StringableMacro\\:\\:\\$value\\.$#"
         - "#^Unsafe usage of new static\\(\\)\\.$#"
+        - "#^Unsafe call to private method Guanguans\\\\LaravelExceptionNotify\\\\.*\\:\\:.*\\(\\) through static\\:\\:\\.$#"
diff --git a/src/Channels/NotifyChannel.php b/src/Channels/NotifyChannel.php
@@ -22,6 +22,7 @@
 use Illuminate\Contracts\Container\BindingResolutionException;
 use Illuminate\Support\Arr;
 use Illuminate\Support\Str;
+use Psr\Http\Message\ResponseInterface;
 
 class NotifyChannel extends Channel
 {
@@ -61,8 +62,10 @@ public function __construct(Repository $config)
     /**
      * @throws BindingResolutionException
      * @throws GuzzleException
+     *
+     * @return Response|ResponseInterface
      */
-    public function report(string $report): Response
+    public function report(string $report): ResponseInterface
     {
         return $this->createClient()->send($this->createMessage($report));
     }
diff --git a/src/Collectors/RequestBasicCollector.php b/src/Collectors/RequestBasicCollector.php
@@ -17,7 +17,7 @@
 
 class RequestBasicCollector extends Collector
 {
-    protected Request $request;
+    private Request $request;
 
     public function __construct(Request $request)
     {
diff --git a/src/Collectors/RequestCookieCollector.php b/src/Collectors/RequestCookieCollector.php
@@ -17,7 +17,7 @@
 
 class RequestCookieCollector extends Collector
 {
-    protected Request $request;
+    private Request $request;
 
     public function __construct(Request $request)
     {
diff --git a/src/Collectors/RequestFileCollector.php b/src/Collectors/RequestFileCollector.php
@@ -18,7 +18,7 @@
 
 class RequestFileCollector extends Collector
 {
-    protected Request $request;
+    private Request $request;
 
     public function __construct(Request $request)
     {
diff --git a/src/Collectors/RequestMiddlewareCollector.php b/src/Collectors/RequestMiddlewareCollector.php
@@ -17,7 +17,7 @@
 
 class RequestMiddlewareCollector extends Collector
 {
-    protected Request $request;
+    private Request $request;
 
     public function __construct(Request $request)
     {
diff --git a/src/Collectors/RequestPostCollector.php b/src/Collectors/RequestPostCollector.php
@@ -18,7 +18,7 @@
 
 class RequestPostCollector extends Collector
 {
-    protected Request $request;
+    private Request $request;
 
     public function __construct(Request $request)
     {
@@ -28,7 +28,7 @@ public function __construct(Request $request)
     public function collect(): array
     {
         return collect($this->request->post())
-            ->transform(static function ($value, $key) {
+            ->transform(static function ($value, string $key) {
                 if (Str::of($key)->is(['password', '*password', 'password*', '*password*'])) {
                     return '******';
                 }
diff --git a/src/Collectors/RequestQueryCollector.php b/src/Collectors/RequestQueryCollector.php
@@ -17,7 +17,7 @@
 
 class RequestQueryCollector extends Collector
 {
-    protected Request $request;
+    private Request $request;
 
     public function __construct(Request $request)
     {
diff --git a/src/Collectors/RequestRawFileCollector.php b/src/Collectors/RequestRawFileCollector.php
@@ -13,17 +13,8 @@
 
 namespace Guanguans\LaravelExceptionNotify\Collectors;
 
-use Illuminate\Http\Request;
-
 class RequestRawFileCollector extends Collector
 {
-    protected Request $request;
-
-    public function __construct(Request $request)
-    {
-        $this->request = $request;
-    }
-
     public function collect(): array
     {
         return $_FILES;
diff --git a/src/Collectors/RequestServerCollector.php b/src/Collectors/RequestServerCollector.php
@@ -17,7 +17,7 @@
 
 class RequestServerCollector extends Collector
 {
-    protected Request $request;
+    private Request $request;
 
     public function __construct(Request $request)
     {
diff --git a/src/Collectors/RequestSessionCollector.php b/src/Collectors/RequestSessionCollector.php
@@ -17,7 +17,7 @@
 
 class RequestSessionCollector extends Collector
 {
-    protected Request $request;
+    private Request $request;
 
     public function __construct(Request $request)
     {
diff --git a/src/Contracts/Channel.php b/src/Contracts/Channel.php
@@ -16,6 +16,8 @@
 interface Channel
 {
     /**
+     * @noinspection MissingReturnTypeInspection
+     *
      * @return mixed|never-return|void
      */
     public function report(string $report);
diff --git a/src/Events/ExceptionReportedEvent.php b/src/Events/ExceptionReportedEvent.php
@@ -22,6 +22,9 @@ class ExceptionReportedEvent
     /** @var mixed */
     public $result;
 
+    /**
+     * @noinspection MissingParameterTypeDeclarationInspection
+     */
     public function __construct(Channel $channel, $result)
     {
         $this->channel = $channel;
diff --git a/src/ExceptionNotifyManager.php b/src/ExceptionNotifyManager.php
@@ -1,5 +1,8 @@
 <?php
 
+/** @noinspection PhpUnused */
+/** @noinspection PhpUnusedPrivateMethodInspection */
+
 declare(strict_types=1);
 
 /**
@@ -18,7 +21,6 @@
 use Guanguans\LaravelExceptionNotify\Jobs\ReportExceptionJob;
 use Illuminate\Cache\RateLimiter;
 use Illuminate\Config\Repository;
-use Illuminate\Foundation\Application;
 use Illuminate\Support\Arr;
 use Illuminate\Support\Facades\Log;
 use Illuminate\Support\Manager;
@@ -27,11 +29,11 @@
 use Illuminate\Support\Traits\Tappable;
 
 /**
- * @property Application $container
+ * @property \Illuminate\Foundation\Application $container
  *
  * @method Channel driver($driver = null)
  *
- * @mixin Channel
+ * @mixin \Guanguans\LaravelExceptionNotify\Contracts\Channel
  */
 class ExceptionNotifyManager extends Manager
 {
@@ -43,6 +45,8 @@ class ExceptionNotifyManager extends Manager
     /**
      * Handle dynamic method calls into the method.
      *
+     * @noinspection MissingReturnTypeInspection
+     *
      * @param mixed $method
      * @param mixed $parameters
      */
@@ -56,6 +60,8 @@ public function __call($method, $parameters)
     }
 
     /**
+     * @noinspection MissingParameterTypeDeclarationInspection
+     *
      * @param mixed $condition
      * @param list<string>|string $channels
      */
@@ -65,6 +71,8 @@ public function reportIf($condition, \Throwable $throwable, $channels = null): v
     }
 
     /**
+     * @noinspection MissingParameterTypeDeclarationInspection
+     *
      * @param list<string>|string $channels
      */
     public function report(\Throwable $throwable, $channels = null): void
@@ -74,10 +82,12 @@ public function report(\Throwable $throwable, $channels = null): void
                 return;
             }
 
-            $dispatch = dispatch(new ReportExceptionJob(app(CollectorManager::class)->mapToReports(
-                (array) ($channels ?? config('exception-notify.defaults')),
-                $throwable
-            )));
+            $dispatch = dispatch(new ReportExceptionJob(
+                app(CollectorManager::class)->mapToReports(
+                    (array) ($channels ?? config('exception-notify.defaults')),
+                    $throwable
+                )
+            ));
 
             if (
                 !$this->container->runningInConsole()
@@ -102,6 +112,12 @@ public function shouldReport(\Throwable $throwable): bool
         return !$this->shouldntReport($throwable);
     }
 
+    /**
+     * @noinspection MissingParentCallInspection
+     * @noinspection MethodVisibilityInspection
+     *
+     * @param mixed $driver
+     */
     protected function createDriver($driver): Channel
     {
         if (isset($this->customCreators[$driver])) {
@@ -123,6 +139,9 @@ protected function createDriver($driver): Channel
         throw new InvalidArgumentException("Driver [$driver] not supported.");
     }
 
+    /**
+     * @noinspection IfSimplificationOrInspection
+     */
     private function shouldntReport(\Throwable $throwable): bool
     {
         if (!config('exception-notify.enabled')) {
diff --git a/src/Macros/StringableMacro.php b/src/Macros/StringableMacro.php
@@ -1,5 +1,7 @@
 <?php
 
+/** @noinspection PhpMethodParametersCountMismatchInspection */
+
 declare(strict_types=1);
 
 /**
diff --git a/src/Pipes/AddChorePipe.php b/src/Pipes/AddChorePipe.php
@@ -22,6 +22,8 @@
 class AddChorePipe
 {
     /**
+     * @noinspection MissingParameterTypeDeclarationInspection
+     *
      * @param mixed $value
      * @param array-key $key
      */
diff --git a/src/Support/JsonFixer.php b/src/Support/JsonFixer.php
@@ -77,7 +77,7 @@ public function fix(string $json): string
             return $json;
         }
 
-        if (null !== $tmpJson = $this->quickFix($json)) {
+        if (null !== ($tmpJson = $this->quickFix($json))) {
             return $tmpJson;
         }
 
@@ -127,7 +127,7 @@ private function isValid(string $json): bool
 
     private function quickFix(string $json): ?string
     {
-        if (1 === \strlen($json) && isset($this->pairs[$json])) {
+        if (isset($this->pairs[$json]) && 1 === \strlen($json)) {
             return $json.$this->pairs[$json];
         }
 
@@ -275,7 +275,7 @@ private function padLiteral(string $tmpJson): string
 
         $match = preg_match('/(tr?u?e?|fa?l?s?e?|nu?l?l?)$/', $tmpJson, $matches);
 
-        if (!$match || null === $literal = $this->maybeLiteral($matches[1])) {
+        if (!$match || null === ($literal = $this->maybeLiteral($matches[1]))) {
             return $tmpJson;
         }
 
@@ -301,7 +301,7 @@ private function padObject(string $tmpJson): string
 
         $part = substr($tmpJson, $this->objectPos + 1);
 
-        if (preg_match('/(\s*\"[^"]+\"\s*:\s*[^,]+,?)+$/', $part, $matches)) {
+        if (preg_match('/(\s*\"[^"]+\"\s*:\s*[^,]+,?)+$/', $part)) {
             return $tmpJson;
         }
 

Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,7 @@`
`22`	`22`	`use Illuminate\Contracts\Container\BindingResolutionException;`
`23`	`23`	`use Illuminate\Support\Arr;`
`24`	`24`	`use Illuminate\Support\Str;`
	`25`	`+use Psr\Http\Message\ResponseInterface;`
`25`	`26`
`26`	`27`	`class NotifyChannel extends Channel`
`27`	`28`	`{`
`@@ -61,8 +62,10 @@ public function __construct(Repository $config)`
`61`	`62`	`/**`
`62`	`63`	`* @throws BindingResolutionException`
`63`	`64`	`* @throws GuzzleException`
	`65`	`+ *`
	`66`	`+ * @return Response\|ResponseInterface`
`64`	`67`	`*/`
`65`		`- public function report(string $report): Response`
	`68`	`+ public function report(string $report): ResponseInterface`
`66`	`69`	`{`
`67`	`70`	`return $this->createClient()->send($this->createMessage($report));`
`68`	`71`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@`
`17`	`17`
`18`	`18`	`class RequestBasicCollector extends Collector`
`19`	`19`	`{`
`20`		`- protected Request $request;`
	`20`	`+ private Request $request;`
`21`	`21`
`22`	`22`	`public function __construct(Request $request)`
`23`	`23`	`{`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@`
`18`	`18`
`19`	`19`	`class RequestFileCollector extends Collector`
`20`	`20`	`{`
`21`		`- protected Request $request;`
	`21`	`+ private Request $request;`
`22`	`22`
`23`	`23`	`public function __construct(Request $request)`
`24`	`24`	`{`