From 481a6bdd5f36374f6433bdeef622f3d18cef16c7 Mon Sep 17 00:00:00 2001
From: James Cole <james@firefly-iii.org>
Date: Sat, 18 Sep 2021 10:08:10 +0200
Subject: [PATCH] Add meta data to models.

---
 app/Models/Account.php            |  2 ++
 app/Models/Attachment.php         |  2 ++
 app/Models/AvailableBudget.php    |  2 ++
 app/Models/Bill.php               |  2 ++
 app/Models/Budget.php             |  2 ++
 app/Models/Category.php           |  2 ++
 app/Models/GroupMembership.php    | 22 ++++++++++++++++++++++
 app/Models/Recurrence.php         |  2 ++
 app/Models/Rule.php               |  2 ++
 app/Models/RuleGroup.php          |  2 ++
 app/Models/Tag.php                |  2 ++
 app/Models/TransactionGroup.php   |  2 ++
 app/Models/TransactionJournal.php |  2 ++
 app/Models/UserGroup.php          | 17 +++++++++++++++++
 app/Models/UserRole.php           | 17 +++++++++++++++++
 app/Models/Webhook.php            |  2 ++
 app/User.php                      |  5 +++++
 17 files changed, 87 insertions(+)

diff --git a/app/Models/Account.php b/app/Models/Account.php
index 5e9d93d8cc..ececd3cca9 100644
--- a/app/Models/Account.php
+++ b/app/Models/Account.php
@@ -99,6 +99,8 @@ use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
  * @property string                          $location
  * @property string                          $liability_direction
  * @property string                          $current_debt
