common/modules/product/models/Product.php

<?php
    
    namespace common\modules\product\models;
    
    use common\behaviors\Slug;
    use common\models\ProductCertificate;
    use common\models\ProductSpec;
    use common\models\ProductToRating;
    use common\modules\comment\models\CommentModel;
    use common\modules\language\behaviors\LanguageBehavior;
    use common\modules\product\behaviors\FilterBehavior;
    use common\modules\rubrication\models\TaxGroup;
    use common\modules\rubrication\models\TaxOption;
    use Yii;
    use yii\db\ActiveQuery;
    use yii\db\ActiveRecord;
    use yii\helpers\ArrayHelper;
    use yii\web\Request;
    
    /**
     * This is the model class for table "{{%product}}".
     * @property string               $name
     * @property integer              $brand_id
     * @property integer              $product_id
     * @property Category             $category
     * @property array                $categories
     * @property array                of ProductVariant $variants
     * @property ProductVariant       $variant
     * @property ProductImage         $image
     * @property array                $images
     * @property boolean              $is_top
     * @property boolean              $is_new
     * @property boolean              $akciya
     * @property ProductToRating      $averageRating
     * @property array                $properties
     * @property ProductVariant       $enabledVariant
     * @property array                $enabledVariants
     * @property string               $video
     * @property string               $description
     * @property TaxOption[]          $options
     * @property Brand                $brand
     * @property ProductVariant[]     $variants
     * @property ProductSpec          $productSpec
     * @property ProductCertificate[] $productCertificates
     * * From language behavior *
     * @property ProductLang          $lang
     * @property ProductLang[]        $langs
     * @property ProductLang          $object_lang
     * @property string               $ownerKey
     * @property string               $langKey
     * @method string           getOwnerKey()
     * @method void             setOwnerKey( string $value )
     * @method string           getLangKey()
     * @method void             setLangKey( string $value )
     * @method ActiveQuery      getLangs()
     * @method ActiveQuery      getLang( integer $language_id )
     * @method ProductLang[]    generateLangs()
     * @method void             loadLangs( Request $request, ActiveRecord[] $model_langs )
     * @method bool             linkLangs( ActiveRecord[] $model_langs )
     * @method bool             saveLangs( ActiveRecord[] $model_langs )
     * * End language behavior *
     */
    class Product extends \yii\db\ActiveRecord
    {
        
        /** @var array $_variants */
        public $_variants = [];
        
        /** @var array $_images */
        public $imagesUpload = '';
        
        public $certificateUpload = [];
        
        /**
         * @inheritdoc
         */
        public function behaviors()
        {
            return [
                [
                    'class' => FilterBehavior::className(),
                ],
                [
                    'class'         => Slug::className(),
                    'in_attribute'  => 'name',
                    'out_attribute' => 'alias',
                    'translit'      => true,
                ],
                'language' => [
                    'class' => LanguageBehavior::className(),
                ],
            ];
        }
        
        /**
         * @inheritdoc
         */
        public static function tableName()
        {
            return '{{%product}}';
        }
        
        /**
         * @inheritdoc
         */
        public function rules()
        {
            return [
                [
                    [ 'brand_id' ],
                    'integer',
                ],
                [
                    [ 'name' ],
                    'string',
                    'max' => 150,
                ],
                [
                    [ 'alias' ],
                    'string',
                    'max' => 250,
                ],
                [
                    [
                        'categories',
                        'variants',
                        'options',
                        'imagesUpload',
                        'certificateUpload',
                    ],
                    'safe',
                ],
                [
                    [
                        'description',
                        'video',
                    ],
                    'safe',
                ],
                [
                    [
                        'is_top',
                        'is_new',
                        'akciya',
                    ],
                    'boolean',
                ],
            ];
        }
        
        /**
         * @inheritdoc
         */
        public function attributeLabels()
        {
            return [
                'product_id'  => Yii::t('product', 'ID'),
                'name'        => Yii::t('product', 'Name'),
                'brand_id'    => Yii::t('product', 'Brand'),
                'categories'  => Yii::t('product', 'Categories'),
                // relation behavior field
                'category'    => Yii::t('product', 'Category'),
                // relation behavior field
                'image'       => Yii::t('product', 'Image'),
                'images'      => Yii::t('product', 'Images'),
                'description' => Yii::t('product', 'Description'),
                'video'       => Yii::t('product', 'Video embeded'),
                'variants'    => Yii::t('product', 'Variants'),
                'is_top'      => Yii::t('product', 'Is top'),
                'is_new'      => Yii::t('product', 'Is new'),
                'akciya'      => Yii::t('product', 'Is promo'),
            ];
        }
        
        public function getUrl()
        {
            return '/product/' . $this->alias;
        }
        
        /**
         * @return \yii\db\ActiveQuery
         */
        public function getBrand()
        {
            return $this->hasOne(Brand::className(), [ 'brand_id' => 'brand_id' ]);
        }
        
        /**
         * @return \yii\db\ActiveQuery
         */
        public function getImage()
        {
            return $this->hasOne(ProductImage::className(), [ 'product_id' => 'product_id' ]);
        }
        
        /**
         * fetch stored image url
         * @return string
         */
        public function getImageUrl()
        {
            $image = empty( $this->variant ) ? NULL : $this->variant->image;
            return !empty( $image ) ? $image->imageUrl : '/images/no_photo.png';
        }
        
        /**
         * @return \yii\db\ActiveQuery
         */
        public function getImages()
        {
            return $this->hasMany(ProductImage::className(), [ 'product_id' => 'product_id' ])
                        ->where([ 'product_variant_id' => NULL ]);
        }
        
        /**
         * @return \yii\db\ActiveQuery
         */
        public function getVariant()
        {
            return $this->hasOne(ProductVariant::className(), [ 'product_id' => 'product_id' ]);
        }
        
        /**
         * @return \yii\db\ActiveQuery
         */
        public function getEnabledVariant()
        {
            return $this->hasOne(ProductVariant::className(), [ 'product_id' => 'product_id' ])
                        ->andOnCondition([
                            '!=',
                            ProductVariant::tableName() . '.stock',
                            0,
                        ]);
        }
        
        public function getVariantPrice()
        {
            return $this->variant->price;
        }
        
        public function getEnabledVariantPrice()
        {
            return $this->enabledVariants[ 0 ]->price;
        }
        
        /**
         * @return \yii\db\ActiveQuery
         */
        public function getVariants()
        {
            return $this->hasMany(ProductVariant::className(), [ 'product_id' => 'product_id' ]);
        }
        
        public function getEnabledVariants()
        {
            return $this->hasMany(ProductVariant::className(), [ 'product_id' => 'product_id' ])
                        ->andOnCondition([
                            '!=',
                            ProductVariant::tableName() . '.stock',
                            0,
                        ])
                        ->joinWith('image');
        }
        
        public function setVariants($variants)
        {
            $this->_variants = $variants;
        }
        
        public function getFullName()
        {
            return empty( $this->brand ) ? $this->name : $this->brand->name . ' ' . $this->name;
        }
        
        public function getCategories()
        {
            return $this->hasMany(Category::className(), [ 'category_id' => 'category_id' ])
                        ->viaTable('product_category', [ 'product_id' => 'product_id' ]);
        }
        
        public function getCategoriesWithName()
        {
            return $this->hasMany(Category::className(), [ 'category_id' => 'category_id' ])
                        ->viaTable('product_category', [ 'product_id' => 'product_id' ]);
        }
        
        public function getCategoriesNames()
        {
            $result = [];
            foreach($this->categories as $category) {
                $result[] = $category->name;
            }
            return $result;
        }
        
        public function getVariantsWithFilters()
        {
            return $this->hasMany(ProductVariant::className(), [ 'product_id' => 'product_id' ])
                        ->with([
                            'filters',
                            'image',
                        ]);
        }
        
        /**
         * @return ActiveQuery
         */
        public function getCategory()
        {
            return $this->hasOne(Category::className(), [ 'category_id' => 'category_id' ])
                        ->viaTable('product_category', [ 'product_id' => 'product_id' ]);
        }
        
        public function getOptions()
        {
            return $this->hasMany(TaxOption::className(), [ 'tax_option_id' => 'option_id' ])
                        ->viaTable('product_option', [ 'product_id' => 'product_id' ]);
        }
        
        public function getProperties()
        {
            $groups = $options = [];
            foreach($this->options as $option) {
                $options[ $option->tax_group_id ][] = $option;
            }
            foreach(TaxGroup::find()
                            ->where([ 'tax_group_id' => array_keys($options) ])
                            ->all() as $group) {
                if(!empty( $options[ $group->tax_group_id ] )) {
                    $group->_options = $options[ $group->tax_group_id ];
                    $groups[] = $group;
                }
            }
            return $groups;
        }
        
        public function getActiveProperties($category_id)
        {
            $groups = $options = [];
            foreach($this->options as $option) {
                $options[ $option->tax_group_id ][] = $option;
            }
            
            $taxGroups = TaxGroup::find()
                                 ->joinWith('categories')
                                 ->where([
                                     'tax_group.tax_group_id' => array_keys($options),
                                     'tax_group.display'      => true,
                                     'category.category_id'   => $category_id,
                                 ])
                                 ->all();
            
            foreach($taxGroups as $group) {
                if(!empty( $options[ $group->tax_group_id ] )) {
                    $group->_options = $options[ $group->tax_group_id ];
                    $groups[] = $group;
                }
            }
            return $groups;
        }
        
        public function getStocks()
        {
            return $this->hasMany(Stock::className(), [ 'stock_id' => 'stock_id' ])
                        ->viaTable(ProductStock::tableName(), [ 'product_id' => 'product_id' ]);
        }
        
        public function getQuantity()
        {
            return ProductStock::find()
                               ->where([ 'product_id' => $this->product_id ])
                               ->sum('quantity');
        }
        
        public function afterSave($insert, $changedAttributes)
        {
            parent::afterSave($insert, $changedAttributes);
            
            $this->unlinkAll('categories', true);
            $this->unlinkAll('options', true);
            
            $categories = Category::findAll($this->categories);
            $options = TaxOption::findAll($this->options);
            
            foreach($options as $option) {
                $this->link('options', $option);
            }
            foreach($categories as $category) {
                $this->link('categories', $category);
            }
            
            if(!empty( $this->_variants )) {
                $todel = [];
                foreach($this->variants ? : [] as $_variant) {
                    $todel[ $_variant->product_variant_id ] = $_variant->product_variant_id;
                }
                foreach($this->_variants as $_variant) {
                    if(!is_array($_variant)) {
                        return;
                    }
                    if(!empty( $_variant[ 'product_variant_id' ] )) {
                        unset( $todel[ $_variant[ 'product_variant_id' ] ] );
                        $model = ProductVariant::findOne($_variant[ 'product_variant_id' ]);
                    } else {
                        $model = new ProductVariant();
                    }
                    $_variant[ 'product_id' ] = $this->product_id;
                    $model->load([ 'ProductVariant' => $_variant ]);
                    $model->product_id = $this->product_id;
                    $model->save();
                }
                if(!empty( $todel )) {
                    ProductVariant::deleteAll([ 'product_variant_id' => $todel ]);
                }
            }
        }
        
        public function imagesUpload()
        {
            if($this->validate()) {
                $images = [];
                foreach($this->imagesUpload as $image) {
                    $imageName = $image->baseName . '.' . $image->extension;
                    $i = 0;
                    while(file_exists(Yii::getAlias('@imagesDir/products/' . $imageName))) {
                        $i++;
                        $imageName = $image->baseName . '_' . $i . '.' . $image->extension;
                    }
                    $imgDir = Yii::getAlias('@imagesDir/products/');
                    if(!is_dir($imgDir)) {
                        mkdir($imgDir, 0755, true);
                    }
                    
                    $image->saveAs($imgDir . $imageName);
                    $images[] = $imageName;
                }
                return $images;
            } else {
                return false;
            }
        }
        
        public function certificateUpload()
        {
            if($this->validate()) {
                $certificates = [];
                foreach($this->certificateUpload as $certificate) {
                    $certificateName = $certificate->baseName . '.' . $certificate->extension;
                    $i = 0;
                    while(file_exists(Yii::getAlias('@storage/certificates/' . $this->product_id . '/' . $certificateName))) {
                        $i++;
                        $certificateName = $certificate->baseName . '_' . $i . '.' . $certificate->extension;
                    }
                    $certificateDir = Yii::getAlias('@storage/certificates/' . $this->product_id . '/');
                    if(!is_dir($certificateDir)) {
                        mkdir($certificateDir, 0755, true);
                    }
                    
                    $certificate->saveAs($certificateDir . $certificateName);
                    $certificates[] = $certificateName;
                }
                return $certificates;
            } else {
                return false;
            }
        }
        
        public function getImagesHTML()
        {
            $op = [];
            if($this->images) {
                foreach($this->images as $image) {
                    $op[] = \common\components\artboximage\ArtboxImageHelper::getImage($image->imageUrl, 'admin_thumb');
                }
            }
            return $op;
        }
        
        public function getImagesConfig()
        {
            $op = [];
            if($this->images) {
                foreach($this->images as $image) {
                    $op[] = [
                        'caption' => $image->image,
                        'width'   => '120px',
                        'url'     => \yii\helpers\Url::to([
                            '/product/manage/delimg',
                            'id' => $image->product_image_id,
                        ]),
                        'key'     => $image->product_image_id,
                        'extra'   => [
                            'id' => $image->product_image_id,
                        ],
                    ];
                }
            }
            return $op;
        }
        
        public function recalculateRating()
        {
            /**
             * @var ProductToRating $averageRating
             */
            $average = $this->getComments()
                            ->joinWith('rating')
                            ->select([ 'average' => 'avg(artbox_comment_rating.value)::float' ])
                            ->scalar();
            if(!$average) {
                $average = 0;
            }
            $averageRating = $this->averageRating;
            if(!empty( $averageRating )) {
                $averageRating->value = $average;
            } else {
                $averageRating = new ProductToRating([
                    'product_id' => $this->product_id,
                    'value'      => $average,
                ]);
            }
            if($averageRating->save()) {
                return true;
            } else {
                return false;
            }
        }
        
        public function getComments()
        {
            return $this->hasMany(CommentModel::className(), [ 'entity_id' => 'product_id' ])
                        ->where([
                            'artbox_comment.entity'             => self::className(),
                            'artbox_comment.status'             => CommentModel::STATUS_ACTIVE,
                            'artbox_comment.artbox_comment_pid' => NULL,
                        ]);
        }
        
        public function getAverageRating()
        {
            return $this->hasOne(ProductToRating::className(), [ 'product_id' => 'product_id' ]);
        }
        
        public function getTaxGroupsByLevel($level)
        {
            $categories = ArrayHelper::getColumn($this->categories, 'category_id');
            return TaxGroup::find()
                           ->distinct()
                           ->innerJoin('tax_group_to_category', 'tax_group_to_category.tax_group_id = tax_group.tax_group_id')
                           ->andWhere([ 'tax_group_to_category.category_id' => $categories ])
                           ->andWhere([ 'level' => $level ]);
        }
        
        public function setCategories($values)
        {
            $this->categories = $values;
        }
        
        public function setOptions($values)
        {
            $this->options = $values;
        }
        
        public function getFilters()
        {
            return $this->hasMany(TaxOption::className(), [ 'tax_option_id' => 'option_id' ])
                        ->viaTable('product_option', [ 'product_id' => 'product_id' ])
                        ->joinWith('taxGroup');
        }
        
        public function getProductSpec()
        {
            return $this->hasOne(ProductSpec::className(), [ 'product_id' => 'product_id' ]);
        }
        
        public function getProductCertificates()
        {
            return $this->hasMany(ProductCertificate::className(), [ 'product_id' => 'product_id' ]);
        }
    }