Chore: Add phpdocs

This commit is contained in:
James Cole
2023-07-04 13:29:19 +02:00
parent 7840e37e1a
commit 775504acb6
121 changed files with 471 additions and 84 deletions

View File

@@ -399,7 +399,13 @@ trait AccountServiceTrait
* Create the opposing "credit liability" transaction for credit liabilities.
*
*
* @param Account $account
* @param string $direction
* @param string $openingBalance
* @param Carbon $openingBalanceDate
* @return TransactionGroup
* @throws FireflyException
* @throws JsonException
*/
protected function updateCreditTransaction(Account $account, string $direction, string $openingBalance, Carbon $openingBalanceDate): TransactionGroup
{
@@ -606,11 +612,12 @@ trait AccountServiceTrait
* Since opening balance and date can still be empty strings, it may fail.
*
* @param Account $account
* @param string $openingBalance
* @param Carbon $openingBalanceDate
* @param string $openingBalance
* @param Carbon $openingBalanceDate
*
* @return TransactionGroup
* @throws FireflyException
* @throws JsonException
*/
protected function updateOBGroupV2(Account $account, string $openingBalance, Carbon $openingBalanceDate): TransactionGroup
{

View File

@@ -34,6 +34,9 @@ use FireflyIII\Models\TransactionType;
use FireflyIII\Repositories\Account\AccountRepositoryInterface;
use Illuminate\Support\Facades\Log;
/**
* Class CreditRecalculateService
*/
class CreditRecalculateService
{
private ?Account $account;
@@ -203,11 +206,10 @@ class CreditRecalculateService
}
/**
* @param Account $account
* @param string $direction
* @param Account $account
* @param string $direction
* @param Transaction $transaction
* @param string $amount
*
* @param string $leftOfDebt
* @return string
*/
private function processTransaction(Account $account, string $direction, Transaction $transaction, string $leftOfDebt): string

View File

@@ -241,6 +241,10 @@ class AccountUpdateService
return $account;
}
/**
* @param array $array
* @return array
*/
private function getTypeIds(array $array): array
{
$return = [];

View File

@@ -42,11 +42,12 @@ class GroupUpdateService
* Update a transaction group.
*
* @param TransactionGroup $transactionGroup
* @param array $data
* @param array $data
*
* @return TransactionGroup
* @throws DuplicateTransactionException
* @throws FireflyException
* @throws JsonException
*/
public function update(TransactionGroup $transactionGroup, array $data): TransactionGroup
{

View File

@@ -211,7 +211,9 @@ class RecurrenceUpdateService
* TODO this method is very complex.
*
* @param Recurrence $recurrence
* @param array $transactions
* @param array $transactions
* @throws FireflyException
* @throws \JsonException
*/
private function updateTransactions(Recurrence $recurrence, array $transactions): void
{