Feature/553 add catalog.product property feature

.php-cs-fixer.php

@@ -29,6 +29,7 @@
     ->in(__DIR__ . '/src/Services/SonetGroup/')
     ->in(__DIR__ . '/src/Services/IMOpenLines/')
     ->in(__DIR__ . '/src/Services/Landing/')
+    ->in(__DIR__ . '/src/Services/Catalog/')
     ->name('*.php')
     ->exclude(['vendor', 'storage', 'docker', 'docs']) // Exclude directories
     ->ignoreDotFiles(true)

CHANGELOG.md

@@ -4,6 +4,15 @@
 
 ### Added
 
+- Added service `Services\Catalog\ProductPropertyFeature` with support for `catalog.productPropertyFeature.*`
+  methods,
+  see [catalog.productPropertyFeature.* methods](https://apidocs.bitrix24.com/api-reference/catalog/product-property-feature/index.html) ([#553](https://github.com/bitrix24/b24phpsdk/issues/553)):
+    - `add` adds a parameter (feature) for a product or variation property
+    - `update` updates a parameter of a product or variation property by id
+    - `get` returns a product or variation property parameter by id
+    - `list` returns the list of product/variation property parameters matching the filter
+    - `getAvailableFeaturesByProperty` returns the list of available parameters for a given property
+    - `getFields` returns the description of product/variation property parameter fields
 - Added service `Services\Landing\Site\Service\Site` with support methods,
   see [landing.site.* methods](https://github.com/bitrix24/b24phpsdk/issues/267):
     - `add` adds a site

Makefile

@@ -492,6 +492,10 @@ test-integration-landing-role:
 test-integration-landing-repowidget:
 	docker compose run --rm php-cli vendor/bin/phpunit --testsuite integration_tests_landing_repowidget
 
+.PHONY: test-integration-catalog-product-property-feature
+test-integration-catalog-product-property-feature:
+	docker compose run --rm php-cli vendor/bin/phpunit --testsuite integration_tests_catalog_product_property_feature
+
 # work dev environment
 .PHONY: php-dev-server-up
 php-dev-server-up:

phpunit.xml.dist

@@ -262,6 +262,9 @@
         <testsuite name="integration_tests_landing_repowidget">
             <directory>./tests/Integration/Services/Landing/RepoWidget/</directory>
         </testsuite>
+        <testsuite name="integration_tests_catalog_product_property_feature">
+            <directory>./tests/Integration/Services/Catalog/ProductPropertyFeature/</directory>
+        </testsuite>
     </testsuites>
     <source>
         <include>

src/Services/Catalog/Catalog/Result/CatalogItemResult.php

@@ -29,4 +29,4 @@
  */
 class CatalogItemResult extends AbstractCatalogItem
 {
-}
+}

src/Services/Catalog/Catalog/Result/CatalogResult.php

@@ -21,4 +21,4 @@ public function catalog(): CatalogItemResult
     {
         return new CatalogItemResult($this->getCoreResponse()->getResponseData()->getResult()['catalog']);
     }
-}
+}

src/Services/Catalog/Catalog/Result/CatalogsResult.php

@@ -32,4 +32,4 @@ public function getCatalogs(): array
 
         return $res;
     }
-}
+}

src/Services/Catalog/Catalog/Service/Catalog.php

@@ -82,4 +82,4 @@ public function fields(): FieldsResult
     {
         return new FieldsResult($this->core->call('catalog.catalog.getFields'));
     }
-}
+}

src/Services/Catalog/CatalogServiceBuilder.php

@@ -17,6 +17,7 @@
 use Bitrix24\SDK\Core\Credentials\Scope;
 use Bitrix24\SDK\Services\AbstractServiceBuilder;
 use Bitrix24\SDK\Services\Catalog;
+
 #[ApiServiceBuilderMetadata(new Scope(['catalog']))]
 class CatalogServiceBuilder extends AbstractServiceBuilder
 {
@@ -44,4 +45,23 @@ public function catalog(): Catalog\Catalog\Service\Catalog
 
         return $this->serviceCache[__METHOD__];
     }
