Merge.

Author: overtrue

.travis.yml

@@ -1,9 +1,9 @@
 language: php
 
 php:
-  - 5.6
   - 7.0
   - 7.1
+  - 7.2
 
 dist: trusty
 sudo: false

README.md

@@ -18,12 +18,18 @@
 - Support actions:
     - Follow
     - Like
+    - Bookmark
     - Subscribe
     - Favorite
     - Vote (Upvote & Downvote)
 
 ## Installation
 
+### Required
+
+- PHP 7.0 +
+- Laravel 5.5 +
+
 You can install the package using composer
 
 ```sh
@@ -76,10 +82,11 @@ use Overtrue\LaravelFollow\Traits\CanLike;
 use Overtrue\LaravelFollow\Traits\CanFavorite;
 use Overtrue\LaravelFollow\Traits\CanSubscribe;
 use Overtrue\LaravelFollow\Traits\CanVote;
+use Overtrue\LaravelFollow\Traits\CanBookmark;
 
 class User extends Model
 {
-    use CanFollow, CanLike, CanFavorite, CanSubscribe, CanVote;
+    use CanFollow, CanBookmark, CanLike, CanFavorite, CanSubscribe, CanVote;
 }
 ```
 
@@ -89,10 +96,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\CanBeBookmarked;
 
 class Post extends Model
 {
-    use CanBeLiked, CanBeFavorited, CanBeVoted;
+    use CanBeLiked, CanBeFavorited, CanBeVoted, CanBeBookmarked;
 }
 ```
 
@@ -108,6 +116,7 @@ $user->unfollow($targets)
 $user->toggleFollow($targets)
 $user->followings()->get() // App\User:class
 $user->followings(App\Post::class)->get()
+$user->areFollowingEachOther($anotherUser);
 $user->isFollowing($target)
 ```
 
@@ -118,6 +127,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`

composer.json

@@ -2,10 +2,10 @@
     "name": "overtrue/laravel-follow",
     "description": "Laravel 5 User Based System",
     "require": {
-        "php": ">=5.5.9"
+        "php": ">=7.0"
     },
     "require-dev": {
-        "laravel/laravel": "5.*",
+        "laravel/laravel": "~5.5",
         "phpunit/phpunit": "~5.0",
         "mockery/mockery": "1.0.x-dev"
     },

database/migrations/create_laravel_follow_tables.php renamed to database/migrations/2018_06_29_032244_create_laravel_follow_tables.php

@@ -10,7 +10,6 @@
  */
 
 namespace Overtrue\LaravelFollow\Events;
-use Illuminate\Database\Eloquent\Model;
 
 /**
  * Class RelationToggled.
@@ -20,7 +19,9 @@
 class RelationToggled extends Event
 {
     public $results = [];
+
     public $attached = [];
+
     public $detached = [];
 
     /**

src/Events/RelationToggled.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',
@@ -72,6 +76,8 @@ public static function isRelationExists(Model $model, $relation, $target, $class
 
         $relationKey = $class ? 'followable_id' : config('follow.users_table_foreign_key', 'user_id');
 
+        $relationKey = self::tablePrefixedField($relationKey);
+
         if ($model->relationLoaded($relation)) {
             return $model->{$relation}->where($relationKey, head($target->ids))->isNotEmpty();
         }
@@ -217,4 +223,14 @@ protected static function getRelationTypeFromRelation(MorphToMany $relation)
 
         return self::RELATION_TYPES[$relation->getRelationName()];
     }
+
+    /**
+     * @param string $field
+     *
+     * @return string
+     */
+    protected static function tablePrefixedField($field)
+    {
+        return \sprintf('%s.%s', config('follow.followable_table'), $field);
+    }
 }

src/Follow.php

@@ -20,27 +20,20 @@ class FollowServiceProvider extends ServiceProvider
      */
     public function boot()
     {
-        $root = dirname(__DIR__);
+        $this->publishes([
+            realpath(__DIR__.'/../config/follow.php') => config_path('follow.php'),
+        ], 'config');
 
-        if (!file_exists(config_path('follow.php'))) {
-            $this->publishes([
-                $root.'/config/follow.php' => config_path('follow.php'),
-            ], 'config');
-        }
-
-        if (!class_exists('CreateLaravelFollowTables')) {
-            $datePrefix = date('Y_m_d_His');
-            $this->publishes([
-                $root.'/database/migrations/create_laravel_follow_tables.php' => database_path("/migrations/{$datePrefix}_create_laravel_follow_tables.php"),
-            ], 'migrations');
-        }
+        $this->publishes([
+            realpath(__DIR__.'/../database/migrations') => database_path('migrations'),
+        ], 'migrations');
     }
 
     /**
      * Register the service provider.
      */
     public function register()
     {
-        $this->mergeConfigFrom(dirname(__DIR__).'/config/follow.php', 'follow');
+        $this->mergeConfigFrom(realpath(__DIR__.'/../config/follow.php'), 'follow');
     }
 }

src/FollowServiceProvider.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/CanBeBookmarked.php

@@ -11,6 +11,7 @@
 
 namespace Overtrue\LaravelFollow\Traits;
 
+use Illuminate\Support\Facades\DB;
 use Overtrue\LaravelFollow\Follow;
 
 /**
@@ -37,8 +38,19 @@ public function isFollowedBy($user)
      */
     public function followers()
     {
+        $table = config('follow.followable_table');
+        $class = \get_class($this);
+        $userTable = config('follow.user_table', 'users');
+        $foreignKey = config('follow.users_table_foreign_key', 'user_id');
+
         return $this->morphToMany(config('follow.user_model'), config('follow.morph_prefix'), config('follow.followable_table'))
                     ->wherePivot('relation', '=', Follow::RELATION_FOLLOW)
-                    ->withPivot('followable_type', 'relation', 'created_at');
+                    ->withPivot('followable_type', 'relation', 'created_at')
+                    ->addSelect("{$userTable}.*", DB::raw("pivot_followables.{$foreignKey} IS NOT NULL AS pivot_each_other"))
+                    ->leftJoin("{$table} as pivot_followables", function ($join) use ($table, $class, $foreignKey) {
+                        $join->on('pivot_followables.followable_type', '=', DB::raw(\addcslashes("'{$class}'", '\\')))
+                            ->on('pivot_followables.followable_id', '=', "{$table}.{$foreignKey}")
+                            ->on("pivot_followables.{$foreignKey}", '=', "{$table}.followable_id");
+                    });
     }
 }

src/Traits/CanBeFollowed.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');
+    }
+}