Files
InvoiceShelf/app/Models/FileDisk.php
Darko Gjorgjijoski 0fa1aac748 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.
2026-04-03 20:46:26 +02:00

134 lines
3.5 KiB
PHP

<?php
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
{
use HasFactory;
public const DISK_TYPE_SYSTEM = 'SYSTEM';
public const DISK_TYPE_REMOTE = 'REMOTE';
protected $guarded = [
'id',
];
protected function casts(): array
{
return [
'set_as_default' => 'boolean',
];
}
public function setCredentialsAttribute(mixed $value): void
{
$this->attributes['credentials'] = json_encode($value);
}
public function scopeWhereOrder($query, $orderByField, $orderBy)
{
$query->orderBy($orderByField, $orderBy);
}
public function scopeFileDisksBetween($query, $start, $end)
{
return $query->whereBetween(
'file_disks.created_at',
[$start->format('Y-m-d'), $end->format('Y-m-d')]
);
}
public function scopeWhereSearch($query, $search)
{
foreach (explode(' ', $search) as $term) {
$query->where('name', 'LIKE', '%'.$term.'%')
->orWhere('driver', 'LIKE', '%'.$term.'%');
}
}
public function scopePaginateData($query, $limit)
{
if ($limit == 'all') {
return $query->get();
}
return $query->paginate($limit);
}
public function scopeApplyFilters($query, array $filters)
{
$filters = collect($filters);
if ($filters->get('search')) {
$query->whereSearch($filters->get('search'));
}
if ($filters->get('from_date') && $filters->get('to_date')) {
$start = Carbon::createFromFormat('Y-m-d', $filters->get('from_date'));
$end = Carbon::createFromFormat('Y-m-d', $filters->get('to_date'));
$query->fileDisksBetween($start, $end);
}
if ($filters->get('orderByField') || $filters->get('orderBy')) {
$field = $filters->get('orderByField') ? $filters->get('orderByField') : 'sequence_number';
$orderBy = $filters->get('orderBy') ? $filters->get('orderBy') : 'asc';
$query->whereOrder($field, $orderBy);
}
}
/**
* Apply this disk's credentials to the filesystem configuration at runtime.
*/
public function setConfig(): void
{
$driver = $this->driver;
$credentials = collect(json_decode($this['credentials']));
self::setFilesystem($credentials, $driver);
}
/**
* Determine whether this disk is configured as the default storage disk.
*/
public function setAsDefault(): bool
{
return $this->set_as_default;
}
/**
* 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_');
config(['filesystems.default' => $prefix.$driver]);
$disks = config('filesystems.disks.'.$driver);
foreach ($disks as $key => $value) {
if ($credentials->has($key)) {
$disks[$key] = $credentials[$key];
}
}
config(['filesystems.disks.'.$prefix.$driver => $disks]);
}
public function isSystem(): bool
{
return $this->type === self::DISK_TYPE_SYSTEM;
}
public function isRemote(): bool
{
return $this->type === self::DISK_TYPE_REMOTE;
}
}