Refactor code to resolve phpstan warnings (#398)

- Updated existing code using phpstan suggestions
    - added missing code where needed
    - deleted unused code/comments

src/backend/app/Console/Commands/AddPlugin.php

@@ -17,6 +17,6 @@ public function runInCompanyScope(): void {
         $composer_name = $this->argument('composer_name');
         $description = $this->argument('description');
 
-        $this->pluginService->addPlugin($name, $composer_name, $description);
+        $this->pluginsService->addPlugin($name, $composer_name, $description);
     }
 }

src/backend/app/Console/Commands/DemoDataCreator.php

@@ -132,6 +132,7 @@ private function generateTransaction(): void {
             'created_at' => $demoDate,
             'updated_at' => $demoDate,
         ]);
+        $subTransaction = null;
 
         $manufacturerTransaction = $this->calinTransaction->newQuery()->create([]);
 
@@ -233,7 +234,7 @@ private function generateTransaction(): void {
             // create an object for the token job
             $transactionData = \App\Misc\TransactionDataContainer::initialize($transaction);
         } catch (\Exception $exception) {
-            event('transaction.failed', [$this->transaction, $e->getMessage()]);
+            event('transaction.failed', [$this->transaction, $exception->getMessage()]);
             throw $exception;
         }
 
@@ -256,7 +257,7 @@ private function generateTransaction(): void {
                 'token' => Str::random(30),
                 'load' => round(
                     $transactionData->transaction->amount /
-                    $randomMeter['tariff']['price'],
+                        $randomMeter['tariff']['price'],
                     2
                 ),
             ];

src/backend/app/Console/Commands/ModelShowTenant.php

