mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2025-10-31 02:36:28 +00:00
424 lines
11 KiB
PHP
424 lines
11 KiB
PHP
<?php
|
|
/**
|
|
* TransactionJournal.php
|
|
* Copyright (C) 2016 thegrumpydictator@gmail.com
|
|
*
|
|
* This software may be modified and distributed under the terms of the
|
|
* Creative Commons Attribution-ShareAlike 4.0 International License.
|
|
*
|
|
* See the LICENSE file for details.
|
|
*/
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace FireflyIII\Models;
|
|
|
|
use Carbon\Carbon;
|
|
use Crypt;
|
|
use FireflyIII\Support\CacheProperties;
|
|
use FireflyIII\Support\Models\TransactionJournalTrait;
|
|
use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
|
|
use Illuminate\Database\Eloquent\Model;
|
|
use Illuminate\Database\Eloquent\Relations\BelongsToMany;
|
|
use Illuminate\Database\Eloquent\Relations\HasMany;
|
|
use Illuminate\Database\Eloquent\SoftDeletes;
|
|
use Log;
|
|
use Preferences;
|
|
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
|
|
use Watson\Validating\ValidatingTrait;
|
|
|
|
/**
|
|
* Class TransactionJournal
|
|
*
|
|
* @package FireflyIII\Models
|
|
*/
|
|
class TransactionJournal extends Model
|
|
{
|
|
use SoftDeletes, ValidatingTrait, TransactionJournalTrait;
|
|
|
|
/**
|
|
* The attributes that should be casted to native types.
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $casts
|
|
= [
|
|
'created_at' => 'date',
|
|
'updated_at' => 'date',
|
|
'deleted_at' => 'date',
|
|
'date' => 'date',
|
|
'interest_date' => 'date',
|
|
'book_date' => 'date',
|
|
'process_date' => 'date',
|
|
'order' => 'int',
|
|
'tag_count' => 'int',
|
|
'encrypted' => 'boolean',
|
|
'completed' => 'boolean',
|
|
];
|
|
/** @var array */
|
|
protected $dates = ['created_at', 'updated_at', 'date', 'deleted_at', 'interest_date', 'book_date', 'process_date'];
|
|
/** @var array */
|
|
protected $fillable
|
|
= ['user_id', 'transaction_type_id', 'bill_id', 'interest_date', 'book_date', 'process_date',
|
|
'transaction_currency_id', 'description', 'completed',
|
|
'date', 'rent_date', 'encrypted', 'tag_count'];
|
|
/** @var array */
|
|
protected $hidden = ['encrypted'];
|
|
/** @var array */
|
|
protected $rules
|
|
= [
|
|
'user_id' => 'required|exists:users,id',
|
|
'transaction_type_id' => 'required|exists:transaction_types,id',
|
|
'description' => 'required|between:1,1024',
|
|
'completed' => 'required|boolean',
|
|
'date' => 'required|date',
|
|
'encrypted' => 'required|boolean',
|
|
];
|
|
|
|
/**
|
|
* @param $value
|
|
*
|
|
* @return mixed
|
|
* @throws NotFoundHttpException
|
|
*/
|
|
public static function routeBinder($value)
|
|
{
|
|
if (auth()->check()) {
|
|
$object = self::where('transaction_journals.id', $value)
|
|
->with('transactionType')
|
|
->leftJoin('transaction_types', 'transaction_types.id', '=', 'transaction_journals.transaction_type_id')
|
|
->where('user_id', auth()->user()->id)->first(['transaction_journals.*']);
|
|
if (!is_null($object)) {
|
|
return $object;
|
|
}
|
|
}
|
|
|
|
throw new NotFoundHttpException;
|
|
}
|
|
|
|
/**
|
|
* @return \Illuminate\Database\Eloquent\Relations\MorphMany
|
|
*/
|
|
public function attachments()
|
|
{
|
|
return $this->morphMany('FireflyIII\Models\Attachment', 'attachable');
|
|
}
|
|
|
|
/**
|
|
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
|
|
*/
|
|
public function bill()
|
|
{
|
|
return $this->belongsTo('FireflyIII\Models\Bill');
|
|
}
|
|
|
|
/**
|
|
* @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
|
|
*/
|
|
public function budgets(): BelongsToMany
|
|
{
|
|
return $this->belongsToMany('FireflyIII\Models\Budget');
|
|
}
|
|
|
|
/**
|
|
* @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
|
|
*/
|
|
public function categories(): BelongsToMany
|
|
{
|
|
return $this->belongsToMany('FireflyIII\Models\Category');
|
|
}
|
|
|
|
/**
|
|
* @param string $name
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function deleteMeta(string $name): bool
|
|
{
|
|
$this->transactionJournalMeta()->where('name', $name)->delete();
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @param $value
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getDescriptionAttribute($value)
|
|
{
|
|
if ($this->encrypted) {
|
|
return Crypt::decrypt($value);
|
|
}
|
|
|
|
return $value;
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @param string $name
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getMeta(string $name)
|
|
{
|
|
$value = null;
|
|
$cache = new CacheProperties;
|
|
$cache->addProperty('journal-meta');
|
|
$cache->addProperty($this->id);
|
|
$cache->addProperty($name);
|
|
|
|
if ($cache->has()) {
|
|
return $cache->get(); // @codeCoverageIgnore
|
|
}
|
|
|
|
Log::debug(sprintf('Looking for journal #%d meta field "%s".', $this->id, $name));
|
|
$entry = $this->transactionJournalMeta()->where('name', $name)->first();
|
|
if (!is_null($entry)) {
|
|
$value = $entry->data;
|
|
// cache:
|
|
$cache->store($value);
|
|
}
|
|
|
|
// convert to Carbon if name is _date
|
|
if (!is_null($value) && substr($name, -5) === '_date') {
|
|
$value = new Carbon($value);
|
|
// cache:
|
|
$cache->store($value);
|
|
}
|
|
|
|
return $value;
|
|
}
|
|
|
|
/**
|
|
* @param string $name
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function hasMeta(string $name): bool
|
|
{
|
|
return !is_null($this->getMeta($name));
|
|
}
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public function isDeposit(): bool
|
|
{
|
|
if (!is_null($this->transaction_type_type)) {
|
|
return $this->transaction_type_type === TransactionType::DEPOSIT;
|
|
}
|
|
|
|
return $this->transactionType->isDeposit();
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function isOpeningBalance(): bool
|
|
{
|
|
if (!is_null($this->transaction_type_type)) {
|
|
return $this->transaction_type_type === TransactionType::OPENING_BALANCE;
|
|
}
|
|
|
|
return $this->transactionType->isOpeningBalance();
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function isTransfer(): bool
|
|
{
|
|
if (!is_null($this->transaction_type_type)) {
|
|
return $this->transaction_type_type === TransactionType::TRANSFER;
|
|
}
|
|
|
|
return $this->transactionType->isTransfer();
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function isWithdrawal(): bool
|
|
{
|
|
if (!is_null($this->transaction_type_type)) {
|
|
return $this->transaction_type_type === TransactionType::WITHDRAWAL;
|
|
}
|
|
|
|
return $this->transactionType->isWithdrawal();
|
|
}
|
|
|
|
/**
|
|
* @return \Illuminate\Database\Eloquent\Relations\HasMany
|
|
*/
|
|
public function piggyBankEvents(): HasMany
|
|
{
|
|
return $this->hasMany('FireflyIII\Models\PiggyBankEvent');
|
|
}
|
|
|
|
/**
|
|
* Save the model to the database.
|
|
*
|
|
* @param array $options
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function save(array $options = []): bool
|
|
{
|
|
$count = $this->tags()->count();
|
|
$this->tag_count = $count;
|
|
|
|
return parent::save($options);
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @param EloquentBuilder $query
|
|
* @param Carbon $date
|
|
*
|
|
* @return EloquentBuilder
|
|
*/
|
|
public function scopeAfter(EloquentBuilder $query, Carbon $date)
|
|
{
|
|
return $query->where('transaction_journals.date', '>=', $date->format('Y-m-d 00:00:00'));
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @param EloquentBuilder $query
|
|
* @param Carbon $date
|
|
*
|
|
* @return EloquentBuilder
|
|
*/
|
|
public function scopeBefore(EloquentBuilder $query, Carbon $date)
|
|
{
|
|
return $query->where('transaction_journals.date', '<=', $date->format('Y-m-d 00:00:00'));
|
|
}
|
|
|
|
/**
|
|
* @param EloquentBuilder $query
|
|
*/
|
|
public function scopeSortCorrectly(EloquentBuilder $query)
|
|
{
|
|
$query->orderBy('transaction_journals.date', 'DESC');
|
|
$query->orderBy('transaction_journals.order', 'ASC');
|
|
$query->orderBy('transaction_journals.id', 'DESC');
|
|
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @param EloquentBuilder $query
|
|
* @param array $types
|
|
*/
|
|
public function scopeTransactionTypes(EloquentBuilder $query, array $types)
|
|
{
|
|
|
|
if (!self::isJoined($query, 'transaction_types')) {
|
|
$query->leftJoin('transaction_types', 'transaction_types.id', '=', 'transaction_journals.transaction_type_id');
|
|
}
|
|
if (count($types) > 0) {
|
|
$query->whereIn('transaction_types.type', $types);
|
|
}
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @param $value
|
|
*/
|
|
public function setDescriptionAttribute($value)
|
|
{
|
|
$encrypt = config('firefly.encryption');
|
|
$this->attributes['description'] = $encrypt ? Crypt::encrypt($value) : $value;
|
|
$this->attributes['encrypted'] = $encrypt;
|
|
}
|
|
|
|
/**
|
|
* @param string $name
|
|
* @param $value
|
|
*
|
|
* @return TransactionJournalMeta
|
|
*/
|
|
public function setMeta(string $name, $value): TransactionJournalMeta
|
|
{
|
|
if (is_null($value)) {
|
|
$this->deleteMeta($name);
|
|
|
|
return new TransactionJournalMeta();
|
|
}
|
|
if (is_string($value) && strlen($value) === 0) {
|
|
return new TransactionJournalMeta();
|
|
}
|
|
|
|
if ($value instanceof Carbon) {
|
|
$value = $value->toW3cString();
|
|
}
|
|
|
|
Log::debug(sprintf('Going to set "%s" with value "%s"', $name, json_encode($value)));
|
|
$entry = $this->transactionJournalMeta()->where('name', $name)->first();
|
|
if (is_null($entry)) {
|
|
$entry = new TransactionJournalMeta();
|
|
$entry->transactionJournal()->associate($this);
|
|
$entry->name = $name;
|
|
}
|
|
$entry->data = $value;
|
|
$entry->save();
|
|
Preferences::mark();
|
|
|
|
return $entry;
|
|
}
|
|
|
|
/**
|
|
* @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
|
|
*/
|
|
public function tags()
|
|
{
|
|
return $this->belongsToMany('FireflyIII\Models\Tag');
|
|
}
|
|
|
|
/**
|
|
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
|
|
*/
|
|
public function transactionCurrency()
|
|
{
|
|
return $this->belongsTo('FireflyIII\Models\TransactionCurrency');
|
|
}
|
|
|
|
/**
|
|
* @return HasMany
|
|
*/
|
|
public function transactionJournalMeta(): HasMany
|
|
{
|
|
return $this->hasMany('FireflyIII\Models\TransactionJournalMeta');
|
|
}
|
|
|
|
/**
|
|
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
|
|
*/
|
|
public function transactionType()
|
|
{
|
|
return $this->belongsTo('FireflyIII\Models\TransactionType');
|
|
}
|
|
|
|
/**
|
|
* @return HasMany
|
|
*/
|
|
public function transactions(): HasMany
|
|
{
|
|
return $this->hasMany('FireflyIII\Models\Transaction');
|
|
}
|
|
|
|
/**
|
|
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
|
|
*/
|
|
public function user()
|
|
{
|
|
return $this->belongsTo('FireflyIII\User');
|
|
}
|
|
|
|
}
|