test(phpstan): fix level 3 typing issues in tests/fakes/

phpstan_next.neon

@@ -40,7 +40,6 @@ parameters:
             - Presenters/
             - WebServices/
             - lib/
-            - tests/fakes/
             - tests/Presenters/
     bootstrapFiles:
         - vendor/autoload.php

tests/fakes/DBFakes.php

@@ -135,7 +135,7 @@ public function GetRow()
         if (sizeof($this->rows) > $this->idx) {
             return $this->rows[$this->idx++];
         }
-        return false;
+        return [];
     }
 
     public function NumRows()
@@ -177,7 +177,7 @@ public function Disconnect()
     public function Query(ISqlCommand $command)
     {
         $this->_LastSqlCommand = $command;
-        return null;
+        return new FakeReader([]);
     }
 
     public function Execute(ISqlCommand $command)
@@ -200,7 +200,7 @@ public function GetLastInsertId()
     public function LimitQuery(ISqlCommand $command, $limit, $offset = null)
     {
         $this->_LimitQueryCalled = true;
-        return null;
+        return new FakeReader([]);
     }
 }
 

tests/fakes/DBRows.php

@@ -4,7 +4,7 @@ class CustomAttributeValueRow
 {
     private $rows = [];
 
-    public function Rows()
+    public function Rows(): array
     {
         return $this->rows;
     }
@@ -303,7 +303,7 @@ private function AddRow($referenceNumber, $userId, $levelId)
      * @param array|int[] $participantIds
      * @return ReservationUserRow
      */
-    public function WithParticipants($instance, $participantIds)
+    public function WithParticipants(Reservation $instance, array $participantIds): ReservationUserRow
     {
         foreach ($participantIds as $id) {
             $this->AddRow($instance->ReferenceNumber(), $id, ReservationUserLevel::PARTICIPANT);
@@ -316,7 +316,7 @@ public function WithParticipants($instance, $participantIds)
      * @param array|int[] $inviteeIds
      * @return ReservationUserRow
      */
-    public function WithInvitees($instance, $inviteeIds)
+    public function WithInvitees(Reservation $instance, array $inviteeIds): ReservationUserRow
     {
         foreach ($inviteeIds as $id) {
             $this->AddRow($instance->ReferenceNumber(), $id, ReservationUserLevel::INVITEE);
@@ -329,7 +329,7 @@ class ReservationGuestRow
 {
     private $rows = [];
 
-    public function Rows()
+    public function Rows(): array
     {
         return $this->rows;
     }
@@ -344,9 +344,9 @@ private function AddRow($referenceNumber, $email, $levelId)
     /**
      * @param Reservation $instance
      * @param array|string[] $participants
-     * @return ReservationUserRow
+     * @return ReservationGuestRow
      */
-    public function WithParticipants($instance, $participants)
+    public function WithParticipants(Reservation $instance, array $participants): ReservationGuestRow
     {
         foreach ($participants as $email) {
             $this->AddRow($instance->ReferenceNumber(), $email, ReservationUserLevel::PARTICIPANT);
@@ -356,13 +356,13 @@ public function WithParticipants($instance, $participants)
 
     /**
      * @param Reservation $instance
-     * @param array|int[] $invitees
-     * @return ReservationUserRow
+     * @param array|string[] $invitees
+     * @return ReservationGuestRow
      */
-    public function WithInvitees($instance, $invitees)
+    public function WithInvitees(Reservation $instance, array $invitees): ReservationGuestRow
     {
-        foreach ($invitees as $email) {
-            $this->AddRow($instance->ReferenceNumber(), $email, ReservationUserLevel::INVITEE);
+        foreach ($invitees as $inviteeEmail) {
+            $this->AddRow($instance->ReferenceNumber(), $inviteeEmail, ReservationUserLevel::INVITEE);
         }
         return $this;
     }

tests/fakes/FakeAccessoryRepository.php

@@ -16,8 +16,7 @@ public function AddAccessory(Accessory $accessory)
      */
     public function LoadById($accessoryId)
     {
-        // TODO: Implement LoadById() method.
-        return null;
+        throw new LogicException('LoadById() not implemented in FakeAccessoryRepository');
     }
 
     /**
@@ -34,8 +33,8 @@ public function LoadAll()
      */
     public function Add(Accessory $accessory)
     {
-        // TODO: Implement Add() method.
-        return null;
+        $this->_AllAccessories[] = $accessory;
+        return count($this->_AllAccessories);
     }
 
     /**

tests/fakes/FakeAnnouncements.php

@@ -67,7 +67,7 @@ public function GetExpectedRows()
 
     public function GetAll($sortField = null, $sortDirection = null)
     {
-        return null;
+        return [];
     }
 
     /**
@@ -97,6 +97,6 @@ public function Update(Announcement $announcement)
      */
     public function LoadById($announcementId)
     {
-        return null;
+        throw new LogicException('LoadById() not implemented in FakeAnnouncementRepository');
     }
 }

tests/fakes/FakeAttributeList.php

@@ -16,27 +16,25 @@ public function __construct($attributes = [])
     /**
      * @return array|string[]
      */
-    public function GetLabels()
+    public function GetLabels(): array
     {
-        // TODO: Implement GetLabels() method.
-        return null;
+        return [];
     }
 
     /**
      * @param null $entityId
      * @return array|CustomAttribute[]
      */
-    public function GetDefinitions($entityId = null)
+    public function GetDefinitions($entityId = null): array
     {
-        // TODO: Implement GetDefinitions() method.
-        return null;
+        return [];
     }
 
     /**
      * @param $entityId int|null
-     * @return array|Attribute[]
+     * @return array|LBAttribute[]
      */
-    public function GetAttributes($entityId = null)
+    public function GetAttributes($entityId = null): array
     {
         if (array_key_exists($entityId, $this->_entityAttributes)) {
             return $this->_entityAttributes[$entityId];

tests/fakes/FakeAttributeService.php

@@ -46,7 +46,7 @@ public function Validate($category, $attributeValues, $entityIds = [], $ignoreEm
      */
     public function GetByCategory($category)
     {
-        return $this->_ByCategory[$category];
+        return $this->_ByCategory[$category] ?? [];
     }
 
     /**
@@ -55,8 +55,7 @@ public function GetByCategory($category)
      */
     public function GetById($attributeId)
     {
-        // TODO: Implement GetById() method.
-        return null;
+        throw new LogicException('GetById() not implemented in FakeAttributeService');
     }
 
     /**

tests/fakes/FakeBlackoutRepository.php

@@ -35,7 +35,7 @@ class FakeBlackoutRepository implements IBlackoutRepository
     public function Add(BlackoutSeries $blackoutSeries)
     {
         $this->_Added = $blackoutSeries;
-        return null;
+        return 1;
     }
 
     /**

tests/fakes/FakeConfig.php

@@ -12,7 +12,7 @@ public function Register($configFile, $envFile, $configId, $overwrite = false, $
 
     public function __construct()
     {
-        $this->_configs[self::DEFAULT_CONFIG_ID] = new FakeConfigFile();
+        $this->SetFile(self::DEFAULT_CONFIG_ID, new FakeConfigFile());
     }
 
     public function SetFile($configId, $file)
@@ -22,7 +22,9 @@ public function SetFile($configId, $file)
 
     public function SetKey($configDef, $value)
     {
-        $this->File(self::DEFAULT_CONFIG_ID)->SetKey($configDef, $value);
+        /** @var FakeConfigFile $file */
+        $file = $this->_configs[self::DEFAULT_CONFIG_ID];
+        $file->SetKey($configDef, $value);
     }
 
     public function SetTimezone($timezone)
@@ -39,15 +41,6 @@ public function EnableSubscription()
     {
     }
 
-    /**
-     * @param string $configId
-     * @return FakeConfigFile
-     */
-
-    public function File($configId)
-    {
-        return $this->_configs[$configId];
-    }
 }
 
 class FakeConfigFile extends ConfigurationFile implements IConfigurationFile

tests/fakes/FakeDailyLayout.php

@@ -21,8 +21,7 @@ public function GetLayout(Date $date, $resourceId)
      */
     public function IsDateReservable(Date $date)
     {
-        // TODO: Implement IsDateReservable() method.
-        return null;
+        return true;
     }
 
     /**
@@ -31,8 +30,7 @@ public function IsDateReservable(Date $date)
      */
     public function GetLabels(Date $displayDate)
     {
-        // TODO: Implement GetLabels() method.
-        return null;
+        return [];
     }
 
     /**
@@ -51,8 +49,7 @@ public function GetPeriods(Date $displayDate)
      */
     public function GetSummary(Date $date, $resourceId)
     {
-        // TODO: Implement GetSummary() method.
-        return null;
+        throw new LogicException('GetSummary() not implemented in FakeDailyLayout');
     }
 
     /**

tests/fakes/FakeExistingReservationPage.php

@@ -7,6 +7,7 @@ class FakeExistingReservationPage extends FakePageBase implements IExistingReser
     public $_CheckInRequired = false;
     public $_CheckOutRequired = false;
     public $_AutoReleaseMinutes = null;
+    public $_IsUnavailable = false;
 
     public function BindViewableResourceReservations($resourceIds)
     {
@@ -241,13 +242,12 @@ public function SetFirstWeekday($weekday)
 
     public function MakeUnavailable()
     {
-        // TODO: Implement MakeUnavailable() method.
+        $this->_IsUnavailable = true;
     }
 
     public function IsUnavailable()
     {
-        // TODO: Implement IsUnavailable() method.
-        return null;
+        return $this->_IsUnavailable;
     }
 
     public function SetTerms($termsOfService)

tests/fakes/FakeGroupRepository.php

@@ -50,8 +50,7 @@ public function GetUsersInGroup(
         $filter = null,
         $accountStatus = AccountStatus::ALL
     ) {
-        // TODO: Implement GetUsersInGroup() method.
-        return null;
+        return [];
     }
 
     /**
@@ -60,13 +59,11 @@ public function GetUsersInGroup(
      */
     public function GetGroupsByRole($roleLevel)
     {
-        // TODO: Implement GetGroupsByRole() method.
-        return null;
+        return [];
     }
 
     public function GetPermissionList()
     {
-        // TODO: Implement GetPermissionList() method.
-        return null;
+        return [];
     }
 }

tests/fakes/FakePaymentRepository.php

@@ -7,7 +7,7 @@ class FakePaymentRepository implements IPaymentRepository
      */
     public $_LastCost;
     /**
-     * @var CreditCost
+     * @var array|CreditCost[]
      */
     public $_CreditCost;
     /**
@@ -32,7 +32,7 @@ class FakePaymentRepository implements IPaymentRepository
     public $_LastSavedPayPalResult;
 
     /**
-     * @var PageablePage
+     * @var PageableData|null
      */
     public $_TransactionLogs;
     public $_LastPage;
@@ -98,7 +98,7 @@ public function GetList($pageNumber, $pageSize, $userId = -1, $sortField = null,
         $this->_LastPageSize = $pageSize;
         $this->_LastUserId = $userId;
 
-        return $this->_TransactionLogs;
+        return $this->_TransactionLogs ?? new PageableData();
     }
 
     public function GetTransactionLogView($transactionLogId)

tests/fakes/FakePermissionService.php

@@ -5,7 +5,7 @@
 class FakePermissionService implements IPermissionService
 {
     /**
-     * @var array|IResource[]
+     * @var array|IPermissibleResource[]
      */
     public $Resources;
 

tests/fakes/FakeRegistrationPage.php

@@ -217,9 +217,9 @@ public function SetAttributes($attributeValues)
     }
 
     /**
-     * @return array|AttributeValue[]
+     * @return array|AttributeFormElement[]
      */
-    public function GetAttributes()
+    public function GetAttributes(): array
     {
         return $this->_AttributeValues;
     }

tests/fakes/FakeReport.php

@@ -58,9 +58,9 @@ public function GetAll()
     }
 
     /**
-     * @return string[]
+     * @return AttributeReportColumn[]
      */
-    public function GetCustomAttributes()
+    public function GetCustomAttributes(): array
     {
         return [];
     }