mirror of
https://github.com/InvoiceShelf/InvoiceShelf.git
synced 2026-04-27 23:24:07 +00:00
Add return types, typed parameters, and PHPDoc to all model methods
Modernize all 16 models with missing type declarations: - Return types on ~87 methods (string, bool, void, array, mixed, etc.) - Typed parameters where missing - PHPDoc blocks on non-obvious methods explaining their purpose Models updated: Invoice, Estimate, Payment, User, Company, Customer, RecurringInvoice, Setting, CompanySetting, FileDisk, Transaction, EmailLog, ExchangeRateLog, PaymentMethod, CustomField, CustomFieldValue.
This commit is contained in:
@@ -5,6 +5,7 @@ namespace App\Models;
|
||||
use Carbon\Carbon;
|
||||
use Illuminate\Database\Eloquent\Factories\HasFactory;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
use Illuminate\Support\Collection;
|
||||
|
||||
class FileDisk extends Model
|
||||
{
|
||||
@@ -25,7 +26,7 @@ class FileDisk extends Model
|
||||
];
|
||||
}
|
||||
|
||||
public function setCredentialsAttribute($value)
|
||||
public function setCredentialsAttribute(mixed $value): void
|
||||
{
|
||||
$this->attributes['credentials'] = json_encode($value);
|
||||
}
|
||||
@@ -80,7 +81,10 @@ class FileDisk extends Model
|
||||
}
|
||||
}
|
||||
|
||||
public function setConfig()
|
||||
/**
|
||||
* Apply this disk's credentials to the filesystem configuration at runtime.
|
||||
*/
|
||||
public function setConfig(): void
|
||||
{
|
||||
$driver = $this->driver;
|
||||
|
||||
@@ -89,12 +93,18 @@ class FileDisk extends Model
|
||||
self::setFilesystem($credentials, $driver);
|
||||
}
|
||||
|
||||
public function setAsDefault()
|
||||
/**
|
||||
* Determine whether this disk is configured as the default storage disk.
|
||||
*/
|
||||
public function setAsDefault(): bool
|
||||
{
|
||||
return $this->set_as_default;
|
||||
}
|
||||
|
||||
public static function setFilesystem($credentials, $driver)
|
||||
/**
|
||||
* Register a dynamic filesystem disk in the runtime configuration using the given credentials.
|
||||
*/
|
||||
public static function setFilesystem(Collection $credentials, string $driver): void
|
||||
{
|
||||
$prefix = env('DYNAMIC_DISK_PREFIX', 'temp_');
|
||||
|
||||
@@ -111,12 +121,12 @@ class FileDisk extends Model
|
||||
config(['filesystems.disks.'.$prefix.$driver => $disks]);
|
||||
}
|
||||
|
||||
public function isSystem()
|
||||
public function isSystem(): bool
|
||||
{
|
||||
return $this->type === self::DISK_TYPE_SYSTEM;
|
||||
}
|
||||
|
||||
public function isRemote()
|
||||
public function isRemote(): bool
|
||||
{
|
||||
return $this->type === self::DISK_TYPE_REMOTE;
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user