Feature/194 add crm status

.php-cs-fixer.php

@@ -12,6 +12,7 @@
     ->in(__DIR__ . '/src/Services/CRM/Quote/')
     ->in(__DIR__ . '/src/Services/CRM/Lead/')
     ->in(__DIR__ . '/src/Services/CRM/Currency/')
+    ->in(__DIR__ . '/src/Services/CRM/Status/')
     ->name('*.php')
     ->exclude(['vendor', 'storage', 'docker', 'docs']) // Exclude directories
     ->ignoreDotFiles(true)

CHANGELOG.md

@@ -4,6 +4,18 @@
 
 ### Added
 
+- Added service `Services\CRM\Status\Service\Status` with support methods,
+  see [crm.status.* methods](https://github.com/bitrix24/b24phpsdk/issues/194):
+    - `fields` returns descriptions of reference book fields
+    - `get` returns an element of the reference book by its identifier
+    - `list` returns a list of elements of the reference book by filter, with batch calls support
+    - `add` creates a new element in the specified reference book, with batch calls support
+    - `delete` deletes an element from the reference book, with batch calls support
+    - `update` updates an existing element of the reference book, with batch calls support
+    - `countByFilter` counts elements of the reference book by filter
+- Added service `Services\CRM\Status\Service\StatusEntity` with support methods,
+    - `items` returns elements of the reference book by its symbolic identifier
+    - `types` returns descriptions of reference book types
 - Added service `Services\CRM\Lead\Service\LeadContact` with support methods,
   see [crm.lead.contact.* methods](https://github.com/bitrix24/b24phpsdk/issues/170):
     - `fields` get fiels for lead contact connection

Makefile

@@ -238,6 +238,10 @@ integration_tests_lead_productrows:
 .PHONY: integration_tests_crm_quote
 integration_tests_crm_quote:
 	docker-compose run --rm php-cli vendor/bin/phpunit --testsuite integration_tests_crm_quote
+
+.PHONY: integration_tests_crm_status
+integration_tests_crm_status:
+	docker-compose run --rm php-cli vendor/bin/phpunit --testsuite integration_tests_crm_status
 
 # work dev environment
 .PHONY: php-dev-server-up

phpstan.neon.dist

@@ -26,6 +26,7 @@ parameters:
     - tests/Integration/Services/CRM/Quote/Service/QuoteProductRowsTest.php
     - tests/Integration/Services/CRM/Lead/Service/LeadUserfieldTest.php
     - tests/Integration/Services/CRM/Currency
+    - tests/Integration/Services/CRM/Status
   bootstrapFiles:
     - tests/bootstrap.php
   parallel:

phpunit.xml.dist

@@ -85,6 +85,9 @@
         <testsuite name="integration_tests_crm_quote">
             <directory>./tests/Integration/Services/CRM/Quote/</directory>
         </testsuite>
+        <testsuite name="integration_tests_crm_status">
+            <directory>./tests/Integration/Services/CRM/Status/</directory>
+        </testsuite>
     </testsuites>
     <source>
         <include>

src/Services/CRM/CRMServiceBuilder.php

@@ -528,4 +528,29 @@ public function duplicate(): Duplicates\Service\Duplicate
 
         return $this->serviceCache[__METHOD__];
     }
+
+    public function status(): Status\Service\Status
+    {
+        if (!isset($this->serviceCache[__METHOD__])) {
+            $this->serviceCache[__METHOD__] = new Status\Service\Status(
+                new Status\Service\Batch($this->batch, $this->log),
+                $this->core,
+                $this->log
+            );
+        }
+
+        return $this->serviceCache[__METHOD__];
+    }
+
+    public function statusEntity(): Status\Service\StatusEntity
+    {
+        if (!isset($this->serviceCache[__METHOD__])) {
+            $this->serviceCache[__METHOD__] = new Status\Service\StatusEntity(
+                $this->core,
+                $this->log
+            );
+        }
+
+        return $this->serviceCache[__METHOD__];
+    }
 }

src/Services/CRM/Status/Result/StatusEntitiesResult.php

@@ -0,0 +1,40 @@
+<?php
+
+/**
+ * This file is part of the bitrix24-php-sdk package.
+ *
+ * © Vadim Soluyanov <[email protected]>
+ *
+ * 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\Services\CRM\Status\Result;
+
+use Bitrix24\SDK\Core\Exceptions\BaseException;
+use Bitrix24\SDK\Core\Result\AbstractResult;
+
+/**
+ * Class StatusEntitiesResult
+ *
+ * @package Bitrix24\SDK\Services\CRM\Status\Result
+ */
+class StatusEntitiesResult extends AbstractResult
+{
+    /**
+     * @return StatusEntityItemResult[]
+     * @throws BaseException
+     */
+    public function getEntities(): array
+    {
+        $res = [];
+        foreach ($this->getCoreResponse()->getResponseData()->getResult() as $item) {
+            $res[] = new StatusEntityItemResult($item);
+        }
+
+        return $res;
+    }
+}

src/Services/CRM/Status/Result/StatusEntityItemResult.php

