Generator::addCategory() - Code Metrics - Bukashk0zzz/YmlGenerator - Measure and Improve Code Quality continuously with Scrutinizer

Generator::addCategory() A
last analyzed 2021-04-03 10:33 UTC

↳ Parent: Generator

Complexity

Conditions	4
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	18
rs	9.6666
c	0
b	0
f	0
cc	4
nc	4
nop	1

<?php

/*
 * This file is part of the Bukashk0zzzYmlGenerator
 *
 * (c) Denis Golubovskiy <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Bukashk0zzz\YmlGenerator;

use Bukashk0zzz\YmlGenerator\Model\Category;
use Bukashk0zzz\YmlGenerator\Model\Currency;
use Bukashk0zzz\YmlGenerator\Model\Delivery;
use Bukashk0zzz\YmlGenerator\Model\Offer\OfferCondition;
use Bukashk0zzz\YmlGenerator\Model\Offer\OfferGroupAwareInterface;
use Bukashk0zzz\YmlGenerator\Model\Offer\OfferInterface;
use Bukashk0zzz\YmlGenerator\Model\Offer\OfferParam;
use Bukashk0zzz\YmlGenerator\Model\ShopInfo;

/**
 * Class Generator
 */
class Generator
{
    /**
     * @var string
     */
    protected $tmpFile;

    /**
     * @var \XMLWriter
     */
    protected $writer;

    /**
     * @var Settings
     */
    protected $settings;

    /**
     * Generator constructor.
     *
     * @param Settings $settings
     */
    public function __construct($settings = null)
    {
        $this->settings = $settings instanceof Settings ? $settings : new Settings();
        $this->writer = new \XMLWriter();

        if ($this->settings->getOutputFile() !== null && $this->settings->getReturnResultYMLString()) {
            throw new \LogicException('Only one destination need to be used ReturnResultYMLString or OutputFile');
        }

        if ($this->settings->getReturnResultYMLString()) {
            $this->writer->openMemory();
        } else {
            $this->tmpFile = $this->settings->getOutputFile() !== null ? \tempnam(\sys_get_temp_dir(), 'YMLGenerator') : 'php://output';
            $this->writer->openURI($this->tmpFile);
        }

        if ($this->settings->getIndentString()) {
            $this->writer->setIndentString($this->settings->getIndentString());
            $this->writer->setIndent(true);
        }
    }

    /**
     * @param ShopInfo $shopInfo
     * @param array    $currencies
     * @param array    $categories
     * @param array    $offers
     * @param array    $deliveries
     *
     * @return bool
     */
    public function generate(ShopInfo $shopInfo, array $currencies, array $categories, array $offers, array $deliveries = [])
    {
        try {
            $this->addHeader();

            $this->addShopInfo($shopInfo);
            $this->addCurrencies($currencies);
            $this->addCategories($categories);

            if (\count($deliveries) !== 0) {
                $this->addDeliveries($deliveries);
            }

            $this->addOffers($offers);
            $this->addFooter();

            if ($this->settings->getReturnResultYMLString()) {
                return $this->writer->flush();
            }

            if (null !== $this->settings->getOutputFile()) {
                \copy($this->tmpFile, $this->settings->getOutputFile());
                @\unlink($this->tmpFile);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
            }

            return true;
        } catch (\Exception $exception) {
            throw new \RuntimeException(\sprintf('Problem with generating YML file: %s', $exception->getMessage()), 0, $exception);
        }
    }

    /**
     * Add document header
     */
    protected function addHeader()
    {
        $this->writer->startDocument('1.0', $this->settings->getEncoding());
        $this->writer->startDTD('yml_catalog', null, 'shops.dtd');
        $this->writer->endDTD();
        $this->writer->startElement('yml_catalog');
        $this->writer->writeAttribute('date', \date('Y-m-d H:i'));
        $this->writer->startElement('shop');
    }

    /**
     * Add document footer
     */
    protected function addFooter()
    {
        $this->writer->fullEndElement();
        $this->writer->fullEndElement();
        $this->writer->endDocument();
    }

    /**
     * Adds shop element data. (See https://yandex.ru/support/webmaster/goods-prices/technical-requirements.xml#shop)
     *
     * @param ShopInfo $shopInfo
     */
    protected function addShopInfo(ShopInfo $shopInfo)
    {
        foreach ($shopInfo->toArray() as $name => $value) {
            if ($value !== null) {
                $this->writer->writeElement($name, $value);
            }
        }
    }

