PHPStan

.gitattributes

@@ -1,20 +1,12 @@
 # Do not export those files in the Composer archive (lighter dependency)
-.gitattributes export-ignore
-.github/ export-ignore
-.gitignore export-ignore
-CHANGELOG.md export-ignore
-README.md export-ignore
-SECURITY.md export-ignore
-composer.lock export-ignore
-ecs.php export-ignore
-package-lock.json export-ignore
-package.json export-ignore
-phpstan.neon export-ignore
-stubs/ export-ignore
-tests/ export-ignore
-codeception.yml export-ignore
-docs/ export-ignore
-tests/ export-ignore
+/.gitattributes export-ignore
+/.github/ export-ignore
+/.gitignore export-ignore
+/ecs.php export-ignore
+/phpstan.neon export-ignore
+/lib/ export-ignore
+/docs/ export-ignore
+/tests/ export-ignore
 
-# Auto-detect text files and perform LF normalization
+# Auto detect text files and perform LF normalization
 * text=auto

lib/craft/behaviors/CustomFieldBehavior.php

@@ -0,0 +1,33 @@
+<?php
+/**
+ * @link http://craftcms.com/
+ * @copyright Copyright (c) Pixel & Tonic, Inc.
+ * @license http://craftcms.com/license
+ */
+
+namespace craft\behaviors;
+
+use yii\base\Behavior;
+
+/**
+ * This file is never loaded at runtime. It’s only here for PHPStan’n sake.
+ *
+ * @internal
+ */
+class CustomFieldBehavior extends Behavior
+{
+    /**
+     * @var bool Whether the behavior should provide methods based on the field handles.
+     */
+    public bool $hasMethods = false;
+
+    /**
+     * @var bool Whether properties on the class should be settable directly.
+     */
+    public bool $canSetProperties = true;
+
+    /**
+     * @var string[] List of supported field handles.
+     */
+    public static $fieldHandles = [];
+}

lib/craft/bootstrap.php

@@ -0,0 +1,3 @@
+<?php
+
+define('CRAFT_BASE_PATH', __DIR__);

phpstan.neon

@@ -2,6 +2,12 @@ includes:
     - vendor/craftcms/phpstan/phpstan.neon
 
 parameters:
-    level: 1
+    level: 2
     paths:
-        - src
+        - src
+    scanFiles:
+        - lib/craft/behaviors/CustomFieldBehavior.php
+    bootstrapFiles:
+        - lib/craft/bootstrap.php
+    excludePaths:
+        - src/services/migrate/Ether.php

src/SeoFields.php

@@ -11,6 +11,7 @@
 namespace studioespresso\seofields;
 
 use Craft;
+use craft\base\Model;
 use craft\base\Plugin;
 use craft\elements\Entry;
 use craft\events\DefineBehaviorsEvent;
@@ -82,7 +83,7 @@ class SeoFields extends Plugin
 
     // Public Properties
     // =========================================================================
-    public string $schemaVersion = "2.0.0";
+    public string $schemaVersion = "4.0.0";
 
 
     public const EVENT_SEOFIELDS_REGISTER_ELEMENT = "registerSeoElement";
@@ -178,9 +179,7 @@ public function getCpNavItem(): ?array
 
     // Protected Methods
     // =========================================================================
-    // Protected Methods
-    // =========================================================================
-    protected function createSettingsModel(): ?craft\base\Model
+    protected function createSettingsModel(): ?Model
     {
         return new Settings();
     }

src/controllers/CpApiController.php

@@ -16,10 +16,6 @@ class CpApiController extends Controller
     public const NOT_FOUND_BASE = "seo-fields/cp-api/not-found";
     public const REDIRECT_BASE = "seo-fields/cp-api/redirect";
 
