2016-05-20 01:57:45 -05:00
|
|
|
<?php
|
2016-05-20 05:41:23 -05:00
|
|
|
/**
|
|
|
|
* Transaction.php
|
2017-10-21 01:40:00 -05:00
|
|
|
* Copyright (c) 2017 thegrumpydictator@gmail.com
|
2016-05-20 05:41:23 -05:00
|
|
|
*
|
2017-10-21 01:40:00 -05:00
|
|
|
* This file is part of Firefly III.
|
2016-10-04 23:52:15 -05:00
|
|
|
*
|
2017-10-21 01:40:00 -05:00
|
|
|
* Firefly III is free software: you can redistribute it and/or modify
|
|
|
|
* it under the terms of the GNU General Public License as published by
|
|
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
|
|
* (at your option) any later version.
|
|
|
|
*
|
|
|
|
* Firefly III 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 General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU General Public License
|
|
|
|
* along with Firefly III. If not, see <http://www.gnu.org/licenses/>.
|
2016-05-20 05:41:23 -05:00
|
|
|
*/
|
|
|
|
|
2017-04-09 00:44:22 -05:00
|
|
|
declare(strict_types=1);
|
2016-05-20 01:57:45 -05:00
|
|
|
|
|
|
|
namespace FireflyIII\Models;
|
2015-02-27 09:48:33 -06:00
|
|
|
|
2015-04-07 11:26:14 -05:00
|
|
|
use Carbon\Carbon;
|
2016-05-05 14:25:20 -05:00
|
|
|
use Illuminate\Database\Eloquent\Builder;
|
2015-02-27 09:48:33 -06:00
|
|
|
use Illuminate\Database\Eloquent\Model;
|
|
|
|
use Illuminate\Database\Eloquent\SoftDeletes;
|
|
|
|
use Watson\Validating\ValidatingTrait;
|
2015-04-07 11:26:14 -05:00
|
|
|
|
2016-11-18 13:06:08 -06:00
|
|
|
/**
|
|
|
|
* Class Transaction
|
|
|
|
*
|
2017-08-30 00:40:39 -05:00
|
|
|
* @property-read int $journal_id
|
2017-09-16 02:24:48 -05:00
|
|
|
* @property Carbon $date
|
2017-08-18 07:45:42 -05:00
|
|
|
* @property-read string $transaction_description
|
2017-09-16 02:24:48 -05:00
|
|
|
* @property string $transaction_amount
|
|
|
|
* @property string $transaction_foreign_amount
|
|
|
|
* @property string $transaction_type_type
|
|
|
|
* @property string $foreign_currency_symbol
|
2017-10-05 04:49:06 -05:00
|
|
|
* @property int $foreign_currency_dp
|
2017-08-18 07:45:42 -05:00
|
|
|
*
|
2017-09-16 02:24:48 -05:00
|
|
|
* @property int $account_id
|
2017-10-05 04:49:06 -05:00
|
|
|
* @property string $account_name
|
2017-08-30 00:40:39 -05:00
|
|
|
* @property string $account_iban
|
|
|
|
* @property string $account_number
|
|
|
|
* @property string $account_bic
|
|
|
|
* @property string $account_currency_code
|
2017-08-18 07:45:42 -05:00
|
|
|
*
|
2017-10-05 04:49:06 -05:00
|
|
|
* @property int $opposing_account_id
|
2017-08-30 00:40:39 -05:00
|
|
|
* @property string $opposing_account_name
|
|
|
|
* @property string $opposing_account_iban
|
|
|
|
* @property string $opposing_account_number
|
|
|
|
* @property string $opposing_account_bic
|
|
|
|
* @property string $opposing_currency_code
|
2017-08-18 07:45:42 -05:00
|
|
|
*
|
|
|
|
*
|
2017-10-05 04:49:06 -05:00
|
|
|
* @property int $transaction_budget_id
|
|
|
|
* @property string $transaction_budget_name
|
|
|
|
* @property int $transaction_journal_budget_id
|
|
|
|
* @property string $transaction_journal_budget_name
|
2017-08-18 07:45:42 -05:00
|
|
|
*
|
2017-08-30 00:40:39 -05:00
|
|
|
* @property-read int $transaction_category_id
|
2017-08-18 07:45:42 -05:00
|
|
|
* @property-read string $transaction_category_name
|
2017-08-30 00:40:39 -05:00
|
|
|
* @property-read int $transaction_journal_category_id
|
2017-08-18 07:45:42 -05:00
|
|
|
* @property-read string $transaction_journal_category_name
|
|
|
|
*
|
2017-08-30 00:40:39 -05:00
|
|
|
* @property-read int $bill_id
|
|
|
|
* @property string $bill_name
|
2017-08-18 07:45:42 -05:00
|
|
|
*
|
2017-08-30 00:40:39 -05:00
|
|
|
* @property string $notes
|
|
|
|
* @property string $tags
|
|
|
|
*
|
|
|
|
* @property string $transaction_currency_symbol
|
|
|
|
* @property int $transaction_currency_dp
|
|
|
|
* @property string $transaction_currency_code
|
2017-08-18 07:45:42 -05:00
|
|
|
*
|
2016-11-18 13:06:08 -06:00
|
|
|
* @package FireflyIII\Models
|
|
|
|
*/
|
2015-02-27 09:48:33 -06:00
|
|
|
class Transaction extends Model
|
|
|
|
{
|
2016-12-24 10:36:51 -06:00
|
|
|
/**
|
|
|
|
* The attributes that should be casted to native types.
|
|
|
|
*
|
|
|
|
* @var array
|
|
|
|
*/
|
|
|
|
protected $casts
|
2017-06-05 04:12:50 -05:00
|
|
|
= [
|
2017-11-03 10:04:17 -05:00
|
|
|
'created_at' => 'datetime',
|
|
|
|
'updated_at' => 'datetime',
|
|
|
|
'deleted_at' => 'datetime',
|
2016-12-25 04:50:42 -06:00
|
|
|
'identifier' => 'int',
|
|
|
|
'encrypted' => 'boolean', // model does not have these fields though
|
|
|
|
'bill_name_encrypted' => 'boolean',
|
2017-11-05 12:48:43 -06:00
|
|
|
'reconciled' => 'boolean',
|
2016-12-24 10:36:51 -06:00
|
|
|
];
|
2017-06-05 04:12:50 -05:00
|
|
|
protected $fillable
|
|
|
|
= ['account_id', 'transaction_journal_id', 'description', 'amount', 'identifier', 'transaction_currency_id', 'foreign_currency_id',
|
|
|
|
'foreign_amount'];
|
|
|
|
protected $hidden = ['encrypted'];
|
2015-02-27 09:48:33 -06:00
|
|
|
protected $rules
|
2017-06-05 04:12:50 -05:00
|
|
|
= [
|
2017-06-04 06:39:16 -05:00
|
|
|
'account_id' => 'required|exists:accounts,id',
|
|
|
|
'transaction_journal_id' => 'required|exists:transaction_journals,id',
|
|
|
|
'transaction_currency_id' => 'required|exists:transaction_currencies,id',
|
|
|
|
'description' => 'between:0,1024',
|
|
|
|
'amount' => 'required|numeric',
|
2015-02-27 09:48:33 -06:00
|
|
|
];
|
|
|
|
|
2016-05-05 14:25:20 -05:00
|
|
|
/**
|
|
|
|
* @param Builder $query
|
|
|
|
* @param string $table
|
|
|
|
*
|
|
|
|
* @return bool
|
|
|
|
*/
|
2016-12-14 11:59:12 -06:00
|
|
|
public static function isJoined(Builder $query, string $table): bool
|
2016-05-05 14:25:20 -05:00
|
|
|
{
|
|
|
|
$joins = $query->getQuery()->joins;
|
|
|
|
if (is_null($joins)) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
foreach ($joins as $join) {
|
|
|
|
if ($join->table === $table) {
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
2017-06-04 06:39:16 -05:00
|
|
|
use SoftDeletes, ValidatingTrait;
|
|
|
|
|
2015-02-27 09:48:33 -06:00
|
|
|
/**
|
|
|
|
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
|
|
|
|
*/
|
|
|
|
public function account()
|
|
|
|
{
|
|
|
|
return $this->belongsTo('FireflyIII\Models\Account');
|
|
|
|
}
|
|
|
|
|
2016-05-05 14:25:20 -05:00
|
|
|
/**
|
|
|
|
* @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
|
|
|
|
*/
|
|
|
|
public function budgets()
|
|
|
|
{
|
|
|
|
return $this->belongsToMany('FireflyIII\Models\Budget');
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
|
|
|
|
*/
|
|
|
|
public function categories()
|
|
|
|
{
|
|
|
|
return $this->belongsToMany('FireflyIII\Models\Category');
|
|
|
|
}
|
|
|
|
|
2017-06-05 04:12:50 -05:00
|
|
|
/**
|
|
|
|
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
|
|
|
|
*/
|
|
|
|
public function foreignCurrency()
|
|
|
|
{
|
|
|
|
return $this->belongsTo('FireflyIII\Models\TransactionCurrency', 'foreign_currency_id');
|
|
|
|
}
|
|
|
|
|
2015-05-23 01:46:46 -05:00
|
|
|
/**
|
|
|
|
* @param $value
|
|
|
|
*
|
|
|
|
* @return float|int
|
|
|
|
*/
|
|
|
|
public function getAmountAttribute($value)
|
|
|
|
{
|
|
|
|
return $value;
|
|
|
|
}
|
|
|
|
|
2015-04-03 15:54:21 -05:00
|
|
|
/**
|
|
|
|
*
|
2016-05-05 14:25:20 -05:00
|
|
|
* @param Builder $query
|
|
|
|
* @param Carbon $date
|
2015-04-03 15:54:21 -05:00
|
|
|
*/
|
2016-05-05 14:25:20 -05:00
|
|
|
public function scopeAfter(Builder $query, Carbon $date)
|
2015-04-03 15:54:21 -05:00
|
|
|
{
|
2016-05-05 14:25:20 -05:00
|
|
|
if (!self::isJoined($query, 'transaction_journals')) {
|
|
|
|
$query->leftJoin('transaction_journals', 'transaction_journals.id', '=', 'transactions.transaction_journal_id');
|
|
|
|
}
|
|
|
|
$query->where('transaction_journals.date', '>=', $date->format('Y-m-d 00:00:00'));
|
2015-04-03 15:54:21 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2016-05-05 14:25:20 -05:00
|
|
|
*
|
|
|
|
* @param Builder $query
|
2016-05-15 11:36:40 -05:00
|
|
|
* @param Carbon $date
|
2015-04-03 15:54:21 -05:00
|
|
|
*
|
|
|
|
*/
|
2016-05-05 14:25:20 -05:00
|
|
|
public function scopeBefore(Builder $query, Carbon $date)
|
2015-04-03 15:54:21 -05:00
|
|
|
{
|
2016-05-05 14:25:20 -05:00
|
|
|
if (!self::isJoined($query, 'transaction_journals')) {
|
|
|
|
$query->leftJoin('transaction_journals', 'transaction_journals.id', '=', 'transactions.transaction_journal_id');
|
|
|
|
}
|
2016-05-06 03:32:26 -05:00
|
|
|
$query->where('transaction_journals.date', '<=', $date->format('Y-m-d 23:59:59'));
|
2015-04-03 15:54:21 -05:00
|
|
|
}
|
|
|
|
|
2015-02-27 09:48:33 -06:00
|
|
|
/**
|
2016-05-05 14:25:20 -05:00
|
|
|
*
|
|
|
|
* @param Builder $query
|
|
|
|
* @param array $types
|
2015-02-27 09:48:33 -06:00
|
|
|
*/
|
2016-05-05 14:25:20 -05:00
|
|
|
public function scopeTransactionTypes(Builder $query, array $types)
|
2015-02-27 09:48:33 -06:00
|
|
|
{
|
2016-05-05 14:25:20 -05:00
|
|
|
if (!self::isJoined($query, 'transaction_journals')) {
|
|
|
|
$query->leftJoin('transaction_journals', 'transaction_journals.id', '=', 'transactions.transaction_journal_id');
|
|
|
|
}
|
2015-02-27 09:48:33 -06:00
|
|
|
|
2016-05-05 14:25:20 -05:00
|
|
|
if (!self::isJoined($query, 'transaction_types')) {
|
|
|
|
$query->leftJoin('transaction_types', 'transaction_types.id', '=', 'transaction_journals.transaction_type_id');
|
|
|
|
}
|
|
|
|
$query->whereIn('transaction_types.type', $types);
|
2015-02-27 09:48:33 -06:00
|
|
|
}
|
2016-04-29 13:59:28 -05:00
|
|
|
|
|
|
|
/**
|
2016-05-05 14:25:20 -05:00
|
|
|
* @param $value
|
2016-04-29 13:59:28 -05:00
|
|
|
*/
|
2016-05-05 14:25:20 -05:00
|
|
|
public function setAmountAttribute($value)
|
2016-04-29 13:59:28 -05:00
|
|
|
{
|
2016-12-28 14:55:46 -06:00
|
|
|
$this->attributes['amount'] = strval(round($value, 12));
|
2016-04-29 13:59:28 -05:00
|
|
|
}
|
|
|
|
|
2017-06-04 06:39:16 -05:00
|
|
|
/**
|
|
|
|
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
|
|
|
|
*/
|
|
|
|
public function transactionCurrency()
|
|
|
|
{
|
|
|
|
return $this->belongsTo('FireflyIII\Models\TransactionCurrency');
|
|
|
|
}
|
|
|
|
|
2016-04-29 13:59:28 -05:00
|
|
|
/**
|
2016-05-05 14:25:20 -05:00
|
|
|
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
|
2016-04-29 13:59:28 -05:00
|
|
|
*/
|
2016-05-05 14:25:20 -05:00
|
|
|
public function transactionJournal()
|
2016-04-29 13:59:28 -05:00
|
|
|
{
|
2016-05-05 14:25:20 -05:00
|
|
|
return $this->belongsTo('FireflyIII\Models\TransactionJournal');
|
2016-04-29 13:59:28 -05:00
|
|
|
}
|
2015-02-27 09:48:33 -06:00
|
|
|
}
|