pastuhov\ymlcatalog\YmlCatalog

Complexity

Total Complexity

23

Size/Duplication

Total Lines	296
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

98.98%

Importance

Changes	1
Bugs	1	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	getFormattedDate()	0	10	2
A	generate()	0	23	1
A	write()	0	4	1
A	writeTag()	0	4	1
A	writeModel()	0	7	2
B	writeTags()	0	17	6
B	writeEachModel()	0	57	7
A	getNewModel()	0	8	1
A	gc()	0	7	2

<?php
namespace pastuhov\ymlcatalog;

use pastuhov\ymlcatalog\models\BaseModel;
use pastuhov\ymlcatalog\models\Category;
use pastuhov\ymlcatalog\models\Currency;
use pastuhov\ymlcatalog\models\CustomOffer;
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\base\Object;
use yii\db\ActiveRecordInterface;
use yii\data\ActiveDataProvider;
use yii\db\ActiveQuery;

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

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

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

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

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

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

        return $date;
    }

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

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

        $tags = [
            'shop' => [
                $this->shopClass,
                'currencies' => $this->currencyClass,
                'categories' => $this->categoryClass,
                'delivery-options' => $this->deliveryOptionClass,
                'offers' => $this->offerClass,
            ],
        ];

        $this->writeTags($tags);

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

    /**
     * @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($model->loadModel($valuesModel, $this->onValidationError)) {

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?

            $string = $model->getYml();
            $this->write($string);
        }
    }

    protected function writeTags($tags)
    {
        foreach ($tags as $tagName => $tagParams) {
            if (is_string($tagName)) {
                $this->writeTag($tagName);
                if (is_string($tagParams) || isset($tagParams['class'])) {
                    $this->writeEachModel($tagParams);
                } else {
                    $this->writeTags($tagParams);
                }

                $this->writeTag('/' . $tagName);
            } else if (!is_null($tagParams)) {
                $this->writeEachModel($tagParams);
            }
        }
    }

    /**
     * @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 ActiveQuery
         */
        $query = null;

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

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

            $modelClass = $modelClass['class'];
        }

        $interfaces = class_implements($modelClass);
        if (!isset($interfaces[BaseFindYmlInterface::class])) {
            return $this->writeModel($this->getNewModel($modelClass), \Yii::createObject($modelClass));
        }

        /**
         * @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();
        }
    }

//    /**

39% of this comment could be valid code. Did you maybe forget this after debugging?

//     * @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 = [];
//        if (is_array($modelClass)) {
//            if (array_key_exists('findParams', $modelClass)) {
//                $findParams = $modelClass['findParams'];
//                unset($modelClass['findParams']);
//            }
//
//            $modelClass = $modelClass['class'];
//        }
//
//        $interfaces = class_implements($modelClass);
//        if (!isset($interfaces[ActiveRecordInterface::class])) {
//            return $this->writeModel($this->getNewModel($modelClass), \Yii::createObject($modelClass));
//        }
//
//        /* @var \yii\db\ActiveQuery $query */
//        $query = $modelClass::findYml($findParams);
//
//        $newModel = $this->getNewModel($modelClass);
//        foreach ($query->batch(100) as $models) {
////
////        /**
////         * @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)
    {
        $factory = new ModelsFactory([
            'modelClass' => $modelClass,
        ]);

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