kenmirrors/firefly-iii
1
0
Fork 0
mirror of https://github.com/firefly-iii/firefly-iii.git synced 2025-09-20 03:08:11 +00:00
Code Issues Projects Releases Wiki Activity

Update some phpdocs, courtesy of Psalm.

Browse Source
This commit is contained in:
James Cole
2020-03-25 07:03:23 +01:00
parent bcfbdcf3f0
commit 5445752588
41 changed files with 61 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
app/Console/Commands/Correction/CreateLinkTypes.php
View File

@@ -47,7 +47,7 @@ class CreateLinkTypes extends Command
/** /**
* Execute the console command. * Execute the console command.
* *
* @return mixed * @return int
*/ */
public function handle(): int public function handle(): int
{ {

3
app/Console/Commands/Correction/DeleteEmptyGroups.php
View File

@@ -50,7 +50,8 @@ class DeleteEmptyGroups extends Command
* Execute the console command. * Execute the console command.
* *
* @throws Exception; * @throws Exception;
* @return mixed *
* @return int
*/ */
public function handle(): int public function handle(): int
{ {

2
app/Console/Commands/Correction/EnableCurrencies.php
View File

@@ -52,7 +52,7 @@ class EnableCurrencies extends Command
/** /**
* Execute the console command. * Execute the console command.
* *
* @return mixed * @return int
*/ */
public function handle(): int public function handle(): int
{ {

2
app/Console/Commands/Correction/FixPiggies.php
View File

@@ -54,7 +54,7 @@ class FixPiggies extends Command
/** /**
* Execute the console command. * Execute the console command.
* *
* @return mixed * @return int
*/ */
public function handle(): int public function handle(): int
{ {

2
app/Console/Commands/Correction/RemoveBills.php
View File

@@ -48,7 +48,7 @@ class RemoveBills extends Command
/** /**
* Execute the console command. * Execute the console command.
* *
* @return mixed * @return int
*/ */
public function handle(): int public function handle(): int
{ {

2
app/Exceptions/Handler.php
View File

@@ -116,8 +116,8 @@ class Handler extends ExceptionHandler
* @param Exception $exception * @param Exception $exception
* *
* @throws Exception * @throws Exception
* @return mixed|void
* *
* @return void
*/ */
public function report(Exception $exception) public function report(Exception $exception)
{ {

2
app/Http/Controllers/Account/DeleteController.php
View File

@@ -71,7 +71,7 @@ class DeleteController extends Controller
* *
* @param Account $account * @param Account $account
* *
* @return Factory|View * @return Factory|RedirectResponse|Redirector|View
*/ */
public function delete(Account $account) public function delete(Account $account)
{ {

3
app/Http/Controllers/Account/EditController.php
View File

@@ -81,8 +81,7 @@ class EditController extends Controller
* @param Account $account * @param Account $account
* @param AccountRepositoryInterface $repository * @param AccountRepositoryInterface $repository
* *
* @return Factory|View * @return Factory|RedirectResponse|Redirector|View
*
*/ */
public function edit(Request $request, Account $account, AccountRepositoryInterface $repository) public function edit(Request $request, Account $account, AccountRepositoryInterface $repository)
{ {

3
app/Http/Controllers/Account/ReconcileController.php
View File

@@ -216,7 +216,8 @@ class ReconcileController extends Controller
* @param string $difference * @param string $difference
* *
* @throws DuplicateTransactionException * @throws DuplicateTransactionException
* @return string *
* @return RedirectResponse|Redirector|string
*/ */
private function createReconciliation(Account $account, Carbon $start, Carbon $end, string $difference) private function createReconciliation(Account $account, Carbon $start, Carbon $end, string $difference)
{ {

6
app/Http/Controllers/Account/ShowController.php
View File

@@ -86,7 +86,8 @@ class ShowController extends Controller
* @param Carbon|null $end * @param Carbon|null $end
* *
* @throws Exception * @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) public function show(Request $request, Account $account, Carbon $start = null, Carbon $end = null)
{ {
@@ -158,7 +159,8 @@ class ShowController extends Controller
* @param Account $account * @param Account $account
* *
* @throws Exception * @throws Exception
* @return RedirectResponse|Redirector|View *
* @return RedirectResponse|Redirector|\Illuminate\Contracts\View\Factory|\Illuminate\View\View
*/ */
public function showAll(Request $request, Account $account) public function showAll(Request $request, Account $account)
{ {

2
app/Http/Controllers/Admin/LinkController.php
View File

@@ -90,7 +90,7 @@ class LinkController extends Controller
* @param Request $request * @param Request $request
* @param LinkType $linkType * @param LinkType $linkType
* *
* @return RedirectResponse|Redirector|View * @return Factory|RedirectResponse|Redirector|\Illuminate\View\View
*/ */
public function delete(Request $request, LinkType $linkType) public function delete(Request $request, LinkType $linkType)
{ {

4
app/Http/Controllers/Admin/TelemetryController.php
View File

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

3
app/Http/Controllers/Auth/ForgotPasswordController.php
View File

@@ -57,10 +57,9 @@ class ForgotPasswordController extends Controller
* Send a reset link to the given user. * Send a reset link to the given user.
* *
* @param Request $request * @param Request $request
*
* @param UserRepositoryInterface $repository * @param UserRepositoryInterface $repository
* *
* @return RedirectResponse|JsonResponse * @return Factory|RedirectResponse|View
*/ */
public function sendResetLinkEmail(Request $request, UserRepositoryInterface $repository) public function sendResetLinkEmail(Request $request, UserRepositoryInterface $repository)
{ {

3
app/Http/Controllers/Auth/ResetPasswordController.php
View File

@@ -68,7 +68,8 @@ class ResetPasswordController extends Controller
* @param Request $request * @param Request $request
* *
* @throws \Illuminate\Validation\ValidationException * @throws \Illuminate\Validation\ValidationException
* @return RedirectResponse|JsonResponse *
* @return Factory|JsonResponse|RedirectResponse|View
*/ */
public function reset(Request $request) public function reset(Request $request)
{ {

6
app/Http/Controllers/CurrencyController.php
View File

@@ -75,7 +75,7 @@ class CurrencyController extends Controller
* *
* @param Request $request * @param Request $request
* *
* @return RedirectResponse|Redirector|View * @return Factory|RedirectResponse|Redirector|\Illuminate\View\View
*/ */
public function create(Request $request) public function create(Request $request)
{ {
@@ -128,7 +128,7 @@ class CurrencyController extends Controller
* @param Request $request * @param Request $request
* @param TransactionCurrency $currency * @param TransactionCurrency $currency
* *
* @return RedirectResponse|Redirector|View * @return Factory|RedirectResponse|Redirector|\Illuminate\View\View
*/ */
public function delete(Request $request, TransactionCurrency $currency) public function delete(Request $request, TransactionCurrency $currency)
{ {
@@ -266,7 +266,7 @@ class CurrencyController extends Controller
* @param Request $request * @param Request $request
* @param TransactionCurrency $currency * @param TransactionCurrency $currency
* *
* @return RedirectResponse|Redirector|View * @return Factory|RedirectResponse|Redirector|\Illuminate\View\View
*/ */
public function edit(Request $request, TransactionCurrency $currency) public function edit(Request $request, TransactionCurrency $currency)
{ {

2
app/Http/Controllers/Import/PrerequisitesController.php
View File

@@ -73,7 +73,7 @@ class PrerequisitesController extends Controller
* @param string $importProvider * @param string $importProvider
* @param ImportJob $importJob * @param ImportJob $importJob
* *
* @return Factory|View * @return Factory|RedirectResponse|Redirector|View
*/ */
public function index(string $importProvider, ImportJob $importJob = null) public function index(string $importProvider, ImportJob $importJob = null)
{ {

2
app/Http/Controllers/NewUserController.php
View File

@@ -58,7 +58,7 @@ class NewUserController extends Controller
/** /**
* Form the user gets when he has no data in the system. * 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() public function index()
{ {

4
app/Http/Controllers/ProfileController.php
View File

@@ -88,7 +88,7 @@ class ProfileController extends Controller
* *
* @param Request $request * @param Request $request
* *
* @return Factory|View * @return Factory|RedirectResponse|Redirector|View
*/ */
public function changeEmail(Request $request) public function changeEmail(Request $request)
{ {
@@ -114,7 +114,7 @@ class ProfileController extends Controller
* *
* @param Request $request * @param Request $request
* *
* @return Factory|View * @return Factory|RedirectResponse|Redirector|View
*/ */
public function changePassword(Request $request) public function changePassword(Request $request)
{ {

2
app/Http/Controllers/System/InstallController.php
View File

@@ -115,7 +115,7 @@ class InstallController extends Controller
/** /**
* Show index. * Show index.
* *
* @return RedirectResponse|Redirector * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
*/ */
public function index() public function index()
{ {

2
app/Http/Controllers/Transaction/BulkController.php
View File

@@ -68,7 +68,7 @@ class BulkController extends Controller
* *
* TODO user wont be able to tell if journal is part of split. * TODO user wont be able to tell if journal is part of split.
* *
* @param Collection $journals * @param array $journals
* *
* @return Factory|View * @return Factory|View
*/ */

3
app/Http/Controllers/Transaction/ConvertController.php
View File

@@ -87,7 +87,8 @@ class ConvertController extends Controller
* @param TransactionGroup $group * @param TransactionGroup $group
* *
* @throws Exception * @throws Exception
* @return RedirectResponse|Redirector|View *
* @return RedirectResponse|Redirector|\Illuminate\Contracts\View\Factory|\Illuminate\View\View
*/ */
public function index(TransactionType $destinationType, TransactionGroup $group) public function index(TransactionType $destinationType, TransactionGroup $group)
{ {

2
app/Http/Controllers/Transaction/EditController.php
View File

@@ -63,7 +63,7 @@ class EditController extends Controller
/** /**
* @param TransactionGroup $transactionGroup * @param TransactionGroup $transactionGroup
* *
* @return Factory|View * @return Factory|View|\Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
*/ */
public function edit(TransactionGroup $transactionGroup) public function edit(TransactionGroup $transactionGroup)
{ {

3
app/Import/Converter/BankDebitCredit.php
View File

@@ -41,8 +41,7 @@ class BankDebitCredit implements ConverterInterface
* *
* @param $value * @param $value
* *
* @return mixed * @return int
*
*/ */
public function convert($value): int public function convert($value): int
{ {

2
app/Repositories/Currency/CurrencyRepository.php
View File

@@ -320,7 +320,7 @@ class CurrencyRepository implements CurrencyRepositoryInterface
* @param int|null $currencyId * @param int|null $currencyId
* @param string|null $currencyCode * @param string|null $currencyCode
* *
* @return TransactionCurrency|null * @return TransactionCurrency
*/ */
public function findCurrency(?int $currencyId, ?string $currencyCode): TransactionCurrency public function findCurrency(?int $currencyId, ?string $currencyCode): TransactionCurrency
{ {

2
app/Repositories/Currency/CurrencyRepositoryInterface.php
View File

@@ -156,7 +156,7 @@ interface CurrencyRepositoryInterface
* @param int|null $currencyId * @param int|null $currencyId
* @param string|null $currencyCode * @param string|null $currencyCode
* *
* @return TransactionCurrency|null * @return TransactionCurrency
*/ */
public function findCurrency(?int $currencyId, ?string $currencyCode): TransactionCurrency; public function findCurrency(?int $currencyId, ?string $currencyCode): TransactionCurrency;

2
app/Repositories/Tag/TagRepositoryInterface.php
View File

@@ -118,7 +118,7 @@ interface TagRepositoryInterface
/** /**
* @param int|null $year * @param int|null $year
* *
* @return Collection * @return array
*/ */
public function getTagsInYear(?int $year): array; public function getTagsInYear(?int $year): array;

2
app/Rules/IsTransferAccount.php
View File

@@ -35,7 +35,7 @@ class IsTransferAccount implements Rule
/** /**
* Get the validation error message. * Get the validation error message.
* *
* @return string|array * @return string
*/ */
public function message(): string public function message(): string
{ {

2
app/Services/Currency/FixerIOv2.php
View File

@@ -128,7 +128,7 @@ class FixerIOv2 implements ExchangeRateInterface
/** /**
* @param User $user * @param User $user
* *
* @return mixed|void * @return void
*/ */
public function setUser(User $user) public function setUser(User $user)
{ {

2
app/Services/Currency/RatesApiIOv1.php
View File

@@ -117,7 +117,7 @@ class RatesApiIOv1 implements ExchangeRateInterface
/** /**
* @param User $user * @param User $user
* *
* @return mixed|void * @return void
*/ */
public function setUser(User $user) public function setUser(User $user)
{ {

2
app/Support/Amount.php
View File

@@ -253,7 +253,7 @@ class Amount
} }
/** /**
* @param User|Authenticatable $user * @param User $user
* *
* @return \FireflyIII\Models\TransactionCurrency * @return \FireflyIII\Models\TransactionCurrency
*/ */

3
app/Support/Binder/ImportProvider.php
View File

@@ -96,7 +96,8 @@ class ImportProvider implements BinderInterface
* @param string $value * @param string $value
* @param Route $route * @param Route $route
* *
* @return Carbon * @return string
*
* @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
*/ */
public static function routeBinder(string $value, Route $route): string public static function routeBinder(string $value, Route $route): string

3
app/Support/Binder/JournalList.php
View File

@@ -36,7 +36,8 @@ class JournalList implements BinderInterface
* @param string $value * @param string $value
* @param Route $route * @param Route $route
* *
* @return mixed * @return array
*
* @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
*/ */
public static function routeBinder(string $value, Route $route): array public static function routeBinder(string $value, Route $route): array

2
app/Support/CacheProperties.php
View File

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

1
app/Support/FireflyConfig.php
View File

@@ -137,6 +137,7 @@ class FireflyConfig
/** /**
* @param string $name * @param string $name
* @param $value * @param $value
* @param int|string|true $value
* *
* @return Configuration * @return Configuration
*/ */

2
app/Support/Form/FormSupport.php
View File

@@ -159,7 +159,7 @@ trait FormSupport
* @param $name * @param $name
* @param $options * @param $options
* *
* @return mixed * @return string
*/ */
protected function label(string $name, array $options = null): string protected function label(string $name, array $options = null): string
{ {

5
app/Support/Http/Controllers/ModelInformation.php
View File

@@ -71,7 +71,10 @@ trait ModelInformation
/** /**
* @codeCoverageIgnore * @codeCoverageIgnore
* @return array *
* @return string[]
*
* @psalm-return array<int|null, string>
*/ */
protected function getLiabilityTypes(): array protected function getLiabilityTypes(): array
{ {

2
app/Support/Http/Controllers/TransactionCalculation.php
View File

@@ -172,7 +172,7 @@ trait TransactionCalculation
* @param Carbon $start * @param Carbon $start
* @param Carbon $end * @param Carbon $end
* *
* @return Collection * @return array
*/ */
protected function getIncomeForTags(Collection $accounts, Collection $tags, Carbon $start, Carbon $end): array protected function getIncomeForTags(Collection $accounts, Collection $tags, Carbon $start, Carbon $end): array
{ {

2
app/Support/Preferences.php
View File

@@ -142,7 +142,7 @@ class Preferences
} }
/** /**
* @param \FireflyIII\User|Authenticatable $user * @param User $user
* @param string $name * @param string $name
* @param null|string $default * @param null|string $default
* *

2
app/TransactionRules/Engine/RuleEngine.php
View File

@@ -206,7 +206,7 @@ class RuleEngine
} }
/** /**
* @param User|Authenticatable $user * @param User $user
*/ */
public function setUser(User $user): void public function setUser(User $user): void
{ {

2
app/TransactionRules/Factory/TriggerFactory.php
View File

@@ -115,7 +115,7 @@ class TriggerFactory
* *
* @param string $triggerType * @param string $triggerType
* *
* @return TriggerInterface|string * @return string
* *
* @throws FireflyException * @throws FireflyException
*/ */

4
app/Validation/AccountValidator.php
View File

@@ -196,8 +196,8 @@ class AccountValidator
/** /**
* @param array $validTypes * @param array $validTypes
* @param int|null $accountId * @param int $accountId
* @param string|null $accountName * @param string $accountName
* *
* @return Account|null * @return Account|null
*/ */