Refresh

app/Models/User.php

@@ -0,0 +1,125 @@
+<?php
+
+namespace App\Models;
+
+use App\Models\Traits\User\HasFeeds;
+use App\Models\Traits\User\HasFolders;
+use App\Models\Traits\User\HasGroups;
+use App\Services\Importer;
+use Illuminate\Contracts\Auth\MustVerifyEmail;
+use Illuminate\Contracts\Translation\HasLocalePreference;
+use Illuminate\Foundation\Auth\User as Authenticatable;
+use Illuminate\Notifications\Notifiable;
+
+class User extends Authenticatable implements MustVerifyEmail, HasLocalePreference
+{
+    use Notifiable;
+    use HasGroups;
+    use HasFolders;
+    use HasFeeds;
+
+    // -------------------------------------------------------------------------
+    // ----| Properties |-------------------------------------------------------
+    // -------------------------------------------------------------------------
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = [
+        'name', 'email', 'password', 'lang'
+    ];
+
+    /**
+     * The attributes that should be hidden for arrays.
+     *
+     * @var array
+     */
+    protected $hidden = [
+        'password', 'remember_token',
+    ];
+
+    /**
+     * The attributes that should be cast to native types.
+     *
+     * @var array
+     */
+    protected $casts = [
+        'email_verified_at' => 'datetime',
+    ];
+
+    public function getLangAttribute() {
+        if(!empty($this->attributes['lang'])) {
+            return trim($this->attributes['lang']);
+        }
+        return 'en';
+    }
+
+    // -------------------------------------------------------------------------
+    // ----| Relations |--------------------------------------------------------
+    // -------------------------------------------------------------------------
+
+    /**
+     * Documents added to user's collection.
+     *
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
+     */
+    public function documents()
+    {
+        return $this->hasManyThrough(Bookmark::class, Folder::class);
+    }
+
+    /**
+     * Highlights registered by this user.
+     *
+     * @return \Illuminate\Database\Eloquent\Relations\HasMany
+     */
+    public function highlights()
+    {
+        return $this->hasMany(Highlight::class);
+    }
+
+    /**
+     * Associated history entries.
+     *
+     * @return \Illuminate\Database\Eloquent\Relations\HasMany
+     */
+    public function userHistoryEntries()
+    {
+        return $this->hasMany(HistoryEntry::class);
+    }
+
+    /**
+     * Permissions affected to this user.
+     *
+     * @return \Illuminate\Database\Eloquent\Relations\HasMany
+     */
+    public function permissions()
+    {
+        return $this->hasMany(Permission::class);
+    }
+
+    // -------------------------------------------------------------------------
+    // ----| Methods |----------------------------------------------------------
+    // -------------------------------------------------------------------------
+
+    /**
+     * Get the user's preferred locale.
+     *
+     * @return string
+     */
+    public function preferredLocale()
+    {
+        return $this->lang;
+    }
+
+    /**
+     * Import initial set of data.
+     */
+    public function importInitialData(Group $group)
+    {
+        $importer = new Importer();
+        $importer->forUser($this)->inGroup($group)->fromFile(resource_path('initial_data.json'))->import();
+    }
+}