diff --git a/app/models/Account.php b/app/models/Account.php index 9e71a5444d..46e8fdc04d 100644 --- a/app/models/Account.php +++ b/app/models/Account.php @@ -144,6 +144,7 @@ class Account extends Ardent } /** + * TODO see if this scope is still used. * @param Builder $query * @param array $types */ diff --git a/app/models/AccountType.php b/app/models/AccountType.php index 1a3f910687..711d494c39 100644 --- a/app/models/AccountType.php +++ b/app/models/AccountType.php @@ -6,11 +6,11 @@ use Illuminate\Database\Eloquent\Model as Eloquent; /** * AccountType * - * @property integer $id - * @property \Carbon\Carbon $created_at - * @property \Carbon\Carbon $updated_at - * @property string $type - * @property boolean $editable + * @property integer $id + * @property \Carbon\Carbon $created_at + * @property \Carbon\Carbon $updated_at + * @property string $type + * @property boolean $editable * @property-read \Illuminate\Database\Eloquent\Collection|\Account[] $accounts * @method static \Illuminate\Database\Query\Builder|\AccountType whereId($value) * @method static \Illuminate\Database\Query\Builder|\AccountType whereCreatedAt($value) @@ -21,7 +21,9 @@ use Illuminate\Database\Eloquent\Model as Eloquent; class AccountType extends Eloquent { public static $rules - = ['type' => ['required', 'between:1,50', 'alphabasic'], 'editable' => 'required|boolean', + = [ + 'type' => ['required', 'between:1,50', 'alphabasic'], + 'editable' => 'required|boolean', ]; diff --git a/app/models/Component.php b/app/models/Component.php index 1c9d1509e2..5f978e08d6 100644 --- a/app/models/Component.php +++ b/app/models/Component.php @@ -26,14 +26,18 @@ class Component extends SingleTableInheritanceEntity { public static $rules - = ['user_id' => 'exists:users,id|required', 'name' => ['required', 'between:1,100', 'min:1', 'alphabasic'], - 'class' => 'required',]; + = [ + 'user_id' => 'exists:users,id|required', + 'name' => 'required|between:1,100|alphabasic', + 'class' => 'required', + ]; protected $fillable = ['name', 'user_id']; protected $subclassField = 'class'; protected $table = 'components'; /** * TODO remove this method in favour of something in the FireflyIII libraries. + * * @return Carbon */ public function lastActionDate() @@ -51,7 +55,7 @@ class Component extends SingleTableInheritanceEntity */ public function transactionjournals() { - return $this->belongsToMany('TransactionJournal','component_transaction_journal','component_id'); + return $this->belongsToMany('TransactionJournal', 'component_transaction_journal', 'component_id'); } diff --git a/app/models/Limit.php b/app/models/Limit.php index bb9830d040..6f7b0ec9d2 100644 --- a/app/models/Limit.php +++ b/app/models/Limit.php @@ -8,16 +8,16 @@ use LaravelBook\Ardent\Ardent as Ardent; /** * Limit * - * @property integer $id - * @property \Carbon\Carbon $created_at - * @property \Carbon\Carbon $updated_at - * @property integer $component_id - * @property \Carbon\Carbon $startdate - * @property float $amount - * @property boolean $repeats - * @property string $repeat_freq - * @property-read \Budget $budget - * @property-read \Component $component + * @property integer $id + * @property \Carbon\Carbon $created_at + * @property \Carbon\Carbon $updated_at + * @property integer $component_id + * @property \Carbon\Carbon $startdate + * @property float $amount + * @property boolean $repeats + * @property string $repeat_freq + * @property-read \Budget $budget + * @property-read \Component $component * @property-read \Illuminate\Database\Eloquent\Collection|\LimitRepetition[] $limitrepetitions * @method static \Illuminate\Database\Query\Builder|\Limit whereId($value) * @method static \Illuminate\Database\Query\Builder|\Limit whereCreatedAt($value) @@ -32,8 +32,12 @@ class Limit extends Ardent { public static $rules - = ['component_id' => 'required|exists:components,id', 'startdate' => 'required|date', 'amount' => 'numeric|required|min:0.01', - 'repeats' => 'required|boolean', 'repeat_freq' => 'required|in:daily,weekly,monthly,quarterly,half-year,yearly' + = [ + 'component_id' => 'required|exists:components,id', + 'startdate' => 'required|date', + 'amount' => 'numeric|required|min:0.01', + 'repeats' => 'required|boolean', + 'repeat_freq' => 'required|in:daily,weekly,monthly,quarterly,half-year,yearly' ]; @@ -47,6 +51,7 @@ class Limit extends Ardent } /** + * TODO see if this method is still used. * Create a new repetition for this limit, starting on * the given date. * diff --git a/app/models/LimitRepetition.php b/app/models/LimitRepetition.php index 07effdb27f..e9e65bff86 100644 --- a/app/models/LimitRepetition.php +++ b/app/models/LimitRepetition.php @@ -7,14 +7,14 @@ use LaravelBook\Ardent\Ardent as Ardent; /** * LimitRepetition * - * @property integer $id + * @property integer $id * @property \Carbon\Carbon $created_at * @property \Carbon\Carbon $updated_at - * @property integer $limit_id + * @property integer $limit_id * @property \Carbon\Carbon $startdate * @property \Carbon\Carbon $enddate - * @property float $amount - * @property-read \Limit $limit + * @property float $amount + * @property-read \Limit $limit * @method static \Illuminate\Database\Query\Builder|\LimitRepetition whereId($value) * @method static \Illuminate\Database\Query\Builder|\LimitRepetition whereCreatedAt($value) * @method static \Illuminate\Database\Query\Builder|\LimitRepetition whereUpdatedAt($value) @@ -26,7 +26,12 @@ use LaravelBook\Ardent\Ardent as Ardent; class LimitRepetition extends Ardent { public static $rules - = ['limit_id' => 'required|exists:limits,id', 'startdate' => 'required|date', 'enddate' => 'required|date', 'amount' => 'numeric|required|min:0.01',]; + = [ + 'limit_id' => 'required|exists:limits,id', + 'startdate' => 'required|date', + 'enddate' => 'required|date', + 'amount' => 'numeric|required|min:0.01', + ]; /** * @return array @@ -37,6 +42,8 @@ class LimitRepetition extends Ardent } /** + * TODO see if this scope is still used. + * * How much money is left in this? */ public function leftInRepetition() @@ -47,6 +54,7 @@ class LimitRepetition extends Ardent /** * TODO remove this method in favour of something in the FireflyIII libraries. + * * @return float */ public function spentInRepetition() diff --git a/app/models/PiggybankEvent.php b/app/models/PiggybankEvent.php index be7b2fbcc2..bd2f2d55f3 100644 --- a/app/models/PiggybankEvent.php +++ b/app/models/PiggybankEvent.php @@ -6,14 +6,14 @@ use LaravelBook\Ardent\Ardent as Ardent; /** * PiggybankEvent * - * @property integer $id - * @property \Carbon\Carbon $created_at - * @property \Carbon\Carbon $updated_at - * @property integer $piggybank_id - * @property \Carbon\Carbon $date - * @property float $amount - * @property integer $transaction_journal_id - * @property-read \Piggybank $piggybank + * @property integer $id + * @property \Carbon\Carbon $created_at + * @property \Carbon\Carbon $updated_at + * @property integer $piggybank_id + * @property \Carbon\Carbon $date + * @property float $amount + * @property integer $transaction_journal_id + * @property-read \Piggybank $piggybank * @property-read \TransactionJournal $transactionJournal * @method static \Illuminate\Database\Query\Builder|\PiggybankEvent whereId($value) * @method static \Illuminate\Database\Query\Builder|\PiggybankEvent whereCreatedAt($value) @@ -27,7 +27,11 @@ class PiggybankEvent extends Ardent { public static $rules - = ['piggybank_id' => 'required|exists:piggybanks,id', 'date' => 'required|date', 'amount' => 'required|numeric']; + = [ + 'piggybank_id' => 'required|exists:piggybanks,id', + 'date' => 'required|date', + 'amount' => 'required|numeric' + ]; /** * @return array diff --git a/app/models/PiggybankRepetition.php b/app/models/PiggybankRepetition.php index 3e4f2fa7fd..8d20be1873 100644 --- a/app/models/PiggybankRepetition.php +++ b/app/models/PiggybankRepetition.php @@ -5,13 +5,13 @@ use LaravelBook\Ardent\Ardent as Ardent; /** * PiggybankRepetition * - * @property integer $id - * @property \Carbon\Carbon $created_at - * @property \Carbon\Carbon $updated_at - * @property integer $piggybank_id - * @property \Carbon\Carbon $startdate - * @property \Carbon\Carbon $targetdate - * @property float $currentamount + * @property integer $id + * @property \Carbon\Carbon $created_at + * @property \Carbon\Carbon $updated_at + * @property integer $piggybank_id + * @property \Carbon\Carbon $startdate + * @property \Carbon\Carbon $targetdate + * @property float $currentamount * @property-read \Piggybank $piggybank * @method static \Illuminate\Database\Query\Builder|\PiggybankRepetition whereId($value) * @method static \Illuminate\Database\Query\Builder|\PiggybankRepetition whereCreatedAt($value) @@ -24,7 +24,11 @@ use LaravelBook\Ardent\Ardent as Ardent; class PiggybankRepetition extends Ardent { public static $rules - = ['piggybank_id' => 'required|exists:piggybanks,id', 'targetdate' => 'date', 'startdate' => 'date', 'currentamount' => 'required|numeric']; + = [ + 'piggybank_id' => 'required|exists:piggybanks,id', + 'targetdate' => 'date', + 'startdate' => 'date', + 'currentamount' => 'required|numeric']; /** * @return array diff --git a/app/models/RecurringTransaction.php b/app/models/RecurringTransaction.php index a1971644bb..db852bfea9 100644 --- a/app/models/RecurringTransaction.php +++ b/app/models/RecurringTransaction.php @@ -6,21 +6,21 @@ use LaravelBook\Ardent\Ardent; /** * RecurringTransaction * - * @property integer $id - * @property \Carbon\Carbon $created_at - * @property \Carbon\Carbon $updated_at - * @property integer $user_id - * @property string $name - * @property string $match - * @property float $amount_min - * @property float $amount_max - * @property \Carbon\Carbon $date - * @property boolean $active - * @property boolean $automatch - * @property string $repeat_freq - * @property integer $skip + * @property integer $id + * @property \Carbon\Carbon $created_at + * @property \Carbon\Carbon $updated_at + * @property integer $user_id + * @property string $name + * @property string $match + * @property float $amount_min + * @property float $amount_max + * @property \Carbon\Carbon $date + * @property boolean $active + * @property boolean $automatch + * @property string $repeat_freq + * @property integer $skip * @property-read \Illuminate\Database\Eloquent\Collection|\TransactionJournal[] $transactionjournals - * @property-read \User $user + * @property-read \User $user * @method static \Illuminate\Database\Query\Builder|\RecurringTransaction whereId($value) * @method static \Illuminate\Database\Query\Builder|\RecurringTransaction whereCreatedAt($value) * @method static \Illuminate\Database\Query\Builder|\RecurringTransaction whereUpdatedAt($value) @@ -39,9 +39,17 @@ class RecurringTransaction extends Ardent { public static $rules - = ['user_id' => 'required|exists:users,id', 'name' => 'required|between:1,255', 'match' => 'required', 'amount_max' => 'required|between:0,65536', - 'amount_min' => 'required|between:0,65536', 'date' => 'required|date', 'active' => 'required|between:0,1', 'automatch' => 'required|between:0,1', - 'repeat_freq' => 'required|in:daily,weekly,monthly,quarterly,half-year,yearly', 'skip' => 'required|between:0,31',]; + = [ + 'user_id' => 'required|exists:users,id', + 'name' => 'required|between:1,255', + 'match' => 'required', + 'amount_max' => 'required|between:0,65536', + 'amount_min' => 'required|between:0,65536', + 'date' => 'required|date', + 'active' => 'required|between:0,1', + 'automatch' => 'required|between:0,1', + 'repeat_freq' => 'required|in:daily,weekly,monthly,quarterly,half-year,yearly', + 'skip' => 'required|between:0,31',]; protected $fillable = ['user_id', 'name', 'match', 'amount_min', 'amount_max', 'date', 'repeat_freq', 'skip', 'active', 'automatch']; @@ -53,6 +61,10 @@ class RecurringTransaction extends Ardent return ['created_at', 'updated_at', 'date']; } + /** + * TODO remove this method in favour of something in the FireflyIII libraries. + * @return null + */ public function lastFoundMatch() { $last = $this->transactionjournals()->orderBy('date', 'DESC')->first(); diff --git a/app/models/Transaction.php b/app/models/Transaction.php index 45cd458e26..8f21da2f14 100644 --- a/app/models/Transaction.php +++ b/app/models/Transaction.php @@ -8,20 +8,20 @@ use LaravelBook\Ardent\Builder; /** * Transaction * - * @property integer $id - * @property \Carbon\Carbon $created_at - * @property \Carbon\Carbon $updated_at - * @property integer $account_id - * @property integer $piggybank_id - * @property integer $transaction_journal_id - * @property string $description - * @property float $amount - * @property-read \Account $account - * @property-read \Illuminate\Database\Eloquent\Collection|\Budget[] $budgets - * @property-read \Illuminate\Database\Eloquent\Collection|\Category[] $categories + * @property integer $id + * @property \Carbon\Carbon $created_at + * @property \Carbon\Carbon $updated_at + * @property integer $account_id + * @property integer $piggybank_id + * @property integer $transaction_journal_id + * @property string $description + * @property float $amount + * @property-read \Account $account + * @property-read \Illuminate\Database\Eloquent\Collection|\Budget[] $budgets + * @property-read \Illuminate\Database\Eloquent\Collection|\Category[] $categories * @property-read \Illuminate\Database\Eloquent\Collection|\Component[] $components - * @property-read \Piggybank $piggybank - * @property-read \TransactionJournal $transactionJournal + * @property-read \Piggybank $piggybank + * @property-read \TransactionJournal $transactionJournal * @method static \Illuminate\Database\Query\Builder|\Transaction whereId($value) * @method static \Illuminate\Database\Query\Builder|\Transaction whereCreatedAt($value) * @method static \Illuminate\Database\Query\Builder|\Transaction whereUpdatedAt($value) @@ -40,8 +40,10 @@ use LaravelBook\Ardent\Builder; class Transaction extends Ardent { public static $rules - = ['account_id' => 'numeric|required|exists:accounts,id', 'piggybank_id' => 'numeric|exists:piggybanks,id', - 'transaction_journal_id' => 'numeric|required|exists:transaction_journals,id', 'description' => 'between:1,255', + = ['account_id' => 'numeric|required|exists:accounts,id', + 'piggybank_id' => 'numeric|exists:piggybanks,id', + 'transaction_journal_id' => 'numeric|required|exists:transaction_journals,id', + 'description' => 'between:1,255', 'amount' => 'required|between:-65536,65536|not_in:0,0.00',]; diff --git a/app/models/TransactionJournal.php b/app/models/TransactionJournal.php index bae052d62e..171e7103ca 100644 --- a/app/models/TransactionJournal.php +++ b/app/models/TransactionJournal.php @@ -8,27 +8,27 @@ use LaravelBook\Ardent\Builder; /** * TransactionJournal * - * @property integer $id - * @property \Carbon\Carbon $created_at - * @property \Carbon\Carbon $updated_at - * @property integer $user_id - * @property integer $transaction_type_id - * @property integer $recurring_transaction_id - * @property integer $transaction_currency_id - * @property string $description - * @property boolean $completed - * @property \Carbon\Carbon $date + * @property integer $id + * @property \Carbon\Carbon $created_at + * @property \Carbon\Carbon $updated_at + * @property integer $user_id + * @property integer $transaction_type_id + * @property integer $recurring_transaction_id + * @property integer $transaction_currency_id + * @property string $description + * @property boolean $completed + * @property \Carbon\Carbon $date * @property-read \Illuminate\Database\Eloquent\Collection|\ * 'Budget[] $budgets * @property-read \Illuminate\Database\Eloquent\Collection|\ * 'Category[] $categories - * @property-read \Illuminate\Database\Eloquent\Collection|\Component[] $components + * @property-read \Illuminate\Database\Eloquent\Collection|\Component[] $components * @property-read \Illuminate\Database\Eloquent\Collection|\PiggybankEvent[] $piggybankevents - * @property-read \RecurringTransaction $recurringTransaction - * @property-read \TransactionCurrency $transactionCurrency - * @property-read \TransactionType $transactionType - * @property-read \Illuminate\Database\Eloquent\Collection|\Transaction[] $transactions - * @property-read \User $user + * @property-read \RecurringTransaction $recurringTransaction + * @property-read \TransactionCurrency $transactionCurrency + * @property-read \TransactionType $transactionType + * @property-read \Illuminate\Database\Eloquent\Collection|\Transaction[] $transactions + * @property-read \User $user * @method static \Illuminate\Database\Query\Builder|\TransactionJournal whereId($value) * @method static \Illuminate\Database\Query\Builder|\TransactionJournal whereCreatedAt($value) * @method static \Illuminate\Database\Query\Builder|\TransactionJournal whereUpdatedAt($value) @@ -57,8 +57,11 @@ class TransactionJournal extends Ardent { public static $rules - = ['transaction_type_id' => 'required|exists:transaction_types,id', 'transaction_currency_id' => 'required|exists:transaction_currencies,id', - 'description' => 'required|between:1,255', 'date' => 'required|date', 'completed' => 'required|between:0,1']; + = ['transaction_type_id' => 'required|exists:transaction_types,id', + 'transaction_currency_id' => 'required|exists:transaction_currencies,id', + 'description' => 'required|between:1,255', + 'date' => 'required|date', + 'completed' => 'required|between:0,1']; /** @@ -91,6 +94,7 @@ class TransactionJournal extends Ardent /** * TODO remove this method in favour of something in the FireflyIII libraries. + * * @return float */ public function getAmount()