-}
+
+    public function productPropertyFeature(): Catalog\ProductPropertyFeature\Service\ProductPropertyFeature
+    {
+        if (!isset($this->serviceCache[__METHOD__])) {
+            // Use specialized Batch for ProductPropertyFeature to ensure correct REST parameter mapping
+            // (lowercase 'id' key, unlike the base Batch default of uppercase 'ID')
+            $productPropertyFeatureBatch = new Catalog\ProductPropertyFeature\Batch(
+                $this->core,
+                $this->log
+            );
+            $this->serviceCache[__METHOD__] = new Catalog\ProductPropertyFeature\Service\ProductPropertyFeature(
+                new Catalog\ProductPropertyFeature\Service\Batch($productPropertyFeatureBatch, $this->log),
+                $this->core,
+                $this->log
+            );
+        }
+
+        return $this->serviceCache[__METHOD__];
+    }
+}

src/Services/Catalog/Common/ProductType.php

@@ -20,4 +20,4 @@ enum ProductType: int
     case SKU = 3;
     case productOffer = 4;
     case genericOffer = 5;
-}
+}

src/Services/Catalog/Common/Result/AbstractCatalogItem.php

@@ -109,4 +109,4 @@ protected function getKeyWithUserfieldByFieldName(string $fieldName)
 
         return $this->$fieldName;
     }
-}
+}

src/Services/Catalog/Product/Result/ProductItemResult.php

@@ -52,4 +52,4 @@
  */
 class ProductItemResult extends AbstractCatalogItem
 {
-}
+}

src/Services/Catalog/Product/Result/ProductResult.php

@@ -26,4 +26,4 @@ public function product(): ProductItemResult
 
         return new ProductItemResult($this->getCoreResponse()->getResponseData()->getResult()['product']);
     }
-}
+}

src/Services/Catalog/Product/Result/ProductsResult.php

@@ -31,4 +31,4 @@ public function getProducts(): array
 
         return $res;
     }
-}
+}

src/Services/Catalog/Product/Service/Batch.php

@@ -25,7 +25,7 @@
 {
     public function __construct(
         protected BatchOperationsInterface $batch,
-        protected LoggerInterface          $log)
-    {
+        protected LoggerInterface          $log
+    ) {
     }
-}
+}

src/Services/Catalog/Product/Service/Product.php

@@ -25,7 +25,6 @@
 use Bitrix24\SDK\Services\Catalog\Common\ProductType;
 use Bitrix24\SDK\Services\Catalog\Product\Result\ProductResult;
 use Bitrix24\SDK\Services\Catalog\Product\Result\ProductsResult;
-
 use Psr\Log\LoggerInterface;
 
 #[ApiServiceMetadata(new Scope(['catalog']))]
@@ -35,8 +34,7 @@ public function __construct(
         public Batch           $batch,
         CoreInterface   $core,
         LoggerInterface $logger
-    )
-    {
+    ) {
         parent::__construct($core, $logger);
     }
 
