mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2025-10-31 02:36:28 +00:00
339 lines
13 KiB
PHP
339 lines
13 KiB
PHP
<?php
|
|
|
|
/**
|
|
* TransactionJournal.php
|
|
* Copyright (c) 2019 james@firefly-iii.org
|
|
*
|
|
* This file is part of Firefly III (https://github.com/firefly-iii).
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License as
|
|
* published by the Free Software Foundation, either version 3 of the
|
|
* License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Affero General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License
|
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
*/
|
|
declare(strict_types=1);
|
|
|
|
namespace FireflyIII\Models;
|
|
|
|
use Carbon\Carbon;
|
|
use Eloquent;
|
|
use FireflyIII\Support\Models\ReturnsIntegerIdTrait;
|
|
use FireflyIII\Support\Models\ReturnsIntegerUserIdTrait;
|
|
use FireflyIII\User;
|
|
use Illuminate\Database\Eloquent\Builder;
|
|
use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
|
|
use Illuminate\Database\Eloquent\Casts\Attribute;
|
|
use Illuminate\Database\Eloquent\Collection;
|
|
use Illuminate\Database\Eloquent\Factories\HasFactory;
|
|
use Illuminate\Database\Eloquent\Model;
|
|
use Illuminate\Database\Eloquent\Relations\BelongsTo;
|
|
use Illuminate\Database\Eloquent\Relations\BelongsToMany;
|
|
use Illuminate\Database\Eloquent\Relations\HasMany;
|
|
use Illuminate\Database\Eloquent\Relations\MorphMany;
|
|
use Illuminate\Database\Eloquent\SoftDeletes;
|
|
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
|
|
|
|
/**
|
|
* FireflyIII\Models\TransactionJournal
|
|
*
|
|
* @property int $id
|
|
* @property null|Carbon $created_at
|
|
* @property null|Carbon $updated_at
|
|
* @property null|Carbon $deleted_at
|
|
* @property int $user_id
|
|
* @property int $transaction_type_id
|
|
* @property null|int|string $transaction_group_id
|
|
* @property null|int|string $bill_id
|
|
* @property null|int|string $transaction_currency_id
|
|
* @property null|string $description
|
|
* @property Carbon $date
|
|
* @property null|Carbon $interest_date
|
|
* @property null|Carbon $book_date
|
|
* @property null|Carbon $process_date
|
|
* @property int $order
|
|
* @property int $tag_count
|
|
* @property string $transaction_type_type
|
|
* @property bool $encrypted
|
|
* @property bool $completed
|
|
* @property Attachment[]|Collection $attachments
|
|
* @property null|int $attachments_count
|
|
* @property null|Bill $bill
|
|
* @property Budget[]|Collection $budgets
|
|
* @property null|int $budgets_count
|
|
* @property Category[]|Collection $categories
|
|
* @property null|int $categories_count
|
|
* @property Collection|TransactionJournalLink[] $destJournalLinks
|
|
* @property null|int $dest_journal_links_count
|
|
* @property Collection|Note[] $notes
|
|
* @property null|int $notes_count
|
|
* @property Collection|PiggyBankEvent[] $piggyBankEvents
|
|
* @property null|int $piggy_bank_events_count
|
|
* @property Collection|TransactionJournalLink[] $sourceJournalLinks
|
|
* @property null|int $source_journal_links_count
|
|
* @property Collection|Tag[] $tags
|
|
* @property null|int $tags_count
|
|
* @property null|TransactionCurrency $transactionCurrency
|
|
* @property null|TransactionGroup $transactionGroup
|
|
* @property Collection|TransactionJournalMeta[] $transactionJournalMeta
|
|
* @property null|int $transaction_journal_meta_count
|
|
* @property TransactionType $transactionType
|
|
* @property Collection|Transaction[] $transactions
|
|
* @property null|int $transactions_count
|
|
* @property User $user
|
|
*
|
|
* @method static EloquentBuilder|TransactionJournal after(Carbon $date)
|
|
* @method static EloquentBuilder|TransactionJournal before(Carbon $date)
|
|
* @method static EloquentBuilder|TransactionJournal newModelQuery()
|
|
* @method static EloquentBuilder|TransactionJournal newQuery()
|
|
* @method static \Illuminate\Database\Query\Builder|TransactionJournal onlyTrashed()
|
|
* @method static EloquentBuilder|TransactionJournal query()
|
|
* @method static EloquentBuilder|TransactionJournal transactionTypes($types)
|
|
* @method static EloquentBuilder|TransactionJournal whereBillId($value)
|
|
* @method static EloquentBuilder|TransactionJournal whereBookDate($value)
|
|
* @method static EloquentBuilder|TransactionJournal whereCompleted($value)
|
|
* @method static EloquentBuilder|TransactionJournal whereCreatedAt($value)
|
|
* @method static EloquentBuilder|TransactionJournal whereDate($value)
|
|
* @method static EloquentBuilder|TransactionJournal whereDeletedAt($value)
|
|
* @method static EloquentBuilder|TransactionJournal whereDescription($value)
|
|
* @method static EloquentBuilder|TransactionJournal whereEncrypted($value)
|
|
* @method static EloquentBuilder|TransactionJournal whereId($value)
|
|
* @method static EloquentBuilder|TransactionJournal whereInterestDate($value)
|
|
* @method static EloquentBuilder|TransactionJournal whereOrder($value)
|
|
* @method static EloquentBuilder|TransactionJournal whereProcessDate($value)
|
|
* @method static EloquentBuilder|TransactionJournal whereTagCount($value)
|
|
* @method static EloquentBuilder|TransactionJournal whereTransactionCurrencyId($value)
|
|
* @method static EloquentBuilder|TransactionJournal whereTransactionGroupId($value)
|
|
* @method static EloquentBuilder|TransactionJournal whereTransactionTypeId($value)
|
|
* @method static EloquentBuilder|TransactionJournal whereUpdatedAt($value)
|
|
* @method static EloquentBuilder|TransactionJournal whereUserId($value)
|
|
* @method static \Illuminate\Database\Query\Builder|TransactionJournal withTrashed()
|
|
* @method static \Illuminate\Database\Query\Builder|TransactionJournal withoutTrashed()
|
|
*
|
|
* @property Collection|Location[] $locations
|
|
* @property null|int $locations_count
|
|
* @property int|string $the_count
|
|
* @property int $user_group_id
|
|
*
|
|
* @method static EloquentBuilder|TransactionJournal whereUserGroupId($value)
|
|
*
|
|
* @property Collection<int, AuditLogEntry> $auditLogEntries
|
|
* @property null|int $audit_log_entries_count
|
|
*
|
|
* @mixin Eloquent
|
|
*/
|
|
class TransactionJournal extends Model
|
|
{
|
|
use HasFactory;
|
|
use ReturnsIntegerIdTrait;
|
|
use ReturnsIntegerUserIdTrait;
|
|
use SoftDeletes;
|
|
|
|
protected $casts
|
|
= [
|
|
'created_at' => 'datetime',
|
|
'updated_at' => 'datetime',
|
|
'deleted_at' => 'datetime',
|
|
'date' => 'datetime',
|
|
'interest_date' => 'date',
|
|
'book_date' => 'date',
|
|
'process_date' => 'date',
|
|
'order' => 'int',
|
|
'tag_count' => 'int',
|
|
'encrypted' => 'boolean',
|
|
'completed' => 'boolean',
|
|
];
|
|
|
|
protected $fillable
|
|
= [
|
|
'user_id',
|
|
'user_group_id',
|
|
'transaction_type_id',
|
|
'bill_id',
|
|
'tag_count',
|
|
'transaction_currency_id',
|
|
'description',
|
|
'completed',
|
|
'order',
|
|
'date',
|
|
];
|
|
|
|
protected $hidden = ['encrypted'];
|
|
|
|
/**
|
|
* Route binder. Converts the key in the URL to the specified object (or throw 404).
|
|
*
|
|
* @throws NotFoundHttpException
|
|
*/
|
|
public static function routeBinder(string $value): self
|
|
{
|
|
if (auth()->check()) {
|
|
$journalId = (int)$value;
|
|
|
|
/** @var User $user */
|
|
$user = auth()->user();
|
|
|
|
/** @var null|TransactionJournal $journal */
|
|
$journal = $user->transactionJournals()->where('transaction_journals.id', $journalId)->first(['transaction_journals.*']);
|
|
if (null !== $journal) {
|
|
return $journal;
|
|
}
|
|
}
|
|
|
|
throw new NotFoundHttpException();
|
|
}
|
|
|
|
public function user(): BelongsTo
|
|
{
|
|
return $this->belongsTo(User::class);
|
|
}
|
|
|
|
public function attachments(): MorphMany
|
|
{
|
|
return $this->morphMany(Attachment::class, 'attachable');
|
|
}
|
|
|
|
public function auditLogEntries(): MorphMany
|
|
{
|
|
return $this->morphMany(AuditLogEntry::class, 'auditable');
|
|
}
|
|
|
|
public function bill(): BelongsTo
|
|
{
|
|
return $this->belongsTo(Bill::class);
|
|
}
|
|
|
|
public function budgets(): BelongsToMany
|
|
{
|
|
return $this->belongsToMany(Budget::class);
|
|
}
|
|
|
|
public function categories(): BelongsToMany
|
|
{
|
|
return $this->belongsToMany(Category::class);
|
|
}
|
|
|
|
public function destJournalLinks(): HasMany
|
|
{
|
|
return $this->hasMany(TransactionJournalLink::class, 'destination_id');
|
|
}
|
|
|
|
public function isTransfer(): bool
|
|
{
|
|
if (null !== $this->transaction_type_type) {
|
|
return TransactionType::TRANSFER === $this->transaction_type_type;
|
|
}
|
|
|
|
return $this->transactionType->isTransfer();
|
|
}
|
|
|
|
public function locations(): MorphMany
|
|
{
|
|
return $this->morphMany(Location::class, 'locatable');
|
|
}
|
|
|
|
/**
|
|
* Get all the notes.
|
|
*/
|
|
public function notes(): MorphMany
|
|
{
|
|
return $this->morphMany(Note::class, 'noteable');
|
|
}
|
|
|
|
public function piggyBankEvents(): HasMany
|
|
{
|
|
return $this->hasMany(PiggyBankEvent::class);
|
|
}
|
|
|
|
public function scopeAfter(EloquentBuilder $query, Carbon $date): EloquentBuilder
|
|
{
|
|
return $query->where('transaction_journals.date', '>=', $date->format('Y-m-d 00:00:00'));
|
|
}
|
|
|
|
public function scopeBefore(EloquentBuilder $query, Carbon $date): EloquentBuilder
|
|
{
|
|
return $query->where('transaction_journals.date', '<=', $date->format('Y-m-d 00:00:00'));
|
|
}
|
|
|
|
public function scopeTransactionTypes(EloquentBuilder $query, array $types): void
|
|
{
|
|
if (!self::isJoined($query, 'transaction_types')) {
|
|
$query->leftJoin('transaction_types', 'transaction_types.id', '=', 'transaction_journals.transaction_type_id');
|
|
}
|
|
if (0 !== count($types)) {
|
|
$query->whereIn('transaction_types.type', $types);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Checks if tables are joined.
|
|
*/
|
|
public static function isJoined(Builder $query, string $table): bool
|
|
{
|
|
$joins = $query->getQuery()->joins;
|
|
foreach ($joins as $join) {
|
|
if ($join->table === $table) {
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
public function sourceJournalLinks(): HasMany
|
|
{
|
|
return $this->hasMany(TransactionJournalLink::class, 'source_id');
|
|
}
|
|
|
|
public function tags(): BelongsToMany
|
|
{
|
|
return $this->belongsToMany(Tag::class);
|
|
}
|
|
|
|
public function transactionCurrency(): BelongsTo
|
|
{
|
|
return $this->belongsTo(TransactionCurrency::class);
|
|
}
|
|
|
|
public function transactionGroup(): BelongsTo
|
|
{
|
|
return $this->belongsTo(TransactionGroup::class);
|
|
}
|
|
|
|
public function transactionJournalMeta(): HasMany
|
|
{
|
|
return $this->hasMany(TransactionJournalMeta::class);
|
|
}
|
|
|
|
public function transactionType(): BelongsTo
|
|
{
|
|
return $this->belongsTo(TransactionType::class);
|
|
}
|
|
|
|
public function transactions(): HasMany
|
|
{
|
|
return $this->hasMany(Transaction::class);
|
|
}
|
|
|
|
protected function order(): Attribute
|
|
{
|
|
return Attribute::make(
|
|
get: static fn ($value) => (int)$value,
|
|
);
|
|
}
|
|
|
|
protected function transactionTypeId(): Attribute
|
|
{
|
|
return Attribute::make(
|
|
get: static fn ($value) => (int)$value,
|
|
);
|
|
}
|
|
}
|