Uploaded files

Author: UnderlineWords

Favorite.php

@@ -0,0 +1,37 @@
+<?php
+namespace CodeForms\Repositories\Favorite;
+
+use Illuminate\Database\Eloquent\Model;
+/**
+ *  @package CodeForms\Repositories\Favorite
+ */
+class Favorite extends Model
+{
+	/**
+	 * @var string
+	 */
+	protected $table = 'favorites';
+
+	/**
+	 * @var array
+	 */
+	protected $fillable = ['user_id'];
+
+	/**
+     * @return void
+     */
+    protected static function booted()
+    {
+        static::creating(function ($favorite) {
+            $favorite->user_id = auth()->user()->id;
+        });
+    }
+
+    /**
+     * 
+     */
+	public function favoriteable()
+	{
+		return $this->morphTo();
+	}
+}

Favoriteable.php

@@ -0,0 +1,72 @@
+<?php
+namespace CodeForms\Repositories\Favorite;
+
+use Illuminate\Support\Facades\DB;
+use Illuminate\Database\Eloquent\Builder;
+/**
+ * @package CodeForms\Repositories\Favorite
+ */
+trait Favoriteable
+{
+	/**
+     * @return Illuminate\Database\Eloquent\Model
+     */
+    public static function bootFavoriteable()
+    {
+        static::deleted(function (self $model) {
+            $model->deleteFavorites();
+        });
+    }
+
+	/**
+	 * @example $post->hasFavorite()
+	 * 
+	 * @return boolean
+	 */
+	public function hasFavorite(): bool
+	{
+		return (bool)$this->favorites()->where('user_id', auth()->user()->id)->first();
+	}
+
+	/**
+	 * @example $post->addFavorite()
+	 * 
+	 * @return object|boolean
+	 */
+	public function addFavorite()
+	{
+		if(!self::hasFavorite())
+			return $this->favorites()->create();
+		return false;
+	}
+
+	/**
+	 * @example $post->removeFavorite()
+	 * 
+	 * @return mixed
+	 */
+	public function removeFavorite(): bool
+	{
+		if(self::hasFavorite())
+			return $this->favorites()->where('user_id', auth()->user()->id)->delete();
+		return false;
+	}
+
+	/**
+	 * @example $post->deleteFavorites()
+	 * 
+	 * @return boolean
+	 */
+	public function deleteFavorites(): bool
+	{
+		return $this->favorites()->delete();
+	}
+
+	/**
+	 * @return Illuminate\Database\Eloquent\Relations\MorphMany
+	 */
+	public function favorites()
+	{
+		return $this->morphMany(Favorite::class, 'favoriteable');
+	}
+}

README.md

@@ -1,2 +1,6 @@
 # Favoriteable
 Simple and handy trait for Laravel based models to allow easy implementation of "favorite / remember" or "follow" feature.
+
+[![GitHub license](https://img.shields.io/github/license/codeforms/Favoriteable)](https://github.com/codeforms/Favoriteable/blob/master/LICENSE)
+![GitHub release (latest by date)](https://img.shields.io/github/v/release/codeforms/Favoriteable)
+[![stable](http://badges.github.io/stability-badges/dist/stable.svg)](https://github.com/codeforms/Favoriteable/releases)

UserFavorites.php

@@ -0,0 +1,61 @@
+<?php
+namespace CodeForms\Repositories\Favorite;
+
+use Illuminate\Support\Facades\DB;
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Collection;
+/**
+ * Trait for user model
+ * 
+ * @package CodeForms\Repositories\Favorite
+ */
+trait UserFavorites
+{
+	/**
+	 * @example $user->favorites()
+	 * 
+	 * @return object|null
+	 */
+	public function favorites()
+	{
+		if(self::hasFavorite()) {
+			$collection = new Collection;
+			foreach($this->userFavorites()->get() as $favorite)
+				$collection->push(app($favorite->favoriteable_type)->find($favorite->favoriteable_id));
+
+			return $collection;
+		}
+
+		return null;
+	}
+
+	/**
+	 * @example $user->hasFavorite()
+	 * 
+	 * @return boolean
+	 */
+	public function hasFavorite(): bool
+	{
+		return (bool)$this->userFavorites()->count();
+	}
+
+	/**
+	 * @example $user->deleteFavorites()
+	 * 
+	 * @return boolean
+	 */
+	public function deleteFavorites(): bool
+	{
+		if(self::hasFavorite())
+			return $this->userFavorites()->delete();
+		return false;
+	}
+
+	/**
+     * @return Illuminate\Database\Eloquent\Relations\MorphMany
+     */
+    public function userFavorites()
+    {
+        return $this->hasMany(Favorite::class, 'user_id', 'id');
+    }
+}

migrations/2020_05_06_014641_create_favorites_table.php

@@ -0,0 +1,40 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+class CreateFavoritesTable extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::create('favorites', function (Blueprint $table) {
+            $table->id();
+            $table->morphs('favoriteable');
+            $table->unsignedInteger('user_id');
+            $table->timestamps();
+
+            $table->foreign('user_id')
+                ->references('id')
+                ->on('users')
+                ->onDelete('cascade');
+
+            $table->unique(['favoriteable_id', 'favoriteable_type', 'user_id']);
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::dropIfExists('favorites');
+    }
+}