Maintenance: Finished getting to PHPStan level 4

Author: ssddanbrown

app/Api/ApiEntityListFormatter.php

@@ -74,18 +74,21 @@ public function withTags(): self
 
     /**
      * Include parent book/chapter info in the formatted data.
+     * These functions are careful to not load the relation themselves, since they should
+     * have already been loaded in a more efficient manner, with permissions applied, by the time
+     * the parent fields are handled here.
      */
     public function withParents(): self
     {
         $this->withField('book', function (Entity $entity) {
-            if ($entity instanceof BookChild) {
+            if ($entity instanceof BookChild && $entity->relationLoaded('book') && $entity->getRelationValue('book')) {
                 return $entity->book->only(['id', 'name', 'slug']);
             }
             return null;
         });
 
         $this->withField('chapter', function (Entity $entity) {
-            if ($entity instanceof Page && $entity->chapter) {
+            if ($entity instanceof Page && $entity->relationLoaded('chapter') && $entity->getRelationValue('chapter')) {
                 return $entity->chapter->only(['id', 'name', 'slug']);
             }
             return null;

app/Entities/Models/Book.php

@@ -17,7 +17,7 @@
  *
  * @property string                                   $description
  * @property string                                   $description_html
- * @property int                                      $image_id
+ * @property ?int                                     $image_id
  * @property ?int                                     $default_template_id
  * @property ?int                                     $sort_rule_id
  * @property \Illuminate\Database\Eloquent\Collection $chapters

app/Entities/Tools/PageContent.php

@@ -359,7 +359,7 @@ protected function getContentCacheKey(string $html): string
     {
         $contentHash = md5($html);
         $contentId = $this->page->id;
-        $contentTime = $this->page->updated_at?->timestamp ?? time();
+        $contentTime = $this->page->updated_at->timestamp ?? time();
         $appVersion = AppVersion::get();
         $filterConfig = config('app.content_filtering') ?? '';
         return "page-content-cache::{$filterConfig}::{$appVersion}::{$contentId}::{$contentTime}::{$contentHash}";

app/Entities/Tools/PermissionsUpdater.php

@@ -47,7 +47,7 @@ public function updateFromApiRequestData(Entity $entity, array $data): void
     {
         if (isset($data['role_permissions'])) {
             $entity->permissions()->where('role_id', '!=', 0)->delete();
-            $rolePermissionData = $this->formatPermissionsFromApiRequestToEntityPermissions($data['role_permissions'] ?? [], false);
+            $rolePermissionData = $this->formatPermissionsFromApiRequestToEntityPermissions($data['role_permissions'], false);
             $entity->permissions()->createMany($rolePermissionData);
         }
 

app/Exports/ExportFormatter.php

@@ -208,7 +208,7 @@ protected function containHtml(string $htmlContent): string
         preg_match_all("/\<img.*?src\=(\'|\")(.*?)(\'|\").*?\>/i", $htmlContent, $imageTagsOutput);
 
         // Replace image src with base64 encoded image strings
-        if (isset($imageTagsOutput[0]) && count($imageTagsOutput[0]) > 0) {
+        if (count($imageTagsOutput[0]) > 0) {
             foreach ($imageTagsOutput[0] as $index => $imgMatch) {
                 $oldImgTagString = $imgMatch;
                 $srcString = $imageTagsOutput[2][$index];
@@ -225,7 +225,7 @@ protected function containHtml(string $htmlContent): string
         preg_match_all("/\<a.*href\=(\'|\")(.*?)(\'|\").*?\>/i", $htmlContent, $linksOutput);
 
         // Update relative links to be absolute, with instance url
-        if (isset($linksOutput[0]) && count($linksOutput[0]) > 0) {
+        if (count($linksOutput[0]) > 0) {
             foreach ($linksOutput[0] as $index => $linkMatch) {
                 $oldLinkString = $linkMatch;
                 $srcString = $linksOutput[2][$index];

app/Exports/ZipExports/ZipImportRunner.php

@@ -82,10 +82,8 @@ public function run(Import $import, ?Entity $parent = null): Entity
             $entity = $this->importBook($exportModel, $reader);
         } else if ($exportModel instanceof ZipExportChapter) {
             $entity = $this->importChapter($exportModel, $parent, $reader);
-        } else if ($exportModel instanceof ZipExportPage) {
-            $entity = $this->importPage($exportModel, $parent, $reader);
         } else {
-            throw new ZipImportException(['No importable data found in import data.']);
+            $entity = $this->importPage($exportModel, $parent, $reader);
         }
 
         $this->references->replaceReferences();
@@ -132,7 +130,7 @@ protected function importBook(ZipExportBook $exportBook, ZipExportReader $reader
             'name' => $exportBook->name,
             'description_html' => $exportBook->description_html ?? '',
             'image' => $exportBook->cover ? $this->zipFileToUploadedFile($exportBook->cover, $reader) : null,
-            'tags' => $this->exportTagsToInputArray($exportBook->tags ?? []),
+            'tags' => $this->exportTagsToInputArray($exportBook->tags),
         ]);
 
         if ($book->coverInfo()->getImage()) {
@@ -151,7 +149,7 @@ protected function importBook(ZipExportBook $exportBook, ZipExportReader $reader
         foreach ($children as $child) {
             if ($child instanceof ZipExportChapter) {
                 $this->importChapter($child, $book, $reader);
-            } else if ($child instanceof ZipExportPage) {
+            } else {
                 $this->importPage($child, $book, $reader);
             }
         }
@@ -166,7 +164,7 @@ protected function importChapter(ZipExportChapter $exportChapter, Book $parent,
         $chapter = $this->chapterRepo->create([
             'name' => $exportChapter->name,
             'description_html' => $exportChapter->description_html ?? '',
-            'tags' => $this->exportTagsToInputArray($exportChapter->tags ?? []),
+            'tags' => $this->exportTagsToInputArray($exportChapter->tags),
         ], $parent);
 
         $exportPages = $exportChapter->pages;
@@ -199,7 +197,7 @@ protected function importPage(ZipExportPage $exportPage, Book|Chapter $parent, Z
             'name' => $exportPage->name,
             'markdown' => $exportPage->markdown ?? '',
             'html' => $exportPage->html ?? '',
-            'tags' => $this->exportTagsToInputArray($exportPage->tags ?? []),
+            'tags' => $this->exportTagsToInputArray($exportPage->tags),
         ]);
 
         $this->references->addPage($page, $exportPage);
@@ -302,7 +300,7 @@ protected function ensurePermissionsPermitImport(ZipExportPage|ZipExportChapter|
             array_push($chapters, ...$exportModel->chapters);
         } else if ($exportModel instanceof ZipExportChapter) {
             $chapters[] = $exportModel;
-        } else if ($exportModel instanceof ZipExportPage) {
+        } else {
             $pages[] = $exportModel;
         }
 

app/Exports/ZipExports/ZipReferenceParser.php

@@ -68,10 +68,6 @@ public function parseReferences(string $content, callable $handler): string
         $matches = [];
         preg_match_all($referenceRegex, $content, $matches);
 
-        if (count($matches) < 3) {
-            return $content;
-        }
-
         for ($i = 0; $i < count($matches[0]); $i++) {
             $referenceText = $matches[0][$i];
             $type = strtolower($matches[1][$i]);

app/Permissions/JointPermissionBuilder.php

@@ -61,8 +61,7 @@ public function rebuildForEntity(Entity $entity): void
             return;
         }
 
-        /** @var BookChild $entity */
-        if ($entity->book) {
+        if ($entity instanceof BookChild) {
             $entities[] = $entity->book;
         }
 

app/Users/Models/User.php

@@ -222,8 +222,7 @@ public function hasSocialAccount(string $socialDriver = ''): bool
     public function getAvatar(int $size = 50): string
     {
         $default = url('/user_avatar.png');
-        $imageId = $this->image_id;
-        if ($imageId === 0 || $imageId === '0' || $imageId === null) {
+        if ($this->image_id === 0) {
             return $default;
         }
 

tests/Api/SearchApiTest.php

@@ -106,6 +106,7 @@ public function test_all_endpoint_includes_parent_details_where_visible()
         $this->permissions->setEntityPermissions($page, ['view'], [$editor->roles()->first()]);
 
         $resp = $this->getJson($this->baseEndpoint . '?query=superextrauniquevalue');
+        $resp->assertOk();
         $resp->assertJsonPath('data.0.id', $page->id);
         $resp->assertJsonPath('data.0.book.name', $book->name);
         $resp->assertJsonMissingPath('data.0.chapter');