mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2025-01-09 07:33:06 -06:00
485 lines
16 KiB
PHP
485 lines
16 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;
|
|
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 CategoryRepositoryInterface $repository
|
|
* @param Category $category
|
|
*
|
|
* @return \Symfony\Component\HttpFoundation\Response
|
|
*/
|
|
public function all(CategoryRepositoryInterface $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
|
|
}
|
|
|
|
while ($start <= $end) {
|
|
$currentEnd = Navigation::endOfPeriod($start, $range);
|
|
$spent = $repository->spentInPeriod($category, $start, $currentEnd);
|
|
$earned = $repository->earnedInPeriod($category, $start, $currentEnd);
|
|
$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 CategoryRepositoryInterface $repository
|
|
*
|
|
* @return \Symfony\Component\HttpFoundation\Response
|
|
*/
|
|
public function frontpage(CategoryRepositoryInterface $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 CategoryRepositoryInterface $repository
|
|
* @param $reportType
|
|
* @param Carbon $start
|
|
* @param Carbon $end
|
|
* @param Collection $accounts
|
|
* @param Collection $categories
|
|
*
|
|
* @return \Illuminate\Http\JsonResponse
|
|
*/
|
|
public function multiYear(CategoryRepositoryInterface $repository, $reportType, Carbon $start, Carbon $end, Collection $accounts, Collection $categories)
|
|
{
|
|
// 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 budget, not by year.
|
|
/** @var Category $category */
|
|
foreach ($categories as $category) {
|
|
$entry = ['name' => '', 'spent' => [], 'earned' => []];
|
|
|
|
$currentStart = clone $start;
|
|
while ($currentStart < $end) {
|
|
// fix the date:
|
|
$currentEnd = clone $currentStart;
|
|
$currentEnd->endOfYear();
|
|
|
|
// get data:
|
|
if (is_null($category->id)) {
|
|
$name = trans('firefly.noCategory');
|
|
$spent = $repository->spentNoCategoryForAccounts($accounts, $currentStart, $currentEnd);
|
|
$earned = $repository->earnedNoCategoryForAccounts($accounts, $currentStart, $currentEnd);
|
|
} else {
|
|
$name = $category->name;
|
|
$spent = $repository->spentInPeriodForAccounts($category, $accounts, $currentStart, $currentEnd);
|
|
$earned = $repository->earnedInPeriodForAccounts($category, $accounts, $currentStart, $currentEnd);
|
|
}
|
|
|
|
// save to array:
|
|
$year = $currentStart->year;
|
|
$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 CategoryRepositoryInterface $repository
|
|
* @param Category $category
|
|
*
|
|
* @return \Symfony\Component\HttpFoundation\Response
|
|
*/
|
|
public function currentPeriod(CategoryRepositoryInterface $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('currentPeriod');
|
|
if ($cache->has()) {
|
|
return Response::json($cache->get()); // @codeCoverageIgnore
|
|
}
|
|
$entries = new Collection;
|
|
|
|
|
|
while ($start <= $end) {
|
|
$spent = $repository->spentOnDaySum($category, $start);
|
|
$earned = $repository->earnedOnDaySum($category, $start);
|
|
$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 CategoryRepositoryInterface $repository
|
|
* @param Category $category
|
|
*
|
|
* @param $date
|
|
*
|
|
* @return \Symfony\Component\HttpFoundation\Response
|
|
*/
|
|
public function specificPeriod(CategoryRepositoryInterface $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;
|
|
|
|
|
|
while ($start <= $end) {
|
|
$spent = $repository->spentOnDaySum($category, $start);
|
|
$earned = $repository->earnedOnDaySum($category, $start);
|
|
$theDate = Navigation::periodShow($start, '1D');
|
|
$entries->push([clone $start, $theDate, $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 CategoryRepositoryInterface $repository
|
|
* @param $reportType
|
|
* @param Carbon $start
|
|
* @param Carbon $end
|
|
* @param Collection $accounts
|
|
*
|
|
* @return \Illuminate\Http\JsonResponse
|
|
*/
|
|
public function earnedInPeriod(CategoryRepositoryInterface $repository, $reportType, Carbon $start, Carbon $end, Collection $accounts)
|
|
{
|
|
$original = clone $start;
|
|
$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
|
|
}
|
|
$categories = new Collection;
|
|
$sets = new Collection;
|
|
$entries = new Collection;
|
|
|
|
// run a very special query each month:
|
|
$start = clone $original;
|
|
while ($start < $end) {
|
|
$currentEnd = clone $start;
|
|
$currentStart = clone $start;
|
|
$currentStart->startOfMonth();
|
|
$currentEnd->endOfMonth();
|
|
// get a list of categories, and what the user has earned for that category
|
|
// (if the user has earned anything)
|
|
$set = $repository->earnedForAccounts($accounts, $currentStart, $currentEnd);
|
|
$categories = $categories->merge($set);
|
|
// save the set combined with the data that is in it:
|
|
// for example:
|
|
// december 2015, salary:1000, bonus:200
|
|
$sets->push([$currentStart, $set]);
|
|
$start->addMonth();
|
|
}
|
|
// filter categories into a single bunch. Useful later on.
|
|
// $categories contains all the categories the user has earned money
|
|
// in in this period.
|
|
$categories = $categories->unique('id');
|
|
$categories = $categories->sortBy(
|
|
function (Category $category) {
|
|
return $category->name;
|
|
}
|
|
);
|
|
|
|
// start looping the time again, this time processing the
|
|
// data for each month.
|
|
$start = clone $original;
|
|
while ($start < $end) {
|
|
$currentEnd = clone $start;
|
|
$currentStart = clone $start;
|
|
$currentStart->startOfMonth();
|
|
$currentEnd->endOfMonth();
|
|
|
|
// in $sets we have saved all the sets of data for each month
|
|
// so now we need to retrieve the corrent one.
|
|
// match is on date of course.
|
|
$currentSet = $sets->first(
|
|
function ($key, $value) use ($currentStart) {
|
|
// set for this date.
|
|
return ($value[0] == $currentStart);
|
|
}
|
|
);
|
|
// create a row used later on.
|
|
$row = [clone $currentStart];
|
|
|
|
// loop all categories:
|
|
/** @var Category $category */
|
|
foreach ($categories as $category) {
|
|
// if entry is not null, we've earned money in this period for this category.
|
|
$entry = $currentSet[1]->first(
|
|
function ($key, $value) use ($category) {
|
|
return $value->id == $category->id;
|
|
}
|
|
);
|
|
// save amount
|
|
if (!is_null($entry)) {
|
|
$row[] = $entry->earned;
|
|
} 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 CategoryRepositoryInterface $repository
|
|
* @param $reportType
|
|
* @param Carbon $start
|
|
* @param Carbon $end
|
|
* @param Collection $accounts
|
|
*
|
|
* @return \Illuminate\Http\JsonResponse
|
|
*/
|
|
public function spentInPeriod(CategoryRepositoryInterface $repository, $reportType, Carbon $start, Carbon $end, Collection $accounts)
|
|
{
|
|
$original = clone $start;
|
|
$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
|
|
}
|
|
$categories = new Collection;
|
|
$sets = new Collection;
|
|
$entries = new Collection;
|
|
|
|
// run a very special query each month:
|
|
$start = clone $original;
|
|
while ($start < $end) {
|
|
$currentEnd = clone $start;
|
|
$currentStart = clone $start;
|
|
$currentStart->startOfMonth();
|
|
$currentEnd->endOfMonth();
|
|
$set = $repository->spentForAccounts($accounts, $currentStart, $currentEnd);
|
|
$categories = $categories->merge($set);
|
|
$sets->push([$currentStart, $set]);
|
|
$start->addMonth();
|
|
}
|
|
$categories = $categories->unique('id');
|
|
$categories = $categories->sortBy(
|
|
function (Category $category) {
|
|
return $category->name;
|
|
}
|
|
);
|
|
|
|
$start = clone $original;
|
|
while ($start < $end) {
|
|
$currentEnd = clone $start;
|
|
$currentStart = clone $start;
|
|
$currentStart->startOfMonth();
|
|
$currentEnd->endOfMonth();
|
|
$currentSet = $sets->first(
|
|
function ($key, $value) use ($currentStart) {
|
|
// set for this date.
|
|
return ($value[0] == $currentStart);
|
|
}
|
|
);
|
|
$row = [clone $currentStart];
|
|
|
|
/** @var Category $category */
|
|
foreach ($categories as $category) {
|
|
/** @var Category $entry */
|
|
$entry = $currentSet[1]->first(
|
|
function ($key, $value) use ($category) {
|
|
return $value->id == $category->id;
|
|
}
|
|
);
|
|
if (!is_null($entry)) {
|
|
$row[] = $entry->spent;
|
|
} else {
|
|
$row[] = 0;
|
|
}
|
|
}
|
|
$entries->push($row);
|
|
$start->addMonth();
|
|
}
|
|
|
|
$data = $this->generator->spentInPeriod($categories, $entries);
|
|
$cache->store($data);
|
|
|
|
return $data;
|
|
|
|
}
|
|
|
|
}
|