kenmirrors/firefly-iii
1
0
Fork 0
mirror of https://github.com/firefly-iii/firefly-iii.git synced 2025-11-16 14:48:11 +00:00
Code Issues Projects Releases Wiki Activity

Various PSR12 code cleanup

Browse Source
This commit is contained in:
James Cole
2022-12-29 19:42:26 +01:00
parent dbf3e76ecc
commit 6cfdc58cb1
415 changed files with 7462 additions and 6874 deletions
Download Patch File Download Diff File Expand all files Collapse all files

145
app/Repositories/Bill/BillRepositoryInterface.php
View File

@@ -1,4 +1,5 @@
<?php
/**
* BillRepositoryInterface.php
* Copyright (c) 2019 james@firefly-iii.org
@@ -35,34 +36,16 @@ use Illuminate\Support\Collection;
interface BillRepositoryInterface
{
/**
* @param string $query
* @param int $limit
* @param string $query
* @param int $limit
*
* @return Collection
*/
public function billEndsWith(string $query, int $limit): Collection;
/**
* Collect multi-currency of sum of bills yet to pay.
*
* @param Carbon $start
* @param Carbon $end
* @return array
*/
public function sumUnpaidInRange(Carbon $start, Carbon $end): array;
/**
* Collect multi-currency of sum of bills already paid.
*
* @param Carbon $start
* @param Carbon $end
* @return array
*/
public function sumPaidInRange(Carbon $start, Carbon $end): array;
/**
* @param string $query
* @param int $limit
* @param string $query
* @param int $limit
*
* @return Collection
*/
@@ -71,10 +54,10 @@ interface BillRepositoryInterface
/**
* Get the total amount of money due for the users active bills in the date range given.
*
* @param Carbon $start
* @param Carbon $end
* @deprecated
* @param Carbon $start
* @param Carbon $end
* @return Collection
* @deprecated
*/
public function collectBillsUnpaidInRange(Carbon $start, Carbon $end): Collection;
@@ -84,7 +67,7 @@ interface BillRepositoryInterface
public function correctOrder(): void;
/**
* @param Bill $bill
* @param Bill $bill
*
* @return bool
*/
@@ -98,7 +81,7 @@ interface BillRepositoryInterface
/**
* Find a bill by ID.
*
* @param int $billId
* @param int $billId
*
* @return Bill|null
*/
@@ -107,8 +90,8 @@ interface BillRepositoryInterface
/**
* Find bill by parameters.
*
* @param int|null $billId
* @param string|null $billName
* @param int|null $billId
* @param string|null $billName
*
* @return Bill|null
*/
@@ -117,7 +100,7 @@ interface BillRepositoryInterface
/**
* Find a bill by name.
*
* @param string $name
* @param string $name
*
* @return Bill|null
*/
@@ -131,7 +114,7 @@ interface BillRepositoryInterface
/**
* Get all attachments.
*
* @param Bill $bill
* @param Bill $bill
*
* @return Collection
*/
@@ -145,7 +128,7 @@ interface BillRepositoryInterface
/**
* Gets the bills which have some kind of relevance to the accounts mentioned.
*
* @param Collection $accounts
* @param Collection $accounts
*
* @return Collection
*/
@@ -153,8 +136,8 @@ interface BillRepositoryInterface
/**
* Get the total amount of money paid for the users active bills in the date range given.
* @param Carbon $start
* @param Carbon $end
* @param Carbon $start
* @param Carbon $end
*
* @return string
* @deprecated
@@ -164,8 +147,8 @@ interface BillRepositoryInterface
/**
* Get the total amount of money paid for the users active bills in the date range given,
* grouped per currency.
* @param Carbon $start
* @param Carbon $end
* @param Carbon $start
* @param Carbon $end
*
* @return array
* @deprecated
@@ -174,8 +157,8 @@ interface BillRepositoryInterface
/**
* Get the total amount of money due for the users active bills in the date range given.
* @param Carbon $start
* @param Carbon $end
* @param Carbon $start
* @param Carbon $end
*
* @return string
* @deprecated
@@ -184,8 +167,8 @@ interface BillRepositoryInterface
/**
* Get the total amount of money due for the users active bills in the date range given.
* @param Carbon $start
* @param Carbon $end
* @param Carbon $start
* @param Carbon $end
*
* @return array
* @deprecated
@@ -195,7 +178,7 @@ interface BillRepositoryInterface
/**
* Get all bills with these ID's.
*
* @param array $billIds
* @param array $billIds
*
* @return Collection
*/
@@ -204,30 +187,30 @@ interface BillRepositoryInterface
/**
* Get text or return empty string.
*
* @param Bill $bill
* @param Bill $bill
*
* @return string
*/
public function getNoteText(Bill $bill): string;
/**
* @param Bill $bill
* @param Bill $bill
*
* @return array
*/
public function getOverallAverage(Bill $bill): array;
/**
* @param int $size
* @param int $size
*
* @return LengthAwarePaginator
*/
public function getPaginator(int $size): LengthAwarePaginator;
/**
* @param Bill $bill
* @param Carbon $start
* @param Carbon $end
* @param Bill $bill
* @param Carbon $start
* @param Carbon $end
*
* @return Collection
*/
@@ -236,9 +219,9 @@ interface BillRepositoryInterface
/**
* Between start and end, tells you on which date(s) the bill is expected to hit.
*
* @param Bill $bill
* @param Carbon $start
* @param Carbon $end
* @param Bill $bill
* @param Carbon $start
* @param Carbon $end
*
* @return Collection
*/
@@ -247,7 +230,7 @@ interface BillRepositoryInterface
/**
* Return all rules for one bill
*
* @param Bill $bill
* @param Bill $bill
*
* @return Collection
*/
@@ -259,15 +242,15 @@ interface BillRepositoryInterface
*
* 5 => [['id' => 1, 'title' => 'Some rule'],['id' => 2, 'title' => 'Some other rule']]
*
* @param Collection $collection
* @param Collection $collection
*
* @return array
*/
public function getRulesForBills(Collection $collection): array;
/**
* @param Bill $bill
* @param Carbon $date
* @param Bill $bill
* @param Carbon $date
*
* @return array
*/
@@ -276,8 +259,8 @@ interface BillRepositoryInterface
/**
* Link a set of journals to a bill.
*
* @param Bill $bill
* @param array $transactions
* @param Bill $bill
* @param array $transactions
*/
public function linkCollectionToBill(Bill $bill, array $transactions): void;
@@ -285,39 +268,39 @@ interface BillRepositoryInterface
* Given a bill and a date, this method will tell you at which moment this bill expects its next
* transaction. Whether or not it is there already, is not relevant.
*
* @param Bill $bill
* @param Carbon $date
* @param Bill $bill
* @param Carbon $date
*
* @return Carbon
*/
public function nextDateMatch(Bill $bill, Carbon $date): Carbon;
/**
* @param Bill $bill
* @param Carbon $date
* @param Bill $bill
* @param Carbon $date
*
* @return Carbon
*/
public function nextExpectedMatch(Bill $bill, Carbon $date): Carbon;
/**
* @param Bill $bill
* @param Bill $bill
*
* @return Bill
*/
public function removeObjectGroup(Bill $bill): Bill;
/**
* @param string $query
* @param int $limit
* @param string $query
* @param int $limit
*
* @return Collection
*/
public function searchBill(string $query, int $limit): Collection;
/**
* @param Bill $bill
* @param string $objectGroupTitle
* @param Bill $bill
* @param string $objectGroupTitle
*
* @return Bill
*/
@@ -326,18 +309,18 @@ interface BillRepositoryInterface
/**
* Set specific piggy bank to specific order.
*
* @param Bill $bill
* @param int $order
* @param Bill $bill
* @param int $order
*/
public function setOrder(Bill $bill, int $order): void;
/**
* @param User $user
* @param User $user
*/
public function setUser(User $user);
/**
* @param array $data
* @param array $data
*
* @return Bill
* @throws FireflyException
@@ -345,13 +328,31 @@ interface BillRepositoryInterface
public function store(array $data): Bill;
/**
* @param Bill $bill
* Collect multi-currency of sum of bills already paid.
*
* @param Carbon $start
* @param Carbon $end
* @return array
*/
public function sumPaidInRange(Carbon $start, Carbon $end): array;
/**
* Collect multi-currency of sum of bills yet to pay.
*
* @param Carbon $start
* @param Carbon $end
* @return array
*/
public function sumUnpaidInRange(Carbon $start, Carbon $end): array;
/**
* @param Bill $bill
*/
public function unlinkAll(Bill $bill): void;
/**
* @param Bill $bill
* @param array $data
* @param Bill $bill
* @param array $data
*
* @return Bill
*/