Clean up dependencies and inits

Author: MGatner

src/Audits.php

@@ -1,34 +1,7 @@
 <?php namespace Tatter\Audits;
 
-/***
-* Name: Audits
-* Author: Matthew Gatner
-* Contact: mgatner@tattersoftware.com
-* Created: 2019-04-05
-*
-* Description:  Lightweight object logging for CodeIgniter 4
-*
-* Requirements:
-* 	>= PHP 7.1
-* 	>= CodeIgniter 4.0
-*	Preconfigured, autoloaded Database
-*	`audits` table (run migrations)
-*
-* Configuration:
-* 	Use Config/Audits.php to override default behavior
-* 	Run migrations to update database tables:
-* 		> php spark migrate:latest -all
-*
-* @package CodeIgniter4-Audits
-* @author Matthew Gatner
-* @link https://github.com/tattersoftware/codeigniter4-audits
-*
-***/
-
 use CodeIgniter\Config\BaseConfig;
-use CodeIgniter\Config\Services;
 use Tatter\Audits\Models\AuditModel;
-//use Tatter\Audits\Exceptions\AuditsException;
 
 /*** CLASS ***/
 class Audits
@@ -39,55 +12,71 @@ class Audits
 	 * @var \Tatter\Audits\Config\Audits
 	 */
 	protected $config;
+	
+	/**
+	 * Audit rows waiting to add to the database.
+	 *
+	 * @var array
+	 */
+	protected $queue = [];
 
 	/**
-	 * The active user session.
+	 * Store the configuration
 	 *
-	 * @var \CodeIgniter\Session\Session
+	 * @param BaseConfig $config  The Audits configuration to use
 	 */
-	protected $session;
-	
-	// array of audit rows waiting to add to the database
-	protected $queue = [ ];
-	
-	// initiate library, check for existing session
 	public function __construct(BaseConfig $config)
 	{		
-		// save configuration
 		$this->config = $config;
-
-		// initiate the Session library
-		$this->session = Services::session();
 	}
-	
-	// checks for a logged in user based on config
-	// returns user ID, 0 for "not logged in", -1 for CLI
+
+	/**
+	 * Checks the session for a logged in user based on config
+	 *
+	 * @return int  The current user ID, 0 for "not logged in", -1 for CLI
+	 */
 	public function sessionUserId(): int
 	{
 		if (is_cli())
+		{
 			return -1;
-		return $this->session->get($this->config->sessionUserId) ?? 0;
+		}
+
+		return session($this->config->sessionUserId) ?? 0;
 	}
-	
-	// add an audit row to the queue
-	public function add($audit)
+
+	/**
+	 * Add an audit row to the queue
+	 *
+	 * @param array|null  The row to cache for insert
+	 */
+	public function add(array $audit = null)
 	{
 		if (empty($audit))
+		{
 			return false;
-		
-		// add common data
-		$audit['user_id'] = $this->sessionUserId();
+		}
+
+		// Add common data
+		$audit['user_id']    = $this->sessionUserId();
 		$audit['created_at'] = date('Y-m-d H:i:s');
+
 		$this->queue[] = $audit;
 	}
-	
-	// batch insert all audits from the queue
-	public function save()
+
+	/**
+	 * Batch insert all audits from the queue
+	 *
+	 * @return $this
+	 */
+	public function save(): self
 	{
-		if (empty($this->queue))
-			return;
+		if (! empty($this->queue))
+		{
+			$audits = new AuditModel();
+			$audits->insertBatch($this->queue);
+		}
 
-		$audits = new AuditModel();
-		$audits->insertBatch($this->queue);
+		return $this;
 	}
 }

src/Config/Events.php

@@ -1,8 +1,7 @@
 <?php namespace Tatter\Audits\Config;
 
 use CodeIgniter\Events\Events;
-use CodeIgniter\Config\Services;
 
 Events::on('post_system', function () {
-	Services::audits()->save();
+	services('audits')->save();
 });

src/Config/Services.php

@@ -1,20 +1,21 @@
 <?php namespace Tatter\Audits\Config;
 
 use CodeIgniter\Config\BaseService;
-use CodeIgniter\Database\ConnectionInterface;
 
 class Services extends BaseService
 {
     public static function audits(BaseConfig $config = null, bool $getShared = true)
     {
-		if ($getShared):
+		if ($getShared)
+		{
 			return static::getSharedInstance('audits', $config);
-		endif;
+		}
 
 		// If no config was injected then load one
-		// Prioritizes app/Config if found
 		if (empty($config))
+		{
 			$config = config('Audits');
+		}
 
 		return new \Tatter\Audits\Audits($config);
 	}