https://github.com/notamedia/yii2-relation
Behavior for support relational data management
https://github.com/notamedia/yii2-relation
activerecord data-management yii2-extension
Last synced: 2 months ago
JSON representation
Behavior for support relational data management
- Host: GitHub
- URL: https://github.com/notamedia/yii2-relation
- Owner: notamedia
- License: mit
- Created: 2015-12-30T17:23:59.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-10-11T21:23:04.000Z (over 7 years ago)
- Last Synced: 2025-03-25T16:46:03.167Z (3 months ago)
- Topics: activerecord, data-management, yii2-extension
- Language: PHP
- Size: 70.3 KB
- Stars: 9
- Watchers: 4
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Saving Related Data in Yii2
[](https://travis-ci.org/notamedia/yii2-relation)
[](https://packagist.org/packages/notamedia/yii2-relation)
[](https://packagist.org/packages/notamedia/yii2-relation)
[](https://packagist.org/packages/notamedia/yii2-relation)
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
```bash
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
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
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
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
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
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
];
}
}
```