@@ -0,0 +1,25 @@
+<?php
+
+/**
+ * This file is part of the bitrix24-php-sdk package.
+ *
+ * © Vadim Soluyanov <[email protected]>
+ *
+ * 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\Services\CRM\Status\Result;
+
+use Bitrix24\SDK\Services\CRM\Common\Result\AbstractCrmItem;
+
+/**
+ * @property-read string $NAME
+ * @property-read int $SORT
+ * @property-read string $STATUS_ID
+ */
+class StatusEntityItemResult extends AbstractCrmItem
+{
+}

src/Services/CRM/Status/Result/StatusEntityTypeItemResult.php

@@ -0,0 +1,31 @@
+<?php
+
+/**
+ * This file is part of the bitrix24-php-sdk package.
+ *
+ * © Vadim Soluyanov <[email protected]>
+ *
+ * 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\Services\CRM\Status\Result;
+
+use Bitrix24\SDK\Services\CRM\Common\Result\AbstractCrmItem;
+
+/**
+ * @property-read string $ID
+ * @property-read string $NAME
+ * @property-read string $PARENT_ID
+ * @property-read array $SEMANTIC_INFO
+ * @property-read int $ENTITY_TYPE_ID
+ * @property-read string $PREFIX
+ * @property-read string $FIELD_ATTRIBUTE_SCOPE
+ * @property-read int $CATEGORY_ID
+ * @property-read bool $IS_ENABLED
+ */
+class StatusEntityTypeItemResult extends AbstractCrmItem
+{
+}

src/Services/CRM/Status/Result/StatusEntityTypesResult.php

@@ -0,0 +1,40 @@
+<?php
+
+/**
+ * This file is part of the bitrix24-php-sdk package.
+ *
+ * © Vadim Soluyanov <[email protected]>
+ *
+ * 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\Services\CRM\Status\Result;
+
+use Bitrix24\SDK\Core\Exceptions\BaseException;
+use Bitrix24\SDK\Core\Result\AbstractResult;
+
+/**
+ * Class StatusEntityTypesResult
+ *
+ * @package Bitrix24\SDK\Services\CRM\Status\Result
+ */
+class StatusEntityTypesResult extends AbstractResult
+{
+    /**
+     * @return StatusEntityTypeItemResult[]
+     * @throws BaseException
+     */
+    public function getEntityTypes(): array
+    {
+        $res = [];
+        foreach ($this->getCoreResponse()->getResponseData()->getResult() as $item) {
+            $res[] = new StatusEntityTypeItemResult($item);
+        }
+
+        return $res;
+    }
+}

src/Services/CRM/Status/Result/StatusItemResult.php

@@ -0,0 +1,35 @@
+<?php
+
+/**
+ * This file is part of the bitrix24-php-sdk package.
+ *
+ * © Vadim Soluyanov <[email protected]>
+ *
+ * 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\Services\CRM\Status\Result;
+
+use Bitrix24\SDK\Services\CRM\Common\Result\AbstractCrmItem;
+
+/**
+ * Class StatusItemResult
+ *
+ * @property-read int $ID
+ * @property-read string|null $ENTITY_ID
+ * @property-read string|null $STATUS_ID
+ * @property-read int|null $SORT
+ * @property-read string|null $NAME
+ * @property-read string|null $NAME_INIT
+ * @property-read bool|null $SYSTEM
+ * @property-read int|null $CATEGORY_ID
+ * @property-read string|null $COLOR
+ * @property-read bool|null $SEMANTICS
+ * @property-read array|null $EXTRA
+ */
+class StatusItemResult extends AbstractCrmItem
+{
+}

src/Services/CRM/Status/Result/StatusResult.php

@@ -0,0 +1,33 @@
+<?php
+
+/**
+ * This file is part of the bitrix24-php-sdk package.
+ *
+ * © Vadim Soluyanov <[email protected]>
+ *
+ * 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\Services\CRM\Status\Result;
+
+use Bitrix24\SDK\Core\Result\AbstractResult;
+
+/**
+ * Class StatusResult
+ *
+ * @package Bitrix24\SDK\Services\CRM\Status\Result
+ */
+class StatusResult extends AbstractResult
+{
+    /**
+     * @throws \Bitrix24\SDK\Core\Exceptions\BaseException
+     */
+    public function status(): StatusItemResult
+    {
+        return new StatusItemResult($this->getCoreResponse()->getResponseData()->getResult());
+    }
+}

src/Services/CRM/Status/Result/StatusesResult.php

@@ -0,0 +1,40 @@
+<?php
+
+/**
+ * This file is part of the bitrix24-php-sdk package.
+ *
+ * © Vadim Soluyanov <[email protected]>
+ *
+ * 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\Services\CRM\Status\Result;
+
+use Bitrix24\SDK\Core\Exceptions\BaseException;
+use Bitrix24\SDK\Core\Result\AbstractResult;
+
+/**
+ * Class StatusesResult
+ *
+ * @package Bitrix24\SDK\Services\CRM\Status\Result
+ */
+class StatusesResult extends AbstractResult
+{
+    /**
+     * @return StatusItemResult[]
+     * @throws BaseException
+     */
+    public function getStatuses(): array
+    {
+        $items = [];
+        foreach ($this->getCoreResponse()->getResponseData()->getResult() as $item) {
+            $items[] = new StatusItemResult($item);
+        }
+
+        return $items;
+    }
+}