    /**
     * @param Currency $currency
     */
    protected function addCurrency(Currency $currency)
    {
        $this->writer->startElement('currency');
        $this->writer->writeAttribute('id', $currency->getId());
        $this->writer->writeAttribute('rate', $currency->getRate());
        $this->writer->endElement();
    }

    /**
     * @param Category $category
     */
    protected function addCategory(Category $category)
    {
        $this->writer->startElement('category');
        $this->writer->writeAttribute('id', $category->getId());

        if ($category->getParentId() !== null) {
            $this->writer->writeAttribute('parentId', $category->getParentId());
        }

        if (!empty($category->getAttributes())) {
            foreach ($category->getAttributes() as $attribute) {
                $this->writer->writeAttribute($attribute['name'], $attribute['value']);
            }
        }

        $this->writer->text($category->getName());
        $this->writer->fullEndElement();
    }

    /**
     * @param Delivery $delivery
     */
    protected function addDelivery(Delivery $delivery)
    {
        $this->writer->startElement('option');
        $this->writer->writeAttribute('cost', $delivery->getCost());
        $this->writer->writeAttribute('days', $delivery->getDays());
        if ($delivery->getOrderBefore() !== null) {
            $this->writer->writeAttribute('order-before', $delivery->getOrderBefore());
        }
        $this->writer->endElement();
    }

    /**
     * @param OfferInterface $offer
     */
    protected function addOffer(OfferInterface $offer)
    {
        $this->writer->startElement('offer');
        $this->writer->writeAttribute('id', $offer->getId());
        $this->writer->writeAttribute('available', $offer->isAvailable() ? 'true' : 'false');

        if ($offer->getType() !== null) {
            $this->writer->writeAttribute('type', $offer->getType());
        }

        if ($offer instanceof OfferGroupAwareInterface && $offer->getGroupId() !== null) {
            $this->writer->writeAttribute('group_id', $offer->getGroupId());
        }

        foreach ($offer->toArray() as $name => $value) {
            if (\is_array($value)) {
                foreach ($value as $itemValue) {
                    $this->addOfferElement($name, $itemValue);
                }
            } else {
                $this->addOfferElement($name, $value);
            }
        }
        $this->addOfferParams($offer);
        $this->addOfferDeliveryOptions($offer);
        $this->addOfferCondition($offer);

        $this->writer->fullEndElement();
    }

    /**
     * Adds <currencies> element. (See https://yandex.ru/support/webmaster/goods-prices/technical-requirements.xml#currencies)
     *
     * @param array $currencies
     */
    private function addCurrencies(array $currencies)
    {
        $this->writer->startElement('currencies');

        /** @var Currency $currency */
        foreach ($currencies as $currency) {
            if ($currency instanceof Currency) {
                $this->addCurrency($currency);
            }
        }

        $this->writer->fullEndElement();
    }

    /**
     * Adds <categories> element. (See https://yandex.ru/support/webmaster/goods-prices/technical-requirements.xml#categories)
     *
     * @param array $categories
     */
    private function addCategories(array $categories)
    {
        $this->writer->startElement('categories');

        /** @var Category $category */
        foreach ($categories as $category) {
            if ($category instanceof Category) {
                $this->addCategory($category);
            }
        }

        $this->writer->fullEndElement();
    }

    /**
     * Adds <delivery-option> element. (See https://yandex.ru/support/partnermarket/elements/delivery-options.xml)
     *
     * @param array $deliveries
     */
    private function addDeliveries(array $deliveries)
    {
        $this->writer->startElement('delivery-options');

        /** @var Delivery $delivery */
        foreach ($deliveries as $delivery) {
            if ($delivery instanceof Delivery) {
                $this->addDelivery($delivery);
            }
        }

        $this->writer->fullEndElement();
    }

    /**
     * Adds <offers> element. (See https://yandex.ru/support/webmaster/goods-prices/technical-requirements.xml#offers)
     *
     * @param array $offers
     */
    private function addOffers(array $offers)
    {
        $this->writer->startElement('offers');

        /** @var OfferInterface $offer */
        foreach ($offers as $offer) {
            if ($offer instanceof OfferInterface) {
                $this->addOffer($offer);
            }
        }

        $this->writer->fullEndElement();
    }

