chore: craft 5 support

.github/workflows/code-analysis.yaml

@@ -0,0 +1,37 @@
+name: Code Analysis
+
+on:
+  pull_request:
+  workflow_dispatch:
+permissions:
+  contents: read
+jobs:
+  code_analysis:
+    strategy:
+      fail-fast: false
+      matrix:
+        actions:
+          - name: 'PHPStan'
+            run: composer phpstan
+          - name: 'Coding Standards'
+            run: composer check-cs
+    name: ${{ matrix.actions.name }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Cache Composer dependencies
+        uses: actions/cache@v4
+        with:
+          path: /tmp/composer-cache
+          key: ${{ runner.os }}-${{ hashFiles('**/composer.lock') }}
+      - name: Setup PHP
+        id: setup-php
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.2
+          extensions: 'ctype,curl,dom,iconv,imagick,intl,json,mbstring,openssl,pcre,pdo,reflection,spl,zip'
+          ini-values: post_max_size=256M, max_execution_time=180, memory_limit=512M
+          tools: composer:v2
+      - name: Install Composer dependencies
+        run: composer install --no-interaction --no-ansi --no-progress
+      - run: ${{ matrix.actions.run }}

composer.json

@@ -22,11 +22,16 @@
         }
     ],
     "require": {
-        "php": "^8.0.2",
+        "php": "^8.2.0",
         "craftcms/cms": "^4.0.0",
         "donatj/phpuseragentparser": "^1.7.0",
         "geoip2/geoip2": "^2.5"
     },
+    "require-dev": {
+        "craftcms/ecs": "dev-main",
+        "craftcms/phpstan": "dev-main",
+        "craftcms/rector": "dev-main"
+    },
     "repositories": [
         {
             "type": "composer",
@@ -38,6 +43,19 @@
           "superbig\\audit\\": "src/"
         }
     },
