mirror of
				https://github.com/firefly-iii/firefly-iii.git
				synced 2025-11-03 20:55:05 +00:00 
			
		
		
		
	
		
			
				
	
	
		
			124 lines
		
	
	
		
			4.0 KiB
		
	
	
	
		
			PHP
		
	
	
	
	
	
			
		
		
	
	
			124 lines
		
	
	
		
			4.0 KiB
		
	
	
	
		
			PHP
		
	
	
	
	
	
<?php
 | 
						|
/**
 | 
						|
 * CurrencyExchangeRate.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 FireflyIII\User;
 | 
						|
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;
 | 
						|
 | 
						|
/**
 | 
						|
 * FireflyIII\Models\CurrencyExchangeRate
 | 
						|
 *
 | 
						|
 * @property int                      $id
 | 
						|
 * @property Carbon|null              $created_at
 | 
						|
 * @property Carbon|null              $updated_at
 | 
						|
 * @property string|null              $deleted_at
 | 
						|
 * @property int                      $user_id
 | 
						|
 * @property int                      $from_currency_id
 | 
						|
 * @property int                      $to_currency_id
 | 
						|
 * @property Carbon                   $date
 | 
						|
 * @property string                   $rate
 | 
						|
 * @property string|null              $user_rate
 | 
						|
 * @property-read TransactionCurrency $fromCurrency
 | 
						|
 * @property-read TransactionCurrency $toCurrency
 | 
						|
 * @property-read User                $user
 | 
						|
 * @method static Builder|CurrencyExchangeRate newModelQuery()
 | 
						|
 * @method static Builder|CurrencyExchangeRate newQuery()
 | 
						|
 * @method static Builder|CurrencyExchangeRate query()
 | 
						|
 * @method static Builder|CurrencyExchangeRate whereCreatedAt($value)
 | 
						|
 * @method static Builder|CurrencyExchangeRate whereDate($value)
 | 
						|
 * @method static Builder|CurrencyExchangeRate whereDeletedAt($value)
 | 
						|
 * @method static Builder|CurrencyExchangeRate whereFromCurrencyId($value)
 | 
						|
 * @method static Builder|CurrencyExchangeRate whereId($value)
 | 
						|
 * @method static Builder|CurrencyExchangeRate whereRate($value)
 | 
						|
 * @method static Builder|CurrencyExchangeRate whereToCurrencyId($value)
 | 
						|
 * @method static Builder|CurrencyExchangeRate whereUpdatedAt($value)
 | 
						|
 * @method static Builder|CurrencyExchangeRate whereUserId($value)
 | 
						|
 * @method static Builder|CurrencyExchangeRate whereUserRate($value)
 | 
						|
 * @mixin Eloquent
 | 
						|
 */
 | 
						|
class CurrencyExchangeRate extends Model
 | 
						|
{
 | 
						|
    /** @var array Convert these fields to other data types */
 | 
						|
    protected $casts
 | 
						|
        = [
 | 
						|
            'created_at'       => 'datetime',
 | 
						|
            'updated_at'       => 'datetime',
 | 
						|
            'user_id'          => 'int',
 | 
						|
            'from_currency_id' => 'int',
 | 
						|
            'to_currency_id'   => 'int',
 | 
						|
            'date'             => 'datetime',
 | 
						|
        ];
 | 
						|
 | 
						|
    /**
 | 
						|
     * @codeCoverageIgnore
 | 
						|
     * @return BelongsTo
 | 
						|
     */
 | 
						|
    public function fromCurrency(): BelongsTo
 | 
						|
    {
 | 
						|
        return $this->belongsTo(TransactionCurrency::class, 'from_currency_id');
 | 
						|
    }
 | 
						|
 | 
						|
    /**
 | 
						|
     * @codeCoverageIgnore
 | 
						|
     * @return BelongsTo
 | 
						|
     */
 | 
						|
    public function toCurrency(): BelongsTo
 | 
						|
    {
 | 
						|
        return $this->belongsTo(TransactionCurrency::class, 'to_currency_id');
 | 
						|
    }
 | 
						|
 | 
						|
    /**
 | 
						|
     * @codeCoverageIgnore
 | 
						|
     * @return BelongsTo
 | 
						|
     */
 | 
						|
    public function user(): BelongsTo
 | 
						|
    {
 | 
						|
        return $this->belongsTo(User::class);
 | 
						|
    }
 | 
						|
 | 
						|
    /**
 | 
						|
     * @return Attribute
 | 
						|
     */
 | 
						|
    protected function rate(): Attribute
 | 
						|
    {
 | 
						|
        return Attribute::make(
 | 
						|
            get: fn($value) => (string) $value,
 | 
						|
        );
 | 
						|
    }
 | 
						|
 | 
						|
    /**
 | 
						|
     * @return Attribute
 | 
						|
     */
 | 
						|
    protected function userRate(): Attribute
 | 
						|
    {
 | 
						|
        return Attribute::make(
 | 
						|
            get: fn($value) => (string) $value,
 | 
						|
        );
 | 
						|
    }
 | 
						|
}
 |