Update some phpdocs, courtesy of Psalm.

2025-02-25 18:45:27 -06:00 · 2020-03-25 07:03:23 +01:00 · 2020-03-25 07:03:23 +01:00 · 5445752588
commit 5445752588
parent bcfbdcf3f0
41 changed files with 61 additions and 50 deletions
--- a/app/Console/Commands/Correction/CreateLinkTypes.php
+++ b/app/Console/Commands/Correction/CreateLinkTypes.php
@ -47,7 +47,7 @@ class CreateLinkTypes extends Command
    /**
     * Execute the console command.
     *
-     * @return mixed
+     * @return int
     */
    public function handle(): int
    {
--- a/app/Console/Commands/Correction/DeleteEmptyGroups.php
+++ b/app/Console/Commands/Correction/DeleteEmptyGroups.php
@ -50,7 +50,8 @@ class DeleteEmptyGroups extends Command
     * Execute the console command.
     *
     * @throws Exception;
-     * @return mixed
+     *
+     * @return int
     */
    public function handle(): int
    {
--- a/app/Console/Commands/Correction/EnableCurrencies.php
+++ b/app/Console/Commands/Correction/EnableCurrencies.php
@ -52,7 +52,7 @@ class EnableCurrencies extends Command
    /**
     * Execute the console command.
     *
-     * @return mixed
+     * @return int
     */
    public function handle(): int
    {
--- a/app/Console/Commands/Correction/FixPiggies.php
+++ b/app/Console/Commands/Correction/FixPiggies.php
@ -54,7 +54,7 @@ class FixPiggies extends Command
    /**
     * Execute the console command.
     *
-     * @return mixed
+     * @return int
     */
    public function handle(): int
    {
--- a/app/Console/Commands/Correction/RemoveBills.php
+++ b/app/Console/Commands/Correction/RemoveBills.php
@ -48,7 +48,7 @@ class RemoveBills extends Command
    /**
     * Execute the console command.
     *
-     * @return mixed
+     * @return int
     */
    public function handle(): int
    {
--- a/app/Exceptions/Handler.php
+++ b/app/Exceptions/Handler.php
@ -116,8 +116,8 @@ class Handler extends ExceptionHandler
     * @param Exception $exception
     *
     * @throws Exception
-     * @return mixed|void
     *
+     * @return void
     */
    public function report(Exception $exception)
    {
--- a/app/Http/Controllers/Account/DeleteController.php
+++ b/app/Http/Controllers/Account/DeleteController.php
@ -71,7 +71,7 @@ class DeleteController extends Controller
     *
     * @param Account $account
     *
-     * @return Factory|View
+     * @return Factory|RedirectResponse|Redirector|View
     */
    public function delete(Account $account)
    {
--- a/app/Http/Controllers/Account/EditController.php
+++ b/app/Http/Controllers/Account/EditController.php
@ -81,8 +81,7 @@ class EditController extends Controller
     * @param Account                    $account
     * @param AccountRepositoryInterface $repository
     *
-     * @return Factory|View
-     *
+     * @return Factory|RedirectResponse|Redirector|View
     */
    public function edit(Request $request, Account $account, AccountRepositoryInterface $repository)
    {
--- a/app/Http/Controllers/Account/ReconcileController.php
+++ b/app/Http/Controllers/Account/ReconcileController.php
@ -216,7 +216,8 @@ class ReconcileController extends Controller
     * @param string  $difference
     *
     * @throws DuplicateTransactionException
-     * @return string
+     *
+     * @return RedirectResponse|Redirector|string
     */
    private function createReconciliation(Account $account, Carbon $start, Carbon $end, string $difference)
    {
--- a/app/Http/Controllers/Account/ShowController.php
+++ b/app/Http/Controllers/Account/ShowController.php
@ -86,7 +86,8 @@ class ShowController extends Controller
     * @param Carbon|null $end
     *
     * @throws Exception
-     * @return RedirectResponse|Redirector|View
+     *
+     * @return RedirectResponse|Redirector|\Illuminate\Contracts\View\Factory|\Illuminate\View\View
     */
    public function show(Request $request, Account $account, Carbon $start = null, Carbon $end = null)
    {
@ -158,7 +159,8 @@ class ShowController extends Controller
     * @param Account $account
     *
     * @throws Exception
-     * @return RedirectResponse|Redirector|View
+     *
+     * @return RedirectResponse|Redirector|\Illuminate\Contracts\View\Factory|\Illuminate\View\View
     */
    public function showAll(Request $request, Account $account)
    {
--- a/app/Http/Controllers/Admin/LinkController.php
+++ b/app/Http/Controllers/Admin/LinkController.php
@ -90,7 +90,7 @@ class LinkController extends Controller
     * @param Request  $request
     * @param LinkType $linkType
     *
-     * @return RedirectResponse|Redirector|View
+     * @return Factory|RedirectResponse|Redirector|\Illuminate\View\View
     */
    public function delete(Request $request, LinkType $linkType)
    {
--- a/app/Http/Controllers/Admin/TelemetryController.php
+++ b/app/Http/Controllers/Admin/TelemetryController.php
@ -55,7 +55,7 @@ class TelemetryController extends Controller
    }

    /**
-     * @return string
+     * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
     */
    public function deleteSubmitted()
    {
@ -67,7 +67,7 @@ class TelemetryController extends Controller
    }

    /**
-     * @return string
+     * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
     */
    public function deleteAll()
    {
--- a/app/Http/Controllers/Auth/ForgotPasswordController.php
+++ b/app/Http/Controllers/Auth/ForgotPasswordController.php
@ -57,10 +57,9 @@ class ForgotPasswordController extends Controller
     * Send a reset link to the given user.
     *
     * @param Request                 $request
-     *
     * @param UserRepositoryInterface $repository
     *
-     * @return RedirectResponse|JsonResponse
+     * @return Factory|RedirectResponse|View
     */
    public function sendResetLinkEmail(Request $request, UserRepositoryInterface $repository)
    {
--- a/app/Http/Controllers/Auth/ResetPasswordController.php
+++ b/app/Http/Controllers/Auth/ResetPasswordController.php
@ -68,7 +68,8 @@ class ResetPasswordController extends Controller
     * @param Request $request
     *
     * @throws \Illuminate\Validation\ValidationException
-     * @return RedirectResponse|JsonResponse
+     *
+     * @return Factory|JsonResponse|RedirectResponse|View
     */
    public function reset(Request $request)
    {
--- a/app/Http/Controllers/CurrencyController.php
+++ b/app/Http/Controllers/CurrencyController.php
@ -75,7 +75,7 @@ class CurrencyController extends Controller
     *
     * @param Request $request
     *
-     * @return RedirectResponse|Redirector|View
+     * @return Factory|RedirectResponse|Redirector|\Illuminate\View\View
     */
    public function create(Request $request)
    {
@ -128,7 +128,7 @@ class CurrencyController extends Controller
     * @param Request             $request
     * @param TransactionCurrency $currency
     *
-     * @return RedirectResponse|Redirector|View
+     * @return Factory|RedirectResponse|Redirector|\Illuminate\View\View
     */
    public function delete(Request $request, TransactionCurrency $currency)
    {
@ -266,7 +266,7 @@ class CurrencyController extends Controller
     * @param Request             $request
     * @param TransactionCurrency $currency
     *
-     * @return RedirectResponse|Redirector|View
+     * @return Factory|RedirectResponse|Redirector|\Illuminate\View\View
     */
    public function edit(Request $request, TransactionCurrency $currency)
    {
--- a/app/Http/Controllers/Import/PrerequisitesController.php
+++ b/app/Http/Controllers/Import/PrerequisitesController.php
@ -73,7 +73,7 @@ class PrerequisitesController extends Controller
     * @param string    $importProvider
     * @param ImportJob $importJob
     *
-     * @return Factory|View
+     * @return Factory|RedirectResponse|Redirector|View
     */
    public function index(string $importProvider, ImportJob $importJob = null)
    {
--- a/app/Http/Controllers/NewUserController.php
+++ b/app/Http/Controllers/NewUserController.php
@ -58,7 +58,7 @@ class NewUserController extends Controller
    /**
     * Form the user gets when he has no data in the system.
     *
-     * @return RedirectResponse|Redirector|View
+     * @return RedirectResponse|Redirector|\Illuminate\Contracts\View\Factory|\Illuminate\View\View
     */
    public function index()
    {
--- a/app/Http/Controllers/ProfileController.php
+++ b/app/Http/Controllers/ProfileController.php
@ -88,7 +88,7 @@ class ProfileController extends Controller
     *
     * @param Request $request
     *
-     * @return Factory|View
+     * @return Factory|RedirectResponse|Redirector|View
     */
    public function changeEmail(Request $request)
    {
@ -114,7 +114,7 @@ class ProfileController extends Controller
     *
     * @param Request $request
     *
-     * @return Factory|View
+     * @return Factory|RedirectResponse|Redirector|View
     */
    public function changePassword(Request $request)
    {
--- a/app/Http/Controllers/System/InstallController.php
+++ b/app/Http/Controllers/System/InstallController.php
@ -115,7 +115,7 @@ class InstallController extends Controller
    /**
     * Show index.
     *
-     * @return RedirectResponse|Redirector
+     * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
     */
    public function index()
    {
--- a/app/Http/Controllers/Transaction/BulkController.php
+++ b/app/Http/Controllers/Transaction/BulkController.php
@ -68,7 +68,7 @@ class BulkController extends Controller
     *
     * TODO user wont be able to tell if journal is part of split.
     *
-     * @param Collection $journals
+     * @param array $journals
     *
     * @return Factory|View
     */
--- a/app/Http/Controllers/Transaction/ConvertController.php
+++ b/app/Http/Controllers/Transaction/ConvertController.php
@ -87,7 +87,8 @@ class ConvertController extends Controller
     * @param TransactionGroup $group
     *
     * @throws Exception
-     * @return RedirectResponse|Redirector|View
+     *
+     * @return RedirectResponse|Redirector|\Illuminate\Contracts\View\Factory|\Illuminate\View\View
     */
    public function index(TransactionType $destinationType, TransactionGroup $group)
    {
--- a/app/Http/Controllers/Transaction/EditController.php
+++ b/app/Http/Controllers/Transaction/EditController.php
@ -63,7 +63,7 @@ class EditController extends Controller
    /**
     * @param TransactionGroup $transactionGroup
     *
-     * @return Factory|View
+     * @return Factory|View|\Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
     */
    public function edit(TransactionGroup $transactionGroup)
    {
--- a/app/Import/Converter/BankDebitCredit.php
+++ b/app/Import/Converter/BankDebitCredit.php
@ -41,8 +41,7 @@ class BankDebitCredit implements ConverterInterface
     *
     * @param $value
     *
-     * @return mixed
-     *
+     * @return int
     */
    public function convert($value): int
    {
--- a/app/Repositories/Currency/CurrencyRepository.php
+++ b/app/Repositories/Currency/CurrencyRepository.php
@ -320,7 +320,7 @@ class CurrencyRepository implements CurrencyRepositoryInterface
     * @param int|null    $currencyId
     * @param string|null $currencyCode
     *
-     * @return TransactionCurrency|null
+     * @return TransactionCurrency
     */
    public function findCurrency(?int $currencyId, ?string $currencyCode): TransactionCurrency
    {
--- a/app/Repositories/Currency/CurrencyRepositoryInterface.php
+++ b/app/Repositories/Currency/CurrencyRepositoryInterface.php
@ -156,7 +156,7 @@ interface CurrencyRepositoryInterface
     * @param int|null    $currencyId
     * @param string|null $currencyCode
     *
-     * @return TransactionCurrency|null
+     * @return TransactionCurrency
     */
    public function findCurrency(?int $currencyId, ?string $currencyCode): TransactionCurrency;

--- a/app/Repositories/Tag/TagRepositoryInterface.php
+++ b/app/Repositories/Tag/TagRepositoryInterface.php
@ -118,7 +118,7 @@ interface TagRepositoryInterface
    /**
     * @param int|null $year
     *
-     * @return Collection
+     * @return array
     */
    public function getTagsInYear(?int $year): array;

--- a/app/Rules/IsTransferAccount.php
+++ b/app/Rules/IsTransferAccount.php
@ -35,7 +35,7 @@ class IsTransferAccount implements Rule
    /**
     * Get the validation error message.
     *
-     * @return string|array
+     * @return string
     */
    public function message(): string
    {
--- a/app/Services/Currency/FixerIOv2.php
+++ b/app/Services/Currency/FixerIOv2.php
@ -128,7 +128,7 @@ class FixerIOv2 implements ExchangeRateInterface
    /**
     * @param User $user
     *
-     * @return mixed|void
+     * @return void
     */
    public function setUser(User $user)
    {
--- a/app/Services/Currency/RatesApiIOv1.php
+++ b/app/Services/Currency/RatesApiIOv1.php
@ -117,7 +117,7 @@ class RatesApiIOv1 implements ExchangeRateInterface
    /**
     * @param User $user
     *
-     * @return mixed|void
+     * @return void
     */
    public function setUser(User $user)
    {
--- a/app/Support/Amount.php
+++ b/app/Support/Amount.php
@ -253,7 +253,7 @@ class Amount
    }

    /**
-     * @param User|Authenticatable $user
+     * @param User $user
     *
     * @return \FireflyIII\Models\TransactionCurrency
     */
--- a/app/Support/Binder/ImportProvider.php
+++ b/app/Support/Binder/ImportProvider.php
@ -96,7 +96,8 @@ class ImportProvider implements BinderInterface
     * @param string $value
     * @param Route  $route
     *
-     * @return Carbon
+     * @return string
+     *
     * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
     */
    public static function routeBinder(string $value, Route $route): string
--- a/app/Support/Binder/JournalList.php
+++ b/app/Support/Binder/JournalList.php
@ -36,7 +36,8 @@ class JournalList implements BinderInterface
     * @param string $value
     * @param Route  $route
     *
-     * @return mixed
+     * @return array
+     *
     * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
     */
    public static function routeBinder(string $value, Route $route): array
--- a/app/Support/CacheProperties.php
+++ b/app/Support/CacheProperties.php
@ -50,6 +50,7 @@ class CacheProperties

    /**
     * @param $property
+     * @param Collection|\Carbon\Carbon|\FireflyIII\Models\Category|array|int|string $property
     */
    public function addProperty($property): void
    {
@ -87,6 +88,7 @@ class CacheProperties

    /**
     * @param $data
+     * @param (array|mixed)[]|Collection|\Carbon\Carbon|string $data
     */
    public function store($data): void
    {
--- a/app/Support/FireflyConfig.php
+++ b/app/Support/FireflyConfig.php
@ -136,7 +136,8 @@ class FireflyConfig

    /**
     * @param string $name
-     * @param        $value
+     * @param $value
+     * @param int|string|true $value
     *
     * @return Configuration
     */
--- a/app/Support/Form/FormSupport.php
+++ b/app/Support/Form/FormSupport.php
@ -159,7 +159,7 @@ trait FormSupport
     * @param $name
     * @param $options
     *
-     * @return mixed
+     * @return string
     */
    protected function label(string $name, array $options = null): string
    {
--- a/app/Support/Http/Controllers/ModelInformation.php
+++ b/app/Support/Http/Controllers/ModelInformation.php
@ -71,7 +71,10 @@ trait ModelInformation

    /**
     * @codeCoverageIgnore 
-     * @return array
+     *
+     * @return string[]
+     *
+     * @psalm-return array<int|null, string>
     */
    protected function getLiabilityTypes(): array
    {
--- a/app/Support/Http/Controllers/TransactionCalculation.php
+++ b/app/Support/Http/Controllers/TransactionCalculation.php
@ -172,7 +172,7 @@ trait TransactionCalculation
     * @param Carbon $start
     * @param Carbon $end
     *
-     * @return Collection
+     * @return array
     */
    protected function getIncomeForTags(Collection $accounts, Collection $tags, Carbon $start, Carbon $end): array
    {
--- a/app/Support/Preferences.php
+++ b/app/Support/Preferences.php
@ -142,7 +142,7 @@ class Preferences
    }

    /**
-     * @param \FireflyIII\User|Authenticatable $user
+     * @param User $user
     * @param string           $name
     * @param null|string      $default
     *
--- a/app/TransactionRules/Engine/RuleEngine.php
+++ b/app/TransactionRules/Engine/RuleEngine.php
@ -206,7 +206,7 @@ class RuleEngine
    }

    /**
-     * @param User|Authenticatable $user
+     * @param User $user
     */
    public function setUser(User $user): void
    {
--- a/app/TransactionRules/Factory/TriggerFactory.php
+++ b/app/TransactionRules/Factory/TriggerFactory.php
@ -115,7 +115,7 @@ class TriggerFactory
     *
     * @param string $triggerType
     *
-     * @return TriggerInterface|string
+     * @return string
     *
     * @throws FireflyException
     */
--- a/app/Validation/AccountValidator.php
+++ b/app/Validation/AccountValidator.php
@ -196,8 +196,8 @@ class AccountValidator

    /**
     * @param array       $validTypes
-     * @param int|null    $accountId
-     * @param string|null $accountName
+     * @param int $accountId
+     * @param string $accountName
     *
     * @return Account|null
     */