YmlCatalog::write() - Code Metrics - Inspection of "Merge pull request #45 from execut/escape-html-sym..." - pastuhov/yii2-yml-catalog - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 871cd8...ab1e03 )

by Kirill

created 2017-06-15 05:28 UTC

YmlCatalog::write() A

↳ Parent: YmlCatalog

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1.0156

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	4
ccs	3
cts	4
cp	0.75
rs	10
cc	1
eloc	2
nc	1
nop	1
crap	1.0156

<?php
namespace pastuhov\ymlcatalog;

use pastuhov\ymlcatalog\models\BaseModel;
use pastuhov\ymlcatalog\models\Category;
use pastuhov\ymlcatalog\models\Currency;
use pastuhov\ymlcatalog\models\LocalDeliveryCost;
use pastuhov\ymlcatalog\models\Shop;
use pastuhov\ymlcatalog\models\SimpleOffer;
use pastuhov\ymlcatalog\models\DeliveryOption;
use Yii;
use pastuhov\FileStream\BaseFileStream;
use yii\base\Exception;
use yii\data\ActiveDataProvider;
use yii\db\ActiveQuery;

/**
 * Yml генератор каталога.
 *
 * @package pastuhov\ymlcatalog
 */
class YmlCatalog
{
    /**
     * @var BaseFileStream
     */
    protected $handle;
    /**
     * @var string
     */
    protected $shopClass;
    /**
     * @var string
     */
    protected $currencyClass;
    /**
     * @var string
     */
    protected $categoryClass;
    /**
     * @var null|string
     */
    protected $localDeliveryCostClass;
    /**
     * @var string
     */
    protected $offerClass;
    /**
     * @var null|string
     */
    protected $date;

    /**
     * @var null|callable
     */
    protected $onValidationError;

    /**
     * @var null|string
     */
    protected $customOfferClass;

    /**
     * @var null|string
     */
    protected $deliveryOptionClass;

    /**
     * @param BaseFileStream $handle
     * @param string $shopClass class name
     * @param string $currencyClass class name
     * @param string $categoryClass class name
     * @param string $localDeliveryCostClass class name
     * @param array $offerClasses
     * @param null|string $date
     * @param null|callable $onValidationError
     * @param null|string $customOfferClass
     */
    public function __construct(
        BaseFileStream $handle,
        $shopClass,
        $currencyClass,
        $categoryClass,
        $localDeliveryCostClass = null,
        Array $offerClasses,
        $date = null,
        $onValidationError = null,
        $customOfferClass = null,
        $deliveryOptionClass = null
    ) {
        $this->handle = $handle;
        $this->shopClass = $shopClass;
        $this->currencyClass = $currencyClass;
        $this->categoryClass = $categoryClass;
        $this->localDeliveryCostClass = $localDeliveryCostClass;
        $this->offerClasses = $offerClasses;

        $this->date = $date;
        $this->onValidationError = $onValidationError;
        $this->customOfferClass = $customOfferClass;
        $this->deliveryOptionClass = $deliveryOptionClass;
    }

