Add a new helper to handle fiscal issues.

Used initially to provide fiscal year support to the reports.
This commit is contained in:
Graham Miller 2016-01-27 11:54:04 +10:00
parent 000f86d318
commit eb31934fb7
3 changed files with 114 additions and 0 deletions

View File

@ -0,0 +1,78 @@
<?php
namespace FireflyIII\Helpers;
use Carbon\Carbon;
use Preferences;
/**
* Class FiscalHelper
*
* @package FireflyIII\Helpers
*/
class FiscalHelper implements FiscalHelperInterface
{
/** @var bool */
protected $useCustomFiscalYear;
/**
* FiscalHelper constructor.
*
* @codeCoverageIgnore
*
*/
public function __construct()
{
if (Preferences::get('customFiscalYear', 0)->data) {
$this->useCustomFiscalYear = true;
} else {
$this->useCustomFiscalYear = false;
}
}
/**
* @param Carbon $date
*
* @return Carbon date object
*/
public function startOfFiscalYear(Carbon $date)
{
// get start mm-dd. Then create a start date in the year passed.
$startDate = clone $date;
if ($this->useCustomFiscalYear === true) {
$prefStartStr = Preferences::get('fiscalYearStart', '01-01')->data;
list($mth, $day) = explode('-', $prefStartStr);
$startDate->month(intval($mth))->day(intval($day));
// if start date is after passed date, sub 1 year.
if ($startDate > $date) {
$startDate->subYear();
}
} else {
$startDate->startOfYear();
}
return $startDate;
}
/**
* @param Carbon $date
*
* @return Carbon date object
*/
public function endOfFiscalYear(Carbon $date)
{
// get start of fiscal year for passed date
$endDate = $this->startOfFiscalYear($date);
if ($this->useCustomFiscalYear === true) {
// add 1 year and sub 1 day
$endDate->addYear();
$endDate->subDay();
} else {
$endDate->endOfYear();
}
return $endDate;
}
}

View File

@ -0,0 +1,35 @@
<?php
namespace FireflyIII\Helpers;
use Carbon\Carbon;
/**
* Interface FiscalHelperInterface
*
* @package FireflyIII\Helpers
*/
interface FiscalHelperInterface
{
/**
* This method produces a clone of the Carbon date object passed, checks preferences
* and calculates the first day of the fiscal year.
*
* @param Carbon $start
*
* @return Carbon date object
*/
public function startOfFiscalYear(Carbon $date);
/**
* 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 $start);
}

View File

@ -113,6 +113,7 @@ class FireflyServiceProvider extends ServiceProvider
$this->app->bind('FireflyIII\Helpers\Help\HelpInterface', 'FireflyIII\Helpers\Help\Help');
$this->app->bind('FireflyIII\Helpers\Report\ReportHelperInterface', 'FireflyIII\Helpers\Report\ReportHelper');
$this->app->bind('FireflyIII\Helpers\Report\ReportQueryInterface', 'FireflyIII\Helpers\Report\ReportQuery');
$this->app->bind('FireflyIII\Helpers\FiscalHelperInterface', 'FireflyIII\Helpers\FiscalHelper');
}