-    /**
-     * @param null $siteHandle
-     * @return \yii\web\Response
-     */
     public function actionNotFound()
     {
         $sort = $this->request->getQueryParam('sort');
@@ -61,7 +57,7 @@ public function actionNotFound()
         $formatter = Craft::$app->getFormatter();
 
         foreach ($query->all() as $row) {
-            $lastHit = DateTimeHelper::toDateTime($row->dateLastHit);
+            $lastHit = DateTimeHelper::toDateTime($row->getAttribute('dateLastHit'));
 
             $row = [
                 'id' => $row->getAttribute('id'),
@@ -141,17 +137,17 @@ public function actionRedirects()
         ];
 
         foreach ($query->all() as $row) {
-            $lastHit = DateTimeHelper::toDateTime($row->dateLastHit);
+            $lastHit = DateTimeHelper::toDateTime($row->getAttribute('dateLastHit'));
             $row = [
-                'url' => UrlHelper::cpUrl("seo-fields/redirects/edit/{$row->id}"),
-                'id' => $row->id,
-                'title' => $row->pattern,
-                'redirect' => $row->redirect,
-                'counter' => $row->counter,
-                'site' => !$row->siteId ? "All" : Craft::$app->getSites()->getSiteById($row->siteId)->name,
+                'url' => UrlHelper::cpUrl("seo-fields/redirects/edit/{$row->getAttribute('id')}"),
+                'id' => $row->getAttribute('id'),
+                'title' => $row->getAttribute('pattern'),
+                'redirect' => $row->getAttribute('redirect'),
+                'counter' => $row->getAttribute('counter'),
+                'site' => !$row->getAttribute('siteId') ? "All" : Craft::$app->getSites()->getSiteById($row->getAttribute('siteId'))->name,
                 'lastHit' => $lastHit ? $formatter->asDatetime($lastHit, Locale::LENGTH_SHORT) : "",
-                'method' => $row->method,
-                'matchType' => $types[$row->matchType],
+                'method' => $row->getAttribute('method'),
+                'matchType' => $types[$row->getAttribute('matchType')],
             ];
 
             $rows[] = $row;

src/controllers/DefaultsController.php

@@ -6,6 +6,7 @@
 use craft\helpers\Cp;
 use craft\helpers\UrlHelper;
 use craft\web\Controller;
+use craft\web\Response;
 use studioespresso\seofields\SeoFields;
 
 class DefaultsController extends Controller
@@ -29,7 +30,7 @@ public function actionIndex()
         }
     }
 
-    public function actionSettings()
+    public function actionSettings(): Response
     {
         $site = $this->request->getRequiredQueryParam('site');
         $currentSite = Craft::$app->getSites()->getSiteByHandle($site);

src/controllers/NotFoundController.php

@@ -6,15 +6,12 @@
 use craft\helpers\Cp;
 use craft\helpers\UrlHelper;
 use craft\web\Controller;
+use craft\web\Response;
 use studioespresso\seofields\SeoFields;
 
 class NotFoundController extends Controller
 {
-    /**
-     * @param null $siteHandle
-     * @return \yii\web\Response
-     */
-    public function actionIndex()
+    public function actionIndex(): Response
     {
         $siteHandle = $this->request->getRequiredQueryParam('site');
         $currentSite = Craft::$app->getSites()->getSiteByHandle($siteHandle);

src/controllers/RedirectsController.php

@@ -209,6 +209,7 @@ private function getHeaders($reader)
     private function getRows(Reader $reader)
     {
         try {
+            /** @phpstan-ignore-next-line */
             return $reader->fetchAll();
         } catch (\Throwable $e) {
         }

src/controllers/SchemaController.php

@@ -15,7 +15,7 @@ public function actionIndex()
     {
         $primarySite = Craft::$app->getSites()->getPrimarySite();
         $data = SeoFields::$plugin->defaultsService->getDataBySiteHandle($primarySite->handle);
-        $sections = Craft::$app->getSections()->getAllSections();
+        $sections = Craft::$app->getEntries()->getAllSections();
 
         return $this->renderTemplate('seo-fields/_schema', [
             'data' => $data,

src/migrations/Install.php

@@ -123,7 +123,7 @@ protected function addForeignKeys()
     {
         // $name, $table, $columns, $refTable, $refColumns, $delete = null, $update = null)
         $this->addForeignKey(
-            $this->db->getForeignKeyName(DefaultsRecord::tableName(), 'siteId'),
+            $this->db->getForeignKeyName(),
             DefaultsRecord::tableName(),
             'siteId',
             '{{%sites}}',
@@ -132,7 +132,7 @@ protected function addForeignKeys()
         );
 
         $this->addForeignKey(
-            $this->db->getForeignKeyName(RedirectRecord::tableName(), 'siteId'),
+            $this->db->getForeignKeyName(),
             RedirectRecord::tableName(),
             'siteId',
             '{{%sites}}',
@@ -141,7 +141,7 @@ protected function addForeignKeys()
         );
 
         $this->addForeignKey(
-            $this->db->getForeignKeyName(NotFoundRecord::tableName(), 'siteId'),
+            $this->db->getForeignKeyName(),
             NotFoundRecord::tableName(),
             'siteId',
             '{{%sites}}',
@@ -150,7 +150,7 @@ protected function addForeignKeys()
         );
 
         $this->addForeignKey(
-            $this->db->getForeignKeyName(NotFoundRecord::tableName(), 'redirect'),
+            $this->db->getForeignKeyName(),
             NotFoundRecord::tableName(),
             'redirect',
             '{{%seofields_redirects}}',

src/migrations/m191114_182559_addNotFoundTable.php

@@ -42,7 +42,7 @@ public function safeUp()
 
         if ($tablesCreated) {
             $this->addForeignKey(
-                $this->db->getForeignKeyName(NotFoundRecord::tableName(), 'siteId'),
+                $this->db->getForeignKeyName(),
                 NotFoundRecord::tableName(),
                 'siteId',
                 '{{%sites}}',

src/migrations/m191114_201532_addRedirectsTable.php

@@ -42,15 +42,15 @@ public function safeUp()
 
         if ($tablesCreated) {
             $this->addForeignKey(
-                $this->db->getForeignKeyName(RedirectRecord::tableName(), 'siteId'),
+                $this->db->getForeignKeyName(),
                 RedirectRecord::tableName(),
                 'siteId',
                 '{{%sites}}',
                 'id',
                 'CASCADE'
             );
             $this->addForeignKey(
-                $this->db->getForeignKeyName(NotFoundRecord::tableName(), 'redirect'),
+                $this->db->getForeignKeyName(),
                 NotFoundRecord::tableName(),
                 'redirect',
                 '{{%seofields_redirects}}',

src/models/SeoFieldModel.php

@@ -70,6 +70,7 @@ public function getSchema(Element $element = null)
             return null;
         }
 
+        /** @phpstan-ignore-next-line */
         if (!$element->getShouldRenderSchema()) {
             return null;
         }
@@ -86,22 +87,22 @@ public function getSchema(Element $element = null)
                     $sectionId = $element->section->id;
                     $schemaClass = $schemaSettings[$sectionId];
 
-                    /** @var $schema Schema */
+                    /** @var Schema $schema */
                     $schema = \Craft::createObject($schemaClass);
-                    $schema->name($this->getMetaTitle($element) ?? "");
-                    $schema->description($this->getMetaDescription() ?? "");
-                    $schema->url($element->getUrl() ?? "");
+                    $schema->name($this->getMetaTitle($element) ?? ""); // @phpstan-ignore-line
+                    $schema->description($this->getMetaDescription() ?? ""); // @phpstan-ignore-line
+                    $schema->url($element->getUrl() ?? ""); // @phpstan-ignore-line
                     break;
                 case Category::class:
                     $schemaSettings = $settings['groups'];
                     $groupId = $element->group->id;
                     $schemaClass = $schemaSettings[$groupId];
 
-                    /** @var $schema Schema */
+                    /** @var Schema $schema */
                     $schema = Craft::createObject($schemaClass);
-                    $schema->name($this->getMetaTitle($element) ?? "");
-                    $schema->description($this->getMetaDescription() ?? "");
-                    $schema->url($element->getUrl() ?? "");
+                    $schema->name($this->getMetaTitle($element) ?? ""); // @phpstan-ignore-line
+                    $schema->description($this->getMetaDescription() ?? ""); // @phpstan-ignore-line
+                    $schema->url($element->getUrl() ?? ""); // @phpstan-ignore-line
                     break;
             }
             if ($schema) {

src/records/RedirectRecord.php

@@ -8,6 +8,9 @@
  * @author    Studio Espresso
  * @package   SeoFields
  * @since     1.0.0
+ * @property $dateLastHit
+ * @property $pattern
+ * @property $redirect
  */
 class RedirectRecord extends ActiveRecord
 {

src/services/NotFoundService.php

@@ -10,7 +10,6 @@
 use craft\models\Site;
 use craft\web\Request;
 use studioespresso\seofields\models\NotFoundModel;
-use studioespresso\seofields\models\RedirectModel;
 use studioespresso\seofields\records\NotFoundRecord;
 use studioespresso\seofields\records\RedirectRecord;
 use studioespresso\seofields\SeoFields;
@@ -61,9 +60,9 @@ public function handleNotFound(Request $request, Site $site)
             if ($redirect) {
                 if (is_array($redirect)) {
                     $record = $redirect['record'];
-                    $notFoundModel->redirect = $record->id;
+                    $notFoundModel->redirect = $record->getAttribute('id');
                 } else {
-                    $notFoundModel->redirect = $redirect->id;
+                    $notFoundModel->redirect = $redirect->getAttribute('id');
                 }
                 $notFoundModel->handled = true;
             }
@@ -93,10 +92,6 @@ public function markAsHandled(NotFoundRecord|int $record): void
         return;
     }
 
-    /**
-     * @param NotFoundModel $model
-     * @return RedirectModel|false
-     */
     private function getMatchingRedirect(NotFoundModel $model): RedirectRecord|array|bool
     {
         Craft::debug("Check if our 404 is matched to a redirect", SeoFields::class);
@@ -197,7 +192,7 @@ private function shouldWeCleanupRedirects()
         $toDelete->limit($limit);
         $toDelete->orderBy("dateCreated ASC");
         foreach ($toDelete->all() as $record) {
-            $this->deletetById($record->id);
+            $this->deletetById($record->getAttribute('id'));
         }
     }
 

src/services/SitemapService.php

@@ -355,6 +355,7 @@ private function _shouldRenderProducts($sitemapSettings)
                 /** @phpstan-ignore-next-line */
                 $productTypeService = new ProductTypes();
                 $site = Craft::$app->getSites()->getCurrentSite();
+                /** @phpstan-ignore-next-line */
                 foreach ($productTypeService->getProductTypeSites($productType) as $productTypeSite) {
                     if ($productTypeSite->siteId == $site->id && $productTypeSite->hasUrls) {
                         return true;