Merge pull request #54 from Chupocabra/refactor-members_req

Use CommonFields in MembersRequest

.github/workflows/ci.yml

@@ -15,14 +15,14 @@ jobs:
       matrix:
         php-version: ['7.3', '7.4', '8.0', '8.1']
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Setup PHP ${{ matrix.php-version }}
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php-version }}
           tools: composer:v1
       - name: Composer cache
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: ${{ env.HOME }}/.composer/cache
           key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}

phpstan-baseline.neon

@@ -1355,6 +1355,11 @@ parameters:
 			count: 1
 			path: src/Bot/Model/Request/MembersRequest.php
 
+		-
+			message: "#^Method RetailCrm\\\\Mg\\\\Bot\\\\Model\\\\Request\\\\MembersRequest\\:\\:setId\\(\\) has no return typehint specified\\.$#"
+			count: 1
+			path: src/Bot/Model/Request/MembersRequest.php
+
 		-
 			message: "#^Method RetailCrm\\\\Mg\\\\Bot\\\\Model\\\\Request\\\\MembersRequest\\:\\:setSince\\(\\) has no return typehint specified\\.$#"
 			count: 1

src/Bot/Model/Constants.php

@@ -38,6 +38,7 @@ class Constants
 
     const BOT_ROLE_DISTRIBUTOR = "distributor";
     const BOT_ROLE_RESPONSIBLE = "responsible";
+    const BOT_ROLE_HIDDEN = "hidden";
 
     const MESSAGE_SCOPE_PUBLIC  = "public";
     const MESSAGE_SCOPE_PRIVATE = "private";

src/Bot/Model/Entity/Message/Item.php

@@ -49,6 +49,15 @@ class Item implements ModelInterface
      */
     private $caption;
 
+    /**
+     * @var string $transcription
+     *
+     * @Type("string")
+     * @Accessor(getter="getTranscription",setter="setTranscription")
+     * @SkipWhenEmpty()
+     */
+    private $transcription;
+
     /**
      * @return string|null
      */
@@ -96,4 +105,20 @@ class Item implements ModelInterface
     {
         $this->caption = $caption;
     }
+
+    /**
+     * @return string|null
+     */
+    public function getTranscription(): ?string
+    {
+        return $this->transcription;
+    }
+
+    /**
+     * @param string $transcription
+     */
+    public function setTranscription(string $transcription): void
+    {
+        $this->transcription = $transcription;
+    }
 }

src/Bot/Model/Entity/User.php

@@ -142,6 +142,15 @@ class User implements ModelInterface
      */
     private $revokedAt;
 
+    /**
+     * @var bool $isSystem
+     *
+     * @Type("bool")
+     * @Accessor(getter="isSystem",setter="setIsSystem")
+     * @SkipWhenEmpty()
+     */
+    private $isSystem;
+
     /**
      * @return string|null
      */
@@ -349,4 +358,20 @@ class User implements ModelInterface
     {
         $this->revokedAt = $revokedAt;
     }
+
+    /**
+     * @return bool|null
+     */
+    public function isSystem(): ?bool
+    {
+        return $this->isSystem;
+    }
+
+    /**
+     * @param bool $isSystem
+     */
+    public function setIsSystem(bool $isSystem): void
+    {
+        $this->isSystem = $isSystem;
+    }
 }

src/Bot/Model/Request/ChatsRequest.php

@@ -24,6 +24,7 @@ class ChatsRequest implements ModelInterface
 {
     use CommonFields;
     use PageLimit;
+    use IncludeMassCommunication;
 
     /**
      * @Type("int")

src/Bot/Model/Request/DialogsRequest.php

@@ -24,6 +24,7 @@ class DialogsRequest implements ModelInterface
 {
     use CommonFields;
     use PageLimit;
+    use IncludeMassCommunication;
 
     /**
      * @var int $sinceId

src/Bot/Model/Request/IncludeMassCommunication.php

@@ -0,0 +1,48 @@
+<?php
+
+/**
+ * PHP version 7.1
+ *
+ * Common fields
+ *
+ * @package  RetailCrm\Mg\Bot\Model\Request
+ */
+
+namespace RetailCrm\Mg\Bot\Model\Request;
+
+use JMS\Serializer\Annotation\Accessor;
+use JMS\Serializer\Annotation\SkipWhenEmpty;
+use JMS\Serializer\Annotation\Type;
+
+/**
+ * CommonFields trait
+ *
+ * @package  RetailCrm\Mg\Bot\Model\Request
+ */
+trait IncludeMassCommunication
+{
+    /**
+     * @var int $includeMassCommunication
+     *
+     * @Type("int")
+     * @Accessor(getter="getIncludeMassCommunication",setter="setIncludeMassCommunication")
+     * @SkipWhenEmpty
+     */
+    private $includeMassCommunication;
+
+    /**
+     * @return int
+     */
+    public function getIncludeMassCommunication()
+    {
+        return $this->includeMassCommunication;
+    }
+
+    /**
+     * @param int $includeMassCommunication
+     */
+    public function setIncludeMassCommunication(?int $includeMassCommunication): void
+    {
+        $this->includeMassCommunication = $includeMassCommunication;
+    }
+}

src/Bot/Model/Request/MembersRequest.php

@@ -22,6 +22,7 @@ use RetailCrm\Mg\Bot\Model\ModelInterface;
  */
 class MembersRequest implements ModelInterface
 {
+    use CommonFields;
     use PageLimit;
 
     /**
@@ -51,24 +52,6 @@ class MembersRequest implements ModelInterface
      */
     private $state;
 
-    /**
-     * @var string $since
-     *
-     * @Type("string")
-     * @Accessor(getter="getSince",setter="setSince")
-     * @SkipWhenEmpty
-     */
-    private $since;
-
-    /**
-     * @var string $until
-     *
-     * @Type("string")
-     * @Accessor(getter="getUntil",setter="setUntil")
-     * @SkipWhenEmpty
-     */
-    private $until;
-
     /**
      * @return int
      */
@@ -116,36 +99,4 @@ class MembersRequest implements ModelInterface
     {
         $this->state = $state;
     }
-
-    /**
-     * @return string
-     */
-    public function getSince()
-    {
-        return $this->since;
-    }
-
-    /**
-     * @param string $since
-     */
-    public function setSince(string $since)
-    {
-        $this->since = $since;
-    }
-
-    /**
-     * @return string
-     */
-    public function getUntil()
-    {
-        return $this->until;
-    }
-
-    /**
-     * @param string $until
-     */
-    public function setUntil(string $until)
-    {
-        $this->until = $until;
-    }
 }

src/Bot/Model/Request/MessagesRequest.php

@@ -23,6 +23,7 @@ use RetailCrm\Mg\Bot\Model\ModelInterface;
 class MessagesRequest implements ModelInterface
 {
     use CommonFields;
+    use IncludeMassCommunication;
 
     /**
      * @var int $chatId