    /**
     * @param OfferInterface $offer
     */
    private function addOfferDeliveryOptions(OfferInterface $offer)
    {
        $options = $offer->getDeliveryOptions();
        if (!empty($options)) {
            $this->addDeliveries($options);
        }
    }

    /**
     * @param OfferInterface $offer
     */
    private function addOfferParams(OfferInterface $offer)
    {
        /** @var OfferParam $param */
        foreach ($offer->getParams() as $param) {
            if ($param instanceof OfferParam) {
                $this->writer->startElement('param');

                $this->writer->writeAttribute('name', $param->getName());
                if ($param->getUnit()) {
                    $this->writer->writeAttribute('unit', $param->getUnit());
                }
                $this->writer->text($param->getValue());

                $this->writer->endElement();
            }
        }
    }

    /**
     * @param OfferInterface $offer
     */
    private function addOfferCondition(OfferInterface $offer)
    {
        $params = $offer->getCondition();
        if ($params instanceof OfferCondition) {
            $this->writer->startElement('condition');
            $this->writer->writeAttribute('type', $params->getType());
            $this->writer->writeElement('reason', $params->getReasonText());
            $this->writer->endElement();
        }
    }

    /**
     * @param string $name
     * @param mixed  $value
     *
     * @return bool
     */
    private function addOfferElement($name, $value)
    {
        if ($value === null) {
            return false;
        }

        if ($value instanceof Cdata) {
            $this->writer->startElement($name);
            $this->writer->writeCdata((string) $value);
            $this->writer->endElement();

            return true;
        }

        if (\is_bool($value)) {
            $value = $value ? 'true' : 'false';
        }
        $this->writer->writeElement($name, $value);

        return true;
    }
}


