improve the Tags feature

Author: damms005

README.md

@@ -153,10 +153,16 @@ Talk::user(auth()->user()->id)->anyMethodHere();
 
 With Talk, you can "tag" conversations. This makes it possible for your users to uniquely identify conversations and categorized them. This is usually a very useful and invaluable tool when you want your users to add labels to their conversations. When creating tags, you can mark a tag as being "special". Special tags are tags that do not belong to any user. Hence, only one copy of a special tag can exist. With this, Talk can effectively replace the default [Laravel notification system](https://laravel.com/docs/6.x/notifications), because you can simply send a Talk message to the concerned user and labelling the conversation with a special tag (e.g. "SYSTEM_NOTIFICATION"). Then in your frontend, you can simply fetch all conversations with that label and you've got yourself a system notification! The applications of Talk tags are limitless!
 
-Please see the API Doc.
+
+Please note that you can quickly get tags that are not special tags by using the `withoutSpecialTags()` [scope of the Tag Eloquent model](https://laravel.com/docs/6.x/eloquent#local-scopes).
+
+
+#### Please see the API Doc.
+
 
 ### API List
 
+
 - [setAuthUserId](https://github.com/nahid/talk#setauthuserid)
 - [user](https://github.com/nahid/talk#user)
 - [isConversationExists](https://github.com/nahid/talk#isconversationexists)

src/Conversations/ConversationRepository.php

@@ -224,6 +224,10 @@ public function getMessagesByTagId($tagId, $userId)
 				$query->where('tags.id', $tagId);
 			},
 		])
+			->where(function ($query) use ($userId) {
+				$query->where('user_one', $userId)
+					->orWhere('user_two', $userId);
+			})
 			->get();
 	}
 

src/Tags/Tag.php

@@ -24,4 +24,11 @@ public function conversations()
 		return $this->hasMany('Nahid\Talk\Messages\Conversations', 'conversation_id')
 			->with('sender');
 	}
+
+	public function scopeWithoutSpecialTags($query)
+	{
+		return $query->where(function ($query) {
+			$query->whereNull('is_special_tag')->orWhere('is_special_tag', '!=', 1);
+		});
+	}
 }

src/Talk.php

@@ -523,7 +523,6 @@ public function getConversationsAllByUserId($senderId, $offset = 0, $take = 20)
 	public function getUserTags()
 	{
 		return Tags\Tag::where(['user_id' => $this->authUserId])
-			->where('name', '!=', Talk::STAR_TAG)
 			->get();
 	}
 
@@ -554,13 +553,13 @@ public function createTagForUser($tagName)
 	 *
 	 * @param int $conversationId
 	 * @param string $tagName
-	 * @param bool $makeItASpecialTag when set to true, ensures that only one tag with the specified name should be maintained, thus supporting use of custom "system tags" e.g. for notifications
+	 * @param bool $makeSpecialTag when set to true, ensures that only one tag with the specified name should be maintained, thus supporting use of custom "system tags" e.g. for notifications
 	 *
 	 * @return bool
 	 */
-	public function addTagToConversation($conversationId, string $tagName, bool $makeItASpecialTag = null)
+	public function addTagToConversation($conversationId, string $tagName, bool $makeSpecialTag = null)
 	{
-		$makeItASpecialTag = is_bool($makeItASpecialTag) ? $makeItASpecialTag : false;
+		$makeSpecialTag = is_bool($makeSpecialTag) ? $makeSpecialTag : false;
 
 		if (empty($tagName)) {
 			return false;
@@ -569,16 +568,16 @@ public function addTagToConversation($conversationId, string $tagName, bool $mak
 		$tag = Tags\Tag::where(['user_id' => $this->authUserId, 'name' => $tagName])->first();
 
 		//treat star tag specially
-		if ($tagName == \Nahid\Talk\Talk::STAR_TAG || $makeItASpecialTag) {
+		if ($tagName == \Nahid\Talk\Talk::STAR_TAG || $makeSpecialTag) {
 			//at any time, we want to always have only one star tag, irrespective of who created it
 			//Therefore, this will ensure that we have only one star tag in our db table
 			$tag = Tags\Tag::where(['name' => $tagName])->first();
 		}
 
 		if (is_null($tag)) {
 			//special tags do not have owners
-			if ($tagName == \Nahid\Talk\Talk::STAR_TAG || $makeItASpecialTag) {
-				$tag = Tags\Tag::create([
+			if ($tagName == \Nahid\Talk\Talk::STAR_TAG || $makeSpecialTag) {
+				$tag = Tags\Tag::forceCreate([
 					'name'           => $tagName,
 					'is_special_tag' => 1,
 				]);
@@ -611,14 +610,14 @@ public function starThisConversation($conversationId)
 	public function removeTagFromConversation($conversationId, $tagId)
 	{
 		if (!empty($conversationId) && !empty($tagId)) {
-			//confirm user owns this tag
-			$tag          = Tags\Tag::where(['user_id' => $this->authUserId, 'id' => $tagId])->firstOrFail();
 			$conversation = \Nahid\Talk\Conversations\Conversation::with('tags')
 				->where(function ($query) {
+					//just to ensure user belongs to the conversation
 					$query
 						->where("user_one", $this->authUserId)
 						->orWhere("user_two", $this->authUserId);
-				})->findOrFail($conversationId);
+				})
+				->findOrFail($conversationId);
 
 			$conversation->tags()->detach($tagId);