Code quality improvements

Api/Activity/ModelInterface.php

@@ -23,17 +23,18 @@
 interface ModelInterface
 {
     /**
-     * Get old data
      * @param DataObject $model
      * @return mixed
      */
     public function getOldData(DataObject $model);
 
     /**
-     * Get edit data
      * @param DataObject $model
-     * @param $fieldArray
-     * @return mixed
+     * @param array<string, string> $fieldArray
+     * @return array{}|array<string, array{
+     *       old_value: string,
+     *       new_value: string
+     *   }>
      */
-    public function getEditData(DataObject $model, $fieldArray);
+    public function getEditData(DataObject $model, array $fieldArray);
 }

Block/Adminhtml/ActivityLogListing.php

@@ -16,6 +16,8 @@
 
 use Magento\Backend\Block\Template;
 use Magento\Backend\Block\Template\Context;
+use Magento\Directory\Helper\Data as DirectoryHelper;
+use Magento\Framework\Json\Helper\Data as JsonHelper;
 use MageOS\AdminActivityLog\Api\ActivityRepositoryInterface;
 use MageOS\AdminActivityLog\Helper\Browser;
 
@@ -25,31 +27,31 @@
  */
 class ActivityLogListing extends Template
 {
-    /**
-     * Path to template file in theme.
-     * @var string
-     */
     protected $_template = 'MageOS_AdminActivityLog::log_listing.phtml';
 
-    /**
-     * ActivityLogListing constructor.
-     * @param Context $context
-     * @param ActivityRepositoryInterface $activityRepository
-     * @param Browser $browser
-     */
     public function __construct(
-        Context $context,
         protected readonly ActivityRepositoryInterface $activityRepository,
-        protected readonly Browser $browser
+        protected readonly Browser $browser,
+        Context $context,
+        array $data = [],
+        ?JsonHelper $jsonHelper = null,
+        ?DirectoryHelper $directoryHelper = null
     ) {
-        parent::__construct($context);
+        parent::__construct($context, $data, $jsonHelper, $directoryHelper);
     }
 
     /**
      * Get admin activity log listing
-     * @return array
+     *
+     * @return null|array<int, array{
+     *     entity_id: string,
+     *     activity_id: string,
+     *     field_name: string,
+     *     old_value: string,
+     *     new_value: string
+     * }>
      */
-    public function getLogListing()
+    public function getLogListing(): ?array
     {
         $id = $this->getRequest()->getParam('id');
         $data = $this->activityRepository->getActivityLog($id);
@@ -58,9 +60,9 @@ public function getLogListing()
 
     /**
      * Get admin activity details
-     * @return array
+     * @return array<string, string>
      */
-    public function getAdminDetails()
+    public function getAdminDetails(): array
     {
         $id = $this->getRequest()->getParam('id');
         $activity = $this->activityRepository->getActivityById($id);
@@ -69,14 +71,14 @@ public function getAdminDetails()
         $this->browser->setUserAgent($activity->getUserAgent());
         $browser = $this->browser->__toString();
 
-        $logData = [];
-        $logData['username'] = $activity->getUsername();
-        $logData['module'] = $activity->getModule();
-        $logData['name'] = $activity->getName();
-        $logData['fullaction'] = $activity->getFullaction();
-        $logData['browser'] = $browser;
-        $logData['date'] = $activity->getUpdatedAt();
-        return $logData;
+        return [
+            'username' => $activity->getUsername(),
+            'module' => $activity->getModule(),
+            'name' => $activity->getName(),
+            'fullaction' => $activity->getFullaction(),
+            'browser' => $browser,
+            'date' => $activity->getUpdatedAt()
+        ];
     }
 
     public function getActivityRepository(): ActivityRepositoryInterface

Block/Adminhtml/Selector.php

@@ -24,7 +24,6 @@ class Selector extends Template
 {
     /**
      * Revert Activity Log action URL
-     * @return string
      */
     public function getRevertUrl(): string
     {

Controller/Adminhtml/Activity/Index.php

@@ -25,25 +25,16 @@
  */
 class Index extends Action
 {
-    /**
-     * @var string
-     */
-    public const ADMIN_RESOURCE = 'MageOS_AdminActivityLog::activity';
+    public const string ADMIN_RESOURCE = 'MageOS_AdminActivityLog::activity';
 
-    /**
-     * Index constructor.
-     * @param Context $context
-     * @param PageFactory $resultPageFactory
-     */
     public function __construct(
         Context $context,
-        protected readonly PageFactory $resultPageFactory
+        private readonly PageFactory $resultPageFactory
     ) {
         parent::__construct($context);
     }
 
     /**
-     * Index action
      * @return Page
      */
     public function execute()

Controller/Adminhtml/Activity/Log.php

@@ -27,30 +27,20 @@
  */
 class Log extends Action
 {
-    /**
-     * Log constructor.
-     * @param Context $context
-     * @param RawFactory $resultRawFactory
-     * @param LayoutFactory $layoutFactory
-     */
     public function __construct(
         Context $context,
-        protected readonly RawFactory $resultRawFactory,
-        protected readonly LayoutFactory $layoutFactory
+        private readonly RawFactory $resultRawFactory,
+        private readonly LayoutFactory $layoutFactory
     ) {
         parent::__construct($context);
     }
 
     /**
-     * view action
      * @return Raw
      */
     public function execute()
     {
-        $content = $this->layoutFactory->create()
-            ->createBlock(
-                ActivityLogListing::class
-            );
+        $content = $this->layoutFactory->create()->createBlock(ActivityLogListing::class);
 
         /** @var Raw $resultRaw */
         $resultRaw = $this->resultRawFactory->create();

Controller/Adminhtml/Activity/Revert.php

@@ -26,29 +26,22 @@
  */
 class Revert extends Action
 {
-    /**
-     * Revert constructor.
-     * @param Context $context
-     * @param JsonFactory $resultJsonFactory
-     * @param Processor $processor
-     */
     public function __construct(
         Context $context,
-        protected readonly JsonFactory $resultJsonFactory,
-        protected readonly Processor $processor
+        private readonly JsonFactory $resultJsonFactory,
+        private readonly Processor $processor
     ) {
         parent::__construct($context);
     }
 
     /**
-     * Revert action
      * @return Json
      */
     public function execute()
     {
         $activityId = $this->getRequest()->getParam('id');
 
-        $result = $this->processor->revertActivity($activityId);
+        $result = $this->processor->revertActivity((int)$activityId);
 
         $json = $this->resultJsonFactory->create();
         $json->setData($result);

Controller/Adminhtml/Login/Index.php

@@ -25,16 +25,8 @@
  */
 class Index extends Action
 {
-    /**
-     * @var string
-     */
-    public const ADMIN_RESOURCE = 'MageOS_AdminActivityLog::login_activity';
+    public const string ADMIN_RESOURCE = 'MageOS_AdminActivityLog::login_activity';
 
-    /**
-     * Index constructor.
-     * @param Context $context
-     * @param PageFactory $resultPageFactory
-     */
     public function __construct(
         Context $context,
         protected readonly PageFactory $resultPageFactory

Cron/ClearLog.php

@@ -29,18 +29,9 @@ class ClearLog
 {
     /**
      * Default date format
-     * @var string
      */
-    protected const DATE_FORMAT = 'Y-m-d H:i:s';
+    protected const string DATE_FORMAT = 'Y-m-d H:i:s';
 
-    /**
-     * ClearLog constructor.
-     * @param LoggerInterface $logger
-     * @param DateTime $dateTime
-     * @param Helper $helper
-     * @param ActivityRepositoryInterface $activityRepository
-     * @param LoginRepositoryInterface $loginRepository
-     */
     public function __construct(
         protected readonly LoggerInterface $logger,
         protected readonly DateTime $dateTime,

Helper/Benchmark.php

@@ -33,18 +33,13 @@ class Benchmark extends AbstractHelper
     /**
      * @var String[] Start time of execution
      */
-    private $startTime = [];
+    private array $startTime = [];
 
     /**
      * @var String[] End time of execution
      */
-    private $endTime = [];
+    private array $endTime = [];
 
-    /**
-     * Benchmark constructor.
-     * @param Context $context
-     * @param LoggerInterface $logger
-     */
     public function __construct(
         Context $context,
         protected LoggerInterface $logger
@@ -54,10 +49,8 @@ public function __construct(
 
     /**
      * log info about start time in millisecond
-     * @param $method
-     * @return void
      */
-    public function start($method): void
+    public function start(string $method): void
     {
         $this->reset($method);
         if (self::BENCHMARK_ENABLE) {
@@ -70,10 +63,8 @@ public function start($method): void
 
     /**
      * log info about end time and time diiference in millisecond
-     * @param $method
-     * @return void
      */
-    public function end($method): void
+    public function end(string $method): void
     {
         if (self::BENCHMARK_ENABLE) {
             $this->endTime[$method] = round(microtime(true) * 1000);
@@ -89,10 +80,8 @@ public function end($method): void
 
     /**
      * Reset start time and end time
-     * @param $method
-     * @return void
      */
-    public function reset($method): void
+    public function reset(string $method): void
     {
         $this->startTime[$method] = 0;
         $this->endTime[$method] = 0;