Generator::addDelivery() - Code Metrics - Inspection of "Add delivery and pickup" - Bukashk0zzz/YmlGenerator - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 4a8227...2407ef )

by Bukashk0zzz

created 2017-10-23 09:19 UTC

Generator::addDelivery() A

↳ Parent: Generator

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	7

Duplication

Lines	10
Ratio	100 %

Importance

Changes

Metric	Value
dl	10
loc	10
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	7
nc	2
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\OfferInterface;
use Bukashk0zzz\YmlGenerator\Model\Offer\OfferParam;
use Bukashk0zzz\YmlGenerator\Model\ShopInfo;

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

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

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

    /**
     * Generator constructor.
     *
     * @param Settings $settings
     */
    public function __construct($settings = null)
    {
        $this->settings = $settings instanceof Settings ? $settings : new Settings();
        $this->tmpFile = $this->settings->getOutputFile() !== null ? \tempnam(\sys_get_temp_dir(), 'YMLGenerator') : 'php://output';

        $this->writer = new \XMLWriter();
        $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 (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());
        }

        $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());
        }

        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->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 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 string $name
     * @param mixed  $value
     *
     * @return bool
     */
    private function addOfferElement($name, $value)
    {
        if ($value === null) {
            return false;
        }

        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\OfferInterface;
18		use Bukashk0zzz\YmlGenerator\Model\Offer\OfferParam;
19		use Bukashk0zzz\YmlGenerator\Model\ShopInfo;
20
21		/**
22		* Class Generator
23		*/
24		class Generator
25		{
26		/**
27		* @var string
28		*/
29		private $tmpFile;
30
31		/**
32		* @var \XMLWriter
33		*/
34		private $writer;
35
36		/**
37		* @var Settings
38		*/
39		private $settings;
40
41		/**
42		* Generator constructor.
43		*
44		* @param Settings $settings
45		*/
46		public function __construct($settings = null)
47		{
48		$this->settings = $settings instanceof Settings ? $settings : new Settings();
49		$this->tmpFile = $this->settings->getOutputFile() !== null ? \tempnam(\sys_get_temp_dir(), 'YMLGenerator') : 'php://output';
50
51		$this->writer = new \XMLWriter();
52		$this->writer->openURI($this->tmpFile);
53
54		if ($this->settings->getIndentString()) {
55		$this->writer->setIndentString($this->settings->getIndentString());
56		$this->writer->setIndent(true);
57		}
58		}
59
60		/**
61		* @param ShopInfo $shopInfo
62		* @param array $currencies
63		* @param array $categories
64		* @param array $offers
65		* @param array $deliveries
66		*
67		* @return bool
68		*/
69		public function generate(ShopInfo $shopInfo, array $currencies, array $categories, array $offers, array $deliveries = [])
70		{
71		try {
72		$this->addHeader();
73
74		$this->addShopInfo($shopInfo);
75		$this->addCurrencies($currencies);
76		$this->addCategories($categories);
77
78		if (\count($deliveries) !== 0) {
79		$this->addDeliveries($deliveries);
80		}
81
82		$this->addOffers($offers);
83		$this->addFooter();
84
85		if (null !== $this->settings->getOutputFile()) {
86		\copy($this->tmpFile, $this->settings->getOutputFile());
87		@\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...
88		}
89
90		return true;
91		} catch (\Exception $exception) {
92		throw new \RuntimeException(\sprintf('Problem with generating YML file: %s', $exception->getMessage()), 0, $exception);
93		}
94		}
95
96		/**
97		* Add document header
98		*/
99		protected function addHeader()
100		{
101		$this->writer->startDocument('1.0', $this->settings->getEncoding());
102		$this->writer->startDTD('yml_catalog', null, 'shops.dtd');
103		$this->writer->endDTD();
104		$this->writer->startElement('yml_catalog');
105		$this->writer->writeAttribute('date', \date('Y-m-d H:i'));
106		$this->writer->startElement('shop');
107		}
108
109		/**
110		* Add document footer
111		*/
112		protected function addFooter()
113		{
114		$this->writer->fullEndElement();
115		$this->writer->fullEndElement();
116		$this->writer->endDocument();
117		}
118
119		/**
120		* Adds shop element data. (See https://yandex.ru/support/webmaster/goods-prices/technical-requirements.xml#shop)
121		*
122		* @param ShopInfo $shopInfo
123		*/
124		protected function addShopInfo(ShopInfo $shopInfo)
125		{
126		foreach ($shopInfo->toArray() as $name => $value) {
127		if ($value !== null) {
128		$this->writer->writeElement($name, $value);
129		}
130		}
131		}
132
133		/**
134		* @param Currency $currency
135		*/
136		protected function addCurrency(Currency $currency)
137		{
138		$this->writer->startElement('currency');
139		$this->writer->writeAttribute('id', $currency->getId());
140		$this->writer->writeAttribute('rate', $currency->getRate());
141		$this->writer->endElement();
142		}
143
144		/**
145		* @param Category $category
146		*/
147	View Code Duplication	protected function addCategory(Category $category)
		0 ignored issues – show Duplication introduced 2017-10-23 09:20 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
148		{
149		$this->writer->startElement('category');
150		$this->writer->writeAttribute('id', $category->getId());
151
152		if ($category->getParentId() !== null) {
153		$this->writer->writeAttribute('parentId', $category->getParentId());
154		}
155
156		$this->writer->text($category->getName());
157		$this->writer->fullEndElement();
158		}
159
160		/**
161		* @param Delivery $delivery
162		*/
163	View Code Duplication	protected function addDelivery(Delivery $delivery)
		0 ignored issues – show Duplication introduced 2017-10-23 09:20 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
164		{
165		$this->writer->startElement('option');
166		$this->writer->writeAttribute('cost', $delivery->getCost());
167		$this->writer->writeAttribute('days', $delivery->getDays());
168		if ($delivery->getOrderBefore() !== null) {
169		$this->writer->writeAttribute('order-before', $delivery->getOrderBefore());
170		}
171		$this->writer->endElement();
172		}
173
174		/**
175		* @param OfferInterface $offer
176		*/
177		protected function addOffer(OfferInterface $offer)
178		{
179		$this->writer->startElement('offer');
180		$this->writer->writeAttribute('id', $offer->getId());
181		$this->writer->writeAttribute('available', $offer->isAvailable() ? 'true' : 'false');
182
183		if ($offer->getType() !== null) {
184		$this->writer->writeAttribute('type', $offer->getType());
185		}
186
187		foreach ($offer->toArray() as $name => $value) {
188		if (\is_array($value)) {
189		foreach ($value as $itemValue) {
190		$this->addOfferElement($name, $itemValue);
191		}
192		} else {
193		$this->addOfferElement($name, $value);
194		}
195		}
196		$this->addOfferParams($offer);
197
198		$this->writer->fullEndElement();
199		}
200
201		/**
202		* Adds <currencies> element. (See https://yandex.ru/support/webmaster/goods-prices/technical-requirements.xml#currencies)
203		*
204		* @param array $currencies
205		*/
206		private function addCurrencies(array $currencies)
207		{
208		$this->writer->startElement('currencies');
209
210		/** @var Currency $currency */
211		foreach ($currencies as $currency) {
212		if ($currency instanceof Currency) {
213		$this->addCurrency($currency);
214		}
215		}
216
217		$this->writer->fullEndElement();
218		}
219
220		/**
221		* Adds <categories> element. (See https://yandex.ru/support/webmaster/goods-prices/technical-requirements.xml#categories)
222		*
223		* @param array $categories
224		*/
225		private function addCategories(array $categories)
226		{
227		$this->writer->startElement('categories');
228
229		/** @var Category $category */
230		foreach ($categories as $category) {
231		if ($category instanceof Category) {
232		$this->addCategory($category);
233		}
234		}
235
236		$this->writer->fullEndElement();
237		}
238
239		/**
240		* Adds <delivery-option> element. (See https://yandex.ru/support/partnermarket/elements/delivery-options.xml)
241		*
242		* @param array $deliveries
243		*/
244		private function addDeliveries(array $deliveries)
245		{
246		$this->writer->startElement('delivery-options');
247
248		/** @var Delivery $delivery */
249		foreach ($deliveries as $delivery) {
250		if ($delivery instanceof Delivery) {
251		$this->addDelivery($delivery);
252		}
253		}
254
255		$this->writer->fullEndElement();
256		}
257
258		/**
259		* Adds <offers> element. (See https://yandex.ru/support/webmaster/goods-prices/technical-requirements.xml#offers)
260		*
261		* @param array $offers
262		*/
263		private function addOffers(array $offers)
264		{
265		$this->writer->startElement('offers');
266
267		/** @var OfferInterface $offer */
268		foreach ($offers as $offer) {
269		if ($offer instanceof OfferInterface) {
270		$this->addOffer($offer);
271		}
272		}
273
274		$this->writer->fullEndElement();
275		}
276
277		/**
278		* @param OfferInterface $offer
279		*/
280		private function addOfferParams(OfferInterface $offer)
281		{
282		/** @var OfferParam $param */
283		foreach ($offer->getParams() as $param) {
284		if ($param instanceof OfferParam) {
285		$this->writer->startElement('param');
286
287		$this->writer->writeAttribute('name', $param->getName());
288		if ($param->getUnit()) {
289		$this->writer->writeAttribute('unit', $param->getUnit());
290		}
291		$this->writer->text($param->getValue());
292
293		$this->writer->endElement();
294		}
295		}
296		}
297
298		/**
299		* @param string $name
300		* @param mixed $value
301		*
302		* @return bool
303		*/
304		private function addOfferElement($name, $value)
305		{
306		if ($value === null) {
307		return false;
308		}
309
310		if (\is_bool($value)) {
311		$value = $value ? 'true' : 'false';
312		}
313		$this->writer->writeElement($name, $value);
314
315		return true;
316		}
317		}
318

Bukashk0zzz / YmlGenerator

Push — master ( 4a8227...2407ef )

Generator::addDelivery() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like