mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2025-01-09 07:33:06 -06:00
492 lines
17 KiB
PHP
492 lines
17 KiB
PHP
<?php
|
|
|
|
namespace FireflyIII\Http\Controllers\Chart;
|
|
|
|
|
|
use Carbon\Carbon;
|
|
use FireflyIII\Http\Controllers\Controller;
|
|
use FireflyIII\Models\Category;
|
|
use FireflyIII\Repositories\Category\CategoryRepositoryInterface as CRI;
|
|
use FireflyIII\Repositories\Category\SingleCategoryRepositoryInterface as SCRI;
|
|
use FireflyIII\Support\CacheProperties;
|
|
use Illuminate\Support\Collection;
|
|
use Navigation;
|
|
use Preferences;
|
|
use Response;
|
|
use Session;
|
|
|
|
/**
|
|
* Class CategoryController
|
|
*
|
|
* @package FireflyIII\Http\Controllers\Chart
|
|
*/
|
|
class CategoryController extends Controller
|
|
{
|
|
/** @var \FireflyIII\Generator\Chart\Category\CategoryChartGenerator */
|
|
protected $generator;
|
|
|
|
/**
|
|
* @codeCoverageIgnore
|
|
*/
|
|
public function __construct()
|
|
{
|
|
parent::__construct();
|
|
// create chart generator:
|
|
$this->generator = app('FireflyIII\Generator\Chart\Category\CategoryChartGenerator');
|
|
}
|
|
|
|
|
|
/**
|
|
* Show an overview for a category for all time, per month/week/year.
|
|
*
|
|
* @param SCRI $repository
|
|
* @param Category $category
|
|
*
|
|
* @return \Symfony\Component\HttpFoundation\Response
|
|
*/
|
|
public function all(SCRI $repository, Category $category)
|
|
{
|
|
// oldest transaction in category:
|
|
$start = $repository->getFirstActivityDate($category);
|
|
$range = Preferences::get('viewRange', '1M')->data;
|
|
$start = Navigation::startOfPeriod($start, $range);
|
|
$end = new Carbon;
|
|
$entries = new Collection;
|
|
|
|
|
|
// chart properties for cache:
|
|
$cache = new CacheProperties();
|
|
$cache->addProperty($start);
|
|
$cache->addProperty($end);
|
|
$cache->addProperty('all');
|
|
$cache->addProperty('categories');
|
|
if ($cache->has()) {
|
|
return Response::json($cache->get()); // @codeCoverageIgnore
|
|
}
|
|
$spentArray = $repository->spentPerDay($category, $start, $end);
|
|
$earnedArray = $repository->earnedPerDay($category, $start, $end);
|
|
|
|
|
|
while ($start <= $end) {
|
|
$currentEnd = Navigation::endOfPeriod($start, $range);
|
|
|
|
// get the sum from $spentArray and $earnedArray:
|
|
$spent = $this->getSumOfRange($start, $currentEnd, $spentArray);
|
|
$earned = $this->getSumOfRange($start, $currentEnd, $earnedArray);
|
|
|
|
$date = Navigation::periodShow($start, $range);
|
|
$entries->push([clone $start, $date, $spent, $earned]);
|
|
$start = Navigation::addPeriod($start, $range, 0);
|
|
}
|
|
// limit the set to the last 40:
|
|
$entries = $entries->reverse();
|
|
$entries = $entries->slice(0, 48);
|
|
$entries = $entries->reverse();
|
|
|
|
$data = $this->generator->all($entries);
|
|
$cache->store($data);
|
|
|
|
return Response::json($data);
|
|
|
|
|
|
}
|
|
|
|
|
|
/**
|
|
* Show this month's category overview.
|
|
*
|
|
* @param CRI $repository
|
|
*
|
|
* @return \Symfony\Component\HttpFoundation\Response
|
|
*/
|
|
public function frontpage(CRI $repository)
|
|
{
|
|
|
|
$start = Session::get('start', Carbon::now()->startOfMonth());
|
|
$end = Session::get('end', Carbon::now()->endOfMonth());
|
|
|
|
// chart properties for cache:
|
|
$cache = new CacheProperties;
|
|
$cache->addProperty($start);
|
|
$cache->addProperty($end);
|
|
$cache->addProperty('category');
|
|
$cache->addProperty('frontpage');
|
|
if ($cache->has()) {
|
|
return Response::json($cache->get()); // @codeCoverageIgnore
|
|
}
|
|
|
|
$array = $repository->getCategoriesAndExpenses($start, $end);
|
|
// sort by callback:
|
|
uasort(
|
|
$array,
|
|
function ($left, $right) {
|
|
if ($left['sum'] == $right['sum']) {
|
|
return 0;
|
|
}
|
|
|
|
return ($left['sum'] < $right['sum']) ? -1 : 1;
|
|
}
|
|
);
|
|
$set = new Collection($array);
|
|
$data = $this->generator->frontpage($set);
|
|
$cache->store($data);
|
|
|
|
return Response::json($data);
|
|
|
|
}
|
|
|
|
/**
|
|
* @param $reportType
|
|
* @param Carbon $start
|
|
* @param Carbon $end
|
|
* @param Collection $accounts
|
|
* @param Collection $categories
|
|
*
|
|
* @return \Illuminate\Http\JsonResponse
|
|
*/
|
|
public function multiYear($reportType, Carbon $start, Carbon $end, Collection $accounts, Collection $categories)
|
|
{
|
|
/** @var CRI $repository */
|
|
$repository = app('FireflyIII\Repositories\Category\CategoryRepositoryInterface');
|
|
|
|
// chart properties for cache:
|
|
$cache = new CacheProperties();
|
|
$cache->addProperty($reportType);
|
|
$cache->addProperty($start);
|
|
$cache->addProperty($end);
|
|
$cache->addProperty($accounts);
|
|
$cache->addProperty($categories);
|
|
$cache->addProperty('multiYearCategory');
|
|
|
|
if ($cache->has()) {
|
|
return Response::json($cache->get()); // @codeCoverageIgnore
|
|
}
|
|
|
|
/**
|
|
* category
|
|
* year:
|
|
* spent: x
|
|
* earned: x
|
|
* year
|
|
* spent: x
|
|
* earned: x
|
|
*/
|
|
$entries = new Collection;
|
|
// go by category, not by year.
|
|
|
|
// given a set of categories and accounts, it should not be difficult to get
|
|
// the exact array of data we need.
|
|
|
|
// then get the data for "no category".
|
|
$set = $repository->listMultiYear($categories, $accounts, $start, $end);
|
|
|
|
/** @var Category $category */
|
|
foreach ($categories as $category) {
|
|
$entry = ['name' => '', 'spent' => [], 'earned' => []];
|
|
|
|
$currentStart = clone $start;
|
|
while ($currentStart < $end) {
|
|
// fix the date:
|
|
$year = $currentStart->year;
|
|
$currentEnd = clone $currentStart;
|
|
$currentEnd->endOfYear();
|
|
|
|
|
|
// get data:
|
|
if (is_null($category->id)) {
|
|
$name = trans('firefly.noCategory');
|
|
$spent = $repository->sumSpentNoCategory($accounts, $currentStart, $currentEnd);
|
|
$earned = $repository->sumEarnedNoCategory($accounts, $currentStart, $currentEnd);
|
|
} else {
|
|
// get from set:
|
|
$entrySpent = $set->filter(
|
|
function (Category $cat) use ($year, $category) {
|
|
return ($cat->type == 'Withdrawal' && $cat->dateFormatted == $year && $cat->id == $category->id);
|
|
}
|
|
)->first();
|
|
$entryEarned = $set->filter(
|
|
function (Category $cat) use ($year, $category) {
|
|
return ($cat->type == 'Deposit' && $cat->dateFormatted == $year && $cat->id == $category->id);
|
|
}
|
|
)->first();
|
|
|
|
$name = $category->name;
|
|
$spent = !is_null($entrySpent) ? $entrySpent->sum : 0;
|
|
$earned = !is_null($entryEarned) ? $entryEarned->sum : 0;
|
|
}
|
|
|
|
// save to array:
|
|
$entry['name'] = $name;
|
|
$entry['spent'][$year] = ($spent * -1);
|
|
$entry['earned'][$year] = $earned;
|
|
|
|
// jump to next year.
|
|
$currentStart = clone $currentEnd;
|
|
$currentStart->addDay();
|
|
}
|
|
$entries->push($entry);
|
|
}
|
|
// generate chart with data:
|
|
$data = $this->generator->multiYear($entries);
|
|
$cache->store($data);
|
|
|
|
return Response::json($data);
|
|
|
|
}
|
|
|
|
/**
|
|
* @param SCRI $repository
|
|
* @param Category $category
|
|
*
|
|
* @return \Symfony\Component\HttpFoundation\Response
|
|
*/
|
|
public function currentPeriod(SCRI $repository, Category $category)
|
|
{
|
|
$start = clone Session::get('start', Carbon::now()->startOfMonth());
|
|
$end = Session::get('end', Carbon::now()->endOfMonth());
|
|
|
|
// chart properties for cache:
|
|
$cache = new CacheProperties;
|
|
$cache->addProperty($start);
|
|
$cache->addProperty($end);
|
|
$cache->addProperty($category->id);
|
|
$cache->addProperty('category');
|
|
$cache->addProperty('current-period');
|
|
if ($cache->has()) {
|
|
return Response::json($cache->get()); // @codeCoverageIgnore
|
|
}
|
|
$entries = new Collection;
|
|
|
|
// get amount earned in period, grouped by day.
|
|
// get amount spent in period, grouped by day.
|
|
$spentArray = $repository->spentPerDay($category, $start, $end);
|
|
$earnedArray = $repository->earnedPerDay($category, $start, $end);
|
|
|
|
while ($start <= $end) {
|
|
$str = $start->format('Y-m-d');
|
|
$spent = isset($spentArray[$str]) ? $spentArray[$str] : 0;
|
|
$earned = isset($earnedArray[$str]) ? $earnedArray[$str] : 0;
|
|
$date = Navigation::periodShow($start, '1D');
|
|
$entries->push([clone $start, $date, $spent, $earned]);
|
|
$start->addDay();
|
|
}
|
|
|
|
$data = $this->generator->period($entries);
|
|
$cache->store($data);
|
|
|
|
return Response::json($data);
|
|
}
|
|
|
|
/**
|
|
* @param SCRI $repository
|
|
* @param Category $category
|
|
*
|
|
* @param $date
|
|
*
|
|
* @return \Symfony\Component\HttpFoundation\Response
|
|
*/
|
|
public function specificPeriod(SCRI $repository, Category $category, $date)
|
|
{
|
|
$carbon = new Carbon($date);
|
|
$range = Preferences::get('viewRange', '1M')->data;
|
|
$start = Navigation::startOfPeriod($carbon, $range);
|
|
$end = Navigation::endOfPeriod($carbon, $range);
|
|
|
|
// chart properties for cache:
|
|
$cache = new CacheProperties;
|
|
$cache->addProperty($start);
|
|
$cache->addProperty($end);
|
|
$cache->addProperty($category->id);
|
|
$cache->addProperty('category');
|
|
$cache->addProperty('specificPeriod');
|
|
$cache->addProperty($date);
|
|
if ($cache->has()) {
|
|
return Response::json($cache->get()); // @codeCoverageIgnore
|
|
}
|
|
$entries = new Collection;
|
|
|
|
// get amount earned in period, grouped by day.
|
|
$spentArray = $repository->spentPerDay($category, $start, $end);
|
|
$earnedArray = $repository->earnedPerDay($category, $start, $end);
|
|
// get amount spent in period, grouped by day.
|
|
|
|
while ($start <= $end) {
|
|
$str = $start->format('Y-m-d');
|
|
$spent = isset($spentArray[$str]) ? $spentArray[$str] : 0;
|
|
$earned = isset($earnedArray[$str]) ? $earnedArray[$str] : 0;
|
|
$date = Navigation::periodShow($start, '1D');
|
|
$entries->push([clone $start, $date, $spent, $earned]);
|
|
$start->addDay();
|
|
}
|
|
|
|
$data = $this->generator->period($entries);
|
|
$cache->store($data);
|
|
|
|
return Response::json($data);
|
|
|
|
|
|
}
|
|
|
|
/**
|
|
* Returns a chart of what has been earned in this period in each category
|
|
* grouped by month.
|
|
*
|
|
* @param CRI $repository
|
|
* @param $reportType
|
|
* @param Carbon $start
|
|
* @param Carbon $end
|
|
* @param Collection $accounts
|
|
*
|
|
* @return \Illuminate\Http\JsonResponse
|
|
*/
|
|
public function earnedInPeriod(CRI $repository, $reportType, Carbon $start, Carbon $end, Collection $accounts)
|
|
{
|
|
$cache = new CacheProperties; // chart properties for cache:
|
|
$cache->addProperty($start);
|
|
$cache->addProperty($end);
|
|
$cache->addProperty($reportType);
|
|
$cache->addProperty($accounts);
|
|
$cache->addProperty('category');
|
|
$cache->addProperty('earned-in-period');
|
|
if ($cache->has()) {
|
|
return Response::json($cache->get()); // @codeCoverageIgnore
|
|
}
|
|
|
|
$set = $repository->earnedForAccountsPerMonth($accounts, $start, $end);
|
|
$categories = $set->unique('id')->sortBy(
|
|
function (Category $category) {
|
|
return $category->name;
|
|
}
|
|
);
|
|
$entries = new Collection;
|
|
|
|
while ($start < $end) { // filter the set:
|
|
$row = [clone $start];
|
|
// get possibly relevant entries from the big $set
|
|
$currentSet = $set->filter(
|
|
function (Category $category) use ($start) {
|
|
return $category->dateFormatted == $start->format("Y-m");
|
|
}
|
|
);
|
|
// check for each category if its in the current set.
|
|
/** @var Category $category */
|
|
foreach ($categories as $category) {
|
|
// if its in there, use the value.
|
|
$entry = $currentSet->filter(
|
|
function (Category $cat) use ($category) {
|
|
return ($cat->id == $category->id);
|
|
}
|
|
)->first();
|
|
if (!is_null($entry)) {
|
|
$row[] = round($entry->earned, 2);
|
|
} else {
|
|
$row[] = 0;
|
|
}
|
|
}
|
|
|
|
$entries->push($row);
|
|
$start->addMonth();
|
|
}
|
|
$data = $this->generator->earnedInPeriod($categories, $entries);
|
|
$cache->store($data);
|
|
|
|
return $data;
|
|
|
|
}
|
|
|
|
/**
|
|
* Returns a chart of what has been spent in this period in each category
|
|
* grouped by month.
|
|
*
|
|
* @param CRI $repository
|
|
* @param $reportType
|
|
* @param Carbon $start
|
|
* @param Carbon $end
|
|
* @param Collection $accounts
|
|
*
|
|
* @return \Illuminate\Http\JsonResponse
|
|
*/
|
|
public function spentInPeriod(CRI $repository, $reportType, Carbon $start, Carbon $end, Collection $accounts)
|
|
{
|
|
$cache = new CacheProperties; // chart properties for cache:
|
|
$cache->addProperty($start);
|
|
$cache->addProperty($end);
|
|
$cache->addProperty($reportType);
|
|
$cache->addProperty($accounts);
|
|
$cache->addProperty('category');
|
|
$cache->addProperty('spent-in-period');
|
|
if ($cache->has()) {
|
|
return Response::json($cache->get()); // @codeCoverageIgnore
|
|
}
|
|
|
|
$set = $repository->spentForAccountsPerMonth($accounts, $start, $end);
|
|
$categories = $set->unique('id')->sortBy(
|
|
function (Category $category) {
|
|
return $category->name;
|
|
}
|
|
);
|
|
$entries = new Collection;
|
|
|
|
while ($start < $end) { // filter the set:
|
|
$row = [clone $start];
|
|
// get possibly relevant entries from the big $set
|
|
$currentSet = $set->filter(
|
|
function (Category $category) use ($start) {
|
|
return $category->dateFormatted == $start->format("Y-m");
|
|
}
|
|
);
|
|
// check for each category if its in the current set.
|
|
/** @var Category $category */
|
|
foreach ($categories as $category) {
|
|
// if its in there, use the value.
|
|
$entry = $currentSet->filter(
|
|
function (Category $cat) use ($category) {
|
|
return ($cat->id == $category->id);
|
|
}
|
|
)->first();
|
|
if (!is_null($entry)) {
|
|
$row[] = round(($entry->spent * -1), 2);
|
|
} else {
|
|
$row[] = 0;
|
|
}
|
|
}
|
|
|
|
$entries->push($row);
|
|
$start->addMonth();
|
|
}
|
|
$data = $this->generator->spentInPeriod($categories, $entries);
|
|
$cache->store($data);
|
|
|
|
return $data;
|
|
}
|
|
|
|
/**
|
|
* Take the array as returned by SingleCategoryRepositoryInterface::spentPerDay and SingleCategoryRepositoryInterface::earnedByDay
|
|
* and sum up everything in the array in the given range.
|
|
*
|
|
* @param Carbon $start
|
|
* @param Carbon $end
|
|
* @param array $array
|
|
*
|
|
* @return string
|
|
*/
|
|
protected function getSumOfRange(Carbon $start, Carbon $end, array $array)
|
|
{
|
|
bcscale(2);
|
|
$sum = '0';
|
|
$currentStart = clone $start; // to not mess with the original one
|
|
$currentEnd = clone $end; // to not mess with the original one
|
|
|
|
while ($currentStart <= $currentEnd) {
|
|
$date = $currentStart->format('Y-m-d');
|
|
if (isset($array[$date])) {
|
|
$sum = bcadd($sum, $array[$date]);
|
|
}
|
|
$currentStart->addDay();
|
|
}
|
|
|
|
return $sum;
|
|
}
|
|
|
|
}
|