firefly-iii/app/Models/TransactionCurrency.php

122 lines
3.6 KiB
PHP
Raw Normal View History

2016-05-20 01:57:45 -05:00
<?php
2022-12-29 12:42:26 -06:00
/**
* TransactionCurrency.php
2020-02-16 06:55:32 -06:00
* 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.
2017-10-21 01:40:00 -05:00
*
* This program is distributed in the hope that it will be useful,
2017-10-21 01:40:00 -05:00
* 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.
2017-10-21 01:40:00 -05:00
*
* 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);
2016-05-20 01:57:45 -05:00
namespace FireflyIII\Models;
2015-02-27 09:48:33 -06:00
2023-11-26 05:10:42 -06:00
use FireflyIII\Support\Models\ReturnsIntegerIdTrait;
2023-10-21 23:56:46 -05:00
use FireflyIII\User;
2023-11-26 05:10:42 -06:00
use Illuminate\Database\Eloquent\Casts\Attribute;
2015-02-27 09:48:33 -06:00
use Illuminate\Database\Eloquent\Model;
2023-10-21 23:56:46 -05:00
use Illuminate\Database\Eloquent\Relations\BelongsToMany;
2018-08-04 10:30:06 -05:00
use Illuminate\Database\Eloquent\Relations\HasMany;
2015-02-27 09:48:33 -06:00
use Illuminate\Database\Eloquent\SoftDeletes;
2016-01-09 09:09:26 -06:00
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
2023-11-26 05:10:42 -06:00
2024-07-31 01:26:43 -05:00
/**
* @mixin IdeHelperTransactionCurrency
*/
2015-02-27 09:48:33 -06:00
class TransactionCurrency extends Model
{
2023-11-05 12:41:37 -06:00
use ReturnsIntegerIdTrait;
2017-10-08 11:27:51 -05:00
use SoftDeletes;
2015-02-27 09:48:33 -06:00
2023-12-16 09:06:23 -06:00
public ?bool $userGroupDefault;
public ?bool $userGroupEnabled;
2023-12-16 12:33:13 -06:00
protected $casts
= [
'created_at' => 'datetime',
'updated_at' => 'datetime',
'deleted_at' => 'datetime',
'decimal_places' => 'int',
'enabled' => 'bool',
];
2023-11-05 02:54:53 -06:00
protected $fillable = ['name', 'code', 'symbol', 'decimal_places', 'enabled'];
2016-01-09 09:09:26 -06:00
/**
2018-08-04 10:30:06 -05:00
* Route binder. Converts the key in the URL to the specified object (or throw 404).
*
2021-08-28 08:47:09 -05:00
* @throws NotFoundHttpException
2016-01-09 09:09:26 -06:00
*/
2023-11-04 08:18:49 -05:00
public static function routeBinder(string $value): self
2016-01-09 09:09:26 -06:00
{
if (auth()->check()) {
2022-12-29 12:42:26 -06:00
$currencyId = (int)$value;
2017-12-29 02:05:35 -06:00
$currency = self::find($currencyId);
2018-04-02 08:10:40 -05:00
if (null !== $currency) {
2023-10-28 09:47:11 -05:00
$currency->refreshForUser(auth()->user());
2023-12-20 12:35:52 -06:00
return $currency;
}
2016-01-09 09:09:26 -06:00
}
2023-12-20 12:35:52 -06:00
2022-10-30 08:24:28 -05:00
throw new NotFoundHttpException();
2016-01-09 09:09:26 -06:00
}
2016-08-11 11:44:11 -05:00
2023-12-20 22:07:26 -06:00
public function refreshForUser(User $user): void
2023-10-21 23:56:46 -05:00
{
2023-12-16 09:06:23 -06:00
$current = $user->userGroup->currencies()->where('transaction_currencies.id', $this->id)->first();
$default = app('amount')->getDefaultCurrencyByUserGroup($user->userGroup);
$this->userGroupDefault = $default->id === $this->id;
$this->userGroupEnabled = null !== $current;
2023-10-21 23:56:46 -05:00
}
2023-10-29 00:36:37 -05:00
public function budgetLimits(): HasMany
{
return $this->hasMany(BudgetLimit::class);
}
2023-10-28 08:03:33 -05:00
public function transactionJournals(): HasMany
2023-10-21 23:56:46 -05:00
{
2023-10-28 08:03:33 -05:00
return $this->hasMany(TransactionJournal::class);
2023-10-21 23:56:46 -05:00
}
2023-10-28 08:03:33 -05:00
public function transactions(): HasMany
2016-08-11 11:44:11 -05:00
{
2023-10-28 08:03:33 -05:00
return $this->hasMany(Transaction::class);
2016-08-11 11:44:11 -05:00
}
/**
2023-10-28 08:03:33 -05:00
* Link to user groups
*/
2023-10-28 08:03:33 -05:00
public function userGroups(): BelongsToMany
{
2023-10-28 08:03:33 -05:00
return $this->belongsToMany(UserGroup::class)->withTimestamps()->withPivot('group_default');
}
/**
2023-10-28 08:03:33 -05:00
* Link to users
*/
2023-10-28 08:03:33 -05:00
public function users(): BelongsToMany
{
2023-10-28 08:03:33 -05:00
return $this->belongsToMany(User::class)->withTimestamps()->withPivot('user_default');
}
2023-11-26 05:10:42 -06:00
protected function decimalPlaces(): Attribute
{
return Attribute::make(
2023-12-20 12:35:52 -06:00
get: static fn ($value) => (int)$value,
2023-11-26 05:10:42 -06:00
);
}
2015-02-27 09:48:33 -06:00
}