@@ -34,8 +34,6 @@ public function __construct(
 
     /**
      * Execute the console command.
-     *
-     * @return int
      */
     public function handle() {
         $this->databaseProxyManagerService->buildDatabaseConnectionDummyCompany();

src/backend/app/Console/Kernel.php

@@ -2,7 +2,7 @@
 
 namespace App\Console;
 
-use app\Console\Commands\MailApplianceDebtsCommand;
+use App\Console\Commands\MailApplianceDebtsCommand;
 use Illuminate\Console\Scheduling\Schedule;
 use Illuminate\Foundation\Console\Kernel as ConsoleKernel;
 use Inensus\AngazaSHS\Console\Commands\InstallPackage as InstallAngazaSHSPackage;

src/backend/app/Http/Middleware/JwtMiddleware.php

@@ -25,7 +25,6 @@ class JwtMiddleware extends BaseMiddleware {
      */
     public function handle(Request $request, \Closure $next, string $type = 'user'): mixed {
         try {
-            // @phpstan-ignore-next-line as no methods are defined on the facade its failing to resolve the function
             $id = JWTAuth::parseToken()->getPayload()->get('sub');
             if ($type === 'agent') {
                 $user = Agent::query()->findOrFail($id);

src/backend/app/Jobs/SmsLoadBalancer.php

@@ -34,7 +34,7 @@ function () {
                 Log::debug('smsgateway', ['data' => $this->smsBody, 'firebase' => $fireBaseResult]);
             },
             function () {
-                return $this->release(1);
+                $this->release(1);
             }
         );
     }

src/backend/app/Models/Admin.php

@@ -2,4 +2,6 @@
 
 namespace App\Models;
 
+use App\Models\Base\BaseModel;
+
 class Admin extends BaseModel {}

src/backend/app/Observers/AgentReceiptObserver.php

@@ -22,7 +22,7 @@ public function __construct(
     public function created(AgentReceipt $receipt): void {
         $agentId = $receipt->agent_id;
         $agent = $this->agentService->getById($agentId);
-        $due = $agent->due_to_energy_supplier;
+        $due = $agent->due_to_energy_supplier ?? 0;
         $sinceLastVisit = 0;
         $lastReceipt = $this->agentReceiptService->getLastReceipt($agentId);
 
@@ -41,11 +41,11 @@ public function created(AgentReceipt $receipt): void {
         $collected = $receipt->amount;
         $agentReceiptDetailData = [
             'agent_receipt_id' => $receipt->id,
-            'due' => $due ?? 0,
-            'collected' => $collected ?? 0,
+            'due' => $due,
+            'collected' => $collected,
             'since_last_visit' => $sinceLastVisit ?? 0,
             'earlier' => $earlier ?? 0,
-            'summary' => $summary ?? 0,
+            'summary' => $summary < 0 ? 0 : $summary,
         ];
         $this->agentReceiptDetailService->create($agentReceiptDetailData);
         $agentBalanceHistoryData = [

src/backend/app/Services/AgentBalanceHistoryService.php

@@ -48,7 +48,7 @@ public function save($agentBalanceHistory): bool {
     }
 
     public function getLastAgentBalanceHistory($agentId) {
-        return $this->agentBalanceHistory->newQuery()->where('agent_id', $agentId)->get()->last();
+        return $this->agentBalanceHistory->newQuery()->where('agent_id', $agentId)->latest('id')->first();
     }
 
     public function getTotalAmountSinceLastVisit($agentBalanceHistoryId, $agentId) {
@@ -59,21 +59,17 @@ public function getTotalAmountSinceLastVisit($agentBalanceHistoryId, $agentId) {
     }
 
     public function getTransactionAverage($agent, $lastReceipt) {
+        $query = $this->agentBalanceHistory->newQuery()
+            ->where('agent_id', $agent->id)
+            ->where('trigger_type', 'agent_transaction');
+
         if ($lastReceipt) {
-            $averageTransactionAmounts = $this->agentBalanceHistory->newQuery()
-                ->where('agent_id', $agent->id)
-                ->where('trigger_type', 'agent_transaction')
-                ->where('created_at', '>', $lastReceipt->created_at)
-                ->get()
-                ->avg('amount');
-        } else {
-            $averageTransactionAmounts = $this->agentBalanceHistory->newQuery()
-                ->where('agent_id', $agent->id)
-                ->where('trigger_type', 'agent_transaction')
-                ->get()
-                ->avg('amount');
+            $query->where('created_at', '>', $lastReceipt->created_at);
         }
 
+        // Use avg directly on the query
+        $averageTransactionAmounts = $query->avg('amount');
+
         return -1 * $averageTransactionAmounts;
     }
 

src/backend/app/Services/AgentReceiptService.php

@@ -56,7 +56,9 @@ public function getLastReceipt($agentId) {
     }
 
     public function getLastReceiptDate($agent) {
-        $lastReceiptDate = $this->agentReceipt->newQuery()->where('agent_id', $agent->id)->get()->last();
+        $lastReceiptDate = $this->agentReceipt->newQuery()->where('agent_id', $agent->id)
+            ->lastest('created_at')
+            ->first();
 
         if ($lastReceiptDate) {
             return $lastReceiptDate->created_at;

src/backend/app/Services/AgentTransactionService.php

@@ -49,7 +49,7 @@ static function ($q) use ($agentId) {
 
     public function getById(int $agentId, ?int $customerId = null): AgentTransaction {
         $customerDeviceSerials = $this->device->newQuery()->where('person_id', $customerId)
-            ->get()->pluck('device_serial');
+            ->pluck('device_serial');
 
         if (!$customerDeviceSerials->count()) {
             return null;

src/backend/app/Services/PluginsService.php

@@ -42,4 +42,14 @@ public function isPluginActive(int $pluginId): bool {
             ->where('mpm_plugin_id', '=', $pluginId)
             ->exists();
     }
+
+    public function addPlugin(string $name, string $composerName, string $description): Plugins {
+        $pluginData = [
+            'name' => $name,
+            'composer_name' => $composerName,
+            'description' => $description,
+        ];
+
+        return $this->create($pluginData);
+    }
 }