refactoring

NullRefExcep · Apr 24, 2018 · 7486492 · 7486492
1 parent 8449cbd
commit 7486492
Show file tree

Hide file tree

Showing 14 changed files with 191 additions and 126 deletions.
diff --git a/src/behaviors/Entity.php b/src/behaviors/Entity.php
@@ -10,9 +10,37 @@
 
 use nullref\eav\models\Entity as EntityModel;
 use yii\base\Behavior;
+use yii\base\InvalidValueException;
 use yii\db\ActiveRecord;
 use yii\validators\Validator;
 
+/**
+ * Entity behavior that allow to use dynamic attributes in model instance
+ *
+ * To use Entity behavior, insert the following code to your ActiveRecord class:
+ *
+ * ```php
+ * use nullref\eav\behaviors\Entity;
+ * use nullref\eav\models\Entity as EntityModel;
+ *
+ * public function behaviors()
+ * {
+ *     return [
+ *          'eav' => [
+ *              'class' => Entity::class,
+ *                  'entity' => function () {
+ *                      return new EntityModel([
+ *                      'sets' => [
+ *                          Set::findOne(['code' => 'catalog']),
+ *                      ],
+ *                  ]);
+ *              },
+ *          ],
+ *     ];
+ * }
+ *
+ * @package nullref\eav\behaviors
+ */
 class Entity extends Behavior
 {
     /** @var string */
@@ -35,36 +63,47 @@ public function events()
     }
 
     /**
-     *
+     * @throws \Exception
+     * @throws \Throwable
+     * @throws \yii\db\Exception
      */
     public function afterFind()
     {
         $this->entityModel->find();
     }
 
     /**
-     *
+     * @throws \yii\db\Exception
      */
     public function afterSave()
     {
         $this->entityModel->save();
     }
 
     /**
-     *
+     * @throws \Exception
+     * @throws \Throwable
+     * @throws \yii\db\StaleObjectException
      */
     public function afterDelete()
     {
         $this->entityModel->delete();
     }
 
     /**
-     * @param ActiveRecord $owner
+     * Configure entity model and update validators for owner model
+     *
+     * @param \yii\base\Component|ActiveRecord $owner
+     * @throws \yii\base\InvalidConfigException
      */
     public function attach($owner)
     {
         parent::attach($owner);
-        $this->entityModel = EntityModel::create($this->entity, $owner);
+        $pk = $owner->primaryKey;
+        if (!is_scalar($pk)) {
+            throw new InvalidValueException('Entity primary key should be scalar');
+        }
+        $this->entityModel = EntityModel::create($this->entity, $pk);
 
         $validators = $owner->getValidators();
         $attributes = $this->entityModel->attributes();
@@ -74,6 +113,7 @@ public function attach($owner)
     /**
      * @param string $name
      * @return EntityModel|mixed
+     * @throws \yii\base\UnknownPropertyException
      */
     public function __get($name)
     {
@@ -90,7 +130,7 @@ public function __get($name)
     /**
      * @param string $name
      * @param mixed $value
-     * @return mixed|void
+     * @throws \yii\base\UnknownPropertyException
      */
     public function __set($name, $value)
     {

diff --git a/src/components/EntityManager.php b/src/components/EntityManager.php
diff --git a/src/controllers/admin/AttributeController.php b/src/controllers/admin/AttributeController.php
@@ -19,7 +19,7 @@ public function behaviors()
     {
         return [
             'verbs' => [
-                'class' => VerbFilter::className(),
+                'class' => VerbFilter::class,
                 'actions' => [
                     'delete' => ['POST'],
                 ],

diff --git a/src/controllers/admin/SetController.php b/src/controllers/admin/SetController.php
@@ -19,7 +19,7 @@ public function behaviors()
     {
         return [
             'verbs' => [
-                'class' => VerbFilter::className(),
+                'class' => VerbFilter::class,
                 'actions' => [
                     'delete' => ['POST'],
                 ],

diff --git a/src/helpers/Grid.php b/src/helpers/Grid.php
@@ -8,9 +8,9 @@
 namespace nullref\eav\helpers;
 
 
-use nullref\eav\models\Attribute;
-use nullref\eav\models\Entity;
-use nullref\eav\widgets\ActiveRangeInputGroup;
+use app\modules\eav\models\Attribute;
+use app\modules\eav\models\Entity;
+use app\modules\eav\widgets\ActiveRangeInputGroup;
 use kartik\select2\Select2;
 use mcms\xeditable\XEditableColumn;
 use yii\base\Model;
@@ -47,8 +47,8 @@ public static function getGridColumnsInternal(Entity $entity, $searchModel = nul
                 continue;
             }
             $column = [
-                'attribute' => $code,
                 'label' => $item['name'],
+                'attribute' => $code,
             ];
             if (isset($item['config']['editable']) && $item['config']['editable']) {
                 $column = self::getEditableConfig($column, $item);
@@ -62,6 +62,56 @@ public static function getGridColumnsInternal(Entity $entity, $searchModel = nul
         return $result;
     }
 
+    protected static function getEditableConfig($column, $item)
+    {
+        $column['class'] = XEditableColumn::class;
+        $column['editable'] = [];
+        $column['url'] = Url::to(['editable']);
+        $column['format'] = 'raw';
+
+        $column['dataType'] = 'text';
+
+        if (isset($item['items'])) {
+            $column['dataType'] = 'select';
+            $column['editable'] = [
+                'source' => $item['items']
+            ];
+        }
+        return $column;
+    }
+
+    public static function addFilter($column, $item, $searchModel)
+    {
+        if ($searchModel) {
+            if (isset($item['items'])) {
+                $column['filter'] = Select2::widget([
+                    'data' => $item['items'],
+                    'attribute' => $column['attribute'],
+                    'options' => ['placeholder' => ' '],
+                    'model' => $searchModel,
+                    'pluginOptions' => [
+                        'allowClear' => true,
+                    ],
+                ]);
+            }
+            $column['headerOptions'] = [
+                'style' => 'min-width: 100px',
+            ];
+            if (in_array($item['type'], [Attribute::TYPE_INT, Attribute::TYPE_DECIMAL])) {
+
+                $column['filter'] = ActiveRangeInputGroup::widget([
+                    'attributeFrom' => $column['attribute'] . '[from]',
+                    'attributeTo' => $column['attribute'] . '[to]',
+                    'model' => $searchModel,
+                    'options' => [
+                        'style' => 'min-width: 100px',
+                    ],
+                ]);
+            }
+        }
+        return $column;
+    }
+
     public static function addValue($column, $item)
     {
         if (isset($item['items'])) {
@@ -127,54 +177,4 @@ public static function addValue($column, $item)
         }
         return $column;
     }
-
-    public static function addFilter($column, $item, $searchModel)
-    {
-        if ($searchModel) {
-            if (isset($item['items'])) {
-                $column['filter'] = Select2::widget([
-                    'data' => $item['items'],
-                    'attribute' => $column['attribute'],
-                    'options' => ['placeholder' => ' '],
-                    'model' => $searchModel,
-                    'pluginOptions' => [
-                        'allowClear' => true,
-                    ],
-                ]);
-            }
-            $column['headerOptions'] = [
-                'style' => 'min-width: 100px',
-            ];
-            if (in_array($item['type'], [Attribute::TYPE_INT, Attribute::TYPE_DECIMAL])) {
-
-                $column['filter'] = ActiveRangeInputGroup::widget([
-                    'attributeFrom' => $column['attribute'] . '[from]',
-                    'attributeTo' => $column['attribute'] . '[to]',
-                    'model' => $searchModel,
-                    'options' => [
-                        'style' => 'min-width: 100px',
-                    ],
-                ]);
-            }
-        }
-        return $column;
-    }
-
-    protected static function getEditableConfig($column, $item)
-    {
-        $column['class'] = XEditableColumn::class;
-        $column['editable'] = [];
-        $column['url'] = Url::to(['editable']);
-        $column['format'] = 'raw';
-
-        $column['dataType'] = 'text';
-
-        if (isset($item['items'])) {
-            $column['dataType'] = 'select';
-            $column['editable'] = [
-                'source' => $item['items']
-            ];
-        }
-        return $column;
-    }
 }
diff --git a/src/helpers/Helper.php b/src/helpers/Helper.php
@@ -14,7 +14,7 @@
 class Helper
 {
     /**
-     * @return null|\yii\base\Module|\nullref\eav\Module
+     * @return \nullref\eav\Module|\yii\base\Module
      */
     public static function getModule()
     {

diff --git a/src/helpers/Migration.php b/src/helpers/Migration.php
@@ -8,9 +8,9 @@
 namespace nullref\eav\helpers;
 
 
-use nullref\eav\models\Attribute;
-use nullref\eav\models\attribute\Option;
-use nullref\eav\models\attribute\Set;
+use app\modules\eav\models\Attribute;
+use app\modules\eav\models\attribute\Option;
+use app\modules\eav\models\attribute\Set;
 
 class Migration
 {
@@ -79,4 +79,6 @@ public static function createOption($attributeId, $config)
         return $option->save();
     }
 
+
+    //@TODO add revert methods
 }
diff --git a/src/migrations/M170520151321EAV__create_tables.php b/src/migrations/M170520151321EAV__create_tables.php
@@ -24,13 +24,6 @@ public function safeUp()
             'set_id' => $this->integer(),
         ]);
 
-        //@TODO remove if it doesn't need
-        $this->createTable('{{%eav_entity_attribute}}', [
-            'attribute_id' => $this->primaryKey(),
-            'entity_id' => $this->integer(),
-            'sort_order' => $this->integer(),
-        ]);
-
         $this->createTable('{{%eav_attribute_option}}', [
             'id' => $this->primaryKey(),
             'attribute_id' => $this->integer(),
@@ -82,7 +75,6 @@ public function safeDown()
         $this->dropTable('{{%eav_entity_value_decimal}}');
         $this->dropTable('{{%eav_entity_value_int}}');
         $this->dropTable('{{%eav_attribute_option}}');
-        $this->dropTable('{{%eav_entity_attribute}}');
         $this->dropTable('{{%eav_attribute}}');
         $this->dropTable('{{%eav_attribute_set}}');
     }

diff --git a/src/models/Attribute.php b/src/models/Attribute.php
@@ -39,6 +39,7 @@ class Attribute extends ActiveRecord
     const TYPE_IMAGE = 'image';
     const TYPE_URL = 'url';
     const TYPE_TEXT = 'text';
+    const TYPE_JSON = 'json';
 
     protected $_optionsMap = null;
 
@@ -80,7 +81,7 @@ public static function getTypesMap()
      */
     public function getSet()
     {
-        return $this->hasOne(Set::className(), ['id' => 'set_id']);
+        return $this->hasOne(Set::class, ['id' => 'set_id']);
     }
 
     /**
@@ -129,11 +130,11 @@ public function attributeLabels()
     }
 
     /**
-     * @return OptionQuery
+     * @return OptionQuery|\yii\db\ActiveQuery
      */
     public function getOptions()
     {
-        return $this->hasMany(Option::className(), ['attribute_id' => 'id']);
+        return $this->hasMany(Option::class, ['attribute_id' => 'id']);
     }
 
     /**
@@ -190,6 +191,7 @@ public function createValue()
         /** @var Value $model */
         $model = new $class;
 
+        $model->attribute_id = $this->id;
         $model->attributeModel = $this;
 
         return $model;