Code clean up.

This commit is contained in:
James Cole
2017-11-15 12:25:49 +01:00
parent 57dcdfa0c4
commit ffca858b8d
476 changed files with 2055 additions and 4181 deletions

View File

@@ -18,7 +18,6 @@
* 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\Http\Controllers\Chart;
@@ -45,14 +44,11 @@ use Response;
use Steam;
/** checked
* Class AccountController
*
* @package FireflyIII\Http\Controllers\Chart
* Class AccountController.
*/
class AccountController extends Controller
{
/** @var GeneratorInterface */
/** @var GeneratorInterface */
protected $generator;
/**
@@ -133,7 +129,7 @@ class AccountController extends Controller
$startBalance = $startBalances[$id] ?? '0';
$endBalance = $endBalances[$id] ?? '0';
$diff = bcsub($endBalance, $startBalance);
if (bccomp($diff, '0') !== 0) {
if (0 !== bccomp($diff, '0')) {
$chartData[$account->name] = $diff;
}
}
@@ -274,7 +270,7 @@ class AccountController extends Controller
Log::debug('Default set is ', $defaultSet);
$frontPage = Preferences::get('frontPageAccounts', $defaultSet);
Log::debug('Frontpage preference set is ', $frontPage->data);
if (count($frontPage->data) === 0) {
if (0 === count($frontPage->data)) {
$frontPage->data = $defaultSet;
Log::debug('frontpage set is empty!');
$frontPage->save();
@@ -346,6 +342,7 @@ class AccountController extends Controller
* @param Carbon $start
*
* @return \Illuminate\Http\JsonResponse
*
* @throws FireflyException
*/
public function period(Account $account, Carbon $start)
@@ -427,7 +424,7 @@ class AccountController extends Controller
$endBalance = $endBalances[$id] ?? '0';
$diff = bcsub($endBalance, $startBalance);
$diff = bcmul($diff, '-1');
if (bccomp($diff, '0') !== 0) {
if (0 !== bccomp($diff, '0')) {
$chartData[$account->name] = $diff;
}
}
@@ -539,7 +536,6 @@ class AccountController extends Controller
*/
private function getBudgetNames(array $budgetIds): array
{
/** @var BudgetRepositoryInterface $repository */
$repository = app(BudgetRepositoryInterface::class);
$budgets = $repository->getBudgets();

View File

@@ -18,7 +18,6 @@
* 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\Http\Controllers\Chart;
@@ -35,18 +34,15 @@ use Illuminate\Support\Collection;
use Response;
/**
* Class BillController
*
* @package FireflyIII\Http\Controllers\Chart
* Class BillController.
*/
class BillController extends Controller
{
/** @var GeneratorInterface */
protected $generator;
/**
* checked
* checked.
*/
public function __construct()
{
@@ -108,9 +104,9 @@ class BillController extends Controller
}
);
$chartData = [
['type' => 'bar', 'label' => trans('firefly.min-amount'), 'entries' => [],],
['type' => 'bar', 'label' => trans('firefly.max-amount'), 'entries' => [],],
['type' => 'line', 'label' => trans('firefly.journal-amount'), 'entries' => [],],
['type' => 'bar', 'label' => trans('firefly.min-amount'), 'entries' => []],
['type' => 'bar', 'label' => trans('firefly.max-amount'), 'entries' => []],
['type' => 'line', 'label' => trans('firefly.journal-amount'), 'entries' => []],
];
/** @var Transaction $entry */

View File

@@ -18,7 +18,6 @@
* 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\Http\Controllers\Chart;
@@ -44,19 +43,16 @@ use Response;
use Steam;
/**
* Class BudgetController
* Class BudgetController.
*
* @SuppressWarnings(PHPMD.CouplingBetweenObjects) // can't realy be helped.
*
* @package FireflyIII\Http\Controllers\Chart
*/
class BudgetController extends Controller
{
/** @var GeneratorInterface */
protected $generator;
/** @var BudgetRepositoryInterface */
/** @var BudgetRepositoryInterface */
protected $repository;
/**
@@ -77,7 +73,6 @@ class BudgetController extends Controller
}
/**
*
* @param Budget $budget
*
* @return \Symfony\Component\HttpFoundation\Response
@@ -125,10 +120,12 @@ class BudgetController extends Controller
* Shows the amount left in a specific budget limit.
*
* @SuppressWarnings(PHPMD.CyclomaticComplexity) // it's exactly five.
*
* @param Budget $budget
* @param BudgetLimit $budgetLimit
*
* @return \Symfony\Component\HttpFoundation\Response
*
* @throws FireflyException
*/
public function budgetLimit(Budget $budget, BudgetLimit $budgetLimit)
@@ -185,7 +182,7 @@ class BudgetController extends Controller
/** @var JournalCollectorInterface $collector */
$collector = app(JournalCollectorInterface::class);
$collector->setAllAssetAccounts()->setBudget($budget);
if (!is_null($budgetLimit->id)) {
if (null !== $budgetLimit->id) {
$collector->setRange($budgetLimit->start_date, $budgetLimit->end_date);
}
@@ -229,7 +226,7 @@ class BudgetController extends Controller
/** @var JournalCollectorInterface $collector */
$collector = app(JournalCollectorInterface::class);
$collector->setAllAssetAccounts()->setBudget($budget)->withCategoryInformation();
if (!is_null($budgetLimit->id)) {
if (null !== $budgetLimit->id) {
$collector->setRange($budgetLimit->start_date, $budgetLimit->end_date);
}
@@ -275,7 +272,7 @@ class BudgetController extends Controller
/** @var JournalCollectorInterface $collector */
$collector = app(JournalCollectorInterface::class);
$collector->setAllAssetAccounts()->setTypes([TransactionType::WITHDRAWAL])->setBudget($budget)->withOpposingAccount();
if (!is_null($budgetLimit->id)) {
if (null !== $budgetLimit->id) {
$collector->setRange($budgetLimit->start_date, $budgetLimit->end_date);
}
@@ -303,6 +300,7 @@ class BudgetController extends Controller
/**
* Shows a budget list with spent/left/overspent.
*
* @SuppressWarnings(PHPMD.CyclomaticComplexity) // it's exactly five.
* @SuppressWarnings(PHPMD.ExcessiveMethodLength) // 46 lines, I'm fine with this.
*
@@ -322,9 +320,9 @@ class BudgetController extends Controller
}
$budgets = $this->repository->getActiveBudgets();
$chartData = [
['label' => strval(trans('firefly.spent_in_budget')), 'entries' => [], 'type' => 'bar',],
['label' => strval(trans('firefly.left_to_spend')), 'entries' => [], 'type' => 'bar',],
['label' => strval(trans('firefly.overspent')), 'entries' => [], 'type' => 'bar',],
['label' => strval(trans('firefly.spent_in_budget')), 'entries' => [], 'type' => 'bar'],
['label' => strval(trans('firefly.left_to_spend')), 'entries' => [], 'type' => 'bar'],
['label' => strval(trans('firefly.overspent')), 'entries' => [], 'type' => 'bar'],
];
/** @var Budget $budget */
@@ -342,7 +340,7 @@ class BudgetController extends Controller
// for no budget:
$spent = $this->spentInPeriodWithout($start, $end);
$name = strval(trans('firefly.no_budget'));
if (bccomp($spent, '0') !== 0) {
if (0 !== bccomp($spent, '0')) {
$chartData[0]['entries'][$name] = bcmul($spent, '-1');
$chartData[1]['entries'][$name] = '0';
$chartData[2]['entries'][$name] = '0';
@@ -354,7 +352,6 @@ class BudgetController extends Controller
return Response::json($data);
}
/**
* @SuppressWarnings(PHPMD.CyclomaticComplexity) // it's exactly five.
*
@@ -383,8 +380,8 @@ class BudgetController extends Controller
// join them into one set of data:
$chartData = [
['label' => strval(trans('firefly.spent')), 'type' => 'bar', 'entries' => [],],
['label' => strval(trans('firefly.budgeted')), 'type' => 'bar', 'entries' => [],],
['label' => strval(trans('firefly.spent')), 'type' => 'bar', 'entries' => []],
['label' => strval(trans('firefly.budgeted')), 'type' => 'bar', 'entries' => []],
];
foreach (array_keys($periods) as $period) {
@@ -509,7 +506,6 @@ class BudgetController extends Controller
}
/**
*
* @SuppressWarnings(PHPMD.CyclomaticComplexity) // it's 6 but ok.
*
* @param Collection $limits
@@ -522,9 +518,9 @@ class BudgetController extends Controller
private function getExpensesForBudget(Collection $limits, Budget $budget, Carbon $start, Carbon $end): array
{
$return = [];
if ($limits->count() === 0) {
if (0 === $limits->count()) {
$spent = $this->repository->spentInPeriod(new Collection([$budget]), new Collection, $start, $end);
if (bccomp($spent, '0') !== 0) {
if (0 !== bccomp($spent, '0')) {
$return[$budget->name]['spent'] = bcmul($spent, '-1');
$return[$budget->name]['left'] = 0;
$return[$budget->name]['overspent'] = 0;
@@ -535,7 +531,7 @@ class BudgetController extends Controller
$rows = $this->spentInPeriodMulti($budget, $limits);
foreach ($rows as $name => $row) {
if (bccomp($row['spent'], '0') !== 0 || bccomp($row['left'], '0') !== 0) {
if (0 !== bccomp($row['spent'], '0') || 0 !== bccomp($row['left'], '0')) {
$return[$name] = $row;
}
}
@@ -607,7 +603,7 @@ class BudgetController extends Controller
* 'name' => "no budget" in local language
* 'repetition_left' => left in budget repetition (always zero)
* 'repetition_overspent' => spent more than budget repetition? (always zero)
* 'spent' => actually spent in period for budget
* 'spent' => actually spent in period for budget.
*
* @param Carbon $start
* @param Carbon $end

View File

@@ -18,7 +18,6 @@
* 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\Http\Controllers\Chart;
@@ -45,15 +44,12 @@ use Response;
* Separate controller because many helper functions are shared.
*
* Class BudgetReportController
*
* @package FireflyIII\Http\Controllers\Chart
*/
class BudgetReportController extends Controller
{
/** @var BudgetRepositoryInterface */
private $budgetRepository;
/** @var GeneratorInterface */
/** @var GeneratorInterface */
private $generator;
/**
@@ -89,7 +85,7 @@ class BudgetReportController extends Controller
$helper->setBudgets($budgets);
$helper->setStart($start);
$helper->setEnd($end);
$helper->setCollectOtherObjects(intval($others) === 1);
$helper->setCollectOtherObjects(1 === intval($others));
$chartData = $helper->generate('expense', 'account');
$data = $this->generator->pieChart($chartData);
@@ -113,7 +109,7 @@ class BudgetReportController extends Controller
$helper->setBudgets($budgets);
$helper->setStart($start);
$helper->setEnd($end);
$helper->setCollectOtherObjects(intval($others) === 1);
$helper->setCollectOtherObjects(1 === intval($others));
$chartData = $helper->generate('expense', 'budget');
$data = $this->generator->pieChart($chartData);

View File

@@ -18,7 +18,6 @@
* 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\Http\Controllers\Chart;
@@ -37,13 +36,11 @@ use Preferences;
use Response;
/**
* Class CategoryController
*
* @package FireflyIII\Http\Controllers\Chart
* Class CategoryController.
*/
class CategoryController extends Controller
{
/** @var GeneratorInterface */
/** @var GeneratorInterface */
protected $generator;
/**
@@ -76,7 +73,7 @@ class CategoryController extends Controller
$start = $repository->firstUseDate($category);
if (is_null($start)) {
if (null === $start) {
$start = new Carbon;
}
@@ -277,7 +274,6 @@ class CategoryController extends Controller
/**
* @param CategoryRepositoryInterface $repository
* @param Category $category
*
* @param $date
*
* @return \Symfony\Component\HttpFoundation\Response
@@ -292,7 +288,6 @@ class CategoryController extends Controller
return Response::json($data);
}
/**
* @param CategoryRepositoryInterface $repository
* @param Category $category
@@ -347,7 +342,6 @@ class CategoryController extends Controller
$chartData[1]['entries'][$label] = round($earned, 12);
$chartData[2]['entries'][$label] = round($sum, 12);
$start->addDay();
}

View File

@@ -18,7 +18,6 @@
* 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\Http\Controllers\Chart;
@@ -44,13 +43,10 @@ use Response;
* Separate controller because many helper functions are shared.
*
* Class CategoryReportController
*
* @package FireflyIII\Http\Controllers\Chart
*/
class CategoryReportController extends Controller
{
/** @var GeneratorInterface */
/** @var GeneratorInterface */
private $generator;
/**
@@ -81,7 +77,7 @@ class CategoryReportController extends Controller
{
/** @var MetaPieChartInterface $helper */
$helper = app(MetaPieChartInterface::class);
$helper->setAccounts($accounts)->setCategories($categories)->setStart($start)->setEnd($end)->setCollectOtherObjects(intval($others) === 1);
$helper->setAccounts($accounts)->setCategories($categories)->setStart($start)->setEnd($end)->setCollectOtherObjects(1 === intval($others));
$chartData = $helper->generate('expense', 'account');
$data = $this->generator->pieChart($chartData);
@@ -106,7 +102,7 @@ class CategoryReportController extends Controller
$helper->setCategories($categories);
$helper->setStart($start);
$helper->setEnd($end);
$helper->setCollectOtherObjects(intval($others) === 1);
$helper->setCollectOtherObjects(1 === intval($others));
$chartData = $helper->generate('income', 'account');
$data = $this->generator->pieChart($chartData);
@@ -130,7 +126,7 @@ class CategoryReportController extends Controller
$helper->setCategories($categories);
$helper->setStart($start);
$helper->setEnd($end);
$helper->setCollectOtherObjects(intval($others) === 1);
$helper->setCollectOtherObjects(1 === intval($others));
$chartData = $helper->generate('expense', 'category');
$data = $this->generator->pieChart($chartData);
@@ -148,14 +144,13 @@ class CategoryReportController extends Controller
*/
public function categoryIncome(Collection $accounts, Collection $categories, Carbon $start, Carbon $end, string $others)
{
/** @var MetaPieChartInterface $helper */
$helper = app(MetaPieChartInterface::class);
$helper->setAccounts($accounts);
$helper->setCategories($categories);
$helper->setStart($start);
$helper->setEnd($end);
$helper->setCollectOtherObjects(intval($others) === 1);
$helper->setCollectOtherObjects(1 === intval($others));
$chartData = $helper->generate('income', 'category');
$data = $this->generator->pieChart($chartData);
@@ -236,7 +231,6 @@ class CategoryReportController extends Controller
$currentIncome = $income[$category->id] ?? '0';
$currentExpense = $expenses[$category->id] ?? '0';
// add to sum:
$sumOfIncome[$category->id] = $sumOfIncome[$category->id] ?? '0';
$sumOfExpense[$category->id] = $sumOfExpense[$category->id] ?? '0';
@@ -255,11 +249,11 @@ class CategoryReportController extends Controller
// remove all empty entries to prevent cluttering:
$newSet = [];
foreach ($chartData as $key => $entry) {
if (!array_sum($entry['entries']) === 0) {
if (0 === !array_sum($entry['entries'])) {
$newSet[$key] = $chartData[$key];
}
}
if (count($newSet) === 0) {
if (0 === count($newSet)) {
$newSet = $chartData;
}
$data = $this->generator->multiSet($newSet);
@@ -268,7 +262,6 @@ class CategoryReportController extends Controller
return Response::json($data);
}
/**
* @param Collection $accounts
* @param Collection $categories

View File

@@ -18,7 +18,6 @@
* 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\Http\Controllers\Chart;
@@ -32,13 +31,10 @@ use FireflyIII\Support\CacheProperties;
use Response;
/**
* Class PiggyBankController
*
* @package FireflyIII\Http\Controllers\Chart
* Class PiggyBankController.
*/
class PiggyBankController extends Controller
{
/** @var GeneratorInterface */
protected $generator;

View File

@@ -18,7 +18,6 @@
* 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\Http\Controllers\Chart;
@@ -35,13 +34,10 @@ use Response;
use Steam;
/**
* Class ReportController
*
* @package FireflyIII\Http\Controllers\Chart
* Class ReportController.
*/
class ReportController extends Controller
{
/** @var GeneratorInterface */
protected $generator;
@@ -92,15 +88,13 @@ class ReportController extends Controller
return Response::json($data);
}
/**
* Shows income and expense, debet/credit: operations
* Shows income and expense, debet/credit: operations.
*
* @param Collection $accounts
* @param Carbon $start
* @param Carbon $end
*
*
* @return \Illuminate\Http\JsonResponse
*/
public function operations(Collection $accounts, Carbon $start, Carbon $end)
@@ -143,7 +137,6 @@ class ReportController extends Controller
$chartData[1]['entries'][$label] = bcadd($spent, $amount);
}
$data = $this->generator->multiSet($chartData);
$cache->store($data);
@@ -151,7 +144,7 @@ class ReportController extends Controller
}
/**
* Shows sum income and expense, debet/credit: operations
* Shows sum income and expense, debet/credit: operations.
*
* @param Carbon $start
* @param Carbon $end
@@ -161,8 +154,6 @@ class ReportController extends Controller
*/
public function sum(Collection $accounts, Carbon $start, Carbon $end)
{
// chart properties for cache:
$cache = new CacheProperties;
$cache->addProperty('chart.report.sum');
@@ -173,7 +164,6 @@ class ReportController extends Controller
return Response::json($cache->get()); // @codeCoverageIgnore
}
$source = $this->getChartData($accounts, $start, $end);
$numbers = [
'sum_earned' => '0',
@@ -185,14 +175,14 @@ class ReportController extends Controller
];
foreach ($source['earned'] as $amount) {
$numbers['sum_earned'] = bcadd($amount, $numbers['sum_earned']);
$numbers['count_earned']++;
++$numbers['count_earned'];
}
if ($numbers['count_earned'] > 0) {
$numbers['avg_earned'] = $numbers['sum_earned'] / $numbers['count_earned'];
}
foreach ($source['spent'] as $amount) {
$numbers['sum_spent'] = bcadd($amount, $numbers['sum_spent']);
$numbers['count_spent']++;
++$numbers['count_spent'];
}
if ($numbers['count_spent'] > 0) {
$numbers['avg_spent'] = $numbers['sum_spent'] / $numbers['count_spent'];
@@ -217,7 +207,6 @@ class ReportController extends Controller
],
];
$data = $this->generator->multiSet($chartData);
$cache->store($data);
@@ -240,7 +229,7 @@ class ReportController extends Controller
}
/**
* Collects the incomes and expenses for the given periods, grouped per month. Will cache its results
* Collects the incomes and expenses for the given periods, grouped per month. Will cache its results.
*
* @param Collection $accounts
* @param Carbon $start
@@ -290,7 +279,6 @@ class ReportController extends Controller
)
);
$label = $currentStart->format('Y-m') . '-01';
$spentArray[$label] = bcmul($spent, '-1');
$earnedArray[$label] = $earned;

View File

@@ -18,7 +18,6 @@
* 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\Http\Controllers\Chart;
@@ -72,7 +71,7 @@ class TagReportController extends Controller
$helper->setTags($tags);
$helper->setStart($start);
$helper->setEnd($end);
$helper->setCollectOtherObjects(intval($others) === 1);
$helper->setCollectOtherObjects(1 === intval($others));
$chartData = $helper->generate('expense', 'account');
$data = $this->generator->pieChart($chartData);
@@ -96,7 +95,7 @@ class TagReportController extends Controller
$helper->setTags($tags);
$helper->setStart($start);
$helper->setEnd($end);
$helper->setCollectOtherObjects(intval($others) === 1);
$helper->setCollectOtherObjects(1 === intval($others));
$chartData = $helper->generate('income', 'account');
$data = $this->generator->pieChart($chartData);
@@ -223,7 +222,6 @@ class TagReportController extends Controller
$currentIncome = $income[$tag->id] ?? '0';
$currentExpense = $expenses[$tag->id] ?? '0';
// add to sum:
$sumOfIncome[$tag->id] = $sumOfIncome[$tag->id] ?? '0';
$sumOfExpense[$tag->id] = $sumOfExpense[$tag->id] ?? '0';
@@ -242,11 +240,11 @@ class TagReportController extends Controller
// remove all empty entries to prevent cluttering:
$newSet = [];
foreach ($chartData as $key => $entry) {
if (!array_sum($entry['entries']) === 0) {
if (0 === !array_sum($entry['entries'])) {
$newSet[$key] = $chartData[$key];
}
}
if (count($newSet) === 0) {
if (0 === count($newSet)) {
$newSet = $chartData; // @codeCoverageIgnore
}
$data = $this->generator->multiSet($newSet);
@@ -272,7 +270,7 @@ class TagReportController extends Controller
$helper->setTags($tags);
$helper->setStart($start);
$helper->setEnd($end);
$helper->setCollectOtherObjects(intval($others) === 1);
$helper->setCollectOtherObjects(1 === intval($others));
$chartData = $helper->generate('expense', 'tag');
$data = $this->generator->pieChart($chartData);
@@ -290,14 +288,13 @@ class TagReportController extends Controller
*/
public function tagIncome(Collection $accounts, Collection $tags, Carbon $start, Carbon $end, string $others)
{
/** @var MetaPieChartInterface $helper */
$helper = app(MetaPieChartInterface::class);
$helper->setAccounts($accounts);
$helper->setTags($tags);
$helper->setStart($start);
$helper->setEnd($end);
$helper->setCollectOtherObjects(intval($others) === 1);
$helper->setCollectOtherObjects(1 === intval($others));
$chartData = $helper->generate('income', 'tag');
$data = $this->generator->pieChart($chartData);