♻️ doc types first pass

src/Audit.php

@@ -16,21 +16,21 @@ trait Audit
     /**
      * Audit data.
      *
-     * @var array
+     * @var array<string,mixed>
      */
     protected $data = [];
 
     /**
      * The Audit attributes that belong to the metadata.
      *
-     * @var array
+     * @var array<int,string>
      */
     protected $metadata = [];
 
     /**
      * The Auditable attributes that were modified.
      *
-     * @var array
+     * @var array<int,string>
      */
     protected $modified = [];
 
@@ -118,8 +118,6 @@ public function resolveData(): array
     /**
      * Get the formatted value of an Eloquent model.
      *
-     * @param Model $model
-     * @param string $key
      * @param mixed $value
      *
      * @return mixed
@@ -162,6 +160,11 @@ protected function getFormattedValue(Model $model, string $key, $value)
         return $value;
     }
 
+    /**
+     * @param  Model  $model
+     * @param  mixed  $value
+     * @return mixed
+     */
     private function castDatetimeUTC($model, $value)
     {
         if (!is_string($value)) {
@@ -216,8 +219,6 @@ public function getDataValue(string $key)
     /**
      * Decode attribute value.
      *
-     * @param Contracts\Auditable $auditable
-     * @param string $attribute
      * @param mixed $value
      *
      * @return mixed
@@ -291,9 +292,9 @@ public function getModified(bool $json = false, int $options = 0, int $depth = 5
     /**
      * Get the Audit tags as an array.
      *
-     * @return array
+     * @return array<string>|false
      */
-    public function getTags(): array
+    public function getTags(): array|false
     {
         return preg_split('/,/', $this->tags, -1, PREG_SPLIT_NO_EMPTY);
     }

src/AuditableObserver.php

@@ -20,8 +20,6 @@ class AuditableObserver
     /**
      * Handle the retrieved event.
      *
-     * @param \OwenIt\Auditing\Contracts\Auditable $model
-     *
      * @return void
      */
     public function retrieved(Auditable $model)
@@ -32,8 +30,6 @@ public function retrieved(Auditable $model)
     /**
      * Handle the created event.
      *
-     * @param \OwenIt\Auditing\Contracts\Auditable $model
-     *
      * @return void
      */
     public function created(Auditable $model)
@@ -44,8 +40,6 @@ public function created(Auditable $model)
     /**
      * Handle the updated event.
      *
-     * @param \OwenIt\Auditing\Contracts\Auditable $model
-     *
      * @return void
      */
     public function updated(Auditable $model)
@@ -59,8 +53,6 @@ public function updated(Auditable $model)
     /**
      * Handle the deleted event.
      *
-     * @param \OwenIt\Auditing\Contracts\Auditable $model
-     *
      * @return void
      */
     public function deleted(Auditable $model)
@@ -71,8 +63,6 @@ public function deleted(Auditable $model)
     /**
      * Handle the restoring event.
      *
-     * @param \OwenIt\Auditing\Contracts\Auditable $model
-     *
      * @return void
      */
     public function restoring(Auditable $model)
@@ -86,8 +76,6 @@ public function restoring(Auditable $model)
     /**
      * Handle the restored event.
      *
-     * @param \OwenIt\Auditing\Contracts\Auditable $model
-     *
      * @return void
      */
     public function restored(Auditable $model)
@@ -99,7 +87,7 @@ public function restored(Auditable $model)
         static::$restoring = false;
     }
 
-    protected function dispatchAudit(Auditable $model)
+    protected function dispatchAudit(Auditable $model): void
     {
         if (!$model->readyForAuditing()) {
             return;
@@ -121,10 +109,6 @@ protected function dispatchAudit(Auditable $model)
 
     /**
      * Fire the Auditing event.
-     *
-     * @param \OwenIt\Auditing\Contracts\Auditable $model
-     *
-     * @return bool
      */
     protected function fireDispatchingAuditEvent(Auditable $model): bool
     {

src/Auditor.php

@@ -94,8 +94,6 @@ public function execute(Auditable $model): void
 
     /**
      * Create an instance of the Database audit driver.
-     *
-     * @return \OwenIt\Auditing\Drivers\Database
      */
     protected function createDatabaseDriver(): Database
     {
@@ -104,11 +102,6 @@ protected function createDatabaseDriver(): Database
 
     /**
      * Fire the Auditing event.
-     *
-     * @param \OwenIt\Auditing\Contracts\Auditable $model
-     * @param \OwenIt\Auditing\Contracts\AuditDriver $driver
-     *
-     * @return bool
      */
     protected function fireAuditingEvent(Auditable $model, AuditDriver $driver): bool
     {

src/Console/InstallCommand.php

@@ -20,7 +20,7 @@ class InstallCommand extends Command
     /**
      * {@inheritdoc}
      */
-    public function handle()
+    public function handle(): void
     {
         $this->comment('Publishing Auditing Configuration...');
         $this->callSilent('vendor:publish', ['--tag' => 'config']);

src/Contracts/AttributeRedactor.php

@@ -8,8 +8,6 @@ interface AttributeRedactor extends AttributeModifier
      * Redact an attribute value.
      *
      * @param mixed $value
-     *
-     * @return string
      */
     public static function redact($value): string;
 }

src/Contracts/Audit.php

@@ -38,7 +38,7 @@ public function user();
     /**
      * Audit data resolver.
      *
-     * @return array
+     * @return array<string,mixed>
      */
     public function resolveData(): array;
 
@@ -55,21 +55,21 @@ public function getDataValue(string $key);
      * Get the Audit metadata.
      *
      * @param bool $json
-     * @param int  $options
-     * @param int  $depth
+     * @param int $options
+     * @param int<1, max> $depth
      *
-     * @return array|string
+     * @return array<string,mixed>|string
      */
     public function getMetadata(bool $json = false, int $options = 0, int $depth = 512);
 
     /**
      * Get the Auditable modified attributes.
      *
      * @param bool $json
-     * @param int  $options
-     * @param int  $depth
+     * @param int $options
+     * @param int<1, max> $depth
      *
-     * @return array|string
+     * @return array<string,mixed>|string
      */
     public function getModified(bool $json = false, int $options = 0, int $depth = 512);
 }

src/Contracts/AuditDriver.php

@@ -6,19 +6,11 @@ interface AuditDriver
 {
     /**
      * Perform an audit.
-     *
-     * @param \OwenIt\Auditing\Contracts\Auditable $model
-     *
-     * @return \OwenIt\Auditing\Contracts\Audit
      */
     public function audit(Auditable $model): ?Audit;
 
     /**
      * Remove older audits that go over the threshold.
-     *
-     * @param \OwenIt\Auditing\Contracts\Auditable $model
-     *
-     * @return bool
      */
     public function prune(Auditable $model): bool;
 }

src/Contracts/Auditable.php

@@ -15,10 +15,6 @@ public function audits(): MorphMany;
 
     /**
      * Set the Audit event.
-     *
-     * @param string $event
-     *
-     * @return Auditable
      */
     public function setAuditEvent(string $event): Auditable;
 
@@ -32,14 +28,12 @@ public function getAuditEvent();
     /**
      * Get the events that trigger an Audit.
      *
-     * @return array
+     * @return array<string>
      */
     public function getAuditEvents(): array;
 
     /**
      * Is the model ready for auditing?
-     *
-     * @return bool
      */
     public function readyForAuditing(): bool;
 
@@ -48,35 +42,31 @@ public function readyForAuditing(): bool;
      *
      * @throws \OwenIt\Auditing\Exceptions\AuditingException
      *
-     * @return array
+     * @return array<string,mixed>
      */
     public function toAudit(): array;
 
     /**
      * Get the (Auditable) attributes included in audit.
      *
-     * @return array
+     * @return array<string>
      */
     public function getAuditInclude(): array;
 
     /**
      * Get the (Auditable) attributes excluded from audit.
      *
-     * @return array
+     * @return array<string>
      */
     public function getAuditExclude(): array;
 
     /**
      * Get the strict audit status.
-     *
-     * @return bool
      */
     public function getAuditStrict(): bool;
 
     /**
      * Get the audit (Auditable) timestamps status.
-     *
-     * @return bool
      */
     public function getAuditTimestamps(): bool;
 
@@ -89,43 +79,35 @@ public function getAuditDriver();
 
     /**
      * Get the Audit threshold.
-     *
-     * @return int
      */
     public function getAuditThreshold(): int;
 
     /**
      * Get the Attribute modifiers.
      *
-     * @return array
+     * @return array<string,string>
      */
     public function getAttributeModifiers(): array;
 
     /**
      * Transform the data before performing an audit.
      *
-     * @param array $data
-     *
-     * @return array
+     * @param array<string,mixed> $data
+     * @return array<string,mixed>
      */
     public function transformAudit(array $data): array;
 
     /**
      * Generate an array with the model tags.
      *
-     * @return array
+     * @return array<string>
      */
     public function generateTags(): array;
 
     /**
      * Transition to another model state from an Audit.
      *
-     * @param Audit $audit
-     * @param bool  $old
-     *
      * @throws \OwenIt\Auditing\Exceptions\AuditableTransitionException
-     *
-     * @return Auditable
      */
     public function transitionTo(Audit $audit, bool $old = false): Auditable;
 }

src/Events/AuditCustom.php

@@ -15,8 +15,6 @@ class AuditCustom
 
     /**
      * Create a new Auditing event instance.
-     *
-     * @param \OwenIt\Auditing\Contracts\Auditable $model
      */
     public function __construct(Auditable $model)
     {

src/Events/Audited.php

@@ -31,10 +31,6 @@ class Audited
 
     /**
      * Create a new Audited event instance.
-     *
-     * @param \OwenIt\Auditing\Contracts\Auditable   $model
-     * @param \OwenIt\Auditing\Contracts\AuditDriver $driver
-     * @param \OwenIt\Auditing\Contracts\Audit|null  $audit
      */
     public function __construct(Auditable $model, AuditDriver $driver, ?Audit $audit = null)
     {

src/Events/Auditing.php

@@ -23,9 +23,6 @@ class Auditing
 
     /**
      * Create a new Auditing event instance.
-     *
-     * @param \OwenIt\Auditing\Contracts\Auditable   $model
-     * @param \OwenIt\Auditing\Contracts\AuditDriver $driver
      */
     public function __construct(Auditable $model, AuditDriver $driver)
     {