Merge pull request #53 from Mombuyish/master

Add Bookmark feature

Author: overtrue

README.md

@@ -18,6 +18,7 @@
 - Support actions:
     - Follow
     - Like
+    - Bookmark
     - Subscribe
     - Favorite
     - Vote (Upvote & Downvote)
@@ -79,7 +80,7 @@ use Overtrue\LaravelFollow\Traits\CanVote;
 
 class User extends Model
 {
-    use CanFollow, CanLike, CanFavorite, CanSubscribe, CanVote;
+    use CanFollow, CanBookmark, CanLike, CanFavorite, CanSubscribe, CanVote;
 }
 ```
 
@@ -89,10 +90,11 @@ Add `CanBeXXX` Trait to target model, such as 'Post' or 'Music' ...:
 use Overtrue\LaravelFollow\Traits\CanBeLiked;
 use Overtrue\LaravelFollow\Traits\CanBeFavorited;
 use Overtrue\LaravelFollow\Traits\CanBeVoted;
+use Overtrue\LaravelFollow\Traits\CanBookmarked;
 
 class Post extends Model
 {
-    use CanBeLiked, CanBeFavorited, CanBeVoted;
+    use CanBeLiked, CanBeFavorited, CanBeVoted, CanBeBookmarked;
 }
 ```
 
@@ -118,6 +120,26 @@ $object->followers()->get()
 $object->isFollowedBy($user)
 ```
 
+### Bookmark
+
+#### `\Overtrue\LaravelFollow\Traits\CanBookmark`
+
+```php
+$user->bookmark($targets)
+$user->unbookmark($targets)
+$user->toggleBookmark($targets)
+$user->hasBookmarked($target)
+$user->bookmarks()->get() // App\User:class
+$user->bookmarks(App\Post::class)->get()
+```
+
+#### `\Overtrue\LaravelFollow\Traits\CanBeBookmarked`
+
+```php
+$object->bookmarkers()->get() // or $object->bookmarkers 
+$object->isBookmarkedBy($user)
+```
+
 ### Like
 
 #### `\Overtrue\LaravelFollow\Traits\CanLike`

src/Follow.php

@@ -34,6 +34,8 @@ class Follow
 
     const RELATION_FOLLOW = 'follow';
 
+    const RELATION_BOOKMARK = 'bookmark';
+
     const RELATION_SUBSCRIBE = 'subscribe';
 
     const RELATION_FAVORITE = 'favorite';
@@ -50,6 +52,8 @@ class Follow
         'followers' => 'follow',
         'favoriters' => 'favorite',
         'favorites' => 'favorite',
+        'bookmarkers' => 'bookmark',
+        'bookmarks' => 'bookmark',
         'subscriptions' => 'subscribe',
         'subscribers' => 'subscribe',
         'upvotes' => 'upvote',

src/Traits/CanBeBookmarked.php

@@ -0,0 +1,44 @@
+<?php
+
+/*
+ * This file is part of the overtrue/laravel-follow
+ *
+ * (c) overtrue <[email protected]>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Overtrue\LaravelFollow\Traits;
+
+use Overtrue\LaravelFollow\Follow;
+
+/**
+ * Trait CanBeBookmarked.
+ */
+trait CanBeBookmarked
+{
+    /**
+     * Check if user is bookmarked by given user.
+     *
+     * @param int $user
+     *
+     * @return bool
+     */
+    public function isBookmarkedBy($user)
+    {
+        return Follow::isRelationExists($this, 'bookmarkers', $user);
+    }
+
+    /**
+     * Return bookmarkers.
+     *
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
+     */
+    public function bookmarkers()
+    {
+        return $this->morphToMany(config('follow.user_model'), config('follow.morph_prefix'), config('follow.followable_table'))
+                    ->wherePivot('relation', '=', Follow::RELATION_BOOKMARK)
+                    ->withPivot('followable_type', 'relation', 'created_at');
+    }
+}

src/Traits/CanBookmark.php

@@ -0,0 +1,90 @@
+<?php
+
+/*
+ * This file is part of the overtrue/laravel-follow
+ *
+ * (c) overtrue <[email protected]>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Overtrue\LaravelFollow\Traits;
+
+use Overtrue\LaravelFollow\Follow;
+
+/**
+ * Trait CanBookmark.
+ */
+trait CanBookmark
+{
+    /**
+     * Follow an item or items.
+     *
+     * @param int|array|\Illuminate\Database\Eloquent\Model $targets
+     * @param string                                        $class
+     *
+     * @return array
+     *
+     * @throws \Exception
+     */
+    public function bookmark($targets, $class = __CLASS__)
+    {
+        return Follow::attachRelations($this, 'bookmarks', $targets, $class);
+    }
+
+    /**
+     * Unbookmark an item or items.
+     *
+     * @param int|array|\Illuminate\Database\Eloquent\Model $targets
+     * @param string                                        $class
+     *
+     * @return array
+     */
+    public function unbookmark($targets, $class = __CLASS__)
+    {
+        return Follow::detachRelations($this, 'bookmarks', $targets, $class);
+    }
+
+    /**
+     * Toggle bookmark an item or items.
+     *
+     * @param int|array|\Illuminate\Database\Eloquent\Model $targets
+     * @param string                                        $class
+     *
+     * @return array
+     *
+     * @throws \Exception
+     */
+    public function toggleBookmark($targets, $class = __CLASS__)
+    {
+        return Follow::toggleRelations($this, 'bookmarks', $targets, $class);
+    }
+
+    /**
+     * Check if user is bookmarked given item.
+     *
+     * @param int|array|\Illuminate\Database\Eloquent\Model $target
+     * @param string                                        $class
+     *
+     * @return bool
+     */
+    public function hasBookmarked($target, $class = __CLASS__)
+    {
+        return Follow::isRelationExists($this, 'bookmarks', $target, $class);
+    }
+
+    /**
+     * Return item bookmarks.
+     *
+     * @param string $class
+     *
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
+     */
+    public function bookmarks($class = __CLASS__)
+    {
+        return $this->morphedByMany($class, config('follow.morph_prefix'), config('follow.followable_table'))
+                    ->wherePivot('relation', '=', Follow::RELATION_BOOKMARK)
+                    ->withPivot('followable_type', 'relation', 'created_at');
+    }
+}