    /**
     * @throws Exception
     */
    public function generate()
    {
        $date = $this->getDate();

        $this->write(
            '<?xml version="1.0" encoding="utf-8"?>' . PHP_EOL .
            '<!DOCTYPE yml_catalog SYSTEM "shops.dtd">' . PHP_EOL .
            '<yml_catalog date="' . $date . '">' . PHP_EOL
        );

        $this->writeTag('shop');
        $this->writeModel(new Shop(), new $this->shopClass());
        $this->writeTag('currencies');
        $this->writeEachModel($this->currencyClass);
        $this->writeTag('/currencies');
        $this->writeTag('categories');
        $this->writeEachModel($this->categoryClass);
        $this->writeTag('/categories');
        if($this->deliveryOptionClass) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $this->writeTag('delivery-options');
            $this->writeModel(new DeliveryOption(), \Yii::createObject($this->deliveryOptionClass));
            $this->writeTag('/delivery-options');
        }
        if($this->localDeliveryCostClass) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $this->writeModel(new LocalDeliveryCost(), \Yii::createObject($this->localDeliveryCostClass));

        }
        $this->writeTag('offers');
        foreach ($this->offerClasses as $offerClass) {

            $this->writeEachModel($offerClass);
        }
        $this->writeTag('/offers');
        $this->writeTag('/shop');

        $this->write('</yml_catalog>');
    }

    /**
     * @return null|string
     */
    protected function getDate()
    {
        $date = $this->date;

        if ($date === null) {
            $date = Yii::$app->formatter->asDatetime(new \DateTime(), 'php:Y-m-d H:i');
        }

        return $date;
    }

    /**
     * @param string $string
     * @throws \Exception
     */
    protected function write($string)
    {
        $this->handle->write($string);
    }

    /**
     * @param string $string tag name
     */
    protected function writeTag($string)
    {
        $this->write('<' . $string . '>' . PHP_EOL);
    }

    /**
     * @param BaseModel $model
     * @param $valuesModel
     * @throws Exception
     */
    protected function writeModel(BaseModel $model, $valuesModel)
    {
        if (method_exists($valuesModel, 'getParams')) {
            $model->setParams($valuesModel->getParams());
        }
        if (method_exists($valuesModel, 'getPictures')) {
            $model->setPictures($valuesModel->getPictures());
        }
        if(method_exists($valuesModel, 'getDeliveryOptions')) {
            $model->setDeliveryOptions($valuesModel->getDeliveryOptions());
        }

        if($model->loadModel($valuesModel, $this->onValidationError)) {
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
            $string = $model->getYml();
            $this->write($string);
        }
    }

    /**
     * @param string|array $modelClass class name or yii configuration array. You can also set params:
     *      `findParams`:   array of additional find params;
     *      `query`:        ActiveQuery object to generate yml use already created object;
     *      `dataProvider`: ActiveDataProvider or true to generate yml with pagination;
     */
    protected function writeEachModel($modelClass)
    {
        /**
         * @var mixed
         */
        $findParams = [];

        /**
         * @var ActiveQuery
         */
        $query = null;

        /**
         * @var ActiveDataProvider
         */
        $dataProvider = null;

        if (is_array($modelClass)) {
            foreach (['findParams', 'query', 'dataProvider'] as $name) {
                if (array_key_exists($name, $modelClass)) {
                    $$name = $modelClass[$name];
                    unset($modelClass[$name]);
                }
            }
        }

        /**
         * @var BaseFindYmlInterface $class
         */
        $class = \Yii::createObject($modelClass);

        /**
         * @var ReaderInterface
         */
        $reader = ReaderFactory::build(
            $class,
            $dataProvider,
            $query,
            $findParams
        );

        $newModel = $this->getNewModel($class);

        foreach ($reader as $models) {
            foreach ($models as $model) {
                $this->writeModel($newModel, $model);
            }
            $this->gc();
        }
    }

    /**
     * @param $modelClass
     * @return Category|Currency|SimpleOffer
     * @throws Exception
     */
    protected function getNewModel($modelClass)
    {
        $obj = is_object($modelClass) ? $modelClass : \Yii::createObject($modelClass);

        if ($obj instanceof CurrencyInterface) {
            $model = new Currency();
        } elseif ($obj instanceof CategoryInterface) {
            $model = new Category();
        } elseif ($obj instanceof CustomOfferInterface && $this->customOfferClass !== null && class_exists($this->customOfferClass)) {
            $model = \Yii::createObject($this->customOfferClass);
        } elseif ($obj instanceof SimpleOfferInterface) {
            $model = new SimpleOffer();
        } else {
            throw new Exception('Model ' . get_class($obj) . ' has unknown interface');
        }

        return $model;
    }
    
    /**
     * Performs PHP memory garbage collection.
     */
    protected function gc()
    {
        if (!gc_enabled()) {
            gc_enable();
        }
        gc_collect_cycles();
    }
}