+    "scripts": {
+        "phpstan": "phpstan --ansi --memory-limit=1G",
+        "check-cs": "ecs check --ansi",
+        "fix-cs": "ecs check --fix --ansi"
+    },
+    "config": {
+        "allow-plugins": {
+            "craftcms/plugin-installer": true,
+            "yiisoft/yii2-composer": true
+        },
+        "optimize-autoloader": true,
+        "sort-packages": true
+    },
     "extra": {
         "name": "Audit",
         "handle": "audit",

ecs.php

@@ -0,0 +1,14 @@
+<?php
+
+use craft\ecs\SetList;
+use Symplify\EasyCodingStandard\Config\ECSConfig;
+
+return static function(ECSConfig $ecsConfig): void {
+    $ecsConfig->paths([
+        __DIR__ . '/src',
+        __FILE__,
+    ]);
+
+    $ecsConfig->parallel();
+    $ecsConfig->sets([SetList::CRAFT_CMS_4]);
+};

phpstan.neon

@@ -0,0 +1,6 @@
+includes:
+    - %currentWorkingDirectory%/vendor/craftcms/phpstan/phpstan.neon
+parameters:
+    level: 5
+    paths:
+        - src

src/Audit.php

@@ -10,30 +10,29 @@
 
 namespace superbig\audit;
 
-use craft\events\ElementEvent;
+use Craft;
 
+use craft\base\Plugin;
+use craft\console\Application as ConsoleApplication;
+use craft\events\ElementEvent;
+use craft\events\PluginEvent;
+use craft\events\RegisterUrlRulesEvent;
 use craft\events\RegisterUserPermissionsEvent;
 use craft\events\RouteEvent;
 use craft\helpers\StringHelper;
 use craft\queue\jobs\ResaveElements;
 use craft\queue\Queue;
+use craft\services\Elements;
+use craft\services\Plugins;
+
 use craft\services\Routes;
 use craft\services\UserPermissions;
 use craft\web\twig\variables\CraftVariable;
+use craft\web\UrlManager;
 use superbig\audit\models\AuditModel;
+use superbig\audit\models\Settings;
 use superbig\audit\services\Audit_GeoService;
 use superbig\audit\services\AuditService;
-use superbig\audit\models\Settings;
-
-use Craft;
-use craft\console\Application as ConsoleApplication;
-use craft\base\Plugin;
-use craft\services\Plugins;
-use craft\events\PluginEvent;
-use craft\web\UrlManager;
-use craft\services\Elements;
-use craft\events\RegisterComponentTypesEvent;
-use craft\events\RegisterUrlRulesEvent;
 
 use superbig\audit\variables\AuditVariable;
 use yii\base\Event;
@@ -54,8 +53,8 @@
  */
 class Audit extends Plugin
 {
-    const PERMISSION_VIEW_LOGS = 'audit-view-logs';
-    const PERMISSION_CLEAR_LOGS = 'audit-clear-logs';
+    public const PERMISSION_VIEW_LOGS = 'audit-view-logs';
+    public const PERMISSION_CLEAR_LOGS = 'audit-clear-logs';
 
     public static Audit $plugin;
     public static $craft31 = false;
@@ -251,7 +250,7 @@
                 'event' => Elements::EVENT_AFTER_SAVE_ELEMENT,
                 'handler' => function(ElementEvent $event) {
                     $isNew = $event->sender->firstSave ?? $event->isNew;
                     $this->auditService->onSaveElement($event->element, $isNew);
                 },
             ],
             [

src/assetbundles/audit/AuditAsset.php

@@ -10,7 +10,6 @@
 
 namespace superbig\audit\assetbundles\audit;
 
-use Craft;
 use craft\web\AssetBundle;
 use craft\web\assets\cp\CpAsset;
 

src/assetbundles/indexcpsection/IndexCPSectionAsset.php

@@ -10,7 +10,6 @@
 
 namespace superbig\audit\assetbundles\indexcpsection;
 
-use Craft;
 use craft\web\AssetBundle;
 use craft\web\assets\cp\CpAsset;
 

src/config.php

@@ -24,26 +24,26 @@
 
 return [
     // How many days to keep log entries around
-    'pruneDays'                   => 30,
+    'pruneDays' => 30,
 
     // Enable logging
-    'enabled'                     => true,
+    'enabled' => true,
 
     // Toggle specific event types
-    'logElementEvents'            => true,
-    'logChildElementEvents'       => false,
-    'logDraftEvents'              => false,
-    'logPluginEvents'             => true,
-    'logUserEvents'               => true,
-    'logRouteEvents'              => true,
+    'logElementEvents' => true,
+    'logChildElementEvents' => false,
+    'logDraftEvents' => false,
+    'logPluginEvents' => true,
+    'logUserEvents' => true,
+    'logRouteEvents' => true,
 
     // Prune old records when a admin is logged in
     'pruneRecordsOnAdminRequests' => false,
 
     // Enable geolocation status
-    'enabledGeolocation'          => true,
-    'maxmindLicenseKey'           => '',
+    'enabledGeolocation' => true,
+    'maxmindLicenseKey' => '',
 
     // Where to save Maxmind DB files
-    'dbPath'                      => '',
+    'dbPath' => '',
 ];

src/console/controllers/DefaultController.php

@@ -23,7 +23,6 @@
  */
 class DefaultController extends Controller
 {
-
     // Protected Properties
     // =========================================================================
 
@@ -59,7 +58,7 @@
         ConsoleHelper::startProgress(4, 6);
 
         if (isset($response['error'])) {
             Console::error($response['error']);
             ConsoleHelper::endProgress();
 
             return ExitCode::DATAERR;

src/controllers/DefaultController.php

@@ -10,12 +10,12 @@
 
 namespace superbig\audit\controllers;
 
+use Craft;
 use craft\helpers\Template;
 use craft\helpers\UrlHelper;
-use superbig\audit\Audit;
 
-use Craft;
 use craft\web\Controller;
+use superbig\audit\Audit;
 use superbig\audit\models\AuditModel;
 use superbig\audit\records\AuditRecord;
 
@@ -26,7 +26,6 @@
  */
 class DefaultController extends Controller
 {
-
     // Protected Properties
     // =========================================================================
 
@@ -35,7 +34,7 @@
      *         The actions must be in 'kebab-case'
      * @access protected
      */
     protected array|int|bool $allowAnonymous = [];
 
     // Public Methods
     // =========================================================================
@@ -48,12 +47,12 @@
         $this->requirePermission(Audit::PERMISSION_VIEW_LOGS);
 
         $itemsPerPage = 100;
-        $query    = AuditRecord::find()
+        $query = AuditRecord::find()
                                ->orderBy('dateCreated desc')
                                ->with('user')
                                ->limit($itemsPerPage)
                                ->where(['parentId' => null]);
-        $models   = [];
+        $models = [];
         $paginate = Template::paginateCriteria($query);
         list($pageInfo, $records) = $paginate;
 
@@ -64,7 +63,7 @@
         }
 
         return $this->renderTemplate('audit/index', [
-            'logs'     => $models,
+            'logs' => $models,
             'pageInfo' => $pageInfo,
         ]);
     }
@@ -80,13 +79,13 @@
     {
         $this->requirePermission(Audit::PERMISSION_VIEW_LOGS);
 
-        $service       = Audit::$plugin->auditService;
-        $log           = $service->getEventById($id);
+        $service = Audit::$plugin->auditService;
+        $log = $service->getEventById($id);
         $logsInSession = $service->getEventsBySessionId($log->sessionId);
 
         return $this->renderTemplate('audit/_view', [
-            'settings'      => Audit::$plugin->getSettings(),
-            'log'           => $log,
+            'settings' => Audit::$plugin->getSettings(),
+            'log' => $log,
             'logsInSession' => $logsInSession,
         ]);
     }

src/controllers/GeoController.php

@@ -10,19 +10,11 @@
 
 namespace superbig\audit\controllers;
 
-use craft\helpers\Template;
-use craft\web\UrlManager;
-use superbig\audit\Audit;
-
 use Craft;
+
 use craft\web\Controller;
-use superbig\audit\models\AuditModel;
-use superbig\audit\records\AuditRecord;
-use yii\data\Pagination;
+use superbig\audit\Audit;
 use yii\web\HttpException;
-use yii\widgets\LinkPager;
-
-use JasonGrimes\Paginator;
 
 /**
  * @author    Superbig
@@ -31,7 +23,6 @@
  */
 class GeoController extends Controller
 {
-
     protected array|int|bool $allowAnonymous = ['update-database'];
 
     // Protected Properties
@@ -69,25 +60,25 @@
     public function actionUpdateDatabase()
     {
         $validKey = Audit::$plugin->getSettings()->updateAuthKey;
-        $key      = Craft::$app->getRequest()->getParam('key');
+        $key = Craft::$app->getRequest()->getParam('key');
 
         if (!Craft::$app->getUser()->getIsAdmin() && $key !== $validKey) {
             throw new HttpException('Not authorized to run this action');
         }
 
         $response = Audit::$plugin->geo->downloadDatabase();
 
         if (isset($response['error'])) {
             return $this->renderJSON($response['error']);
         }
 
         $response = Audit::$plugin->geo->unpackDatabase();
 
         if (isset($response['error'])) {
             return $this->renderJSON($response['error']);
         }
 
         return $this->renderJSON($response);
     }
 
     /**

src/events/SnapshotEvent.php

@@ -29,5 +29,4 @@ class SnapshotEvent extends Event
      * @var array Snapshot
      */
     public $snapshot;
-
 }

src/helpers/Route.php

@@ -10,25 +10,9 @@
 
 namespace superbig\audit\helpers;
 
-use craft\base\Element;
-use craft\base\ElementInterface;
-use craft\base\Field;
-use craft\base\Plugin;
-use craft\base\PluginInterface;
-use craft\fields\Assets;
-use craft\fields\Entries;
-use craft\fields\Lightswitch;
 use craft\helpers\Html;
-use craft\helpers\Json;
-use craft\models\EntryDraft;
 use superbig\audit\Audit;
 
-use Craft;
-use craft\base\Component;
-use superbig\audit\models\AuditModel;
-use superbig\audit\records\AuditRecord;
-use yii\base\Exception;
-
 /**
  * @author    Superbig
  * @package   Audit
@@ -48,16 +32,15 @@ public static function getUriDisplayHtml($uriParts = [])
         foreach ($uriParts as $part) {
             if (is_string($part)) {
                 $uriDisplayHtml .= Html::encode($part);
-            }
-            else {
+            } else {
                 $uriDisplayHtml .= Html::encodeParams('<span class="token" data-name="{name}" data-value="{value}"><span>{name}</span></span>',
                     [
-                        'name'  => $part[0],
+                        'name' => $part[0],
                         'value' => $part[1],
                     ]);
             }
         }
 
         return $uriDisplayHtml;
     }
-}
+}