Allow to use custom AR constructors

framework/CHANGELOG.md

@@ -13,6 +13,7 @@ Yii Framework 2 Change Log
 - Enh #4495:  Added closure support in `yii\i18n\Formatter` (developeruz)
 - Enh #13787: Added `yii\db\Migration::$maxSqlOutputLength` that allows limiting number of characters for outputting SQL (thiagotalma)
 - Enh #13824: Support extracting concatenated strings in `yii message` (developeruz)
+- Enh #14078: Allowed to use custom constructors in ActiveRecord-based classes (ElisDN)
 - Enh #14089: Added tests for `yii\base\Theme` (vladis84)
 - Enh #13586: Added `$preserveNonEmptyValues` property to the `yii\behaviors\AttributeBehavior` (Kolyunya)
 - Bug #14192: Fixed wrong default null value for TIMESTAMP when using PostgreSQL (Tigrov)

framework/UPGRADE.md

@@ -76,6 +76,9 @@ Upgrade from Yii 2.0.11
 * Inputmask package name was changed from `jquery.inputmask` to `inputmask`. If you've configured path to
   assets manually, please adjust it. 
 
+* The usage of `yii\db\BaseActiveRecord::instantiate()` was changed to more general `instantiate($row = [])`. The method is called
+  everywhere in framework internal code instead of `new $modelClass()` and can receive empty `$row` array in this cases.
+
 Upgrade from Yii 2.0.10
 -----------------------
 

framework/data/ActiveDataProvider.php

@@ -177,7 +177,12 @@ public function setSort($value)
         parent::setSort($value);
         if (($sort = $this->getSort()) !== false && $this->query instanceof ActiveQueryInterface) {
             /* @var $model Model */
-            $model = new $this->query->modelClass();
+            if (is_subclass_of($this->query->modelClass, 'yii\db\ActiveRecordInterface')) {
+                $modelClass = $this->query->modelClass;
+                $model = $modelClass::instantiate();
+            } else {
+                $model = new $this->query->modelClass();
+            }
             if (empty($sort->attributes)) {
                 foreach ($model->attributes() as $attribute) {
                     $sort->attributes[$attribute] = [

framework/db/ActiveQuery.php

@@ -435,7 +435,9 @@ private function buildJoinWith()
         $join = $this->join;
         $this->join = [];
 
-        $model = new $this->modelClass();
+        $modelClass = $this->modelClass;
+        $model = $modelClass::instantiate();
+
         foreach ($this->joinWith as $config) {
             list($with, $eagerLoading, $joinType) = $config;
             $this->joinWithRelations($model, $with, $joinType);
@@ -515,7 +517,8 @@ private function joinWithRelations($model, $with, $joinType)
                 } else {
                     $relation = $relations[$fullName];
                 }
-                $primaryModel = new $relation->modelClass();
+                $modelClass = $relation->modelClass;
+                $primaryModel = $modelClass::instantiate();
                 $parent = $relation;
                 $prefix = $fullName;
                 $name = $childName;

framework/db/ActiveRecordInterface.php

@@ -427,4 +427,19 @@ public function unlink($name, $model, $delete = false);
      * @return mixed the database connection used by this AR class.
      */
     public static function getDb();
+
+    /**
+     * Creates an active record instance.
+     *
+     * This method is called internally by framework for instantiating new record object.
+     * It is not meant to be used for creating new records directly.
+     *
+     * You may override this method if the instance being created
+     * depends on the row data to be populated into the record.
+     * For example, by creating a record based on the value of a column,
+     * you may implement the so-called single-table inheritance mapping.
+     * @param array $row row data to be populated into the record (can be empty).
+     * @return ActiveRecordInterface the newly created active record
+     */
+    public static function instantiate($row = []);
 }

framework/db/ActiveRelationTrait.php

@@ -177,7 +177,8 @@ private function addInverseRelations(&$result)
                 $relatedModel->populateRelation($this->inverseOf, $inverseRelation->multiple ? [$this->primaryModel] : $this->primaryModel);
             } else {
                 if (!isset($inverseRelation)) {
-                    $inverseRelation = (new $this->modelClass())->getRelation($this->inverseOf);
+                    $modelClass = $this->modelClass;
+                    $inverseRelation = $modelClass::instantiate()->getRelation($this->inverseOf);
                 }
                 $result[$i][$this->inverseOf] = $inverseRelation->multiple ? [$this->primaryModel] : $this->primaryModel;
             }
@@ -298,7 +299,12 @@ private function populateInverseRelation(&$primaryModels, $models, $primaryName,
         }
         $model = reset($models);
         /* @var $relation ActiveQueryInterface|ActiveQuery */
-        $relation = $model instanceof ActiveRecordInterface ? $model->getRelation($name) : (new $this->modelClass())->getRelation($name);
+        if ($model instanceof ActiveRecordInterface) {
+            $relation = $model->getRelation($name);
+        } else {
+            $modelClass = $this->modelClass;
+            $relation = $modelClass::instantiate()->getRelation($name);
+        }
 
         if ($relation->multiple) {
             $buckets = $this->buildBuckets($primaryModels, $relation->link, null, null, false);

framework/db/BaseActiveRecord.php

@@ -1148,17 +1148,17 @@ public static function populateRecord($record, $row)
     /**
      * Creates an active record instance.
      *
-     * This method is called together with [[populateRecord()]] by [[ActiveQuery]].
+     * This method is called internally by framework for instantiating new record object.
      * It is not meant to be used for creating new records directly.
      *
      * You may override this method if the instance being created
      * depends on the row data to be populated into the record.
      * For example, by creating a record based on the value of a column,
      * you may implement the so-called single-table inheritance mapping.
-     * @param array $row row data to be populated into the record.
+     * @param array $row row data to be populated into the record (can be empty).
      * @return static the newly created active record
      */
-    public static function instantiate($row)
+    public static function instantiate($row = [])
     {
         return new static();
     }
@@ -1271,7 +1271,7 @@ public function link($name, $model, $extraColumns = [])
             if (is_array($relation->via)) {
                 /* @var $viaClass ActiveRecordInterface */
                 /* @var $record ActiveRecordInterface */
-                $record = new $viaClass();
+                $record = $viaClass::instantiate();
                 foreach ($columns as $column => $value) {
                     $record->$column = $value;
                 }
@@ -1570,7 +1570,8 @@ public function getAttributeLabel($attribute)
                     } catch (InvalidParamException $e) {
                         return $this->generateAttributeLabel($attribute);
                     }
-                    $relatedModel = new $relation->modelClass();
+                    $modelClass = $relation->modelClass;
+                    $relatedModel = $modelClass::instantiate();
                 }
             }
 
@@ -1610,7 +1611,8 @@ public function getAttributeHint($attribute)
                     } catch (InvalidParamException $e) {
                         return '';
                     }
