mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2024-11-26 19:00:22 -06:00
334 lines
11 KiB
PHP
334 lines
11 KiB
PHP
<?php
|
|
/**
|
|
* Account.php
|
|
* Copyright (C) 2016 thegrumpydictator@gmail.com
|
|
*
|
|
* This software may be modified and distributed under the terms
|
|
* of the MIT license. See the LICENSE file for details.
|
|
*/
|
|
|
|
declare(strict_types = 1);
|
|
|
|
namespace FireflyIII\Models;
|
|
|
|
use Crypt;
|
|
use FireflyIII\Exceptions\FireflyException;
|
|
use Illuminate\Contracts\Encryption\DecryptException;
|
|
use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
|
|
use Illuminate\Database\Eloquent\Model;
|
|
use Illuminate\Database\Eloquent\Relations\BelongsTo;
|
|
use Illuminate\Database\Eloquent\Relations\HasMany;
|
|
use Illuminate\Database\Eloquent\SoftDeletes;
|
|
use Illuminate\Database\Query\JoinClause;
|
|
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
|
|
use Watson\Validating\ValidatingTrait;
|
|
|
|
/**
|
|
* FireflyIII\Models\Account
|
|
*
|
|
* @property integer $id
|
|
* @property \Carbon\Carbon $created_at
|
|
* @property \Carbon\Carbon $updated_at
|
|
* @property \Carbon\Carbon $deleted_at
|
|
* @property integer $user_id
|
|
* @property integer $account_type_id
|
|
* @property string $name
|
|
* @property boolean $active
|
|
* @property boolean $encrypted
|
|
* @property float $virtual_balance
|
|
* @property string $iban
|
|
* @property-read \Illuminate\Database\Eloquent\Collection|\FireflyIII\Models\AccountMeta[] $accountMeta
|
|
* @property-read \FireflyIII\Models\AccountType $accountType
|
|
* @property-read mixed $name_for_editform
|
|
* @property-read \Illuminate\Database\Eloquent\Collection|\FireflyIII\Models\PiggyBank[] $piggyBanks
|
|
* @property-read \Illuminate\Database\Eloquent\Collection|\FireflyIII\Models\Transaction[] $transactions
|
|
* @property-read \FireflyIII\User $user
|
|
* @method static \Illuminate\Database\Query\Builder|\FireflyIII\Models\Account accountTypeIn($types)
|
|
* @method static \Illuminate\Database\Query\Builder|\FireflyIII\Models\Account hasMetaValue($name, $value)
|
|
* @property string $startBalance
|
|
* @property string $endBalance
|
|
* @property float $difference
|
|
* @property \Carbon\Carbon $lastActivityDate
|
|
* @property float $piggyBalance
|
|
* @property float $percentage
|
|
* @method static \Illuminate\Database\Query\Builder|\FireflyIII\Models\Account whereId($value)
|
|
* @method static \Illuminate\Database\Query\Builder|\FireflyIII\Models\Account whereCreatedAt($value)
|
|
* @method static \Illuminate\Database\Query\Builder|\FireflyIII\Models\Account whereUpdatedAt($value)
|
|
* @method static \Illuminate\Database\Query\Builder|\FireflyIII\Models\Account whereDeletedAt($value)
|
|
* @method static \Illuminate\Database\Query\Builder|\FireflyIII\Models\Account whereUserId($value)
|
|
* @method static \Illuminate\Database\Query\Builder|\FireflyIII\Models\Account whereAccountTypeId($value)
|
|
* @method static \Illuminate\Database\Query\Builder|\FireflyIII\Models\Account whereName($value)
|
|
* @method static \Illuminate\Database\Query\Builder|\FireflyIII\Models\Account whereActive($value)
|
|
* @method static \Illuminate\Database\Query\Builder|\FireflyIII\Models\Account whereEncrypted($value)
|
|
* @method static \Illuminate\Database\Query\Builder|\FireflyIII\Models\Account whereVirtualBalance($value)
|
|
* @method static \Illuminate\Database\Query\Builder|\FireflyIII\Models\Account whereIban($value)
|
|
* @mixin \Eloquent
|
|
*/
|
|
class Account extends Model
|
|
{
|
|
use SoftDeletes, ValidatingTrait;
|
|
|
|
/** @var array */
|
|
protected $dates = ['created_at', 'updated_at', 'deleted_at'];
|
|
/** @var array */
|
|
protected $fillable = ['user_id', 'account_type_id', 'name', 'active', 'virtual_balance', 'iban'];
|
|
/** @var array */
|
|
protected $hidden = ['virtual_balance_encrypted', 'encrypted'];
|
|
protected $rules
|
|
= [
|
|
'user_id' => 'required|exists:users,id',
|
|
'account_type_id' => 'required|exists:account_types,id',
|
|
'name' => 'required|between:1,200',
|
|
'active' => 'required|boolean',
|
|
'iban' => 'between:1,50|iban',
|
|
];
|
|
/** @var bool */
|
|
private $joinedAccountTypes;
|
|
|
|
/**
|
|
* @param array $fields
|
|
*
|
|
* @return Account|null
|
|
*/
|
|
public static function firstOrCreateEncrypted(array $fields)
|
|
{
|
|
// everything but the name:
|
|
$query = Account::orderBy('id');
|
|
$search = $fields;
|
|
unset($search['name'], $search['iban']);
|
|
|
|
foreach ($search as $name => $value) {
|
|
$query->where($name, $value);
|
|
}
|
|
$set = $query->get(['accounts.*']);
|
|
/** @var Account $account */
|
|
foreach ($set as $account) {
|
|
if ($account->name == $fields['name']) {
|
|
return $account;
|
|
}
|
|
}
|
|
// account must have a name. If not set, use IBAN.
|
|
if (!isset($fields['name'])) {
|
|
$fields['name'] = $fields['iban'];
|
|
}
|
|
|
|
// create it!
|
|
$account = Account::create($fields);
|
|
|
|
return $account;
|
|
|
|
}
|
|
|
|
/**
|
|
* @param array $fields
|
|
*
|
|
* @return Account|null
|
|
*/
|
|
public static function firstOrNullEncrypted(array $fields)
|
|
{
|
|
// everything but the name:
|
|
$query = Account::orderBy('id');
|
|
$search = $fields;
|
|
unset($search['name']);
|
|
foreach ($search as $name => $value) {
|
|
$query->where($name, $value);
|
|
}
|
|
$set = $query->get(['accounts.*']);
|
|
/** @var Account $account */
|
|
foreach ($set as $account) {
|
|
if ($account->name == $fields['name']) {
|
|
return $account;
|
|
}
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* @param Account $value
|
|
*
|
|
* @return Account
|
|
*/
|
|
public static function routeBinder(Account $value)
|
|
{
|
|
|
|
if (auth()->check()) {
|
|
if ($value->user_id == auth()->user()->id) {
|
|
return $value;
|
|
}
|
|
}
|
|
throw new NotFoundHttpException;
|
|
}
|
|
|
|
/**
|
|
* @return HasMany
|
|
*/
|
|
public function accountMeta(): HasMany
|
|
{
|
|
return $this->hasMany('FireflyIII\Models\AccountMeta');
|
|
}
|
|
|
|
/**
|
|
* @return BelongsTo
|
|
*/
|
|
public function accountType(): BelongsTo
|
|
{
|
|
return $this->belongsTo('FireflyIII\Models\AccountType');
|
|
}
|
|
|
|
/**
|
|
* FIxxME can return null
|
|
*
|
|
* @param $value
|
|
*
|
|
* @return string
|
|
* @throws FireflyException
|
|
*/
|
|
public function getIbanAttribute($value): string
|
|
{
|
|
if (is_null($value) || strlen(strval($value)) === 0) {
|
|
return '';
|
|
}
|
|
try {
|
|
$result = Crypt::decrypt($value);
|
|
} catch (DecryptException $e) {
|
|
throw new FireflyException('Cannot decrypt value "' . $value . '" for account #' . $this->id);
|
|
}
|
|
if (is_null($result)) {
|
|
return '';
|
|
}
|
|
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @param string $fieldName
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getMeta(string $fieldName): string
|
|
{
|
|
foreach ($this->accountMeta as $meta) {
|
|
if ($meta->name == $fieldName) {
|
|
return $meta->data;
|
|
}
|
|
}
|
|
|
|
return '';
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @param $value
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getNameAttribute($value): string
|
|
{
|
|
|
|
if (intval($this->encrypted) == 1) {
|
|
return Crypt::decrypt($value);
|
|
}
|
|
|
|
return $value;
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getNameForEditformAttribute(): string
|
|
{
|
|
$name = $this->name;
|
|
if ($this->accountType->type == 'Cash account') {
|
|
$name = '';
|
|
}
|
|
|
|
return $name;
|
|
}
|
|
|
|
/**
|
|
* @return HasMany
|
|
*/
|
|
public function piggyBanks(): HasMany
|
|
{
|
|
return $this->hasMany('FireflyIII\Models\PiggyBank');
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @param EloquentBuilder $query
|
|
* @param array $types
|
|
*/
|
|
public function scopeAccountTypeIn(EloquentBuilder $query, array $types)
|
|
{
|
|
if (is_null($this->joinedAccountTypes)) {
|
|
$query->leftJoin('account_types', 'account_types.id', '=', 'accounts.account_type_id');
|
|
$this->joinedAccountTypes = true;
|
|
}
|
|
$query->whereIn('account_types.type', $types);
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @param EloquentBuilder $query
|
|
* @param string $name
|
|
* @param string $value
|
|
*/
|
|
public function scopeHasMetaValue(EloquentBuilder $query, $name, $value)
|
|
{
|
|
$joinName = str_replace('.', '_', $name);
|
|
$query->leftJoin(
|
|
'account_meta as ' . $joinName, function (JoinClause $join) use ($joinName, $name) {
|
|
$join->on($joinName . '.account_id', '=', 'accounts.id')->where($joinName . '.name', '=', $name);
|
|
}
|
|
);
|
|
$query->where($joinName . '.data', json_encode($value));
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @param $value
|
|
*/
|
|
public function setIbanAttribute($value)
|
|
{
|
|
$this->attributes['iban'] = Crypt::encrypt($value);
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @param $value
|
|
*/
|
|
public function setNameAttribute($value)
|
|
{
|
|
$this->attributes['name'] = $value;
|
|
$this->attributes['encrypted'] = false;
|
|
}
|
|
|
|
/**
|
|
* @param $value
|
|
*
|
|
*/
|
|
public function setVirtualBalanceAttribute($value)
|
|
{
|
|
$this->attributes['virtual_balance'] = strval(round($value, 2));
|
|
}
|
|
|
|
/**
|
|
* @return HasMany
|
|
*/
|
|
public function transactions(): HasMany
|
|
{
|
|
return $this->hasMany('FireflyIII\Models\Transaction');
|
|
}
|
|
|
|
/**
|
|
* @return BelongsTo
|
|
*/
|
|
public function user(): BelongsTo
|
|
{
|
|
return $this->belongsTo('FireflyIII\User');
|
|
}
|
|
}
|