Refactor changeBitrix24Partner method into linkBitrix24Partner and unlinkBitrix24Partner. Add corresponding events, update related documentation, unit tests, and CHANGELOG.

mesilov · mesilov · commit 4c9b381908d6 · 2025-06-22T20:20:49.000+06:00
Signed-off-by: mesilov &lt;mesilov.maxim@gmail.com&gt;
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -110,10 +110,13 @@
     - changed method `public function applicationInstalled(?string $applicationToken): void` application token now is nullable
     - changed method `public function applicationUninstalled(?string $applicationToken): void` application token now is nullable
     - added method `linkContactPerson(Uuid $uuid)`
+    - added method `linkBitrix24Partner()`
+    - added method `unlinkBitrix24Partner()`
     - added method `unlinkContactPerson()`
     - added method `linkBitrix24PartnerContactPerson()`
     - added method `unlinkBitrix24PartnerContactPerson()`
     - remove method `changeContactPerson(?Uuid $uuid)`
+    - remove method `changeBitrix24Partner(?Uuid $uuid)`
     - remove method `changeBitrix24PartnerContactPerson(?Uuid $uuid)`
 
 ### Statistics
diff --git a/src/Application/Contracts/ApplicationInstallations/Docs/ApplicationInstallations.md b/src/Application/Contracts/ApplicationInstallations/Docs/ApplicationInstallations.md
@@ -20,7 +20,8 @@ Optional can store links to:
 | `linkBitrix24PartnerContactPerson()`   | `void`                          | Link Bitrix24 partner contact person                                                   |                            |
 | `unlinkBitrix24PartnerContactPerson()` | `void`                          | Unlink Bitrix24 partner contact person                                                 |                            |
 | `getBitrix24PartnerId()`               | `?Uuid`                         | Returns Bitrix24 Partner id related to this installation (optional)                    |                            |
-| `changeBitrix24Partner()`              | `void`                          | Changes Bitrix24 partner                                                               |                            |
+| `linkBitrix24Partner()`                | `void`                          | Link Bitrix24 partner                                                                  |                            |
+| `unlinkBitrix24Partner()`              | `void`                          | Unlink Bitrix24 partner                                                                |                            |
 | `getExternalId()`                      | `?string`                       | Returns external id for application installation                                       |                            |
 | `setExternalId()`                      | `void`                          | Sets external id for application installation                                          | `InvalidArgumentException` |
 | `getStatus()`                          | `ApplicationInstallationStatus` | Returns application installation status                                                |                            |
diff --git a/src/Application/Contracts/ApplicationInstallations/Entity/ApplicationInstallationInterface.php b/src/Application/Contracts/ApplicationInstallations/Entity/ApplicationInstallationInterface.php
@@ -97,11 +97,18 @@ public function unlinkBitrix24PartnerContactPerson(): void;
     public function getBitrix24PartnerId(): ?Uuid;
 
     /**
-     * Change bitrix24 partner
+     * Link Bitrix24 partner
      *
-     * Change bitrix24 partner if other partner starts support client portal
+     * Link Bitrix24 partner who supports this portal
      */
