Files
firefly-iii/app/Models/TransactionType.php
T

123 lines
3.5 KiB
PHP

<?php
/**
* TransactionType.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 Deprecated;
use FireflyIII\Enums\TransactionTypeEnum;
use FireflyIII\Support\Models\ReturnsIntegerIdTrait;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Illuminate\Database\Eloquent\SoftDeletes;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
class TransactionType extends Model
{
use ReturnsIntegerIdTrait;
use SoftDeletes;
/** @deprecated */
#[Deprecated]
public const string DEPOSIT = 'Deposit';
/** @deprecated */
#[Deprecated]
public const string INVALID = 'Invalid';
/** @deprecated */
#[Deprecated]
public const string LIABILITY_CREDIT = 'Liability credit';
/** @deprecated */
#[Deprecated]
public const string OPENING_BALANCE = 'Opening balance';
/** @deprecated */
#[Deprecated]
public const string RECONCILIATION = 'Reconciliation';
/** @deprecated */
#[Deprecated]
public const string TRANSFER = 'Transfer';
/** @deprecated */
#[Deprecated]
public const string WITHDRAWAL = 'Withdrawal';
protected $casts = ['created_at' => 'datetime', 'updated_at' => 'datetime', 'deleted_at' => 'datetime'];
protected $fillable = ['type'];
/**
* Route binder. Converts the key in the URL to the specified object (or throw 404).
*
* @throws NotFoundHttpException
*/
public static function routeBinder(self|string $value): self
{
if (!auth()->check()) {
throw new NotFoundHttpException();
}
if ($value instanceof self) {
$value = (string) $value->type;
}
$transactionType = self::where('type', ucfirst($value))->first();
if (null !== $transactionType) {
return $transactionType;
}
throw new NotFoundHttpException();
}
public function isDeposit(): bool
{
return TransactionTypeEnum::DEPOSIT->value === $this->type;
}
public function isOpeningBalance(): bool
{
return TransactionTypeEnum::OPENING_BALANCE->value === $this->type;
}
public function isTransfer(): bool
{
return TransactionTypeEnum::TRANSFER->value === $this->type;
}
public function isWithdrawal(): bool
{
return TransactionTypeEnum::WITHDRAWAL->value === $this->type;
}
public function transactionJournals(): HasMany
{
return $this->hasMany(TransactionJournal::class);
}
protected function casts(): array
{
return [
// 'type' => TransactionTypeEnum::class,
];
}
}