-                    $relatedModel = new $relation->modelClass();
+                    $modelClass = $relation->modelClass;
+                    $relatedModel = $modelClass::instantiate();
                 }
             }
 

framework/grid/DataColumn.php

@@ -146,11 +146,21 @@ protected function getHeaderCellLabel()
         if ($this->label === null) {
             if ($provider instanceof ActiveDataProvider && $provider->query instanceof ActiveQueryInterface) {
                 /* @var $model Model */
-                $model = new $provider->query->modelClass();
+                if (is_subclass_of($provider->query->modelClass, 'yii\db\ActiveRecordInterface')) {
+                    $modelClass = $provider->query->modelClass;
+                    $model = $modelClass::instantiate();
+                } else {
+                    $model = new $provider->query->modelClass();
+                }
                 $label = $model->getAttributeLabel($this->attribute);
             } elseif ($provider instanceof ArrayDataProvider && $provider->modelClass !== null) {
                 /* @var $model Model */
-                $model = new $provider->modelClass();
+                if (is_subclass_of($provider->modelClass, 'yii\db\ActiveRecordInterface')) {
+                    $modelClass = $provider->modelClass;
+                    $model = $modelClass::instantiate();
+                } else {
+                    $model = new $provider->modelClass();
+                }
                 $label = $model->getAttributeLabel($this->attribute);
             } elseif ($this->grid->filterModel !== null && $this->grid->filterModel instanceof Model) {
                 $label = $this->grid->filterModel->getAttributeLabel($this->attribute);

tests/data/ar/Animal.php

@@ -36,10 +36,11 @@ public function getDoes()
     }
 
     /**
-     * @param type $row
+     *
+     * @param array $row
      * @return \yiiunit\data\ar\Animal
      */
-    public static function instantiate($row)
+    public static function instantiate($row = [])
     {
         $class = $row['type'];
         return new $class();

tests/data/ar/CustomerWithConstructor.php

@@ -0,0 +1,51 @@
+<?php
+namespace yiiunit\data\ar;
+
+use yiiunit\framework\db\ActiveRecordTest;
+
+/**
+ * Class Customer
+ *
+ * @property int $id
+ * @property string $name
+ * @property string $email
+ * @property string $address
+ * @property int $status
+ *
+ * @property ProfileWithConstructor $profile
+ */
+class CustomerWithConstructor extends ActiveRecord
+{
+    const STATUS_ACTIVE = 1;
+    const STATUS_INACTIVE = 2;
+
+    public static function tableName()
+    {
+        return 'customer';
+    }
+
+    public function __construct($name, $email, $address)
+    {
+        $this->name = $name;
+        $this->email = $email;
+        $this->address = $address;
+        parent::__construct();
+    }
+
+    public static function instantiate($row = [])
+    {
+        return (new \ReflectionClass(static::className()))->newInstanceWithoutConstructor();
+    }
+
+    public function getProfile()
+    {
+        return $this->hasOne(ProfileWithConstructor::className(), ['id' => 'profile_id']);
+    }
+
+    public function afterSave($insert, $changedAttributes)
+    {
+        ActiveRecordTest::$afterSaveInsert = $insert;
+        ActiveRecordTest::$afterSaveNewRecord = $this->isNewRecord;
+        parent::afterSave($insert, $changedAttributes);
+    }
+}

tests/data/ar/OrderItemWithConstructor.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace yiiunit\data\ar;
+
+/**
+ * Class OrderItem
+ *
+ * @property int $order_id
+ * @property int $item_id
+ * @property int $quantity
+ * @property string $subtotal
+ */
+class OrderItemWithConstructor extends ActiveRecord
+{
+    public static $tableName;
+
+    public static function tableName()
+    {
+        return static::$tableName ?: 'order_item';
+    }
+
+    public function __construct($item_id, $quantity)
+    {
+        $this->item_id = $item_id;
+        $this->quantity = $quantity;
+        parent::__construct();
+    }
+
+    public static function instantiate($row = [])
+    {
+        return (new \ReflectionClass(static::className()))->newInstanceWithoutConstructor();
+    }
+
+    public function getOrder()
+    {
+        return $this->hasOne(OrderWithConstructor::className(), ['id' => 'order_id']);
+    }
+}

tests/data/ar/OrderWithConstructor.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace yiiunit\data\ar;
+
+/**
+ * Class Order
+ *
+ * @property int $id
+ * @property int $customer_id
+ * @property int $created_at
+ * @property string $total
+ *
+ * @property OrderItemWithConstructor $orderItems
+ * @property CustomerWithConstructor $customer
+ * @property CustomerWithConstructor $customerJoinedWithProfile
+ */
+class OrderWithConstructor extends ActiveRecord
+{
+    public static $tableName;
+
+    public static function tableName()
+    {
+        return static::$tableName ?: 'order';
+    }
+
+    public function __construct($id)
+    {
+        $this->id = $id;
+        $this->created_at = time();
+        parent::__construct();
+    }
+
+    public static function instantiate($row = [])
+    {
+        return (new \ReflectionClass(static::className()))->newInstanceWithoutConstructor();
+    }
+
+    public function getCustomer()
+    {
+        return $this->hasOne(CustomerWithConstructor::className(), ['id' => 'customer_id']);
+    }
+
+    public function getCustomerJoinedWithProfile()
+    {
+        return $this->hasOne(CustomerWithConstructor::className(), ['id' => 'customer_id'])
+            ->joinWith('profile');
+    }
+
+    public function getOrderItems()
+    {
+        return $this->hasMany(OrderItemWithConstructor::className(), ['order_id' => 'id'])->inverseOf('order');
+    }
+}

tests/data/ar/ProfileWithConstructor.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace yiiunit\data\ar;
+
+/**
+ * Class Profile
+ *
+ * @property int $id
+ * @property string $description
+ *
+ */
+class ProfileWithConstructor extends ActiveRecord
+{
+    public static function tableName()
+    {
+        return 'profile';
+    }
+
+    public function __construct($description)
+    {
+        $this->description = $description;
+        parent::__construct();
+    }
+
+    public static function instantiate($row = [])
+    {
+        return (new \ReflectionClass(static::className()))->newInstanceWithoutConstructor();
+    }
+}