deadmantfa/yii2-relation-trait

Yii 2 Models load with relation, & transaction save with relation

yii2-relation-trait

I am not the creator of this extension, I have made a bug fix and made a pull request. I am just publishing this for my own usage. Feel free to use it.

All thanks to @mootensai for creating the extension.

This is not to replace the package maintained by @mootensai

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

PLUS soft delete/restore feature!, _(*2)

Best work with mootensai/yii2-enhanced-gii, _(*3)

, _(*4)

Support

, _(*5)

https://www.paypal.me/yohanesc, _(*6)

Endorse me on LinkedIn, _(*7)

https://www.linkedin.com/in/yohanes-candrajaya-b68394102/, _(*8)

Installation

The preferred way to install this extension is through composer., _(*9)

Either run, _(*10)

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

or add, _(*11)

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

to the require section of your composer.json file., _(*12)

Usage At Model

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

Array Input & Usage At Controller

It takes a normal array of POST. This is the example, _(*13)

Array (
    $_POST['ParentClass'] => Array 
        (
            [attr1] => value1
            [attr2] => value2 
            // has many
            [relationName] => Array 
                ( 
                    [0] => Array 
                        (
                            [relAttr] => relValue1
                        )
                    [1] => Array 
                        (
                            [relAttr] => relValue1
                        )
                )
            // has one
            [relationName] => Array
                ( 
                    [relAttr1] => relValue1
                    [relAttr2] => relValue2
                )
        )
)

OR

Array (
    $_POST['ParentClass'] => ['attr1' => 'value1','attr2' => 'value2'],
    // Has One
    $_POST['RelatedClass'] => ['relAttr1' => 'value1','relAttr2' => 'value2'], 
    // Has Many
    $_POST['RelatedClass'] => Array
        (
            [0] => Array
                (
                    [attr1] => value1
                    [attr2] => value2
                )
            [1] => Array
                (
                    [attr1] => value1
                    [attr2] => value2
                )
        )      
)

// sample at controller
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), _(*14)

Use Normal Save

So your behaviors still works, _(*15)

Add Validation At Main Model

$form->errorSummary($model);

will give you, _(*16)

<<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 :, _(*17)

https://github.com/mootensai/yii2-uuid-behavior, _(*18)

Soft Delete

Add this line to your Model to enable soft delete, _(*19)

private $_rt_softdelete;

function __construct(){
    $this->_rt_softdelete = [
        '<column>' => <undeleted row marker value>
        // multiple row marker column example
        'isdeleted' => 1,
        'deleted_by' => \Yii::$app->user->id,
        'deleted_at' => date('Y-m-d H:i:s')
    ];
}

Add this line to your Model to enable soft restore, _(*20)

private $_rt_softrestore;

function __construct(){
    $this->_rt_softrestore = [
        '<column>' => <undeleted row marker value>
        // multiple row marker column example
        'isdeleted' => 0,
        'deleted_by' => 0,
        'deleted_at' => 'NULL'
    ];
}

Should work on Yii's supported DB

It use all Yii's Active Query or Active Record to execute DB command, _(*21)

I'm open for any improvement

Please create issue if you got a problem or an idea for enhancement, _(*22)

~ SDG ~