+ * @property int|null $user_group_id
+ * @method static EloquentBuilder|Account whereUserGroupId($value)
  */
 class Account extends Model
 {
diff --git a/app/Models/Attachment.php b/app/Models/Attachment.php
index 6b2284ca20..ab1a324ea6 100644
--- a/app/Models/Attachment.php
+++ b/app/Models/Attachment.php
@@ -78,6 +78,8 @@ use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
  * @method static Builder|Attachment withTrashed()
  * @method static Builder|Attachment withoutTrashed()
  * @mixin Eloquent
+ * @property int|null $user_group_id
+ * @method static \Illuminate\Database\Eloquent\Builder|Attachment whereUserGroupId($value)
  */
 class Attachment extends Model
 {
diff --git a/app/Models/AvailableBudget.php b/app/Models/AvailableBudget.php
index 20a4241fb1..05e89eb4cd 100644
--- a/app/Models/AvailableBudget.php
+++ b/app/Models/AvailableBudget.php
@@ -61,6 +61,8 @@ use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
  * @method static Builder|AvailableBudget withTrashed()
  * @method static Builder|AvailableBudget withoutTrashed()
  * @mixin Eloquent
+ * @property int|null $user_group_id
+ * @method static \Illuminate\Database\Eloquent\Builder|AvailableBudget whereUserGroupId($value)
  */
 class AvailableBudget extends Model
 {
diff --git a/app/Models/Bill.php b/app/Models/Bill.php
index 34fd41804d..6581eb2312 100644
--- a/app/Models/Bill.php
+++ b/app/Models/Bill.php
@@ -94,6 +94,8 @@ use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
  * @method static Builder|Bill withTrashed()
  * @method static Builder|Bill withoutTrashed()
  * @mixin Eloquent
+ * @property int|null $user_group_id
+ * @method static \Illuminate\Database\Eloquent\Builder|Bill whereUserGroupId($value)
  */
 class Bill extends Model
 {
diff --git a/app/Models/Budget.php b/app/Models/Budget.php
index 184b37d57c..6d07df3d48 100644
--- a/app/Models/Budget.php
+++ b/app/Models/Budget.php
@@ -75,6 +75,8 @@ use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
  * @method static Builder|Budget withoutTrashed()
  * @mixin Eloquent
  * @property string                               $email
+ * @property int|null $user_group_id
+ * @method static \Illuminate\Database\Eloquent\Builder|Budget whereUserGroupId($value)
  */
 class Budget extends Model
 {
diff --git a/app/Models/Category.php b/app/Models/Category.php
index c23eb0cd5e..2623e25009 100644
--- a/app/Models/Category.php
+++ b/app/Models/Category.php
@@ -69,6 +69,8 @@ use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
  * @method static Builder|Category withTrashed()
  * @method static Builder|Category withoutTrashed()
  * @mixin Eloquent
+ * @property int|null $user_group_id
+ * @method static \Illuminate\Database\Eloquent\Builder|Category whereUserGroupId($value)
  */
 class Category extends Model
 {
diff --git a/app/Models/GroupMembership.php b/app/Models/GroupMembership.php
index 6dcf50c4b7..4f328ba998 100644
--- a/app/Models/GroupMembership.php
+++ b/app/Models/GroupMembership.php
@@ -30,6 +30,28 @@ use Illuminate\Database\Eloquent\Relations\BelongsTo;
 
 /**
  * Class GroupMembership
+ *
+ * @property int $id
+ * @property \Illuminate\Support\Carbon|null $created_at
+ * @property \Illuminate\Support\Carbon|null $updated_at
+ * @property string|null $deleted_at
+ * @property int $user_id
+ * @property int $user_group_id
+ * @property int $user_role_id
+ * @property-read User $user
+ * @property-read \FireflyIII\Models\UserGroup $userGroup
+ * @property-read \FireflyIII\Models\UserRole $userRole
+ * @method static \Illuminate\Database\Eloquent\Builder|GroupMembership newModelQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder|GroupMembership newQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder|GroupMembership query()
+ * @method static \Illuminate\Database\Eloquent\Builder|GroupMembership whereCreatedAt($value)
+ * @method static \Illuminate\Database\Eloquent\Builder|GroupMembership whereDeletedAt($value)
+ * @method static \Illuminate\Database\Eloquent\Builder|GroupMembership whereId($value)
+ * @method static \Illuminate\Database\Eloquent\Builder|GroupMembership whereUpdatedAt($value)
+ * @method static \Illuminate\Database\Eloquent\Builder|GroupMembership whereUserGroupId($value)
+ * @method static \Illuminate\Database\Eloquent\Builder|GroupMembership whereUserId($value)
+ * @method static \Illuminate\Database\Eloquent\Builder|GroupMembership whereUserRoleId($value)
+ * @mixin \Eloquent
  */
 class GroupMembership extends Model
 {
diff --git a/app/Models/Recurrence.php b/app/Models/Recurrence.php
index ff2e99a395..2dca75f241 100644
--- a/app/Models/Recurrence.php
+++ b/app/Models/Recurrence.php
@@ -86,6 +86,8 @@ use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
  * @method static Builder|Recurrence withTrashed()
  * @method static Builder|Recurrence withoutTrashed()
  * @mixin Eloquent
+ * @property int|null $user_group_id
+ * @method static \Illuminate\Database\Eloquent\Builder|Recurrence whereUserGroupId($value)
  */
 class Recurrence extends Model
 {
diff --git a/app/Models/Rule.php b/app/Models/Rule.php
index 4d37bd6f9f..f8bbd75b2a 100644
--- a/app/Models/Rule.php
+++ b/app/Models/Rule.php
@@ -74,6 +74,8 @@ use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
  * @method static Builder|Rule withTrashed()
  * @method static Builder|Rule withoutTrashed()
  * @mixin Eloquent
+ * @property int|null $user_group_id
+ * @method static \Illuminate\Database\Eloquent\Builder|Rule whereUserGroupId($value)
  */
 class Rule extends Model
 {
diff --git a/app/Models/RuleGroup.php b/app/Models/RuleGroup.php
index 04aa7b4108..8481c2de12 100644
--- a/app/Models/RuleGroup.php
+++ b/app/Models/RuleGroup.php
@@ -66,6 +66,8 @@ use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
  * @method static Builder|RuleGroup withTrashed()
  * @method static Builder|RuleGroup withoutTrashed()
  * @mixin Eloquent
+ * @property int|null $user_group_id
+ * @method static \Illuminate\Database\Eloquent\Builder|RuleGroup whereUserGroupId($value)
  */
 class RuleGroup extends Model
 {
diff --git a/app/Models/Tag.php b/app/Models/Tag.php
index 7546cfd5ab..6297365cea 100644
--- a/app/Models/Tag.php
+++ b/app/Models/Tag.php
@@ -75,6 +75,8 @@ use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
  * @method static Builder|Tag withTrashed()
  * @method static Builder|Tag withoutTrashed()
  * @mixin Eloquent
+ * @property int|null $user_group_id
+ * @method static \Illuminate\Database\Eloquent\Builder|Tag whereUserGroupId($value)
  */
 class Tag extends Model
 {
diff --git a/app/Models/TransactionGroup.php b/app/Models/TransactionGroup.php
index 53cdb3a815..d29a0ef693 100644
--- a/app/Models/TransactionGroup.php
+++ b/app/Models/TransactionGroup.php
@@ -58,6 +58,8 @@ use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
  * @method static Builder|TransactionGroup withTrashed()
  * @method static Builder|TransactionGroup withoutTrashed()
  * @mixin Eloquent
+ * @property int|null $user_group_id
+ * @method static \Illuminate\Database\Eloquent\Builder|TransactionGroup whereUserGroupId($value)
  */
 class TransactionGroup extends Model
 {
diff --git a/app/Models/TransactionJournal.php b/app/Models/TransactionJournal.php
index ed1635f8d9..70963b2ad4 100644
--- a/app/Models/TransactionJournal.php
+++ b/app/Models/TransactionJournal.php
@@ -116,6 +116,8 @@ use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
  * @property-read Collection|Location[] $locations
  * @property-read int|null                                            $locations_count
  * @property int                                                      $the_count
+ * @property int|null $user_group_id
+ * @method static EloquentBuilder|TransactionJournal whereUserGroupId($value)
  */
 class TransactionJournal extends Model
 {
diff --git a/app/Models/UserGroup.php b/app/Models/UserGroup.php
index ba20e0deca..f47d81c061 100644
--- a/app/Models/UserGroup.php
+++ b/app/Models/UserGroup.php
@@ -29,6 +29,23 @@ use Illuminate\Database\Eloquent\Relations\HasMany;
 
 /**
  * Class UserGroup
+ *
+ * @property int $id
+ * @property \Illuminate\Support\Carbon|null $created_at
+ * @property \Illuminate\Support\Carbon|null $updated_at
+ * @property string|null $deleted_at
+ * @property string $title
+ * @property-read \Illuminate\Database\Eloquent\Collection|\FireflyIII\Models\GroupMembership[] $groupMemberships
+ * @property-read int|null $group_memberships_count
+ * @method static \Illuminate\Database\Eloquent\Builder|UserGroup newModelQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder|UserGroup newQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder|UserGroup query()
+ * @method static \Illuminate\Database\Eloquent\Builder|UserGroup whereCreatedAt($value)
+ * @method static \Illuminate\Database\Eloquent\Builder|UserGroup whereDeletedAt($value)
+ * @method static \Illuminate\Database\Eloquent\Builder|UserGroup whereId($value)
+ * @method static \Illuminate\Database\Eloquent\Builder|UserGroup whereTitle($value)
+ * @method static \Illuminate\Database\Eloquent\Builder|UserGroup whereUpdatedAt($value)
+ * @mixin \Eloquent
  */
 class UserGroup extends Model
 {
diff --git a/app/Models/UserRole.php b/app/Models/UserRole.php
index 4600abaea0..d4be7c292f 100644
--- a/app/Models/UserRole.php
+++ b/app/Models/UserRole.php
@@ -29,6 +29,23 @@ use Illuminate\Database\Eloquent\Relations\HasMany;
 
 /**
  * Class UserRole
+ *
+ * @property int $id
+ * @property \Illuminate\Support\Carbon|null $created_at
+ * @property \Illuminate\Support\Carbon|null $updated_at
+ * @property string|null $deleted_at
+ * @property string $title
+ * @property-read \Illuminate\Database\Eloquent\Collection|\FireflyIII\Models\GroupMembership[] $groupMemberships
+ * @property-read int|null $group_memberships_count
+ * @method static \Illuminate\Database\Eloquent\Builder|UserRole newModelQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder|UserRole newQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder|UserRole query()
+ * @method static \Illuminate\Database\Eloquent\Builder|UserRole whereCreatedAt($value)
+ * @method static \Illuminate\Database\Eloquent\Builder|UserRole whereDeletedAt($value)
+ * @method static \Illuminate\Database\Eloquent\Builder|UserRole whereId($value)
+ * @method static \Illuminate\Database\Eloquent\Builder|UserRole whereTitle($value)
+ * @method static \Illuminate\Database\Eloquent\Builder|UserRole whereUpdatedAt($value)
+ * @mixin \Eloquent
  */
 class UserRole extends Model
 {
diff --git a/app/Models/Webhook.php b/app/Models/Webhook.php
index 05d6781e43..e4963677e9 100644
--- a/app/Models/Webhook.php
+++ b/app/Models/Webhook.php
@@ -71,6 +71,8 @@ use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
  * @property string                           $secret
  * @method static Builder|Webhook whereSecret($value)
  * @method static Builder|Webhook whereTitle($value)
+ * @property int|null $user_group_id
+ * @method static Builder|Webhook whereUserGroupId($value)
  */
 class Webhook extends Model
 {
diff --git a/app/User.php b/app/User.php
index 6fc8901162..875f950a6b 100644
--- a/app/User.php
+++ b/app/User.php
@@ -151,6 +151,11 @@ use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
  * @method static Builder|User whereGuid($value)
  * @method static Builder|User whereTwoFactorRecoveryCodes($value)
  * @method static Builder|User whereTwoFactorSecret($value)
+ * @property int|null $user_group_id
+ * @property-read \Illuminate\Database\Eloquent\Collection|GroupMembership[] $groupMemberships
+ * @property-read int|null $group_memberships_count
+ * @property-read UserGroup|null $userGroup
+ * @method static Builder|User whereUserGroupId($value)
  */
 class User extends Authenticatable
 {