mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2024-12-25 08:21:08 -06:00
135 lines
4.2 KiB
PHP
135 lines
4.2 KiB
PHP
<?php
|
|
|
|
/**
|
|
* BudgetLimit.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 Eloquent;
|
|
use Illuminate\Database\Eloquent\Builder;
|
|
use Illuminate\Database\Eloquent\Casts\Attribute;
|
|
use Illuminate\Database\Eloquent\Model;
|
|
use Illuminate\Database\Eloquent\Relations\BelongsTo;
|
|
use Illuminate\Support\Carbon;
|
|
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
|
|
|
|
/**
|
|
* FireflyIII\Models\BudgetLimit
|
|
*
|
|
* @property int $id
|
|
* @property Carbon|null $created_at
|
|
* @property Carbon|null $updated_at
|
|
* @property int $budget_id
|
|
* @property int|null $transaction_currency_id
|
|
* @property Carbon $start_date
|
|
* @property Carbon|null $end_date
|
|
* @property string $amount
|
|
* @property string $spent
|
|
* @property string|null $period
|
|
* @property int $generated
|
|
* @property-read Budget $budget
|
|
* @property-read TransactionCurrency|null $transactionCurrency
|
|
* @method static Builder|BudgetLimit newModelQuery()
|
|
* @method static Builder|BudgetLimit newQuery()
|
|
* @method static Builder|BudgetLimit query()
|
|
* @method static Builder|BudgetLimit whereAmount($value)
|
|
* @method static Builder|BudgetLimit whereBudgetId($value)
|
|
* @method static Builder|BudgetLimit whereCreatedAt($value)
|
|
* @method static Builder|BudgetLimit whereEndDate($value)
|
|
* @method static Builder|BudgetLimit whereGenerated($value)
|
|
* @method static Builder|BudgetLimit whereId($value)
|
|
* @method static Builder|BudgetLimit wherePeriod($value)
|
|
* @method static Builder|BudgetLimit whereStartDate($value)
|
|
* @method static Builder|BudgetLimit whereTransactionCurrencyId($value)
|
|
* @method static Builder|BudgetLimit whereUpdatedAt($value)
|
|
* @mixin Eloquent
|
|
*/
|
|
class BudgetLimit extends Model
|
|
{
|
|
/**
|
|
* The attributes that should be casted to native types.
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $casts
|
|
= [
|
|
'created_at' => 'datetime',
|
|
'updated_at' => 'datetime',
|
|
'start_date' => 'date',
|
|
'end_date' => 'date',
|
|
'auto_budget' => 'boolean',
|
|
];
|
|
|
|
/** @var array Fields that can be filled */
|
|
protected $fillable = ['budget_id', 'start_date', 'end_date', 'amount', 'transaction_currency_id'];
|
|
|
|
/**
|
|
* Route binder. Converts the key in the URL to the specified object (or throw 404).
|
|
*
|
|
* @param string $value
|
|
*
|
|
* @return BudgetLimit
|
|
* @throws NotFoundHttpException
|
|
*/
|
|
public static function routeBinder(string $value): BudgetLimit
|
|
{
|
|
if (auth()->check()) {
|
|
$budgetLimitId = (int)$value;
|
|
$budgetLimit = self::where('budget_limits.id', $budgetLimitId)
|
|
->leftJoin('budgets', 'budgets.id', '=', 'budget_limits.budget_id')
|
|
->where('budgets.user_id', auth()->user()->id)
|
|
->first(['budget_limits.*']);
|
|
if (null !== $budgetLimit) {
|
|
return $budgetLimit;
|
|
}
|
|
}
|
|
throw new NotFoundHttpException();
|
|
}
|
|
|
|
/**
|
|
* @return BelongsTo
|
|
*/
|
|
public function budget(): BelongsTo
|
|
{
|
|
return $this->belongsTo(Budget::class);
|
|
}
|
|
|
|
/**
|
|
* @return BelongsTo
|
|
*/
|
|
public function transactionCurrency(): BelongsTo
|
|
{
|
|
return $this->belongsTo(TransactionCurrency::class);
|
|
}
|
|
|
|
/**
|
|
* Get the amount
|
|
*
|
|
* @return Attribute
|
|
*/
|
|
protected function amount(): Attribute
|
|
{
|
|
return Attribute::make(
|
|
get: fn ($value) => (string)$value,
|
|
);
|
|
}
|
|
}
|