Download the PHP package arogachev/yii2-many-to-many without Composer
On this page you can find all versions of the php package arogachev/yii2-many-to-many. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download arogachev/yii2-many-to-many
More information about arogachev/yii2-many-to-many
Files in arogachev/yii2-many-to-many
Package yii2-many-to-many
Short Description Many-to-many ActiveRecord relation for Yii 2 framework
License BSD-3-Clause
Homepage https://github.com/arogachev/yii2-many-to-many
Informations about the package yii2-many-to-many
Yii 2 Many-to-many
Implementation of Many-to-many relationship for Yii 2 framework.
- Installation
- Features
- Creating editable attribute
- Attaching and configuring behavior
- Filling relations
- Saving relations without massive assignment
- Adding attribute as safe
- Adding control to view
- Relation features
- Running tests
Installation
The preferred way to install this extension is through composer.
Either run
or add
to the require section of your composer.json
file.
Features
- Configuring using existing relations
- Multiple relations
- No extra queries. For example, if initially model has 100 related records, after adding just one, exactly one row will be inserted. If nothing was changed, no queries will be executed.
- Auto filling of editable attribute
- Validator for checking if the received list is valid
Creating editable attribute
Simply add public property to your ActiveRecord
model like this:
It will store primary keys of related records during update.
Attaching and configuring behavior
First way is to explicitly specify all parameters:
But more often we also need to display related models, so it's better to define relation for that and use it for both display and behavior configuration. Both ways ( and ) are considered valid:
Using :
Using (requires additional model for junction table):
Order is not required.
Then just pass the name of this relation and all other parameters will be fetched automatically.
Additional many-to-many relations can be added exactly the same.
Note that even for one relation you should declare it as a part of relations
section.
Filling relations
By default, editableAttribute
of each found model will be populated with ids of related models (eager loading is
used). If you want more manual control, prevent extra queries, disable autoFill
option:
and fill it only when it's needed, for example in update
action of controller. This is recommended way of using.
Alternatively you can specify conditions of filling in closure:
Even it's possible to do something like this:
but it's not recommended for usage because model is not appropriate place for handling routes.
Saving relations without massive assignment
When creating model:
When updating model ('autoFill' => true
):
When updating model ('autoFill' => false
, manual filling):
When updating model ('autoFill' => false
, without manual filling):
In this case many-to-many relations will stay untouched.
Adding attribute as safe
Add editable attribute to model rules for massive assignment.
Either mark it as safe at least:
Or use custom validator:
Validator checks list for being array and containing only primary keys presented in related model.
It can not be used without attaching ManyToManyBehavior
.
Adding control to view
Add control to view for managing related list. Without extensions it can be done with multiple select:
Example of getList()
method contents (it needs to be placed in User
model):
Relation features
You can access many-to-many relation like so:
users
can be value of either name
or table
relation property specified in config.
You can fill editableAttribute
with ids of related records like so:
You can get added and deleted primary keys of related models for specific relation like so:
Note that they are only available after the model was saved so you can access it after $model->save()
call
or in afterSave()
event handler.
Running tests
Install dependencies:
Add database config (tests/config/db-local.php
file) with following contents:
You can change dbname
, username
and password
how you want. Make sure create database and user before running
tests.
Run tests: