firefly-iii/app/Models/TransactionType.php

69 lines
1.8 KiB
PHP
Raw Normal View History

2015-02-27 09:48:33 -06:00
<?php namespace FireflyIII\Models;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;
/**
2016-01-01 14:49:27 -06:00
* FireflyIII\Models\TransactionType
2015-02-27 09:48:33 -06:00
*
* @property integer $id
* @property \Carbon\Carbon $created_at
* @property \Carbon\Carbon $updated_at
* @property \Carbon\Carbon $deleted_at
* @property string $type
* @property-read \Illuminate\Database\Eloquent\Collection|TransactionJournal[] $transactionJournals
2015-02-27 09:48:33 -06:00
*/
class TransactionType extends Model
{
use SoftDeletes;
2015-12-18 09:38:50 -06:00
const WITHDRAWAL = 'Withdrawal';
const DEPOSIT = 'Deposit';
const TRANSFER = 'Transfer';
const OPENING_BALANCE = 'Opening balance';
2016-01-15 15:32:21 -06:00
protected $dates = ['created_at', 'updated_at', 'deleted_at'];
2015-02-27 09:48:33 -06:00
/**
2015-12-18 09:38:50 -06:00
* @return bool
2015-02-27 09:48:33 -06:00
*/
2015-12-18 09:38:50 -06:00
public function isDeposit()
2015-02-27 09:48:33 -06:00
{
2015-12-18 09:38:50 -06:00
return $this->type === TransactionType::DEPOSIT;
2015-02-27 09:48:33 -06:00
}
/**
* @return bool
*/
2015-12-18 09:38:50 -06:00
public function isOpeningBalance()
{
2015-12-18 09:38:50 -06:00
return $this->type === TransactionType::OPENING_BALANCE;
}
/**
* @return bool
*/
2015-12-18 09:38:50 -06:00
public function isTransfer()
{
2015-12-18 09:38:50 -06:00
return $this->type === TransactionType::TRANSFER;
}
/**
* @return bool
*/
2015-12-18 09:38:50 -06:00
public function isWithdrawal()
{
2015-12-18 09:38:50 -06:00
return $this->type === TransactionType::WITHDRAWAL;
}
/**
2016-01-17 08:28:01 -06:00
* @codeCoverageIgnore
*
2015-12-18 09:38:50 -06:00
* @return \Illuminate\Database\Eloquent\Relations\HasMany
*/
2015-12-18 09:38:50 -06:00
public function transactionJournals()
{
2015-12-18 09:38:50 -06:00
return $this->hasMany('FireflyIII\Models\TransactionJournal');
}
2015-02-27 09:48:33 -06:00
}