mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2024-11-26 19:00:22 -06:00
53 lines
1.6 KiB
PHP
53 lines
1.6 KiB
PHP
<?php
|
|
|
|
/**
|
|
* FiscalHelperInterface.php
|
|
* 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.
|
|
*
|
|
* This program 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 Affero General Public License for more details.
|
|
*
|
|
* 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/>.
|
|
*/
|
|
declare(strict_types=1);
|
|
|
|
namespace FireflyIII\Helpers\Fiscal;
|
|
|
|
use Carbon\Carbon;
|
|
|
|
/**
|
|
* Interface FiscalHelperInterface.
|
|
*/
|
|
interface FiscalHelperInterface
|
|
{
|
|
/**
|
|
* This method produces a clone of the Carbon date object passed, checks preferences
|
|
* and calculates the last day of the fiscal year.
|
|
*
|
|
* @param Carbon $date
|
|
*
|
|
* @return Carbon date object
|
|
*/
|
|
public function endOfFiscalYear(Carbon $date): Carbon;
|
|
|
|
/**
|
|
* This method produces a clone of the Carbon date object passed, checks preferences
|
|
* and calculates the first day of the fiscal year.
|
|
*
|
|
* @param Carbon $date
|
|
*
|
|
* @return Carbon date object
|
|
*/
|
|
public function startOfFiscalYear(Carbon $date): Carbon;
|
|
}
|