Apply SA fixes

Author: MGatner

phpstan.neon.dist

@@ -10,8 +10,6 @@ parameters:
 		- src/Config/Routes.php
 		- src/Views/*
 	ignoreErrors:
-		- '#Cannot access property [\$a-z_]+ on (array|object)#'
-		- '#Unsafe usage of new static\(\)*#'
 	universalObjectCratesClasses:
 		- CodeIgniter\Entity
 		- Faker\Generator

src/Audits.php

@@ -1,15 +1,15 @@
 <?php namespace Tatter\Audits;
 
-use CodeIgniter\Config\BaseConfig;
 use Tatter\Audits\Models\AuditModel;
+use Tatter\Audits\Config\Audits as AuditsConfig;
 
 /*** CLASS ***/
 class Audits
 {
 	/**
 	 * Our configuration instance.
 	 *
-	 * @var \Tatter\Audits\Config\Audits
+	 * @var AuditsConfig
 	 */
 	protected $config;
 
@@ -23,9 +23,9 @@ class Audits
 	/**
 	 * Store the configuration
 	 *
-	 * @param BaseConfig $config  The Audits configuration to use
+	 * @param AuditsConfig $config  The Audits configuration to use
 	 */
-	public function __construct(BaseConfig $config)
+	public function __construct(AuditsConfig $config)
 	{		
 		$this->config = $config;
 	}
@@ -58,7 +58,7 @@ public function getQueue(): array
 	/**
 	 * Add an audit row to the queue
 	 *
-	 * @param array|null  The row to cache for insert
+	 * @param array|null $audit The row to cache for insert
 	 */
 	public function add(array $audit = null)
 	{

src/Config/Services.php

@@ -1,10 +1,18 @@
 <?php namespace Tatter\Audits\Config;
 
+use Config\Services as BaseServices;
 use Tatter\Audits\Audits;
+use Tatter\Audits\Config\Audits as AuditsConfig;
 
-class Services extends \Config\Services
+class Services extends BaseServices
 {
-    public static function audits(BaseConfig $config = null, bool $getShared = true)
+	/**
+	 * @param AuditsConfig|null $config
+	 * @param bool $getShared
+	 *
+	 * @return Audits
+	 */
+    public static function audits(AuditsConfig $config = null, bool $getShared = true): Audits
     {
 		if ($getShared)
 		{

src/Traits/AuditsTrait.php

@@ -1,40 +1,61 @@
 <?php namespace Tatter\Audits\Traits;
 
-use CodeIgniter\Config\Services;
 use Tatter\Audits\Models\AuditModel;
 
 /*** CLASS ***/
 trait AuditsTrait
 {
-	// takes an array of model $returnTypes and returns an array of Audits, arranged by object and event
-	// optionally filter by $events (string or array of strings)
+	/**
+	 * Takes an array of model $returnTypes
+	 * and returns an array of Audits,
+	 * arranged by object and event.
+	 * Optionally filter by $events
+	 * (string or array of strings).
+	 *
+	 * @param array $objects
+	 * @param array|string|null $events
+	 *
+	 * @internal Due to a typo this function has never worked in a released version.
+	 *           It will be refactored soon without announcing a new major release
+	 *           so do not build on the signature or functionality.
+	 */
 	public function getAudits(array $objects, $events = null): array
 	{
 		if (empty($objects))
-			return null;
-	
-		// get the primary keys from the objects
+		{
+			return [];
+		}
+
+		// Get the primary keys from the objects
 		$objectIds = array_column($objects, $this->primaryKey);
-		
-		$audits = new AuditModel();
-		$query = $query->where('source', $this->table)
-			->whereIn('source_id', $objectIds);
+
+		// Start the query
+		$query = model(AuditModel::class)->where('source', $this->table)->whereIn('source_id', $objectIds);
+
 		if (is_string($events))
+		{
 			$query = $query->where('event', $events);
+		}
 		elseif (is_array($events))
+		{
 			$query = $query->whereIn('event', $events);
+		}
 
-		// index by objectId, event
-		$array = [ ];
-		while ($audit = $query->getUnbufferedRow()):
+		// Index by objectId, event
+		$array = [];
+		while ($audit = $query->getUnbufferedRow())
+		{
 			if (empty($array[$audit->{$this->primaryKey}]))
-				$array[$audit->{$this->primaryKey}] = [ ];
-				
+			{
+				$array[$audit->{$this->primaryKey}] = [];
+			}	
 			if (empty($array[$audit->{$this->primaryKey}][$audit->event]))
-				$array[$audit->{$this->primaryKey}][$audit->event] = [ ];
+			{
+				$array[$audit->{$this->primaryKey}][$audit->event] = [];
+			}
 
 			$array[$audit->{$this->primaryKey}][$audit->event][] = $audit;
-		endwhile;
+		}
 
 		return $array;
 	}
@@ -47,11 +68,11 @@ protected function auditInsert(array $data)
 
 		$audit = [
 			'source'    => $this->table,
-			'source_id' => $this->db->insertID(),
+			'source_id' => $this->db->insertID(), // @phpstan-ignore-line
 			'event'     => 'insert',
 			'summary'   => count($data['data']) . ' fields',
 		];
-		Services::audits()->add($audit);
+		service('audits')->add($audit);
 
 		return $data;
 	}
@@ -65,7 +86,7 @@ protected function auditUpdate(array $data)
 			'event'     => 'update',
 			'summary'   => count($data['data']) . ' fields',
 		];
-		Services::audits()->add($audit);
+		service('audits')->add($audit);
 
 		return $data;
 	}
@@ -85,7 +106,7 @@ protected function auditDelete(array $data)
 		];
 
 		// add an entry for each ID
-		$audits = Services::audits();
+		$audits = service('audits');
 		foreach ($data['id'] as $id):
 			$audit['source_id'] = $id;
 			$audits->add($audit);

tests/_support/Database/Migrations/2019-09-02-092335_create_test_tables.php

@@ -6,8 +6,6 @@ class CreateTestTables extends Migration
 {
 	public function up()
 	{
-		$this->db->disableForeignKeyChecks();
-		
 		// Widgets
 		$fields = [
 			'name'           => ['type' => 'varchar', 'constraint' => 31],
@@ -27,16 +25,10 @@ public function up()
 		$this->forge->addKey('created_at');
 
 		$this->forge->createTable('widgets');
-
-		$this->db->enableForeignKeyChecks();
 	}
 
 	public function down()
 	{
-		$this->db->disableForeignKeyChecks();
-		
 		$this->forge->dropTable('widgets');
-		
-		$this->db->enableForeignKeyChecks();
 	}
 }

tests/_support/DatabaseTestCase.php

@@ -4,6 +4,7 @@
 use CodeIgniter\Test\Fabricator;
 use Config\Services;
 use Tatter\Audits\Audits;
+use Tatter\Audits\Config\Audits as AuditsConfig;
 use Tests\Support\Models\WidgetModel;
 
 class DatabaseTestCase extends CIDatabaseTestCase
@@ -18,21 +19,21 @@ class DatabaseTestCase extends CIDatabaseTestCase
 	/**
 	 * Our configuration
 	 *
-	 * @var Tatter\Audits\Config\Audits
+	 * @var AuditsConfig
 	 */
 	protected $config;
 
 	/**
 	 * Instance of the test model
 	 *
-	 * @var Tests\Support\Models\WidgetModel
+	 * @var WidgetModel
 	 */
 	protected $model;
 
 	/**
 	 * Instance of the fabricator primed with our model
 	 *
-	 * @var CodeIgniter\Test\Fabricator
+	 * @var Fabricator
 	 */
 	protected $fabricator;
 
@@ -57,8 +58,6 @@ public function setUp(): void
 	 * Asserts that an audit with the given properties is in the queue
 	 *
 	 * @param array $values  Array of values to confirm
-	 *
-	 * @return self
 	 */
 	public function seeAudit(array $values)
 	{

tests/_support/Models/WidgetModel.php

@@ -26,7 +26,7 @@ class WidgetModel extends Model
 	 *
 	 * @param Generator $faker
 	 *
-	 * @return stdClass
+	 * @return object
 	 */
 	public function fake(Generator &$faker): object
 	{