@@ -71,7 +69,9 @@ public function get(int $productId): ProductResult
     )]
     public function add(array $productFields): ProductResult
     {
-        return new ProductResult($this->core->call('catalog.product.add', [
+        return new ProductResult($this->core->call(
+            'catalog.product.add',
+            [
                 'fields' => $productFields
             ]
         ));
@@ -140,4 +140,4 @@ public function fieldsByFilter(int $iblockId, ProductType $productType, ?array $
 
         return new FieldsResult($this->core->call('catalog.product.getFieldsByFilter', ['filter' => $filter]));
     }
-}
+}

src/Services/Catalog/ProductPropertyFeature/Batch.php

@@ -0,0 +1,47 @@
+<?php
+
+/**
+ * This file is part of the bitrix24-php-sdk package.
+ *
+ * © Dmitriy Ignatenko <algonexys@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\Services\Catalog\ProductPropertyFeature;
+
+use Bitrix24\SDK\Core\Response\DTO\ResponseData;
+
+/**
+ * Class Batch
+ *
+ * Overrides base Batch to handle differences in catalog.productPropertyFeature.* REST methods:
+ * - the id key is lowercase 'id', not 'ID' as assumed by the base class default
+ * - catalog.productPropertyFeature.list wraps list items under the 'productPropertyFeatures' key
+ *   instead of returning a flat array in 'result', as the base class assumes for non-CRM methods
+ *
+ * @see https://apidocs.bitrix24.com/api-reference/catalog/product-property-feature/catalog-product-property-feature-list.html
+ */
+class Batch extends \Bitrix24\SDK\Core\Batch
+{
+    /**
+     * Determines the ID key — lowercase 'id' for catalog.productPropertyFeature.*
+     */
+    #[\Override]
+    protected function determineKeyId(string $apiMethod, ?array $additionalParameters): string
+    {
+        return 'id';
+    }
+
+    /**
+     * Extracts list items from the 'productPropertyFeatures' key of the batch/list result
+     */
+    #[\Override]
+    protected function extractElementsFromBatchResult(ResponseData $responseData, bool $isCrmItemsInBatch): array
+    {
+        return $responseData->getResult()['productPropertyFeatures'] ?? [];
+    }
+}

src/Services/Catalog/ProductPropertyFeature/Result/AvailableFeatureItemResult.php

@@ -0,0 +1,25 @@
+<?php
+
+/**
+ * This file is part of the bitrix24-php-sdk package.
+ *
+ * © Dmitriy Ignatenko <algonexys@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\Services\Catalog\ProductPropertyFeature\Result;
+
+use Bitrix24\SDK\Core\Result\AbstractItem;
+
+/**
+ * @property-read string $featureId
+ * @property-read string $featureName
+ * @property-read string $moduleId
+ */
+class AvailableFeatureItemResult extends AbstractItem
+{
+}

src/Services/Catalog/ProductPropertyFeature/Result/AvailableFeaturesResult.php

@@ -0,0 +1,35 @@
+<?php
+
+/**
+ * This file is part of the bitrix24-php-sdk package.
+ *
+ * © Dmitriy Ignatenko <algonexys@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\Services\Catalog\ProductPropertyFeature\Result;
+
+use Bitrix24\SDK\Core\Exceptions\BaseException;
+use Bitrix24\SDK\Core\Result\AbstractResult;
+
+class AvailableFeaturesResult extends AbstractResult
+{
+    /**
+     * @return AvailableFeatureItemResult[]
+     * @throws BaseException
+     */
+    public function features(): array
+    {
+        $items = [];
+        $result = $this->getCoreResponse()->getResponseData()->getResult();
+        foreach (($result['features'] ?? []) as $item) {
+            $items[] = new AvailableFeatureItemResult($item);
+        }
+
+        return $items;
+    }
+}

src/Services/Catalog/ProductPropertyFeature/Result/ProductPropertyFeatureAddedBatchResult.php

@@ -0,0 +1,25 @@
+<?php
+
+/**
+ * This file is part of the bitrix24-php-sdk package.
+ *
+ * © Dmitriy Ignatenko <algonexys@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\Services\Catalog\ProductPropertyFeature\Result;
+
+use Bitrix24\SDK\Core\Result\AddedItemBatchResult;
+
+class ProductPropertyFeatureAddedBatchResult extends AddedItemBatchResult
+{
+    #[\Override]
+    public function getId(): int
+    {
+        return (int)($this->getResponseData()->getResult()['productPropertyFeature']['id'] ?? 0);
+    }
+}

src/Services/Catalog/ProductPropertyFeature/Result/ProductPropertyFeatureAddedResult.php

@@ -0,0 +1,27 @@
+<?php
+
+/**
+ * This file is part of the bitrix24-php-sdk package.
+ *
+ * © Dmitriy Ignatenko <algonexys@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\Services\Catalog\ProductPropertyFeature\Result;
+
+use Bitrix24\SDK\Core\Exceptions\BaseException;
+
+class ProductPropertyFeatureAddedResult extends ProductPropertyFeatureResult
+{
+    /**
+     * @throws BaseException
+     */
+    public function getId(): int
+    {
+        return (int)($this->productPropertyFeature()->id ?? 0);
+    }
+}

src/Services/Catalog/ProductPropertyFeature/Result/ProductPropertyFeatureFieldsResult.php

@@ -0,0 +1,29 @@
+<?php
+
+/**
+ * This file is part of the bitrix24-php-sdk package.
+ *
+ * © Dmitriy Ignatenko <algonexys@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\Services\Catalog\ProductPropertyFeature\Result;
+
+use Bitrix24\SDK\Core\Exceptions\BaseException;
+use Bitrix24\SDK\Core\Result\FieldsResult;
+
+class ProductPropertyFeatureFieldsResult extends FieldsResult
+{
+    /**
+     * @throws BaseException
+     */
+    #[\Override]
+    public function getFieldsDescription(): array
+    {
+        return $this->getCoreResponse()->getResponseData()->getResult()['productPropertyFeature'] ?? [];
+    }
+}