Files
firefly-iii/app/Models/PiggyBank.php

122 lines
3.3 KiB
PHP
Raw Normal View History

2015-02-06 04:52:16 +01:00
<?php namespace FireflyIII\Models;
2016-01-01 21:49:27 +01:00
use Carbon\Carbon;
2015-04-07 18:26:14 +02:00
use Crypt;
2016-01-01 21:49:27 +01:00
use Illuminate\Database\Eloquent\Collection;
2015-02-06 04:52:16 +01:00
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;
2015-04-07 18:26:14 +02:00
2015-02-11 07:35:10 +01:00
/**
2016-01-01 21:49:27 +01:00
* FireflyIII\Models\PiggyBank
2015-02-11 07:35:10 +01:00
*
2016-01-01 21:49:27 +01:00
* @property integer $id
* @property Carbon $created_at
* @property Carbon $updated_at
* @property Carbon $deleted_at
* @property integer $account_id
* @property string $name
* @property float $targetamount
* @property Carbon $startdate
* @property Carbon $targetdate
* @property integer $order
* @property boolean $encrypted
* @property boolean $remind_me
* @property integer $reminder_skip
* @property-read Account $account
* @property-read Collection|PiggyBankRepetition[] $piggyBankRepetitions
* @property-read Collection|PiggyBankEvent[] $piggyBankEvents
2015-02-11 07:35:10 +01:00
*/
2015-02-06 05:04:06 +01:00
class PiggyBank extends Model
{
use SoftDeletes;
2015-02-06 04:52:16 +01:00
protected $fillable
2015-06-23 22:13:13 +02:00
= ['name', 'account_id', 'order', 'targetamount', 'startdate', 'targetdate', 'remind_me', 'reminder_skip'];
2015-05-23 17:11:16 +02:00
protected $hidden = ['targetamount_encrypted', 'encrypted'];
2015-02-25 19:32:33 +01:00
2015-02-11 07:35:10 +01:00
/**
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
*/
2015-02-06 05:14:27 +01:00
public function account()
{
2015-02-06 05:35:00 +01:00
return $this->belongsTo('FireflyIII\Models\Account');
2015-02-06 05:14:27 +01:00
}
2015-02-06 04:52:16 +01:00
2015-02-24 21:10:25 +01:00
/**
* Grabs the PiggyBankRepetition that's currently relevant / active
*
* @returns PiggyBankRepetition
*/
public function currentRelevantRep()
{
if (!is_null($this->currentRep)) {
2015-02-24 21:10:25 +01:00
return $this->currentRep;
}
2015-03-27 18:17:15 +01:00
// repeating piggy banks are no longer supported.
2015-03-30 20:08:27 +02:00
$rep = $this->piggyBankRepetitions()->first(['piggy_bank_repetitions.*']);
$this->currentRep = $rep;
2015-02-24 21:10:25 +01:00
2015-03-30 20:08:27 +02:00
return $rep;
2015-02-24 21:10:25 +01:00
}
2015-02-25 19:32:33 +01:00
/**
* @return \Illuminate\Database\Eloquent\Relations\HasMany
*/
public function piggyBankRepetitions()
{
return $this->hasMany('FireflyIII\Models\PiggyBankRepetition');
}
/**
* @return string[]
2015-02-25 19:32:33 +01:00
*/
public function getDates()
{
return ['created_at', 'updated_at', 'deleted_at', 'startdate', 'targetdate'];
}
2015-05-23 08:46:46 +02:00
/**
*
* @param $value
*
* @return string
*/
public function getNameAttribute($value)
{
if (intval($this->encrypted) == 1) {
return Crypt::decrypt($value);
}
return $value;
}
2015-02-25 19:32:33 +01:00
/**
* @return \Illuminate\Database\Eloquent\Relations\HasMany
*/
public function piggyBankEvents()
{
return $this->hasMany('FireflyIII\Models\PiggyBankEvent');
}
2015-03-30 20:08:27 +02:00
/**
2015-05-14 09:51:54 +02:00
*
2015-03-30 20:08:27 +02:00
* @param $value
*/
public function setNameAttribute($value)
{
$this->attributes['name'] = Crypt::encrypt($value);
$this->attributes['encrypted'] = true;
}
2015-04-07 18:26:14 +02:00
2015-03-30 20:08:27 +02:00
/**
* @param $value
*/
2015-05-23 08:46:46 +02:00
public function setTargetamountAttribute($value)
2015-03-30 20:08:27 +02:00
{
2015-05-24 08:00:40 +02:00
$this->attributes['targetamount'] = strval(round($value, 2));
2015-03-30 20:08:27 +02:00
}
2015-02-06 04:52:16 +01:00
}