yii2-relation-trait

Yii 2 Models add functionality for load with relation (loadAll($POST)), & transactional save with relation (saveAll())

PLUS soft delete/restore feature!

Best work with mootensai/yii2-enhanced-gii

Support

https://www.paypal.me/yohanesc

Installation

The preferred way to install this extension is through composer.

Either run

$ composer require 'mootensai/yii2-relation-trait:dev-master'

or add

"mootensai/yii2-relation-trait": "*"

to the require section of your composer.json file.

Usage At Model

class MyModel extends ActiveRecord{
    use \mootensai\relation\RelationTrait;
}

Array Input & Usage At Controller

It takes a normal array of POST. This is the example

// sample at controller
//$_POST['ParentClass'] = ['attr1' => 'value1','attr2' => 'value2'];
//$_POST['RelatedClass'][0] = ['attr1' => 'value1','attr2' => 'value2'];      
if($model->loadAll(Yii:$app->request->post()) && $model->saveAll()){
    return $this->redirect(['view', 'id' => $model->id, 'created' => $model->created]);
}

Features

Array Output

// I use this to send model & related through JSON / Serialize
print_r($model->getAttributesWithRelatedAsPost());

Array
(
    [MainClass] => Array
        (
            [attr1] => value1
            [attr2] => value2
        )

    [RelatedClass] => Array
        (
            [0] => Array
                (
                    [attr1] => value1
                    [attr2] => value2
                )
        )

)

print_r($model->getAttributesWithRelated());

Array
(
    [attr1] => value1
    [attr2] => value2
    [relationName] => Array
        (
            [0] => Array
                (
                    [attr1] => value1
                    [attr2] => value2
                )
        )
)

Use Transaction

So your data will be atomic (see : http://en.wikipedia.org/wiki/ACID)

Use Normal Save

So your behaviors still works

Add Validation At Main Model

$form->errorSummary($model);

will give you

<<Related Class Name>> #<<index + 1>> : <<error message>>
My Related Model #1 : Attribute is required

It Works On Auto Incremental PK Or Not (I Have Tried Use UUID)

See here if you want to use my behavior :

https://github.com/mootensai/yii2-uuid-behavior

Soft Delete

Add this line to your Model to enable soft delete

private $_rt_softdelete = ['<column>' => <deleted row marker value>];

Example :

private $_rt_softdelete = ['isdeleted' => 1];

Or :

private $_rt_softdelete = ['deleted_by' => Yii::app()->user->id]

And add this line to your Model to enable soft restore

private $_rt_softrestore = ['<column>' => <undeleted row marker value];

example :

private $_rt_softrestore = ['isdeleted' => 0];

or :

private $_rt_softdelete = ['deleted_by' => 0];

Should work on Yii's supported DB

As it used all Yii's Active Query or Active Record to execute DB command

I'm open for any improvement

Please create issue if you got a problem or an idea for enhancement

~ SDG ~