Merge pull request #9 from yii-podium/feature/disconnect-members

Removed unfriend and unignore methods in favor of disconnect method

Author: Bizley

docs/en/account.md

@@ -32,6 +32,7 @@ component's ID or configuration array that can be resolved as the above. Default
 - [createForum](#createforum)
 - [createPost](#createpost)
 - [createThread](#createthread)
+- [disconnectMember](#disconnectmember)
 - [edit](#edit)
 - [getMembership](#getmembership)
 - [getPodium](#getpodium)
@@ -48,8 +49,6 @@ component's ID or configuration array that can be resolved as the above. Default
 - [thumbDownPost](#thumbdownpost)
 - [thumbResetPost](#thumbresetpost)
 - [thumbUpPost](#thumbuppost)
-- [unfriendMember](#unfriendmember)
-- [unignoreMember](#unignoremember)
 - [unsubscribeThread](#unsubscribethread)
 - [votePoll](#votepoll)
 
@@ -116,6 +115,16 @@ Creates a thread under the parent forum as the current user. See [create](thread
 
 ---
 
+### disconnectMember
+
+```
+disconnectMember(Podium\Api\Interfaces\MemberRepositoryInterface $target): Podium\Api\PodiumResponse
+```
+
+Disconnects the target member from the current user. See [disconnect](member.md#disconnect).
+
+---
+
 ### edit
 
 ```
@@ -280,26 +289,6 @@ Gives the post a thumb up from the current user. See [thumbUp](post.md#thumbup).
 
 ---
 
-### unfriendMember
-
-```
-unfriendMember(Podium\Api\Interfaces\MemberRepositoryInterface $target): Podium\Api\PodiumResponse
-```
-
-Unfriends the target member as the current user. See [unfriend](member.md#unfriend).
-
----
-
-### unignoreMember
-
-```
-unignoreMember(Podium\Api\Interfaces\MemberRepositoryInterface $target): Podium\Api\PodiumResponse
-```
-
-Unignores the target member as the current user. See [unignore](member.md#unignore).
-
----
-
 ### unsubscribeThread
 
 ```

docs/en/member.md

@@ -46,6 +46,7 @@ or component's ID or configuration array that can be resolved as the above. Defa
 
 - [ban](#ban)
 - [befriend](#befriend)
+- [disconnect](#disconnect)
 - [edit](#edit)
 - [getAcquaintance](#getacquaintance)
 - [getAcquaintanceRepository](#getacquaintancerepository)
@@ -57,8 +58,6 @@ or component's ID or configuration array that can be resolved as the above. Defa
 - [register](#register)
 - [remove](#remove)
 - [unban](#unban)
-- [unfriend](#unfriend)
-- [unignore](#unignore)
 
 ### ban
 
@@ -84,8 +83,8 @@ befriend(
 ): Podium\Api\PodiumResponse
 ```
 
-Befriends the target as the member if the target is not befriended already (can be ignored though). See also [unfriend](#unfriend), 
-[ignore](#ignore), and [unignore](#unignore).
+Befriends the target as the member if the target is not befriended already (can be ignored though). See also [ignore](#ignore) 
+and [disconnect](#disconnect).
 
 #### Events
 
@@ -94,6 +93,24 @@ Befriends the target as the member if the target is not befriended already (can
 
 ---
 
+### disconnect
+
+```
+disconnect(
+    Podium\Api\Interfaces\MemberRepositoryInterface $member,
+    Podium\Api\Interfaces\MemberRepositoryInterface $target
+): Podium\Api\PodiumResponse
+```
+
+Disconnects the target from the member if there is a relationship between them. See also [befriend](#befriend) and [ignore](#ignore).
+
+#### Events
+
+- `Podium\Api\Services\Member\MemberAcquaintance::EVENT_BEFORE_DISCONNECTING`
+- `Podium\Api\Services\Member\MemberAcquaintance::EVENT_AFTER_DISCONNECTING`
+
+---
+
 ### edit
 
 ```
@@ -180,7 +197,7 @@ ignore(
 ```
 
 Ignores the target as the member if the target is not ignored already (can be befriended though). Member cannot send 
-messages to the member that ignores him. See also [befriend](#unfriend), [unfriend](#unfriend), and [unignore](#unignore).
+messages to the member that ignores him. See also [befriend](#unfriend) and [disconnect](#disconnect).
 
 #### Events
 
@@ -234,42 +251,4 @@ Unbans the member. See also [ban](#ban).
 
 ---
 
-### unfriend
-
-```
-unfriend(
-    Podium\Api\Interfaces\MemberRepositoryInterface $member,
-    Podium\Api\Interfaces\MemberRepositoryInterface $target
-): Podium\Api\PodiumResponse
-```
-
-Unfriends the target as the member if the target is befriended. See also [befriend](#befriend), [ignore](#ignore), 
-and [unignore](#unignore).
-
-#### Events
-
-- `Podium\Api\Services\Member\MemberAcquaintance::EVENT_BEFORE_UNFRIENDING`
-- `Podium\Api\Services\Member\MemberAcquaintance::EVENT_AFTER_UNFRIENDING`
-
----
-
-### unignore
-
-```
-unignore(
-    Podium\Api\Interfaces\MemberRepositoryInterface $member,
-    Podium\Api\Interfaces\MemberRepositoryInterface $target
-): Podium\Api\PodiumResponse
-```
-
-Unignores the target as the member if the target is ignored. See also [befriend](#befriend), [unfriend](#unfriend), 
-and [ignore](#ignore).
-
-#### Events
-
-- `Podium\Api\Services\Member\MemberAcquaintance::EVENT_BEFORE_UNIGNORING`
-- `Podium\Api\Services\Member\MemberAcquaintance::EVENT_AFTER_UNIGNORING`
-
----
-
 [<<< Index](../README.md) | [Next >>> Message](message.md)

src/Components/Account.php

@@ -257,17 +257,6 @@ public function befriendMember(MemberRepositoryInterface $target): PodiumRespons
         return $memberComponent->befriend($this->getMembership(), $target);
     }
 
-    /**
-     * @throws InvalidConfigException|NoMembershipException
-     */
-    public function unfriendMember(MemberRepositoryInterface $target): PodiumResponse
-    {
-        /** @var MemberInterface $memberComponent */
-        $memberComponent = $this->getPodium()->getMember();
-
-        return $memberComponent->unfriend($this->getMembership(), $target);
-    }
-
     /**
      * @throws InvalidConfigException|NoMembershipException
      */
@@ -282,12 +271,12 @@ public function ignoreMember(MemberRepositoryInterface $target): PodiumResponse
     /**
      * @throws InvalidConfigException|NoMembershipException
      */
-    public function unignoreMember(MemberRepositoryInterface $target): PodiumResponse
+    public function disconnectMember(MemberRepositoryInterface $target): PodiumResponse
     {
         /** @var MemberInterface $memberComponent */
         $memberComponent = $this->getPodium()->getMember();
 
-        return $memberComponent->unignore($this->getMembership(), $target);
+        return $memberComponent->disconnect($this->getMembership(), $target);
     }
 
     /**

src/Components/Member.php

@@ -143,14 +143,6 @@ public function befriend(MemberRepositoryInterface $member, MemberRepositoryInte
         return $this->getAcquaintance()->befriend($this->getAcquaintanceRepository(), $member, $target);
     }
 
-    /**
-     * @throws InvalidConfigException
-     */
-    public function unfriend(MemberRepositoryInterface $member, MemberRepositoryInterface $target): PodiumResponse
-    {
-        return $this->getAcquaintance()->unfriend($this->getAcquaintanceRepository(), $member, $target);
-    }
-
     /**
      * @throws InvalidConfigException
      */
@@ -162,9 +154,9 @@ public function ignore(MemberRepositoryInterface $member, MemberRepositoryInterf
     /**
      * @throws InvalidConfigException
      */
-    public function unignore(MemberRepositoryInterface $member, MemberRepositoryInterface $target): PodiumResponse
+    public function disconnect(MemberRepositoryInterface $member, MemberRepositoryInterface $target): PodiumResponse
     {
-        return $this->getAcquaintance()->unignore($this->getAcquaintanceRepository(), $member, $target);
+        return $this->getAcquaintance()->disconnect($this->getAcquaintanceRepository(), $member, $target);
     }
 
     private ?BanisherInterface $banisher = null;

src/Events/AcquaintanceEvent.php

@@ -14,20 +14,15 @@ class AcquaintanceEvent extends Event
      */
     public bool $canBeFriends = true;
 
-    /**
-     * @var bool whether member can unfriend target
-     */
-    public bool $canUnfriend = true;
-
     /**
      * @var bool whether member can ignore target
      */
     public bool $canIgnore = true;
 
     /**
-     * @var bool whether member can unignore target
+     * @var bool whether member can disconnect target
      */
-    public bool $canUnignore = true;
+    public bool $canDisconnect = true;
 
     public ?AcquaintanceRepositoryInterface $repository = null;
 }

src/Interfaces/AccountInterface.php

@@ -88,20 +88,15 @@ public function edit(array $data = []): PodiumResponse;
      */
     public function befriendMember(MemberRepositoryInterface $target): PodiumResponse;
 
-    /**
-     * Unfriends the target member as the current user.
-     */
-    public function unfriendMember(MemberRepositoryInterface $target): PodiumResponse;
-
     /**
      * Ignores the target member as the current user.
      */
     public function ignoreMember(MemberRepositoryInterface $target): PodiumResponse;
 
     /**
-     * Unignores the target member as the current user.
+     * Disconnects the target member from the current user.
      */
-    public function unignoreMember(MemberRepositoryInterface $target): PodiumResponse;
+    public function disconnectMember(MemberRepositoryInterface $target): PodiumResponse;
 
     /**
      * Sends a message to the receiver as the current user.

src/Interfaces/AcquaintanceInterface.php

@@ -17,15 +17,6 @@ public function befriend(
         MemberRepositoryInterface $target
     ): PodiumResponse;
 
-    /**
-     * Handles unfriending process.
-     */
-    public function unfriend(
-        AcquaintanceRepositoryInterface $acquaintance,
-        MemberRepositoryInterface $member,
-        MemberRepositoryInterface $target
-    ): PodiumResponse;
-
     /**
      * Handles ignoring process.
      */
@@ -36,9 +27,9 @@ public function ignore(
     ): PodiumResponse;
 
     /**
-     * Handles unignoring process.
+     * Handles disconnecting process.
      */
-    public function unignore(
+    public function disconnect(
         AcquaintanceRepositoryInterface $acquaintance,
         MemberRepositoryInterface $member,
         MemberRepositoryInterface $target

src/Interfaces/MemberInterface.php

@@ -40,20 +40,15 @@ public function edit(MemberRepositoryInterface $member, array $data = []): Podiu
      */
     public function befriend(MemberRepositoryInterface $member, MemberRepositoryInterface $target): PodiumResponse;
 
-    /**
-     * Unfriends the target as the member.
-     */
-    public function unfriend(MemberRepositoryInterface $member, MemberRepositoryInterface $target): PodiumResponse;
-
     /**
      * Ignores the target as the member.
      */
     public function ignore(MemberRepositoryInterface $member, MemberRepositoryInterface $target): PodiumResponse;
 
     /**
-     * Unignores the target as the member.
+     * Disconnects the target from the member.
      */
-    public function unignore(MemberRepositoryInterface $member, MemberRepositoryInterface $target): PodiumResponse;
+    public function disconnect(MemberRepositoryInterface $member, MemberRepositoryInterface $target): PodiumResponse;
 
     /**
      * Bans the member.