1			<?php
2
3			/*
4			* This file is part of the Bukashk0zzzYmlGenerator
5			*
6			* (c) Denis Golubovskiy <[email protected]>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace Bukashk0zzz\YmlGenerator;
13
14			use Bukashk0zzz\YmlGenerator\Model\Category;
15			use Bukashk0zzz\YmlGenerator\Model\Currency;
16			use Bukashk0zzz\YmlGenerator\Model\Delivery;
17			use Bukashk0zzz\YmlGenerator\Model\Offer\OfferCondition;
18			use Bukashk0zzz\YmlGenerator\Model\Offer\OfferGroupAwareInterface;
19			use Bukashk0zzz\YmlGenerator\Model\Offer\OfferInterface;
20			use Bukashk0zzz\YmlGenerator\Model\Offer\OfferParam;
21			use Bukashk0zzz\YmlGenerator\Model\ShopInfo;
22
23			/**
24			* Class Generator
25			*/
26			class Generator
27			{
28			/**
29			* @var string
30			*/
31			protected $tmpFile;
32
33			/**
34			* @var \XMLWriter
35			*/
36			protected $writer;
37
38			/**
39			* @var Settings
40			*/
41			protected $settings;
42
43			/**
44			* Generator constructor.
45			*
46			* @param Settings $settings
47			*/
48			public function __construct($settings = null)
49			{
50			$this->settings = $settings instanceof Settings ? $settings : new Settings();
51			$this->writer = new \XMLWriter();
52
53			if ($this->settings->getOutputFile() !== null && $this->settings->getReturnResultYMLString()) {
54			throw new \LogicException('Only one destination need to be used ReturnResultYMLString or OutputFile');
55			}
56
57			if ($this->settings->getReturnResultYMLString()) {
58			$this->writer->openMemory();
59			} else {
60			$this->tmpFile = $this->settings->getOutputFile() !== null ? \tempnam(\sys_get_temp_dir(), 'YMLGenerator') : 'php://output';
61			$this->writer->openURI($this->tmpFile);
62			}
63
64			if ($this->settings->getIndentString()) {
65			$this->writer->setIndentString($this->settings->getIndentString());
66			$this->writer->setIndent(true);
67			}
68			}
69
70			/**
71			* @param ShopInfo $shopInfo
72			* @param array $currencies
73			* @param array $categories
74			* @param array $offers
75			* @param array $deliveries
76			*
77			* @return bool
78			*/
79			public function generate(ShopInfo $shopInfo, array $currencies, array $categories, array $offers, array $deliveries = [])
80			{
81			try {
82			$this->addHeader();
83
84			$this->addShopInfo($shopInfo);
85			$this->addCurrencies($currencies);
86			$this->addCategories($categories);
87
88			if (\count($deliveries) !== 0) {
89			$this->addDeliveries($deliveries);
90			}
91
92			$this->addOffers($offers);
93			$this->addFooter();
94
95			if ($this->settings->getReturnResultYMLString()) {
96			return $this->writer->flush();
97			}
98
99			if (null !== $this->settings->getOutputFile()) {
100			\copy($this->tmpFile, $this->settings->getOutputFile());
101			@\unlink($this->tmpFile);
			0 ignored issues – show Security Best Practice introduced 2017-10-23 09:20 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
102			}
103
104			return true;
105			} catch (\Exception $exception) {
106			throw new \RuntimeException(\sprintf('Problem with generating YML file: %s', $exception->getMessage()), 0, $exception);
107			}
108			}
109
110			/**
111			* Add document header
112			*/
113			protected function addHeader()
114			{
115			$this->writer->startDocument('1.0', $this->settings->getEncoding());
116			$this->writer->startDTD('yml_catalog', null, 'shops.dtd');
117			$this->writer->endDTD();
118			$this->writer->startElement('yml_catalog');
119			$this->writer->writeAttribute('date', \date('Y-m-d H:i'));
120			$this->writer->startElement('shop');
121			}
122
123			/**
124			* Add document footer
125			*/
126			protected function addFooter()
127			{
128			$this->writer->fullEndElement();
129			$this->writer->fullEndElement();
130			$this->writer->endDocument();
131			}
132
133			/**
134			* Adds shop element data. (See https://yandex.ru/support/webmaster/goods-prices/technical-requirements.xml#shop)
135			*
136			* @param ShopInfo $shopInfo
137			*/
138			protected function addShopInfo(ShopInfo $shopInfo)
139			{
140			foreach ($shopInfo->toArray() as $name => $value) {
141			if ($value !== null) {
142			$this->writer->writeElement($name, $value);
143			}
144			}
145			}
146
147			/**
148			* @param Currency $currency
149			*/
150			protected function addCurrency(Currency $currency)
151			{
152			$this->writer->startElement('currency');
153			$this->writer->writeAttribute('id', $currency->getId());
154			$this->writer->writeAttribute('rate', $currency->getRate());
155			$this->writer->endElement();
156			}
157
158			/**
159			* @param Category $category
160			*/
161			protected function addCategory(Category $category)
162			{
163			$this->writer->startElement('category');
164			$this->writer->writeAttribute('id', $category->getId());
165
166			if ($category->getParentId() !== null) {
167			$this->writer->writeAttribute('parentId', $category->getParentId());
168			}
169
170			if (!empty($category->getAttributes())) {
171			foreach ($category->getAttributes() as $attribute) {
172			$this->writer->writeAttribute($attribute['name'], $attribute['value']);
173			}
174			}
175
176			$this->writer->text($category->getName());
177			$this->writer->fullEndElement();
178			}
179
180			/**
181			* @param Delivery $delivery
182			*/
183			protected function addDelivery(Delivery $delivery)
184			{
185			$this->writer->startElement('option');
186			$this->writer->writeAttribute('cost', $delivery->getCost());
187			$this->writer->writeAttribute('days', $delivery->getDays());
188			if ($delivery->getOrderBefore() !== null) {
189			$this->writer->writeAttribute('order-before', $delivery->getOrderBefore());
190			}
191			$this->writer->endElement();
192			}
193
194			/**
195			* @param OfferInterface $offer
196			*/
197			protected function addOffer(OfferInterface $offer)
198			{
199			$this->writer->startElement('offer');
200			$this->writer->writeAttribute('id', $offer->getId());
201			$this->writer->writeAttribute('available', $offer->isAvailable() ? 'true' : 'false');
202
203			if ($offer->getType() !== null) {
204			$this->writer->writeAttribute('type', $offer->getType());
205			}
206
207			if ($offer instanceof OfferGroupAwareInterface && $offer->getGroupId() !== null) {
208			$this->writer->writeAttribute('group_id', $offer->getGroupId());
209			}
210
211			foreach ($offer->toArray() as $name => $value) {
212			if (\is_array($value)) {
213			foreach ($value as $itemValue) {
214			$this->addOfferElement($name, $itemValue);
215			}
216			} else {
217			$this->addOfferElement($name, $value);
218			}
219			}
220			$this->addOfferParams($offer);
221			$this->addOfferDeliveryOptions($offer);
222			$this->addOfferCondition($offer);
223
224			$this->writer->fullEndElement();
225			}
226
227			/**
228			* Adds <currencies> element. (See https://yandex.ru/support/webmaster/goods-prices/technical-requirements.xml#currencies)
229			*
230			* @param array $currencies
231			*/
232			private function addCurrencies(array $currencies)
233			{
234			$this->writer->startElement('currencies');
235
236			/** @var Currency $currency */
237			foreach ($currencies as $currency) {
238			if ($currency instanceof Currency) {
239			$this->addCurrency($currency);
240			}
241			}
242
243			$this->writer->fullEndElement();
244			}
245
246			/**
247			* Adds <categories> element. (See https://yandex.ru/support/webmaster/goods-prices/technical-requirements.xml#categories)
248			*
249			* @param array $categories
250			*/
251			private function addCategories(array $categories)
252			{
253			$this->writer->startElement('categories');
254
255			/** @var Category $category */
256			foreach ($categories as $category) {
257			if ($category instanceof Category) {
258			$this->addCategory($category);
259			}
260			}
261
262			$this->writer->fullEndElement();
263			}
264
265			/**
266			* Adds <delivery-option> element. (See https://yandex.ru/support/partnermarket/elements/delivery-options.xml)
267			*
268			* @param array $deliveries
269			*/
270			private function addDeliveries(array $deliveries)
271			{
272			$this->writer->startElement('delivery-options');
273
274			/** @var Delivery $delivery */
275			foreach ($deliveries as $delivery) {
276			if ($delivery instanceof Delivery) {
277			$this->addDelivery($delivery);
278			}
279			}
280
281			$this->writer->fullEndElement();
282			}
283
284			/**
285			* Adds <offers> element. (See https://yandex.ru/support/webmaster/goods-prices/technical-requirements.xml#offers)
286			*
287			* @param array $offers
288			*/
289			private function addOffers(array $offers)
290			{
291			$this->writer->startElement('offers');
292
293			/** @var OfferInterface $offer */
294			foreach ($offers as $offer) {
295			if ($offer instanceof OfferInterface) {
296			$this->addOffer($offer);
297			}
298			}
299
300			$this->writer->fullEndElement();
301			}
302
303			/**
304			* @param OfferInterface $offer
305			*/
306			private function addOfferDeliveryOptions(OfferInterface $offer)
307			{
308			$options = $offer->getDeliveryOptions();
309			if (!empty($options)) {
310			$this->addDeliveries($options);
311			}
312			}
313
314			/**
315			* @param OfferInterface $offer
316			*/
317			private function addOfferParams(OfferInterface $offer)
318			{
319			/** @var OfferParam $param */
320			foreach ($offer->getParams() as $param) {
321			if ($param instanceof OfferParam) {
322			$this->writer->startElement('param');
323
324			$this->writer->writeAttribute('name', $param->getName());
325			if ($param->getUnit()) {
326			$this->writer->writeAttribute('unit', $param->getUnit());
327			}
328			$this->writer->text($param->getValue());
329
330			$this->writer->endElement();
331			}
332			}
333			}
334
335			/**
336			* @param OfferInterface $offer
337			*/
338			private function addOfferCondition(OfferInterface $offer)
339			{
340			$params = $offer->getCondition();
341			if ($params instanceof OfferCondition) {
342			$this->writer->startElement('condition');
343			$this->writer->writeAttribute('type', $params->getType());
344			$this->writer->writeElement('reason', $params->getReasonText());
345			$this->writer->endElement();
346			}
347			}
348
349			/**
350			* @param string $name
351			* @param mixed $value
352			*
353			* @return bool
354			*/
355			private function addOfferElement($name, $value)
356			{
357			if ($value === null) {
358			return false;
359			}
360
361			if ($value instanceof Cdata) {
362			$this->writer->startElement($name);
363			$this->writer->writeCdata((string) $value);
364			$this->writer->endElement();
365
366			return true;
367			}
368
369			if (\is_bool($value)) {
370			$value = $value ? 'true' : 'false';
371			}
372			$this->writer->writeElement($name, $value);
373
374			return true;
375			}
376			}
377

Bukashk0zzz / YmlGenerator

Generator::addCategory() A last analyzed 2021-04-03 10:33 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Generator::addCategory() A
last analyzed 2021-04-03 10:33 UTC