Code Monkey home page Code Monkey logo

yii2-relation's Introduction

Saving Related Data in Yii2

Build Status Latest Stable Version Total Downloads License

Behavior for support relational data management.

  • Insert related models from POST array.
  • Pre-processing for new models via callback function.
  • Delete related models from database which not exist in POST array.
  • Skip related models which already exist in database with same attributes.
  • Rollback database changes, if relational model save/delete error occurred.
  • Support one-to-one and one-to-many relations.

With pre-processing you can set additional logic before create related models. For example, to add additional columns data to the junction table in a many-to-many relationship.

This behavior uses getters for relational attribute in owner model, such getters must return ActiveQuery object. If you use string values in ON condition in ActiveQuery object, then this behavior will throw exception.

Installation

composer require notamedia/yii2-relation

Usages

For make works this behavior you need:

  • Add all relational properties to rules as safe attribute.
  • Declare getter for relational attribute.
  • Put attribute or attribute with callback to relations property of behavior.
  • All used models need to have only one primary key column.

One to One Relationships

<?php

class News extends \yii\db\ActiveRecord
{
    public function rules()
    {
        return [
            [['file'], 'safe']
        ];
    }
    
    public function getFile()
    {
        return $this->hasOne(File::class, ['id' => 'file_id']);
    }
    
    public function behaviors()
    {
        return [
            [
                'class' => \notamedia\relation\RelationBehavior::class,
                'relations' => ['file']
            ]
        ];
    }
    
    public function transactions()
    {
        return [
            $this->getScenario() => static::OP_ALL
        ];
    }
}

One to Many Relationships

<?php

class News extends \yii\db\ActiveRecord
{
    public function rules()
    {
        return [
            [['images'], 'safe']
        ];
    }
    
    public function getImages()
    {
        return $this->hasMany(Image::class, 
            ['news_id' => 'id']);
    }
    
    public function behaviors()
    {
        return [
            [
                'class' => \notamedia\relation\RelationBehavior::class,
                'relations' => ['images']
            ]
        ];
    }
    
    public function transactions()
    {
        return [
            $this->getScenario() => static::OP_ALL
        ];
    }
}

Many to Many Relationships

With via:

<?php

class News extends \yii\db\ActiveRecord
{
    public function rules()
    {
        return [
            [['categories'], 'safe']
        ];
    }
       
    public function getNewsHasCategories()
    {
        return $this->hasMany(NewsHasCategory::class, ['news_id' => 'id']);
    }

    public function getCategories()
    {
        return $this->hasMany(Category::class, ['id' => 'category_id'])
            ->via('newsHasCategories');
    }
    
    public function behaviors()
    {
        return [
            [
                'class' => \notamedia\relation\RelationBehavior::class,
                'relations' => ['categories']
            ]
        ];
    }
    
    public function transactions()
    {
        return [
            $this->getScenario() => static::OP_ALL
        ];
    }
}

With viaTable:

<?php

class News extends \yii\db\ActiveRecord
{
    public function rules()
    {
        return [
            [['categories', 'categories_type_archive'], 'safe']
        ];
    }

    public function getCategories()
    {
        return $this->hasMany(Category::class, ['id' => 'category_id'])
            ->viaTable('news_has_categories', ['news_id' => 'id']);
    }
    
    // with onCondition
    public function getCategories_type_archive()
    {
        return $this->hasMany(Category::class, ['id' => 'category_id'])
            ->viaTable('news_has_categories', ['news_id' => 'id'], function($query) {
                 return $query->onCondition(['type' => 'archive']);
            });
    }
    
    public function behaviors()
    {
        return [
            [
                'class' => \notamedia\relation\RelationBehavior::class,
                'relations' => ['categories', 'categories_type_archive']
            ]
        ];
    }
    
    public function transactions()
    {
        return [
            $this->getScenario() => static::OP_ALL
        ];
    }
}

Sorting Data Relationships

<?php

class News extends \yii\db\ActiveRecord
{
    public function rules()
    {
        return [
            [['categories'], 'safe']
        ];
    }
       
    public function getNewsHasCategories()
    {
        return $this->hasMany(NewsHasCategory::class, ['news_id' => 'id']);
    }
    
    public function getCategories()
    {
        return $this->hasMany(Category::class, ['id' => 'category_id'])
            ->via('newsHasCategories');
    }
    
    public function behaviors()
    {
        $sortIndex = 1;
        
        return [
            [
                'class' => \notamedia\relation\RelationBehavior::class,
                'relations' => [
                    'categories' => function (NewsHasCategory $model) use (&$sortIndex) {
                        $model->sort = $sortIndex++;
    
                        return $model;
                    }
                ]
            ]
        ];
    }
    
    public function transactions()
    {
        return [
            $this->getScenario() => static::OP_ALL
        ];
    }
}

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.