firefly-iii/app/Models/AccountType.php

100 lines
3.1 KiB
PHP
Raw Normal View History

2016-05-20 01:57:45 -05:00
<?php
/**
* AccountType.php
2020-02-16 06:55:32 -06:00
* Copyright (c) 2019 james@firefly-iii.org
*
* This file is part of Firefly III (https://github.com/firefly-iii).
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
2017-10-21 01:40:00 -05:00
*
* This program is distributed in the hope that it will be useful,
2017-10-21 01:40:00 -05:00
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
2017-10-21 01:40:00 -05:00
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
2017-03-24 09:15:12 -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
use Eloquent;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Collection;
2015-02-27 09:48:33 -06:00
use Illuminate\Database\Eloquent\Model;
2016-04-06 02:27:45 -05:00
use Illuminate\Database\Eloquent\Relations\HasMany;
use Illuminate\Support\Carbon;
2015-02-27 09:48:33 -06:00
2016-11-18 13:06:08 -06:00
/**
2017-11-15 05:25:49 -06:00
* Class AccountType.
2018-06-06 14:23:00 -05:00
*
2020-03-25 00:58:29 -05:00
* @property string $type
* @method whereType(string $type)
2020-03-25 00:58:29 -05:00
* @property int $id
* @property Carbon|null $created_at
* @property Carbon|null $updated_at
* @property-read Collection|Account[] $accounts
* @method static Builder|AccountType newModelQuery()
* @method static Builder|AccountType newQuery()
* @method static Builder|AccountType query()
* @method static Builder|AccountType whereCreatedAt($value)
* @method static Builder|AccountType whereId($value)
* @method static Builder|AccountType whereUpdatedAt($value)
* @mixin Eloquent
2020-03-25 00:58:29 -05:00
* @property-read int|null $accounts_count
2016-11-18 13:06:08 -06:00
*/
2015-02-27 09:48:33 -06:00
class AccountType extends Model
{
2018-08-06 12:14:30 -05:00
/** @var string */
public const DEFAULT = 'Default account';
/** @var string */
public const CASH = 'Cash account';
/** @var string */
public const ASSET = 'Asset account';
/** @var string */
public const EXPENSE = 'Expense account';
/** @var string */
public const REVENUE = 'Revenue account';
/** @var string */
2018-03-29 12:01:47 -05:00
public const INITIAL_BALANCE = 'Initial balance account';
2018-08-06 12:14:30 -05:00
/** @var string */
public const BENEFICIARY = 'Beneficiary account';
/** @var string */
public const IMPORT = 'Import account';
/** @var string */
public const RECONCILIATION = 'Reconciliation account';
/** @var string */
public const LOAN = 'Loan';
/** @var string */
public const DEBT = 'Debt';
/** @var string */
public const MORTGAGE = 'Mortgage';
/** @var string */
public const CREDITCARD = 'Credit card';
2018-08-04 10:30:06 -05:00
/**
* The attributes that should be casted to native types.
*
* @var array
*/
2016-12-24 10:36:51 -06:00
protected $casts
= [
2017-11-03 10:04:17 -05:00
'created_at' => 'datetime',
'updated_at' => 'datetime',
2016-12-24 10:36:51 -06:00
];
2018-08-04 10:30:06 -05:00
/** @var array Fields that can be filled */
2017-11-22 13:30:23 -06:00
protected $fillable = ['type'];
2016-12-24 10:36:51 -06:00
2015-02-27 09:48:33 -06:00
/**
2016-04-06 02:27:45 -05:00
* @return HasMany
* @codeCoverageIgnore
2015-02-27 09:48:33 -06:00
*/
2016-04-06 02:27:45 -05:00
public function accounts(): HasMany
2015-02-27 09:48:33 -06:00
{
2018-04-27 23:23:13 -05:00
return $this->hasMany(Account::class);
2015-02-27 09:48:33 -06:00
}
}