firefly-iii/app/Helpers/Collection/BillLine.php

176 lines
3.3 KiB
PHP
Raw Normal View History

<?php
/**
* BillLine.php
2017-10-21 01:40:00 -05:00
* Copyright (c) 2017 thegrumpydictator@gmail.com
*
2017-10-21 01:40:00 -05:00
* This file is part of Firefly III.
*
2017-10-21 01:40:00 -05:00
* Firefly III is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Firefly III is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Firefly III. If not, see <http://www.gnu.org/licenses/>.
*/
declare(strict_types=1);
namespace FireflyIII\Helpers\Collection;
2016-11-20 05:08:43 -06:00
use Carbon\Carbon;
use FireflyIII\Models\Bill as BillModel;
/**
2017-11-15 05:25:49 -06:00
* Class BillLine.
*/
class BillLine
{
2017-11-15 05:25:49 -06:00
/** @var string */
protected $amount;
2017-11-15 05:25:49 -06:00
/** @var BillModel */
protected $bill;
2017-11-15 05:25:49 -06:00
/** @var bool */
protected $hit;
2017-11-15 05:25:49 -06:00
/** @var string */
protected $max;
2017-11-15 05:25:49 -06:00
/** @var string */
protected $min;
2017-11-15 05:25:49 -06:00
/** @var Carbon */
2016-11-20 05:08:43 -06:00
private $lastHitDate;
2017-11-15 05:25:49 -06:00
/** @var int */
private $transactionJournalId;
2016-11-20 05:08:43 -06:00
/**
* BillLine constructor.
*/
public function __construct()
{
$this->lastHitDate = new Carbon;
}
/**
2015-06-14 01:22:02 -05:00
* @return string
*/
2016-02-18 03:04:26 -06:00
public function getAmount(): string
{
2016-02-18 03:06:34 -06:00
return $this->amount ?? '0';
}
/**
2015-06-14 01:22:02 -05:00
* @param string $amount
*/
2016-02-05 02:25:15 -06:00
public function setAmount(string $amount)
{
$this->amount = $amount;
}
/**
* @return BillModel
*/
2016-02-18 03:04:26 -06:00
public function getBill(): BillModel
{
return $this->bill;
}
/**
* @param BillModel $bill
*/
2016-02-05 02:25:15 -06:00
public function setBill(BillModel $bill)
{
$this->bill = $bill;
}
2016-12-14 11:59:12 -06:00
/**
* @return Carbon
*/
public function getLastHitDate(): Carbon
{
return $this->lastHitDate;
}
/**
* @param Carbon $lastHitDate
*/
public function setLastHitDate(Carbon $lastHitDate)
{
$this->lastHitDate = $lastHitDate;
}
/**
2015-06-14 01:22:02 -05:00
* @return string
*/
2016-02-18 03:04:26 -06:00
public function getMax(): string
{
return $this->max;
}
/**
2015-06-14 01:22:02 -05:00
* @param string $max
*/
2016-02-05 02:25:15 -06:00
public function setMax(string $max)
{
$this->max = $max;
}
/**
2015-06-14 01:22:02 -05:00
* @return string
*/
2016-02-18 03:04:26 -06:00
public function getMin(): string
{
return $this->min;
}
/**
2015-06-14 01:22:02 -05:00
* @param string $min
*/
2016-02-05 02:25:15 -06:00
public function setMin(string $min)
{
$this->min = $min;
}
/**
* @return int
*/
public function getTransactionJournalId(): int
{
return $this->transactionJournalId ?? 0;
}
/**
* @param int $transactionJournalId
*/
public function setTransactionJournalId(int $transactionJournalId)
{
$this->transactionJournalId = $transactionJournalId;
}
/**
2016-04-06 02:27:45 -05:00
* @return bool
*/
2016-02-18 03:04:26 -06:00
public function isActive(): bool
{
2017-11-15 05:25:49 -06:00
return 1 === intval($this->bill->active);
}
/**
2016-04-06 02:27:45 -05:00
* @return bool
*/
2016-02-18 03:04:26 -06:00
public function isHit(): bool
{
return $this->hit;
}
/**
2016-02-05 02:25:15 -06:00
* @param bool $hit
*/
2016-02-05 02:25:15 -06:00
public function setHit(bool $hit)
{
$this->hit = $hit;
}
2015-05-20 12:56:14 -05:00
}