1		<?php
2		namespace pastuhov\ymlcatalog;
3
4		use pastuhov\ymlcatalog\models\BaseModel;
5		use pastuhov\ymlcatalog\models\Category;
6		use pastuhov\ymlcatalog\models\Currency;
7		use pastuhov\ymlcatalog\models\LocalDeliveryCost;
8		use pastuhov\ymlcatalog\models\Shop;
9		use pastuhov\ymlcatalog\models\SimpleOffer;
10		use pastuhov\ymlcatalog\models\DeliveryOption;
11		use Yii;
12		use pastuhov\FileStream\BaseFileStream;
13		use yii\base\Exception;
14		use yii\data\ActiveDataProvider;
15		use yii\db\ActiveQuery;
16
17		/**
18		* Yml генератор каталога.
19		*
20		* @package pastuhov\ymlcatalog
21		*/
22		class YmlCatalog
23		{
24		/**
25		* @var BaseFileStream
26		*/
27		protected $handle;
28		/**
29		* @var string
30		*/
31		protected $shopClass;
32		/**
33		* @var string
34		*/
35		protected $currencyClass;
36		/**
37		* @var string
38		*/
39		protected $categoryClass;
40		/**
41		* @var null\|string
42		*/
43		protected $localDeliveryCostClass;
44		/**
45		* @var string
46		*/
47		protected $offerClass;
48		/**
49		* @var null\|string
50		*/
51		protected $date;
52
53		/**
54		* @var null\|callable
55		*/
56		protected $onValidationError;
57
58		/**
59		* @var null\|string
60		*/
61		protected $customOfferClass;
62
63		/**
64		* @var null\|string
65		*/
66		protected $deliveryOptionClass;
67
68		/**
69		* @param BaseFileStream $handle
70		* @param string $shopClass class name
71		* @param string $currencyClass class name
72		* @param string $categoryClass class name
73		* @param string $localDeliveryCostClass class name
74		* @param array $offerClasses
75		* @param null\|string $date
76		* @param null\|callable $onValidationError
77		* @param null\|string $customOfferClass
78		*/
79	5	public function __construct(
80		BaseFileStream $handle,
81		$shopClass,
82		$currencyClass,
83		$categoryClass,
84		$localDeliveryCostClass = null,
85		Array $offerClasses,
86		$date = null,
87		$onValidationError = null,
88		$customOfferClass = null,
89		$deliveryOptionClass = null
90		) {
91	5	$this->handle = $handle;
92	5	$this->shopClass = $shopClass;
93	5	$this->currencyClass = $currencyClass;
94	5	$this->categoryClass = $categoryClass;
95	5	$this->localDeliveryCostClass = $localDeliveryCostClass;
96	5	$this->offerClasses = $offerClasses;
		0 ignored issues – show Bug introduced 2016-01-15 12:20 UTC by Report Bug Copy Issue Report The property `offerClasses` does not seem to exist. Did you mean `offerClass`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
97	5	$this->date = $date;
98	5	$this->onValidationError = $onValidationError;
99	5	$this->customOfferClass = $customOfferClass;
100	5	$this->deliveryOptionClass = $deliveryOptionClass;
101	5	}
102
103		/**
104		* @throws Exception
105		*/
106	5	public function generate()
107		{
108	5	$date = $this->getDate();
109
110	5	$this->write(
111	5	'<?xml version="1.0" encoding="utf-8"?>' . PHP_EOL .
112	5	'<!DOCTYPE yml_catalog SYSTEM "shops.dtd">' . PHP_EOL .
113	5	'<yml_catalog date="' . $date . '">' . PHP_EOL
114	5	);
115
116	5	$this->writeTag('shop');
117	5	$this->writeModel(new Shop(), new $this->shopClass());
118	5	$this->writeTag('currencies');
119	5	$this->writeEachModel($this->currencyClass);
120	5	$this->writeTag('/currencies');
121	5	$this->writeTag('categories');
122	5	$this->writeEachModel($this->categoryClass);
123	5	$this->writeTag('/categories');
124	5	if($this->deliveryOptionClass) {
		0 ignored issues – show Bug Best Practice introduced 2016-08-23 05:49 UTC by Report Bug Copy Issue Report The expression `$this->deliveryOptionClass` of type `null\|string` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
125	4	$this->writeTag('delivery-options');
126	4	$this->writeModel(new DeliveryOption(), \Yii::createObject($this->deliveryOptionClass));
127	4	$this->writeTag('/delivery-options');
128	4	}
129	5	if($this->localDeliveryCostClass) {
		0 ignored issues – show Bug Best Practice introduced 2016-08-23 05:49 UTC by Report Bug Copy Issue Report The expression `$this->localDeliveryCostClass` of type `null\|string` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
130	1	$this->writeModel(new LocalDeliveryCost(), \Yii::createObject($this->localDeliveryCostClass));
		0 ignored issues – show Deprecated Code introduced 2016-08-23 06:53 UTC by Report Bug Copy Issue Report The class `pastuhov\ymlcatalog\models\LocalDeliveryCost` has been deprecated. This class, trait or interface has been deprecated. Loading history...
131	1	}
132	5	$this->writeTag('offers');
133	5	foreach ($this->offerClasses as $offerClass) {
		0 ignored issues – show Bug introduced 2016-01-15 12:20 UTC by Report Bug Copy Issue Report The property `offerClasses` does not seem to exist. Did you mean `offerClass`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
134	5	$this->writeEachModel($offerClass);
135	4	}
136	4	$this->writeTag('/offers');
137	4	$this->writeTag('/shop');
138
139	4	$this->write('</yml_catalog>');
140	4	}
141
142		/**
143		* @return null\|string
144		*/
145	5	protected function getDate()
146		{
147	5	$date = $this->date;
148
149	5	if ($date === null) {
150	1	$date = Yii::$app->formatter->asDatetime(new \DateTime(), 'php:Y-m-d H:i');
151	1	}
152
153	5	return $date;
154		}
155
156		/**
157		* @param string $string
158		* @throws \Exception
159		*/
160	5	protected function write($string)
161		{
162	5	$this->handle->write($string);
163	5	}
164
165		/**
166		* @param string $string tag name
167		*/
168	5	protected function writeTag($string)
169		{
170	5	$this->write('<' . $string . '>' . PHP_EOL);
171	5	}
172
173		/**
174		* @param BaseModel $model
175		* @param $valuesModel
176		* @throws Exception
177		*/
178	5	protected function writeModel(BaseModel $model, $valuesModel)
179		{
180	5	if (method_exists($valuesModel, 'getParams')) {
181	5	$model->setParams($valuesModel->getParams());
182	5	}
183	5	if (method_exists($valuesModel, 'getPictures')) {
184	5	$model->setPictures($valuesModel->getPictures());
185	5	}
186	5	if(method_exists($valuesModel, 'getDeliveryOptions')) {
187	5	$model->setDeliveryOptions($valuesModel->getDeliveryOptions());
188	5	}
189
190	5	if($model->loadModel($valuesModel, $this->onValidationError)) {
		0 ignored issues – show Bug introduced 2016-09-15 06:16 UTC by Report Bug Copy Issue Report It seems like `$this->onValidationError` can also be of type `callable`; however, `pastuhov\ymlcatalog\models\BaseModel::loadModel()` does only seem to accept `null`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
191	5	$string = $model->getYml();
192	5	$this->write($string);
193	5	}
194	5	}
195
196		/**
197		* @param string\|array $modelClass class name or yii configuration array. You can also set params:
198		* `findParams`: array of additional find params;
199		* `query`: ActiveQuery object to generate yml use already created object;
200		* `dataProvider`: ActiveDataProvider or true to generate yml with pagination;
201		*/
202	5	protected function writeEachModel($modelClass)
203		{
204		/**
205		* @var mixed
206		*/
207	5	$findParams = [];
208
209		/**
210		* @var ActiveQuery
211		*/
212	5	$query = null;
213
214		/**
215		* @var ActiveDataProvider
216		*/
217	5	$dataProvider = null;
218
219	5	if (is_array($modelClass)) {
220	4	foreach (['findParams', 'query', 'dataProvider'] as $name) {
221	4	if (array_key_exists($name, $modelClass)) {
222	4	$$name = $modelClass[$name];
223	4	unset($modelClass[$name]);
224	4	}
225	4	}
226	4	}
227
228		/**
229		* @var BaseFindYmlInterface $class
230		*/
231	5	$class = \Yii::createObject($modelClass);
232
233		/**
234		* @var ReaderInterface
235		*/
236	5	$reader = ReaderFactory::build(
237	5	$class,
238	5	$dataProvider,
239	5	$query,
240		$findParams
241	5	);
242
243	5	$newModel = $this->getNewModel($class);
244
245	5	foreach ($reader as $models) {
246	5	foreach ($models as $model) {
247	5	$this->writeModel($newModel, $model);
248	5	}
249	5	$this->gc();
250	5	}
251	5	}
252
253		/**
254		* @param $modelClass
255		* @return Category\|Currency\|SimpleOffer
256		* @throws Exception
257		*/
258	5	protected function getNewModel($modelClass)
259		{
260	5	$obj = is_object($modelClass) ? $modelClass : \Yii::createObject($modelClass);
261
262	5	if ($obj instanceof CurrencyInterface) {
263	5	$model = new Currency();
264	5	} elseif ($obj instanceof CategoryInterface) {
265	5	$model = new Category();
266	5	} elseif ($obj instanceof CustomOfferInterface && $this->customOfferClass !== null && class_exists($this->customOfferClass)) {
267	1	$model = \Yii::createObject($this->customOfferClass);
268	5	} elseif ($obj instanceof SimpleOfferInterface) {
269	4	$model = new SimpleOffer();
270	4	} else {
271		throw new Exception('Model ' . get_class($obj) . ' has unknown interface');
272		}
273
274	5	return $model;
275		}
276
277		/**
278		* Performs PHP memory garbage collection.
279		*/
280	5	protected function gc()
281		{
282	5	if (!gc_enabled()) {
283		gc_enable();
284		}
285	5	gc_collect_cycles();
286	5	}
287		}
288

pastuhov / yii2-yml-catalog

Push — master ( 871cd8...ab1e03 )

YmlCatalog::write() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like