Some code cleanup.

app/Export/Collector/AttachmentCollector.php

@@ -33,6 +33,9 @@ class AttachmentCollector extends BasicCollector implements CollectorInterface
         parent::__construct($job);
     }
 
+    /**
+     *
+     */
     public function run()
     {
         // grab all the users attachments:

app/Export/Collector/BasicCollector.php

@@ -29,6 +29,8 @@ class BasicCollector
 
     /**
      * BasicCollector constructor.
+     *
+     * @param ExportJob $job
      */
     public function __construct(ExportJob $job)
     {

app/Export/ConfigurationFile.php

@@ -22,6 +22,11 @@ class ConfigurationFile
     /** @var  ExportJob */
     private $job;
 
+    /**
+     * ConfigurationFile constructor.
+     *
+     * @param ExportJob $job
+     */
     public function __construct(ExportJob $job)
     {
         $this->job = $job;

app/Export/Exporter/BasicExporter.php

@@ -28,6 +28,8 @@ class BasicExporter
 
     /**
      * BasicExporter constructor.
+     *
+     * @param ExportJob $job
      */
     public function __construct(ExportJob $job)
     {

app/Export/Exporter/CsvExporter.php

@@ -30,6 +30,8 @@ class CsvExporter extends BasicExporter implements ExporterInterface
 
     /**
      * CsvExporter constructor.
+     *
+     * @param ExportJob $job
      */
     public function __construct(ExportJob $job)
     {

app/Generator/Chart/Budget/ChartJsBudgetChartGenerator.php

@@ -85,8 +85,8 @@ class ChartJsBudgetChartGenerator implements BudgetChartGeneratorInterface
         foreach ($filtered as $entry) {
             $data['labels'][] = $entry[0];
             $left[]           = round($entry[1], 2);
-            $spent[]          = round(bcmul($entry[2],'-1'), 2); // spent is coming in negative, must be positive
+            $spent[]          = round(bcmul($entry[2], '-1'), 2); // spent is coming in negative, must be positive
-            $overspent[]      = round(bcmul($entry[3],'-1'), 2); // same
+            $overspent[]      = round(bcmul($entry[3], '-1'), 2); // same
         }
 
         $data['datasets'][] = [

app/Handlers/Events/ConnectJournalToPiggyBank.php

@@ -58,7 +58,7 @@ class ConnectJournalToPiggyBank
         $amount = $journal->amount_positive;
         // if piggy account matches source account, the amount is positive
         if ($piggyBank->account_id == $journal->source_account->id) {
-            $amount = bcmul($amount,'-1');
+            $amount = bcmul($amount, '-1');
         }
 
 

app/Http/Controllers/AccountController.php

@@ -154,7 +154,9 @@ class AccountController extends Controller
         $subTitleIcon = Config::get('firefly.subIconsByIdentifier.' . $what);
         $types        = Config::get('firefly.accountTypesByIdentifier.' . $what);
         $accounts     = $repository->getAccounts($types);
+        /** @var Carbon $start */
         $start        = clone session('start', Carbon::now()->startOfMonth());
+        /** @var Carbon $end */
         $end          = clone session('end', Carbon::now()->endOfMonth());
         $start->subDay();
 

app/Http/Controllers/BudgetController.php

@@ -45,6 +45,7 @@ class BudgetController extends Controller
     public function amount(BudgetRepositoryInterface $repository, Budget $budget)
     {
         $amount = intval(Input::get('amount'));
+        /** @var Carbon $date */
         $date            = session('start', Carbon::now()->startOfMonth());
         $limitRepetition = $repository->updateLimitAmount($budget, $date, $amount);
         if ($amount == 0) {
@@ -145,7 +146,9 @@ class BudgetController extends Controller
         $spent    = '0';
         $budgeted = '0';
         $range    = Preferences::get('viewRange', '1M')->data;
-        $start             = Navigation::startOfPeriod(session('start', new Carbon), $range);
+        /** @var Carbon $date */
+        $date              = session('start', new Carbon);
+        $start             = Navigation::startOfPeriod($date, $range);
         $end               = Navigation::endOfPeriod($start, $range);
         $key               = 'budgetIncomeTotal' . $start->format('Ymd') . $end->format('Ymd');
         $budgetIncomeTotal = Preferences::get($key, 1000)->data;
@@ -187,7 +190,9 @@ class BudgetController extends Controller
     public function noBudget(BudgetRepositoryInterface $repository)
     {
         $range = Preferences::get('viewRange', '1M')->data;
-        $start    = Navigation::startOfPeriod(session('start', new Carbon), $range);
+        /** @var Carbon $date */
+        $date     = session('start', new Carbon);
+        $start    = Navigation::startOfPeriod($date, $range);
         $end      = Navigation::endOfPeriod($start, $range);
         $list     = $repository->getWithoutBudget($start, $end);
         $subTitle = trans(
@@ -204,7 +209,9 @@ class BudgetController extends Controller
     public function postUpdateIncome()
     {
         $range = Preferences::get('viewRange', '1M')->data;
-        $start = Navigation::startOfPeriod(session('start', new Carbon), $range);
+        /** @var Carbon $date */
+        $date  = session('start', new Carbon);
+        $start = Navigation::startOfPeriod($date, $range);
         $end   = Navigation::endOfPeriod($start, $range);
         $key   = 'budgetIncomeTotal' . $start->format('Ymd') . $end->format('Ymd');
 
@@ -323,7 +330,10 @@ class BudgetController extends Controller
     public function updateIncome()
     {
         $range = Preferences::get('viewRange', '1M')->data;
-        $start  = Navigation::startOfPeriod(session('start', new Carbon), $range);
+
+        /** @var Carbon $date */
+        $date   = session('start', new Carbon);
+        $start  = Navigation::startOfPeriod($date, $range);
         $end    = Navigation::endOfPeriod($start, $range);
         $key    = 'budgetIncomeTotal' . $start->format('Ymd') . $end->format('Ymd');
         $amount = Preferences::get($key, 1000);

app/Http/Controllers/CategoryController.php

@@ -133,7 +133,9 @@ class CategoryController extends Controller
      */
     public function noCategory(CRI $repository)
     {
+        /** @var Carbon $start */
         $start = session('start', Carbon::now()->startOfMonth());
+        /** @var Carbon $end */
         $end      = session('end', Carbon::now()->startOfMonth());
         $list     = $repository->listNoCategory($start, $end);
         $subTitle = trans(

app/Http/Controllers/ExportController.php

@@ -66,6 +66,8 @@ class ExportController extends Controller
     }
 
     /**
+     * @param ExportJob $job
+     *
      * @return \Illuminate\Http\JsonResponse
      */
     public function getStatus(ExportJob $job)
@@ -76,6 +78,8 @@ class ExportController extends Controller
     /**
      * @param ARI  $repository
      *
+     * @param EJRI $jobs
+     *
      * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
      */
     public function index(ARI $repository, EJRI $jobs)
@@ -100,7 +104,10 @@ class ExportController extends Controller
      * @param ExportFormRequest $request
      * @param ARI               $repository
      *
+     * @param EJRI              $jobs
+     *
      * @return string
+     * @throws \FireflyIII\Exceptions\FireflyException
      */
     public function postIndex(ExportFormRequest $request, ARI $repository, EJRI $jobs)
     {

app/Http/Controllers/HomeController.php

@@ -90,7 +90,9 @@ class HomeController extends Controller
         $mainTitleIcon     = 'fa-fire';
         $transactions      = [];
         $frontPage         = Preferences::get('frontPageAccounts', []);
+        /** @var Carbon $start */
         $start             = session('start', Carbon::now()->startOfMonth());
+        /** @var Carbon $end */
         $end               = session('end', Carbon::now()->endOfMonth());
         $showTour          = Preferences::get('tour', true)->data;
         $accounts          = $repository->getFrontpageAccounts($frontPage);
@@ -105,11 +107,11 @@ class HomeController extends Controller
 
         $sum = $repository->sumOfEverything();
 
-        if ($sum != 0) {
+        if (bccomp($sum, '0') !== 0) {
             Session::flash(
                 'error', 'Your transactions are unbalanced. This means a'
                          . ' withdrawal, deposit or transfer was not stored properly. '
-                         . 'Please check your accounts and transactions for errors.'
+                         . 'Please check your accounts and transactions for errors (' . $sum . ').'
             );
         }
 

app/Http/Controllers/JsonController.php

@@ -66,7 +66,7 @@ class JsonController extends Controller
         if ($creditCardDue >= 0) {
             $amount = bcadd($amount, $creditCardDue);
         }
-        $amount = bcmul($amount,'-1');
+        $amount = bcmul($amount, '-1');
 
         $data = ['box' => 'bills-paid', 'amount' => Amount::format($amount, false), 'amount_raw' => $amount];
 

app/Http/Controllers/PiggyBankController.php

@@ -48,6 +48,7 @@ class PiggyBankController extends Controller
     public function add(ARI $repository, PiggyBank $piggyBank)
     {
         bcscale(2);
+        /** @var Carbon $date */
         $date          = session('end', Carbon::now()->endOfMonth());
         $leftOnAccount = $repository->leftOnAccount($piggyBank->account, $date);
         $savedSoFar    = $piggyBank->currentRelevantRep()->currentamount;
@@ -229,6 +230,7 @@ class PiggyBankController extends Controller
     {
         bcscale(2);
         $amount        = round(Input::get('amount'), 2);
+        /** @var Carbon $date */
         $date          = session('end', Carbon::now()->endOfMonth());
         $leftOnAccount = $accounts->leftOnAccount($piggyBank->account, $date);
         $savedSoFar    = $piggyBank->currentRelevantRep()->currentamount;

app/Http/Controllers/ReportController.php

@@ -52,6 +52,7 @@ class ReportController extends Controller
      */
     public function index(ARI $repository)
     {
+        /** @var Carbon $start */
         $start            = session('first');
         $months           = $this->helper->listOfMonths($start);
         $customFiscalYear = Preferences::get('customFiscalYear', 0)->data;

app/Repositories/Budget/BudgetRepository.php

@@ -696,11 +696,11 @@ class BudgetRepository extends ComponentRepository implements BudgetRepositoryIn
     /**
      * @param Budget $budget
      * @param Carbon $date
-     * @param        $amount
+     * @param int    $amount
      *
      * @return BudgetLimit
      */
-    public function updateLimitAmount(Budget $budget, Carbon $date, $amount)
+    public function updateLimitAmount(Budget $budget, Carbon $date, int $amount)
     {
         // there should be a budget limit for this startdate:
         /** @var BudgetLimit $limit */

app/Repositories/Budget/BudgetRepositoryInterface.php

@@ -253,10 +253,10 @@ interface BudgetRepositoryInterface
     /**
      * @param Budget $budget
      * @param Carbon $date
-     * @param        $amount
+     * @param int       $amount
      *
      * @return mixed
      */
-    public function updateLimitAmount(Budget $budget, Carbon $date, $amount);
+    public function updateLimitAmount(Budget $budget, Carbon $date, int $amount);
 
 }

app/Support/Amount.php

@@ -112,7 +112,7 @@ class Amount
 
     /**
      * @param string       $symbol
-     * @param float  $amount
+     * @param float|string $amount
      * @param bool         $coloured
      *
      * @return string

app/Support/Migration/TestData.php

@@ -323,6 +323,7 @@ class TestData
     }
 
     /**
+     * @param User   $user
      * @param Carbon $date
      * @SuppressWarnings(PHPMD.ExcessiveMethodLength)
      */
@@ -651,9 +652,10 @@ class TestData
     }
 
     /**
-     * @param        $description
+     * @param User   $user
+     * @param string $description
      * @param Carbon $date
-     * @param        $amount
+     * @param string $amount
      *
      * @return TransactionJournal
      */
@@ -848,6 +850,7 @@ class TestData
     }
 
     /**
+     * @param User   $user
      * @param Carbon $date
      *
      * @return TransactionJournal
@@ -985,7 +988,7 @@ class TestData
      * @param Carbon $date
      * @param string $amount
      *
-     * @return static
+     * @return TransactionJournal|static
      */
     public static function createWater(User $user, string $description, Carbon $date, string $amount): TransactionJournal
     {

app/Support/Steam.php

@@ -184,7 +184,7 @@ class Steam
 
         if (!(strpos($string, 'm') === false)) {
             // has a M in it, remove the M and multiply by 1048576.
-            $bytes = bcmul(rtrim($string, 'm'),'1048576');
+            $bytes = bcmul(rtrim($string, 'm'), '1048576');
 
             return intval($bytes);
         }

database/migrations/2014_07_09_204843_create_session_table.php

@@ -1,7 +1,6 @@
 <?php
 
 use Illuminate\Database\Migrations\Migration;
-use Illuminate\Database\Schema\Blueprint;
 
 /**
  * @SuppressWarnings(PHPMD.ShortMethodName)
@@ -29,14 +28,16 @@ class CreateSessionTable extends Migration
      */
     public function up()
     {
-        Schema::create('sessions', function ($table) {
+        Schema::create(
+            'sessions', function ($table) {
             $table->string('id')->unique();
             $table->integer('user_id')->nullable();
             $table->string('ip_address', 45)->nullable();
             $table->text('user_agent')->nullable();
             $table->text('payload');
             $table->integer('last_activity');
-        });
+        }
+        );
     }
 
 }

tests/acceptance/Controllers/AccountControllerTest.php

@@ -16,6 +16,8 @@ class AccountControllerTest extends TestCase
      * @covers       FireflyIII\Http\Controllers\AccountController::create
      * @covers       FireflyIII\Http\Controllers\AccountController::__construct
      * @dataProvider dateRangeProvider
+     *
+     * @param $range
      */
     public function testCreate($range)
     {
@@ -61,6 +63,8 @@ class AccountControllerTest extends TestCase
      * @covers       FireflyIII\Http\Controllers\AccountController::index
      * @covers       FireflyIII\Http\Controllers\AccountController::isInArray
      * @dataProvider dateRangeProvider
+     *
+     * @param $range
      */
     public function testIndex($range)
     {
@@ -73,6 +77,8 @@ class AccountControllerTest extends TestCase
     /**
      * @covers       FireflyIII\Http\Controllers\AccountController::show
      * @dataProvider dateRangeProvider
+     *
+     * @param $range
      */
     public function testShow($range)
     {

tests/acceptance/Controllers/BillControllerTest.php

@@ -60,6 +60,8 @@ class BillControllerTest extends TestCase
     /**
      * @covers       FireflyIII\Http\Controllers\BillController::index
      * @dataProvider dateRangeProvider
+     *
+     * @param $range
      */
     public function testIndex($range)
     {
@@ -72,6 +74,8 @@ class BillControllerTest extends TestCase
     /**
      * @covers       FireflyIII\Http\Controllers\BillController::rescan
      * @dataProvider dateRangeProvider
+     *
+     * @param $range
      */
     public function testRescan($range)
     {
@@ -85,6 +89,8 @@ class BillControllerTest extends TestCase
     /**
      * @covers       FireflyIII\Http\Controllers\BillController::show
      * @dataProvider dateRangeProvider
+     *
+     * @param $range
      */
     public function testShow($range)
     {

tests/acceptance/Controllers/BudgetControllerTest.php

@@ -17,6 +17,8 @@ class BudgetControllerTest extends TestCase
      * @covers       FireflyIII\Http\Controllers\BudgetController::amount
      * @covers       FireflyIII\Http\Controllers\BudgetController::__construct
      * @dataProvider dateRangeProvider
+     *
+     * @param $range
      */
     public function testAmount($range)
     {
@@ -76,6 +78,8 @@ class BudgetControllerTest extends TestCase
     /**
      * @covers       FireflyIII\Http\Controllers\BudgetController::index
      * @dataProvider dateRangeProvider
+     *
+     * @param $range
      */
     public function testIndex($range)
     {
@@ -88,6 +92,8 @@ class BudgetControllerTest extends TestCase
     /**
      * @covers       FireflyIII\Http\Controllers\BudgetController::noBudget
      * @dataProvider dateRangeProvider
+     *
+     * @param $range
      */
     public function testNoBudget($range)
     {
@@ -100,6 +106,8 @@ class BudgetControllerTest extends TestCase
     /**
      * @covers       FireflyIII\Http\Controllers\BudgetController::postUpdateIncome
      * @dataProvider dateRangeProvider
+     *
+     * @param $range
      */
     public function testPostUpdateIncome($range)
     {
@@ -116,6 +124,8 @@ class BudgetControllerTest extends TestCase
     /**
      * @covers       FireflyIII\Http\Controllers\BudgetController::show
      * @dataProvider dateRangeProvider
+     *
+     * @param $range
      */
     public function testShow($range)
     {
@@ -165,6 +175,8 @@ class BudgetControllerTest extends TestCase
     /**
      * @covers       FireflyIII\Http\Controllers\BudgetController::updateIncome
      * @dataProvider dateRangeProvider
+     *
+     * @param $range
      */
     public function testUpdateIncome($range)
     {

tests/acceptance/Controllers/CategoryControllerTest.php

@@ -63,6 +63,7 @@ class CategoryControllerTest extends TestCase
      * @covers       FireflyIII\Http\Controllers\CategoryController::index
      * @dataProvider dateRangeProvider
      *
+     * @param $range
      */
     public function testIndex($range)
     {
@@ -75,6 +76,8 @@ class CategoryControllerTest extends TestCase
     /**
      * @covers       FireflyIII\Http\Controllers\CategoryController::noCategory
      * @dataProvider dateRangeProvider
+     *
+     * @param $range
      */
     public function testNoCategory($range)
     {
@@ -88,6 +91,8 @@ class CategoryControllerTest extends TestCase
      * @covers       FireflyIII\Http\Controllers\CategoryController::show
      * @covers       FireflyIII\Http\Controllers\Controller::getSumOfRange
      * @dataProvider dateRangeProvider
+     *
+     * @param $range
      */
     public function testShow($range)
     {
@@ -101,6 +106,8 @@ class CategoryControllerTest extends TestCase
     /**
      * @covers       FireflyIII\Http\Controllers\CategoryController::showWithDate
      * @dataProvider dateRangeProvider
+     *
+     * @param $range
      */
     public function testShowWithDate($range)
     {

tests/acceptance/Controllers/CurrencyControllerTest.php

@@ -74,6 +74,8 @@ class CurrencyControllerTest extends TestCase
     /**
      * @covers       FireflyIII\Http\Controllers\CurrencyController::index
      * @dataProvider dateRangeProvider
+     *
+     * @param $range
      */
     public function testIndex($range)
     {

tests/acceptance/Controllers/HomeControllerTest.php

@@ -43,6 +43,8 @@ class HomeControllerTest extends TestCase
      * @covers       FireflyIII\Http\Controllers\HomeController::index
      * @covers       FireflyIII\Http\Controllers\Controller::__construct
      * @dataProvider dateRangeProvider
+     *
+     * @param $range
      */
     public function testIndex($range)
     {

tests/acceptance/Controllers/JsonControllerTest.php

@@ -29,6 +29,8 @@ class JsonControllerTest extends TestCase
     /**
      * @covers       FireflyIII\Http\Controllers\JsonController::boxBillsPaid
      * @dataProvider dateRangeProvider
+     *
+     * @param $range
      */
     public function testBoxBillsPaid($range)
     {
@@ -41,6 +43,8 @@ class JsonControllerTest extends TestCase
     /**
      * @covers       FireflyIII\Http\Controllers\JsonController::boxBillsUnpaid
      * @dataProvider dateRangeProvider
+     *
+     * @param $range
      */
     public function testBoxBillsUnpaid($range)
     {
@@ -53,6 +57,8 @@ class JsonControllerTest extends TestCase
     /**
      * @covers       FireflyIII\Http\Controllers\JsonController::boxIn
      * @dataProvider dateRangeProvider
+     *
+     * @param $range
      */
     public function testBoxIn($range)
     {
@@ -65,6 +71,8 @@ class JsonControllerTest extends TestCase
     /**
      * @covers       FireflyIII\Http\Controllers\JsonController::boxOut
      * @dataProvider dateRangeProvider
+     *
+     * @param $range
      */
     public function testBoxOut($range)
     {
@@ -77,6 +85,8 @@ class JsonControllerTest extends TestCase
     /**
      * @covers       FireflyIII\Http\Controllers\JsonController::categories
      * @dataProvider dateRangeProvider
+     *
+     * @param $range
      */
     public function testCategories($range)
     {
@@ -140,6 +150,8 @@ class JsonControllerTest extends TestCase
     /**
      * @covers       FireflyIII\Http\Controllers\JsonController::transactionJournals
      * @dataProvider dateRangeProvider
+     *
+     * @param $range
      */
     public function testTransactionJournals($range)
     {

tests/acceptance/Controllers/PiggyBankControllerTest.php

@@ -17,6 +17,8 @@ class PiggyBankControllerTest extends TestCase
      * @covers       FireflyIII\Http\Controllers\PiggyBankController::add
      * @covers       FireflyIII\Http\Controllers\PiggyBankController::__construct
      * @dataProvider dateRangeProvider
+     *
+     * @param $range
      */
     public function testAdd($range)
     {
@@ -71,6 +73,8 @@ class PiggyBankControllerTest extends TestCase
     /**
      * @covers       FireflyIII\Http\Controllers\PiggyBankController::index
      * @dataProvider dateRangeProvider
+     *
+     * @param $range
      */
     public function testIndex($range)
     {
@@ -138,6 +142,8 @@ class PiggyBankControllerTest extends TestCase
     /**
      * @covers       FireflyIII\Http\Controllers\PiggyBankController::show
      * @dataProvider dateRangeProvider
+     *
+     * @param $range
      */
     public function testShow($range)
     {

tests/acceptance/Controllers/PreferencesControllerTest.php

@@ -28,6 +28,8 @@ class PreferencesControllerTest extends TestCase
     /**
      * @covers       FireflyIII\Http\Controllers\PreferencesController::postIndex
      * @dataProvider dateRangeProvider
+     *
+     * @param $range
      */
     public function testPostIndex($range)
     {

tests/acceptance/Controllers/ReportControllerTest.php

@@ -21,6 +21,8 @@ class ReportControllerTest extends TestCase
     /**
      * @covers       FireflyIII\Http\Controllers\ReportController::index
      * @dataProvider dateRangeProvider
+     *
+     * @param $range
      */
     public function testIndex($range)
     {
@@ -36,6 +38,8 @@ class ReportControllerTest extends TestCase
      * @covers       FireflyIII\Http\Controllers\ReportController::report
      * @covers       FireflyIII\Http\Controllers\ReportController::defaultMonth
      * @dataProvider dateRangeProvider
+     *
+     * @param $range
      */
     public function testReportDefaultMonth($range)
     {
@@ -57,6 +61,8 @@ class ReportControllerTest extends TestCase
      * @covers       FireflyIII\Http\Controllers\ReportController::report
      * @covers       FireflyIII\Http\Controllers\ReportController::defaultYear
      * @dataProvider dateRangeProvider
+     *
+     * @param $range
      */
     public function testReportDefaultYear($range)
     {
@@ -70,6 +76,8 @@ class ReportControllerTest extends TestCase
      * @covers       FireflyIII\Http\Controllers\ReportController::report
      * @covers       FireflyIII\Http\Controllers\ReportController::defaultMultiYear
      * @dataProvider dateRangeProvider
+     *
+     * @param $range
      */
     public function testReportDefaultMultiYear($range)
     {

tests/acceptance/Controllers/TransactionControllerTest.php

@@ -61,6 +61,8 @@ class TransactionControllerTest extends TestCase
     /**
      * @covers       FireflyIII\Http\Controllers\TransactionController::index
      * @dataProvider dateRangeProvider
+     *
+     * @param $range
      */
     public function testIndex($range)
     {
@@ -87,6 +89,8 @@ class TransactionControllerTest extends TestCase
     /**
      * @covers       FireflyIII\Http\Controllers\TransactionController::show
      * @dataProvider dateRangeProvider
+     *
+     * @param $range
      */
     public function testShow($range)
     {