Generator::addHeader() - Code Metrics - Inspection of "Add new offer types" - Bukashk0zzz/YmlGenerator - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b73efb...175f05 )

by Bukashk0zzz

created 2016-10-19 13:31 UTC

Generator::addHeader() A

↳ Parent: Generator

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	7
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	5
nc	1
nop	0

<?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\Offer\OfferInterface;
use Bukashk0zzz\YmlGenerator\Model\Offer\OfferParam;
use Bukashk0zzz\YmlGenerator\Model\ShopInfo;

/**
 * Class Generator
 *
 * @author Denis Golubovskiy <[email protected]>
 */
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
     *
     * @return bool
     *
     * @throws \RuntimeException
     */
    public function generate(ShopInfo $shopInfo, array $currencies, array $categories, array $offers)
    {
        try {
            $this->addHeader();

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

            $this->addFooter();

            if (null !== $this->settings->getOutputFile()) {
                rename($this->tmpFile, $this->settings->getOutputFile());
            }

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

    /**
     * Add document header
     */
    protected function addHeader()
    {
        $this->writer->startDocument('1.0', $this->settings->getEncoding());
        $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 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) {
            $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 <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_array($value)) {
            /** @var string $v */
            foreach ((array) $value as $v) {
                $this->writer->writeElement($name, $v);
            }

            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\Offer\OfferInterface;
17			use Bukashk0zzz\YmlGenerator\Model\Offer\OfferParam;
18			use Bukashk0zzz\YmlGenerator\Model\ShopInfo;
19
20			/**
21			* Class Generator
22			*
23			* @author Denis Golubovskiy <[email protected]>
24			*/
25			class Generator
26			{
27			/**
28			* @var string
29			*/
30			private $tmpFile;
31
32			/**
33			* @var \XMLWriter
34			*/
35			private $writer;
36
37			/**
38			* @var Settings
39			*/
40			private $settings;
41
42			/**
43			* Generator constructor.
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			*
66			* @return bool
67			*
68			* @throws \RuntimeException
69			*/
70			public function generate(ShopInfo $shopInfo, array $currencies, array $categories, array $offers)
71			{
72			try {
73			$this->addHeader();
74
75			$this->addShopInfo($shopInfo);
76			$this->addCurrencies($currencies);
77			$this->addCategories($categories);
78			$this->addOffers($offers);
79
80			$this->addFooter();
81
82			if (null !== $this->settings->getOutputFile()) {
83			rename($this->tmpFile, $this->settings->getOutputFile());
84			}
85
86			return true;
87			} catch (\Exception $exception) {
88			throw new \RuntimeException('Problem with generating YML file: '.$exception->getMessage(), 0, $exception);
89			}
90			}
91
92			/**
93			* Add document header
94			*/
95			protected function addHeader()
96			{
97			$this->writer->startDocument('1.0', $this->settings->getEncoding());
98			$this->writer->startElement('yml_catalog');
99			$this->writer->writeAttribute('date', date('Y-m-d H:i'));
100			$this->writer->startElement('shop');
101			}
102
103			/**
104			* Add document footer
105			*/
106			protected function addFooter()
107			{
108			$this->writer->fullEndElement();
109			$this->writer->fullEndElement();
110			$this->writer->endDocument();
111			}
112
113			/**
114			* Adds shop element data. (See https://yandex.ru/support/webmaster/goods-prices/technical-requirements.xml#shop)
115			* @param ShopInfo $shopInfo
116			*/
117			protected function addShopInfo(ShopInfo $shopInfo)
118			{
119			foreach ($shopInfo->toArray() as $name => $value) {
120			if ($value !== null) {
121			$this->writer->writeElement($name, $value);
122			}
123			}
124			}
125
126			/**
127			* @param Currency $currency
128			*/
129			protected function addCurrency(Currency $currency)
130			{
131			$this->writer->startElement('currency');
132			$this->writer->writeAttribute('id', $currency->getId());
133			$this->writer->writeAttribute('rate', $currency->getRate());
134			$this->writer->endElement();
135			}
136
137			/**
138			* @param Category $category
139			*/
140			protected function addCategory(Category $category)
141			{
142			$this->writer->startElement('category');
143			$this->writer->writeAttribute('id', $category->getId());
144
145			if ($category->getParentId() !== null) {
146			$this->writer->writeAttribute('parentId', $category->getParentId());
147			}
148
149			$this->writer->text($category->getName());
150			$this->writer->fullEndElement();
151			}
152
153			/**
154			* @param OfferInterface $offer
155			*/
156			protected function addOffer(OfferInterface $offer)
157			{
158			$this->writer->startElement('offer');
159			$this->writer->writeAttribute('id', $offer->getId());
160			$this->writer->writeAttribute('available', $offer->isAvailable() ? 'true' : 'false');
161
162			if ($offer->getType() !== null) {
163			$this->writer->writeAttribute('type', $offer->getType());
164			}
165
166			foreach ($offer->toArray() as $name => $value) {
167			$this->addOfferElement($name, $value);
168			}
169			$this->addOfferParams($offer);
170
171			$this->writer->fullEndElement();
172			}
173
174			/**
175			* Adds <currencies> element. (See https://yandex.ru/support/webmaster/goods-prices/technical-requirements.xml#currencies)
176			* @param array $currencies
177			*/
178			private function addCurrencies(array $currencies)
179			{
180			$this->writer->startElement('currencies');
181
182			/** @var Currency $currency */
183			foreach ($currencies as $currency) {
184			if ($currency instanceof Currency) {
185			$this->addCurrency($currency);
186			}
187			}
188
189			$this->writer->fullEndElement();
190			}
191
192			/**
193			* Adds <categories> element. (See https://yandex.ru/support/webmaster/goods-prices/technical-requirements.xml#categories)
194			* @param array $categories
195			*/
196			private function addCategories(array $categories)
197			{
198			$this->writer->startElement('categories');
199
200			/** @var Category $category */
201			foreach ($categories as $category) {
202			if ($category instanceof Category) {
203			$this->addCategory($category);
204			}
205			}
206
207			$this->writer->fullEndElement();
208			}
209
210			/**
211			* Adds <offers> element. (See https://yandex.ru/support/webmaster/goods-prices/technical-requirements.xml#offers)
212			* @param array $offers
213			*/
214			private function addOffers(array $offers)
215			{
216			$this->writer->startElement('offers');
217
218			/** @var OfferInterface $offer */
219			foreach ($offers as $offer) {
220			if ($offer instanceof OfferInterface) {
221			$this->addOffer($offer);
222			}
223			}
224
225			$this->writer->fullEndElement();
226			}
227
228			/**
229			* @param OfferInterface $offer
230			*/
231			private function addOfferParams(OfferInterface $offer)
232			{
233			/** @var OfferParam $param */
234			foreach ($offer->getParams() as $param) {
235			if ($param instanceof OfferParam) {
236			$this->writer->startElement('param');
237
238			$this->writer->writeAttribute('name', $param->getName());
239			if ($param->getUnit()) {
240			$this->writer->writeAttribute('unit', $param->getUnit());
241			}
242			$this->writer->text($param->getValue());
243
244			$this->writer->endElement();
245			}
246			}
247			}
248
249			/**
250			* @param string $name
251			* @param mixed $value
252			* @return bool
253			*/
254			private function addOfferElement($name, $value)
255			{
256			if ($value === null) {
257			return false;
258			}
259
260			if (is_array($value)) {
261			/** @var string $v */
262			foreach ((array) $value as $v) {
263			$this->writer->writeElement($name, $v);
264			}
265
266			return true;
267			}
268
269			if (is_bool($value)) {
270			$value = $value ? 'true' : 'false';
271			}
272			$this->writer->writeElement($name, $value);
273
274			return true;
275			}
276			}
277

Bukashk0zzz / YmlGenerator

Push — master ( b73efb...175f05 )

Generator::addHeader() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like