kenmirrors/firefly-iii
1
0
Fork 0
mirror of https://github.com/firefly-iii/firefly-iii.git synced 2025-10-31 02:36:28 +00:00
Code Issues Projects Releases Wiki Activity

Add annotated methods.

Browse Source
This commit is contained in:
James Cole
2018-07-15 10:00:08 +02:00
parent 7b41c5b301
commit ac8776aea4
13 changed files with 63 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
app/Support/Facades/Amount.php
View File

@@ -24,13 +24,20 @@ namespace FireflyIII\Support\Facades;
use FireflyIII\Models\TransactionCurrency;
use FireflyIII\User;
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\Facade;
/**
* @codeCoverageIgnore
* Class Amount.
*
* @method string formatAnything(TransactionCurrency $format, string $amount, bool $coloured = true)
* @method Collection getAllCurrencies()
* @method string getCurrencyCode()
* @method string getCurrencySymbol()
* @method TransactionCurrency getDefaultCurrency()
* @method TransactionCurrency getDefaultCurrencyByUser(User $user)
* @method array getJsConfig(array $config)
*/
class Amount extends Facade
{

4
app/Support/Facades/ExpandedForm.php
View File

@@ -22,11 +22,15 @@ declare(strict_types=1);
namespace FireflyIII\Support\Facades;
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\Facade;
/**
* @codeCoverageIgnore
* Class ExpandedForm.
*
* @method array makeSelectList(Collection $set)
* @method array makeSelectListWithEmpty(Collection $set)
*/
class ExpandedForm extends Facade
{

18
app/Support/Facades/Navigation.php
View File

@@ -22,14 +22,28 @@ declare(strict_types=1);
namespace FireflyIII\Support\Facades;
use Carbon\Carbon;
use Illuminate\Support\Facades\Facade;
/**
* @codeCoverageIgnore
* Class Navigation.
*
* @method array blockPeriods(\Carbon\Carbon $start, \Carbon\Carbon $end, string $range)
* @method string periodShow(\Carbon\Carbon $theDate, string $repeatFrequency)
* @method Carbon addPeriod(Carbon $theDate, string $repeatFreq, int $skip)
* @method array blockPeriods(Carbon $start, Carbon $end, string $range)
* @method Carbon endOfPeriod(Carbon $end, string $repeatFreq)
* @method Carbon endOfX(Carbon $theCurrentEnd, string $repeatFreq, Carbon $maxDate = null)
* @method array listOfPeriods(Carbon $start, Carbon $end)
* @method string periodShow(Carbon $theDate, string $repeatFrequency)
* @method string preferredCarbonFormat(Carbon $start, Carbon $end)
* @method string preferredCarbonLocalizedFormat(Carbon $start, Carbon $end)
* @method string preferredEndOfPeriod(Carbon $start, Carbon $end)
* @method string preferredRangeFormat(Carbon $start, Carbon $end)
* @method string preferredSqlFormat(Carbon $start, Carbon $end)
* @method Carbon startOfPeriod(Carbon $theDate, string $repeatFreq)
* @method Carbon subtractPeriod(Carbon $theDate, string $repeatFreq, int $subtract = 1)
* @method Carbon updateEndDate(string $range, Carbon $start)
* @method Carbon updateStartDate(string $range, Carbon $start)
*/
class Navigation extends Facade
{

9
app/Support/Facades/Preferences.php
View File

@@ -24,16 +24,23 @@ namespace FireflyIII\Support\Facades;
use FireflyIII\Models\Preference;
use FireflyIII\User;
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\Facade;
/**
* @codeCoverageIgnore
* Class Preferences.
*
* @method Preference set(string $name, $value)
* @method Collection beginsWith(User $user, string $search)
* @method bool delete(string $name)
* @method Collection findByName(string $name)
* @method Preference get(string $name, $value)
* @method array getArrayForUser(User $user, array $list)
* @method Preference|null getForUser(User $user, string $name, $default = null)
* @method string lastActivity()
* @method void mark()
* @method Preference set(string $name, $value)
* @method Preference setForUser(User $user, string $name, $value)
*/
class Preferences extends Facade
{

14
app/Support/Facades/Steam.php
View File

@@ -22,12 +22,26 @@ declare(strict_types=1);
namespace FireflyIII\Support\Facades;
use Carbon\Carbon;
use FireflyIII\Models\Account;
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\Facade;
/**
* @codeCoverageIgnore
* Class Steam.
* @method string balance(Account $account, Carbon $date)
* @method string balanceIgnoreVirtual(Account $account, Carbon $date)
* @method array balanceInRange(Account $account, Carbon $start, Carbon $end)
* @method array balancesByAccounts(Collection $accounts, Carbon $date)
* @method decrypt(int $isEncrypted, string $value)
* @method array getLastActivities(array $accounts)
* @method string negative(string $amount)
* @method string|null opposite(string $amount = null)
* @method int phpBytes(string $string)
* @method tryDecrypt($value)
* @method string positive(string $amount)
*
*/
class Steam extends Facade
{