Add sets for performers (#54)

* add Sets

* add set to generate function

* add set to generate function

* fix variable type

* fix set-ids

* Update doc comment - add sets variable

* fix code style

* update tests

Author: AlexSrc-2

README.md

@@ -78,6 +78,14 @@ $categories[] = (new Category())
     ->setName($this->faker->name)
 ;
 
+// Creating sets array
+$categories = [];
+$categories[] = (new Set())
+    ->setId('s1')
+    ->setName('Set name')
+    ->setUrl('https://google.com')
+;
+
 // Creating offers array (https://yandex.ru/support/webmaster/goods-prices/technical-requirements.xml#offers)
 $offers = [];
 $offers[] = (new OfferSimple())

src/Generator.php

@@ -19,6 +19,7 @@
 use Bukashk0zzz\YmlGenerator\Model\Offer\OfferInterface;
 use Bukashk0zzz\YmlGenerator\Model\Offer\OfferOutlet;
 use Bukashk0zzz\YmlGenerator\Model\Offer\OfferParam;
+use Bukashk0zzz\YmlGenerator\Model\Set;
 use Bukashk0zzz\YmlGenerator\Model\ShopInfo;
 
 /**
@@ -74,10 +75,11 @@ public function __construct($settings = null)
      * @param iterable $categories
      * @param iterable $offers
      * @param iterable $deliveries
+     * @param iterable $sets
      *
      * @return bool
      */
-    public function generate(ShopInfo $shopInfo, iterable $currencies, iterable $categories, iterable $offers, iterable $deliveries = [])
+    public function generate(ShopInfo $shopInfo, iterable $currencies, iterable $categories, iterable $offers, iterable $deliveries = [], iterable $sets = [])
     {
         try {
             $this->addHeader();
@@ -86,6 +88,10 @@ public function generate(ShopInfo $shopInfo, iterable $currencies, iterable $cat
             $this->addCurrencies($currencies);
             $this->addCategories($categories);
 
+            if (\count($sets) !== 0) {
+                $this->addSets($sets);
+            }
+
             if (\count($deliveries) !== 0) {
                 $this->addDeliveries($deliveries);
             }
@@ -156,6 +162,25 @@ protected function addCurrency(Currency $currency)
         $this->writer->endElement();
     }
 
+    /**
+     * @param Set $set
+     */
+    protected function addSet(Set $set)
+    {
+        $this->writer->startElement('set');
+        $this->writer->writeAttribute('id', $set->getId());
+
+        if ($set->getName() !== null) {
+            $this->writer->writeElement('name', $set->getName());
+        }
+
+        if ($set->getUrl() !== null) {
+            $this->writer->writeElement('url', $set->getUrl());
+        }
+
+        $this->writer->fullEndElement();
+    }
+
     /**
      * @param Category $category
      */
@@ -245,6 +270,25 @@ private function addCurrencies(iterable $currencies)
         $this->writer->fullEndElement();
     }
 
+    /**
+     * Adds <sets> element.
+     *
+     * @param iterable $sets
+     */
+    private function addSets(iterable $sets)
+    {
+        $this->writer->startElement('sets');
+
+        /** @var Set $set */
+        foreach ($sets as $set) {
+            if ($set instanceof Set) {
+                $this->addSet($set);
+            }
+        }
+
+        $this->writer->fullEndElement();
+    }
+
     /**
      * Adds <categories> element. (See https://yandex.ru/support/webmaster/goods-prices/technical-requirements.xml#categories)
      *

src/Model/Offer/AbstractOffer.php

@@ -63,6 +63,16 @@ abstract class AbstractOffer implements OfferInterface
      */
     private $categoriesId = [];
 
+    /**
+     * @var string
+     */
+    private $setId;
+
+    /**
+     * @var array
+     */
+    private $setsId = [];
+
     /**
      * @var string
      */
@@ -329,6 +339,46 @@ public function setCurrencyId($currencyId)
         return $this;
     }
 
+    /**
+     * @return string
+     */
+    public function getSetId()
+    {
+        return $this->setId;
+    }
+
+    /**
+     * @param string $setId
+     *
+     * @return $this
+     */
+    public function setSetId($setId)
+    {
+        $this->setId = $setId;
+
+        return $this;
+    }
+
+    /**
+     * @return array
+     */
+    public function getSetsId()
+    {
+        return $this->setsId;
+    }
+
+    /**
+     * @param array $setsId
+     *
+     * @return $this
+     */
+    public function setSetsId(array $setsId)
+    {
+        $this->setsId = $setsId;
+
+        return $this;
+    }
+
     /**
      * @return int
      */
@@ -927,6 +977,11 @@ abstract protected function getOptions();
      */
     private function getHeaderOptions()
     {
+        $sets = \array_unique(\array_merge(
+            !empty($this->getSetId()) ? [$this->getSetId()] : [],
+            $this->getSetsId()
+        ));
+
         return [
                 'url' => $this->getUrl(),
                 'price' => $this->getPrice(),
@@ -937,6 +992,7 @@ private function getHeaderOptions()
                     [$this->getCategoryId()],
                     $this->getCategoriesId()
                 ),
+                'set-ids' => empty($sets) ? null : \implode(',', $sets),
                 'market_category' => $this->getMarketCategory(),
                 'picture' => $this->getPictures(),
                 'pickup' => $this->isPickup(),

src/Model/Set.php

@@ -0,0 +1,93 @@
+<?php
+
+/*
+ * This file is part of the Bukashk0zzzYmlGenerator
+ *
+ * (c) Denis Golubovskiy <bukashk0zzz@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Bukashk0zzz\YmlGenerator\Model;
+
+/**
+ * Class Set
+ */
+class Set
+{
+    /**
+     * @var string
+     */
+    private $id;
+
+    /**
+     * @var string
+     */
+    private $name;
+
+    /**
+     * @var string
+     */
+    private $url;
+
+    /**
+     * @return string
+     */
+    public function getId()
+    {
+        return $this->id;
+    }
+
+    /**
+     * @param string $id
+     *
+     * @return Set
+     */
+    public function setId($id)
+    {
+        $this->id = $id;
+
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getUrl()
+    {
+        return $this->url;
+    }
+
+    /**
+     * @param string $url
+     *
+     * @return Set
+     */
+    public function setUrl($url)
+    {
+        $this->url = $url;
+
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getName()
+    {
+        return $this->name;
+    }
+
+    /**
+     * @param string $name
+     *
+     * @return Set
+     */
+    public function setName($name)
+    {
+        $this->name = $name;
+
+        return $this;
+    }
+}

tests/AbstractGeneratorTest.php

@@ -15,6 +15,7 @@
 use Bukashk0zzz\YmlGenerator\Model\Category;
 use Bukashk0zzz\YmlGenerator\Model\Currency;
 use Bukashk0zzz\YmlGenerator\Model\Delivery;
+use Bukashk0zzz\YmlGenerator\Model\Set;
 use Bukashk0zzz\YmlGenerator\Model\ShopInfo;
 use Bukashk0zzz\YmlGenerator\Settings;
 use Faker\Factory as Faker;
@@ -45,6 +46,11 @@ abstract class AbstractGeneratorTest extends TestCase
      */
     protected $currencies;
 
+    /**
+     * @var array
+     */
+    protected $sets;
+
     /**
      * @var array
      */
@@ -72,6 +78,7 @@ protected function setUp(): void
         $this->currencies = $this->createCurrencies();
         $this->categories = $this->createCategories();
         $this->deliveries = $this->createDeliveries();
+        $this->sets = $this->createSets();
     }
 
     /**
@@ -89,7 +96,8 @@ protected function generateFile()
             $this->currencies,
             $this->categories,
             $this->createOffers(),
-            $this->deliveries
+            $this->deliveries,
+            $this->sets
         ));
     }
 
@@ -125,6 +133,7 @@ protected function createOffers()
                 )
                 ->setCurrencyId('UAH')
                 ->setCategoryId($id)
+                ->setSetsId(['setId1', 'setId2'])
                 ->setDelivery($this->faker->boolean)
                 ->setLocalDeliveryCost($this->faker->numberBetween(1, 9999))
                 ->setDescription($this->faker->sentence)
@@ -213,6 +222,27 @@ private function createCurrencies()
         return $currencies;
     }
 
+    /**
+     * @return array
+     */
+    private function createSets()
+    {
+        $sets = [];
+        $sets[] = (new Set())
+            ->setId('setId1')
+            ->setName($this->faker->name)
+            ->setUrl($this->faker->url)
+        ;
+
+        $sets[] = (new Set())
+            ->setId('setId2')
+            ->setName($this->faker->name)
+            ->setName($this->faker->url)
+        ;
+
+        return $sets;
+    }
+
     /**
      * @return array
      */

tests/dtd/ArtistTitle.dtd

@@ -2,7 +2,7 @@
 <!ATTLIST yml_catalog
     date CDATA #REQUIRED>
 
-<!ELEMENT shop (name, company, url, phone?, platform?, version?, agency?, email*, enable_auto_discounts?, currencies, categories, delivery-options, store?, pickup?, delivery?, deliveryIncluded?, local_delivery_cost?, adult?, offers)>
+<!ELEMENT shop (name, company, url, phone?, platform?, version?, agency?, email*, enable_auto_discounts?, currencies, categories, sets?, delivery-options, store?, pickup?, delivery?, deliveryIncluded?, local_delivery_cost?, adult?, offers)>
 <!ELEMENT company (#PCDATA)>
 <!ELEMENT phone (#PCDATA)>
 
@@ -13,6 +13,10 @@
     rate CDATA "1"
     plus CDATA "0">
 
+<!ELEMENT sets (set+)>
+<!ELEMENT set (name?, url?)>
+<!ATTLIST set
+        id CDATA #REQUIRED>
 
 <!ELEMENT categories (category+)>
 <!ELEMENT category (#PCDATA)>
@@ -40,6 +44,7 @@
     currencyId,
     xCategory?,
     categoryId+,
+    set-ids?,
     market_category?,
     delivery?,
     local_delivery_cost?,
@@ -143,6 +148,7 @@
 <!ELEMENT description (#PCDATA)>
 <!ELEMENT sales_notes (#PCDATA)>
 <!ELEMENT promo (#PCDATA)>
+<!ELEMENT set-ids (#PCDATA)>
 <!ELEMENT aliases (#PCDATA)>
 <!ELEMENT provider (#PCDATA)>
 <!ELEMENT tarifplan (#PCDATA)>