-    public function changeBitrix24Partner(?Uuid $uuid): void;
+    public function linkBitrix24Partner(Uuid $uuid): void;
+
+    /**
+     * Unlink Bitrix24 partner
+     *
+     * Unlink Bitrix24 partner who stops supporting this portal
+     */
+    public function unlinkBitrix24Partner(): void;
 
     /**
      * Get external id for application installation
diff --git a/src/Application/Contracts/ApplicationInstallations/Events/ApplicationInstallationBitrix24PartnerContactPersonLinkedEvent.php b/src/Application/Contracts/ApplicationInstallations/Events/ApplicationInstallationBitrix24PartnerContactPersonLinkedEvent.php
@@ -17,13 +17,12 @@
 use Symfony\Component\Uid\Uuid;
 use Symfony\Contracts\EventDispatcher\Event;
 
-class ApplicationInstallationContactPersonChangedEvent extends Event
+class ApplicationInstallationBitrix24PartnerContactPersonLinkedEvent extends Event
 {
     public function __construct(
-        public readonly Uuid            $applicationInstallationId,
+        public readonly Uuid $applicationInstallationId,
         public readonly CarbonImmutable $timestamp,
-        public readonly ?Uuid           $previousContactPersonId,
-        public readonly ?Uuid           $currentContactPersonId)
-    {
+        public readonly Uuid $bitrix24PartnerContactPersonId
+    ) {
     }
 }
diff --git a/src/Application/Contracts/ApplicationInstallations/Events/ApplicationInstallationBitrix24PartnerContactPersonUnlinkedEvent.php b/src/Application/Contracts/ApplicationInstallations/Events/ApplicationInstallationBitrix24PartnerContactPersonUnlinkedEvent.php
@@ -17,13 +17,12 @@
 use Symfony\Component\Uid\Uuid;
 use Symfony\Contracts\EventDispatcher\Event;
 
-class ApplicationInstallationBitrix24PartnerContactPersonChangedEvent extends Event
+class ApplicationInstallationBitrix24PartnerContactPersonUnlinkedEvent extends Event
 {
     public function __construct(
-        public readonly Uuid            $applicationInstallationId,
+        public readonly Uuid $applicationInstallationId,
         public readonly CarbonImmutable $timestamp,
-        public readonly ?Uuid           $previousBitrix24PartnerContactPersonId,
-        public readonly ?Uuid           $currentBitrix24PartnerContactPersonId)
-    {
+        public readonly Uuid $unlinkedBitrix24PartnerContactPersonId
+    ) {
     }
 }
diff --git a/src/Application/Contracts/ApplicationInstallations/Events/ApplicationInstallationBitrix24PartnerLinkedEvent.php b/src/Application/Contracts/ApplicationInstallations/Events/ApplicationInstallationBitrix24PartnerLinkedEvent.php
@@ -0,0 +1,28 @@
+<?php
+
+/**
+ * This file is part of the bitrix24-php-sdk package.
+ *
+ * © Maksim Mesilov <mesilov.maxim@gmail.com>
+ *
+ * For the full copyright and license information, please view the MIT-LICENSE.txt
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Bitrix24\SDK\Application\Contracts\ApplicationInstallations\Events;
+
+use Carbon\CarbonImmutable;
+use Symfony\Component\Uid\Uuid;
+use Symfony\Contracts\EventDispatcher\Event;
+
+class ApplicationInstallationBitrix24PartnerLinkedEvent extends Event
+{
+    public function __construct(
+        public readonly Uuid $applicationInstallationId,
+        public readonly CarbonImmutable $timestamp,
+        public readonly Uuid $bitrix24PartnerId
+    ) {
+    }
+}
diff --git a/src/Application/Contracts/ApplicationInstallations/Events/ApplicationInstallationBitrix24PartnerUnlinkedEvent.php b/src/Application/Contracts/ApplicationInstallations/Events/ApplicationInstallationBitrix24PartnerUnlinkedEvent.php
@@ -0,0 +1,28 @@
+<?php
+
+/**
+ * This file is part of the bitrix24-php-sdk package.
+ *
+ * © Maksim Mesilov <mesilov.maxim@gmail.com>
+ *
+ * For the full copyright and license information, please view the MIT-LICENSE.txt
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Bitrix24\SDK\Application\Contracts\ApplicationInstallations\Events;
+
+use Carbon\CarbonImmutable;
+use Symfony\Component\Uid\Uuid;
+use Symfony\Contracts\EventDispatcher\Event;
+
+class ApplicationInstallationBitrix24PartnerUnlinkedEvent extends Event
+{
+    public function __construct(
+        public readonly Uuid $applicationInstallationId,
+        public readonly CarbonImmutable $timestamp,
+        public readonly Uuid $unlinkedBitrix24PartnerId
+    ) {
+    }
+}
diff --git a/tests/Application/Contracts/ApplicationInstallations/Entity/ApplicationInstallationInterfaceTest.php b/tests/Application/Contracts/ApplicationInstallations/Entity/ApplicationInstallationInterfaceTest.php
@@ -410,8 +410,8 @@ final public function testUnlinkBitrix24PartnerContactPerson(
 
     #[Test]
     #[DataProvider('applicationInstallationDataProvider')]
-    #[TestDox('test changeBitrix24Partner method')]
-    final public function testChangeBitrix24Partner(
+    #[TestDox('test linkBitrix24Partner method')]
+    final public function linkBitrix24Partner(
         Uuid $uuid,
         ApplicationInstallationStatus $applicationInstallationStatus,
         CarbonImmutable $createdAt,
@@ -441,11 +441,51 @@ final public function testChangeBitrix24Partner(
         );
 
         $newBitrix24PartnerUuid = Uuid::v7();
-        $installation->changeBitrix24Partner($newBitrix24PartnerUuid);
+        $installation->linkBitrix24Partner($newBitrix24PartnerUuid);
         $this->assertEquals($newBitrix24PartnerUuid, $installation->getBitrix24PartnerId());
         $this->assertFalse($installation->getCreatedAt()->equalTo($installation->getUpdatedAt()));
     }
 
+    #[Test]
+    #[DataProvider('applicationInstallationDataProvider')]
+    #[TestDox('test unlinkBitrix24Partner method')]
+    final public function unlinkBitrix24Partner(
+        Uuid $uuid,
+        ApplicationInstallationStatus $applicationInstallationStatus,
+        CarbonImmutable $createdAt,
+        CarbonImmutable $updatedAt,
+        Uuid $bitrix24AccountUuid,
+        ApplicationStatus $applicationStatus,
+        PortalLicenseFamily $portalLicenseFamily,
+        ?int $portalUsersCount,
+        ?Uuid $clientContactPersonUuid,
+        ?Uuid $partnerContactPersonUuid,
+        ?Uuid $partnerUuid,
+        ?string $externalId
+    ): void {
+        $installation = $this->createApplicationInstallationImplementation(
+            $uuid,
+            $applicationInstallationStatus,
+            $createdAt,
+            $updatedAt,
+            $bitrix24AccountUuid,
+            $applicationStatus,
+            $portalLicenseFamily,
+            $portalUsersCount,
+            $clientContactPersonUuid,
+            $partnerContactPersonUuid,
+            $partnerUuid,
+            $externalId
+        );
+
+        $newBitrix24PartnerUuid = Uuid::v7();
+        $installation->linkBitrix24Partner($newBitrix24PartnerUuid);
+        $this->assertEquals($newBitrix24PartnerUuid, $installation->getBitrix24PartnerId());
+        $installation->unlinkBitrix24Partner();
+        $this->assertNull($installation->getBitrix24PartnerId());
+        $this->assertFalse($installation->getCreatedAt()->equalTo($installation->getUpdatedAt()));
+    }
+
     #[Test]
     #[DataProvider('applicationInstallationDataProvider')]
     #[TestDox('test getExternalId method')]
diff --git a/tests/Unit/Application/Contracts/ApplicationInstallations/Entity/ApplicationInstallationReferenceEntityImplementation.php b/tests/Unit/Application/Contracts/ApplicationInstallations/Entity/ApplicationInstallationReferenceEntityImplementation.php
@@ -129,12 +129,18 @@ public function getBitrix24PartnerId(): ?Uuid
         return $this->bitrix24PartnerUuid;
     }
 
-    public function changeBitrix24Partner(?Uuid $uuid): void
+    public function linkBitrix24Partner(Uuid $uuid): void
     {
         $this->bitrix24PartnerUuid = $uuid;
         $this->updatedAt = new CarbonImmutable();
     }
 
+    public function unlinkBitrix24Partner(): void
+    {
+        $this->bitrix24PartnerUuid = null;
+        $this->updatedAt = new CarbonImmutable();
+    }
+
     public function getExternalId(): ?string
     {
         return $this->externalId;

Original file line number	Diff line number	Diff line change
`@@ -17,13 +17,12 @@`
`17`	`17`	`use Symfony\Component\Uid\Uuid;`
`18`	`18`	`use Symfony\Contracts\EventDispatcher\Event;`
`19`	`19`
`20`		`-class ApplicationInstallationContactPersonChangedEvent extends Event`
	`20`	`+class ApplicationInstallationBitrix24PartnerContactPersonLinkedEvent extends Event`
`21`	`21`	`{`
`22`	`22`	`public function __construct(`
`23`		`- public readonly Uuid $applicationInstallationId,`
	`23`	`+ public readonly Uuid $applicationInstallationId,`
`24`	`24`	`public readonly CarbonImmutable $timestamp,`
`25`		`- public readonly ?Uuid $previousContactPersonId,`
`26`		`- public readonly ?Uuid $currentContactPersonId)`
`27`		`- {`
	`25`	`+ public readonly Uuid $bitrix24PartnerContactPersonId`
	`26`	`+ ) {`
`28`	`27`	`}`
`29`	`28`	`}`
Original file line number	Diff line number	Diff line change
`@@ -129,12 +129,18 @@ public function getBitrix24PartnerId(): ?Uuid`
`129`	`129`	`return $this->bitrix24PartnerUuid;`
`130`	`130`	`}`
`131`	`131`
`132`		`- public function changeBitrix24Partner(?Uuid $uuid): void`
	`132`	`+ public function linkBitrix24Partner(Uuid $uuid): void`
`133`	`133`	`{`
`134`	`134`	`$this->bitrix24PartnerUuid = $uuid;`
`135`	`135`	`$this->updatedAt = new CarbonImmutable();`
`136`	`136`	`}`
`137`	`137`
	`138`	`+ public function unlinkBitrix24Partner(): void`
	`139`	`+ {`
	`140`	`+ $this->bitrix24PartnerUuid = null;`
	`141`	`+ $this->updatedAt = new CarbonImmutable();`
	`142`	`+ }`
	`143`	`+`
`138`	`144`	`public function getExternalId(): ?string`
`139`	`145`	`{`
`140`	`146`	`return $this->externalId;`