replace MemberUser with Member

Author: alexweissman

src/Database/Models/Member.php

@@ -1,48 +1,124 @@
 <?php
 namespace UserFrosting\Sprinkle\ExtendUser\Database\Models;
 
-use UserFrosting\Sprinkle\Core\Database\Models\Model;
+use UserFrosting\Sprinkle\Account\Database\Models\User;
+use UserFrosting\Sprinkle\ExtendUser\Database\Models\MemberAux;
+use UserFrosting\Sprinkle\ExtendUser\Database\Scopes\MemberAuxScope;
 
-class Member extends Model
+trait LinkMemberAux
 {
-    public $timestamps = true;
-
     /**
-     * @var string The name of the table for the current model.
+     * The "booting" method of the trait.
+     *
+     * @return void
      */
-    protected $table = "members";
+    protected static function bootLinkMemberAux()
+    {
+        /**
+         * Create a new MemberAux if necessary, and save the associated member data every time.
+         */
+        static::saved(function ($member) {
+            $member->createAuxIfNotExists();
+
+            if ($member->auxType) {
+                // Set the aux PK, if it hasn't been set yet
+                if (!$member->aux->id) {
+                    $member->aux->id = $member->id;
+                }
+
+                $member->aux->save();
+            }
+        });
+    }
+}
+
+class Member extends User
+{
+    use LinkMemberAux;
 
     protected $fillable = [
-        "user_id",
-        "city",
-        "country"
+        'user_name',
+        'first_name',
+        'last_name',
+        'email',
+        'locale',
+        'theme',
+        'group_id',
+        'flag_verified',
+        'flag_enabled',
+        'last_activity_id',
+        'password',
+        'deleted_at',
+        'city',
+        'country'
     ];
 
+    protected $auxType = 'UserFrosting\Sprinkle\ExtendUser\Database\Models\MemberAux';
+
+    /**
+     * Required to be able to access the `aux` relationship in Twig without needing to do eager loading.
+     * @see http://stackoverflow.com/questions/29514081/cannot-access-eloquent-attributes-on-twig/35908957#35908957
+     */
+    public function __isset($name)
+    {
+        if (in_array($name, [
+            'aux'
+        ])) {
+            return true;
+        } else {
+            return parent::__isset($name);
+        }
+    }
+
+    /**
+     * Globally joins the `members` table to access additional properties.
+     */
+    protected static function boot()
+    {
+        parent::boot();
+
+        static::addGlobalScope(new MemberAuxScope);
+    }
+
     /**
-     * Directly joins the related user, so we can do things like sort, search, paginate, etc.
+     * Custom mutator for Member property
      */
-    public function scopeJoinUser($query)
+    public function setCityAttribute($value)
     {
-        /** @var UserFrosting\Sprinkle\Core\Util\ClassMapper $classMapper */
-        $classMapper = static::$ci->classMapper;
-        $membersTable = $classMapper->createInstance('member')->getTable();
-        $usersTable = $classMapper->createInstance('user')->getTable();
+        $this->createAuxIfNotExists();
+
+        $this->aux->city = $value;
+    }
 
-        $query = $query->select("$membersTable.*");
+    /**
+     * Custom mutator for Member property
+     */
+    public function setCountryAttribute($value)
+    {
+        $this->createAuxIfNotExists();
 
-        $query = $query->leftJoin($usersTable, "$membersTable.user_id", '=', "$usersTable.id");
+        $this->aux->country = $value;
+    }
 
-        return $query;
+    /**
+     * Relationship for interacting with aux model (`members` table).
+     */
+    public function aux()
+    {
+        return $this->hasOne($this->auxType, 'id');
     }
 
     /**
-     * Get the user associated with this member.
+     * If this instance doesn't already have a related aux model (either in the db on in the current object), then create one
      */
-    public function user()
+    protected function createAuxIfNotExists()
     {
-        /** @var UserFrosting\Sprinkle\Core\Util\ClassMapper $classMapper */
-        $classMapper = static::$ci->classMapper;
+        if ($this->auxType && !count($this->aux)) {
+            // Create aux model and set primary key to be the same as the main user's
+            $aux = new $this->auxType;
 
-        return $this->belongsTo($classMapper->getClassMapping('user'), 'user_id');
+            // Needed to immediately hydrate the relation.  It will actually get saved in the bootLinkMemberAux method.
+            $this->setRelation('aux', $aux);
+        }
     }
-}
+}

src/Database/Models/MemberUser.php

@@ -16,12 +16,11 @@ public function register($container)
         /**
          * Extend the 'classMapper' service to register model classes.
          *
-         * Mappings added: MemberUser
+         * Mappings added: Member
          */
         $container->extend('classMapper', function ($classMapper, $c) {
-            $classMapper->setClassMapping('member', 'UserFrosting\Sprinkle\ExtendUser\Database\Models\Member');
-            $classMapper->setClassMapping('user', 'UserFrosting\Sprinkle\ExtendUser\Database\Models\MemberUser');
+            $classMapper->setClassMapping('user', 'UserFrosting\Sprinkle\ExtendUser\Database\Models\Member');
             return $classMapper;
         });
     }
-}
+}