You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
341 lines
14 KiB
341 lines
14 KiB
9 years ago
|
<?php
|
||
|
|
|
||
|
|
namespace lhs\Yii2SaveRelationsBehavior;
|
||
|
|
|
||
|
|
use RuntimeException;
|
||
|
|
use Yii;
|
||
|
|
use yii\base\Behavior;
|
||
|
|
use yii\base\Exception;
|
||
|
|
use yii\base\ModelEvent;
|
||
|
|
use yii\db\ActiveQuery;
|
||
|
|
use yii\db\ActiveRecord;
|
||
|
|
use yii\helpers\ArrayHelper;
|
||
|
|
use yii\helpers\Inflector;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* This Active Record Behavior allows to save the Model relations when the save() method is invoked.
|
||
|
|
* List of handled relations should be declared using the $relations parameter via an array of relation names.
|
||
|
|
* @author albanjubert
|
||
|
|
*/
|
||
|
|
class SaveRelationsBehavior extends Behavior
|
||
|
|
{
|
||
|
|
|
||
|
|
public $relations = [];
|
||
|
|
private $_oldRelationValue = [];
|
||
|
|
private $_relationsSaveStarted = false;
|
||
|
|
private $_transaction;
|
||
|
|
|
||
|
|
public function events()
|
||
|
|
{
|
||
|
|
return [
|
||
|
|
ActiveRecord::EVENT_BEFORE_VALIDATE => 'beforeValidate',
|
||
|
|
ActiveRecord::EVENT_AFTER_INSERT => 'afterSave',
|
||
|
|
ActiveRecord::EVENT_AFTER_UPDATE => 'afterSave',
|
||
|
|
];
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Check if the behavior is attached to an Active Record
|
||
|
|
* @param ActiveRecord $owner
|
||
|
|
* @throws RuntimeException
|
||
|
|
*/
|
||
|
|
public function attach($owner)
|
||
|
|
{
|
||
|
|
if (!($owner instanceof ActiveRecord)) {
|
||
|
|
throw new RuntimeException('Owner must be instance of yii\db\ActiveRecord');
|
||
|
|
}
|
||
|
|
parent::attach($owner);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Override canSetProperty method to be able to detect if a relation setter is allowed
|
||
|
|
* @param string $name
|
||
|
|
* @param boolean $checkVars
|
||
|
|
* @return boolean
|
||
|
|
*/
|
||
|
|
public function canSetProperty($name, $checkVars = true)
|
||
|
|
{
|
||
|
|
$getter = 'get' . $name;
|
||
|
|
if (in_array($name, $this->relations) && method_exists($this->owner,
|
||
|
|
$getter) && $this->owner->$getter() instanceof ActiveQuery
|
||
|
|
) {
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
return parent::canSetProperty($name, $checkVars);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Override __set method to be able to set relations values either by providing related primary keys
|
||
|
|
* or instance of related model
|
||
|
|
* @param string $name
|
||
|
|
* @param mixed $value
|
||
|
|
*/
|
||
|
|
public function __set($name, $value)
|
||
|
|
{
|
||
|
|
if (in_array($name, $this->relations)) {
|
||
|
|
//echo "Setting " . $name . "\n";
|
||
|
|
/** @var ActiveRecord $model */
|
||
|
|
$model = $this->owner;
|
||
|
|
Yii::trace("Setting {$name} relation value", __METHOD__);
|
||
|
|
/** @var \yii\db\ActiveQuery $relation */
|
||
|
|
$relation = $model->getRelation($name);
|
||
|
|
if (!isset($this->_oldRelationValue[$name])) {
|
||
|
|
//Yii::trace("Initializing old {$name} relation value", __METHOD__);
|
||
|
|
$this->_oldRelationValue[$name] = $this->owner->{$name};
|
||
|
|
}
|
||
|
|
if ($relation->multiple === true) {
|
||
|
|
$newRelations = [];
|
||
|
|
foreach ($value as $entry) {
|
||
|
|
if ($entry instanceof $relation->modelClass) {
|
||
|
|
$newRelations[] = $entry;
|
||
|
|
} else {
|
||
|
|
// TODO handle this with one DB request to retrieve all models
|
||
|
|
$newRelations[] = $this->_processModelAsArray($entry, $relation);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
$model->populateRelation($name, $newRelations);
|
||
|
|
} else {
|
||
|
|
if (!($value instanceof $relation->modelClass)) {
|
||
|
|
$value = $this->_processModelAsArray($value, $relation);
|
||
|
|
}
|
||
|
|
$model->populateRelation($name, $value);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get an ActiveRecord model using the given $data parameter.
|
||
|
|
* $data could either be a model ID or a model associative array representing its attributes => values
|
||
|
|
* @param mixed $data
|
||
|
|
* @param \yii\db\ActiveQuery $relation
|
||
|
|
* @return ActiveRecord
|
||
|
|
*/
|
||
|
|
public function _processModelAsArray($data, $relation)
|
||
|
|
{
|
||
|
|
/** @var ActiveRecord $modelClass */
|
||
|
|
$modelClass = $relation->modelClass;
|
||
|
|
// get the related model foreign keys
|
||
|
|
if (is_array($data)) {
|
||
|
|
$fks = [];
|
||
|
|
foreach ($relation->link as $relatedAttribute => $modelAttribute) {
|
||
|
|
if (array_key_exists($relatedAttribute, $data) && !empty($data[$relatedAttribute])) {
|
||
|
|
$fks[$relatedAttribute] = $data[$relatedAttribute];
|
||
|
|
}
|
||
|
|
}
|
||
|
|
} else {
|
||
|
|
$fks = $data;
|
||
|
|
}
|
||
|
|
// Load existing model or create one if no key was provided
|
||
|
|
/** @var ActiveRecord $relationModel */
|
||
|
|
$relationModel = null;
|
||
|
|
if (!empty($fks)) {
|
||
|
|
$relationModel = $modelClass::findOne($fks);
|
||
|
|
}
|
||
|
|
if (!$relationModel) {
|
||
|
|
$relationModel = new $modelClass;
|
||
|
|
}
|
||
|
|
if (is_array($data)) {
|
||
|
|
$relationModel->setAttributes($data);
|
||
|
|
}
|
||
|
|
return $relationModel;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Before the owner model validation, for has one relations, set the according foreign keys of the owner model
|
||
|
|
* to be able to validate it
|
||
|
|
* @param ModelEvent $event
|
||
|
|
*/
|
||
|
|
public function beforeValidate(ModelEvent $event)
|
||
|
|
{
|
||
|
|
if ($this->_relationsSaveStarted == false && !empty($this->_oldRelationValue)) {
|
||
|
|
/* @var $model ActiveRecord */
|
||
|
|
$model = $this->owner;
|
||
|
|
if ($this->_saveRelatedRecords($model, $event)) {
|
||
|
|
// If relation is has_one, try to set related model attributes
|
||
|
|
foreach ($this->relations as $relationName) {
|
||
|
|
if (array_key_exists($relationName,
|
||
|
|
$this->_oldRelationValue)) { // Relation was not set, do nothing...
|
||
|
|
$relation = $model->getRelation($relationName);
|
||
|
|
if ($relation->multiple === false && !empty($model->{$relationName})) {
|
||
|
|
Yii::trace("Setting foreign keys for {$relationName}", __METHOD__);
|
||
|
|
foreach ($relation->link as $relatedAttribute => $modelAttribute) {
|
||
|
|
$model->{$modelAttribute} = $model->{$relationName}->{$relatedAttribute};
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* For each related model, try to save it first.
|
||
|
|
* If set in the owner model, operation is done in a transactional way so if one of the models should not validate
|
||
|
|
* or be saved, a rollback will occur.
|
||
|
|
* This is done during the before validation process to be able to set the related foreign keys.
|
||
|
|
* @param ActiveRecord $model
|
||
|
|
* @param ModelEvent $event
|
||
|
|
* @return bool
|
||
|
|
*/
|
||
|
|
public function _saveRelatedRecords(ActiveRecord $model, ModelEvent $event)
|
||
|
|
{
|
||
|
|
if (($model->isNewRecord && $model->isTransactional($model::OP_INSERT))
|
||
|
|
|| (!$model->isNewRecord && $model->isTransactional($model::OP_UPDATE))
|
||
|
|
|| $model->isTransactional($model::OP_ALL)
|
||
|
|
) {
|
||
|
|
$this->_transaction = $model->getDb()->beginTransaction();
|
||
|
|
}
|
||
|
|
try {
|
||
|
|
foreach ($this->relations as $relationName) {
|
||
|
|
|
||
|
|
if (array_key_exists($relationName,
|
||
|
|
$this->_oldRelationValue)) { // Relation was not set, do nothing...
|
||
|
|
$relation = $model->getRelation($relationName);
|
||
|
|
if (!empty($model->{$relationName})) {
|
||
|
|
if ($relation->multiple === false) {
|
||
|
|
// Save Has one relation new record
|
||
|
|
$pettyRelationName = Inflector::camel2words($relationName, true);
|
||
|
|
$this->_saveModelRecord($model->{$relationName}, $event, $pettyRelationName,
|
||
|
|
$relationName);
|
||
|
|
} else {
|
||
|
|
// Save Has many relations new records
|
||
|
|
/** @var ActiveRecord $relationModel */
|
||
|
|
foreach ($model->{$relationName} as $i => $relationModel) {
|
||
|
|
$pettyRelationName = Inflector::camel2words($relationName, true) . " #{$i}";
|
||
|
|
$this->_saveModelRecord($relationModel, $event, $pettyRelationName, $relationName);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
if (!$event->isValid) {
|
||
|
|
throw new Exception("One of the related model could not be validated");
|
||
|
|
}
|
||
|
|
} catch (Exception $e) {
|
||
|
|
$this->_transaction->rollBack(); // If anything goes wrong, transaction will be rolled back
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
*
|
||
|
|
* @param ActiveRecord $model
|
||
|
|
* @param ModelEvent $event
|
||
|
|
* @param $pettyRelationName
|
||
|
|
* @param $relationName
|
||
|
|
*/
|
||
|
|
public function _saveModelRecord(ActiveRecord $model, ModelEvent $event, $pettyRelationName, $relationName)
|
||
|
|
{
|
||
|
|
$this->_validateRelationModel($pettyRelationName, $relationName, $model,
|
||
|
|
$event);
|
||
|
|
if ($event->isValid && count($model->dirtyAttributes)) {
|
||
|
|
Yii::trace("Saving {$pettyRelationName} relation model", __METHOD__);
|
||
|
|
$model->save(false);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Validate a relation model and add an error message to owner attribute if needed
|
||
|
|
* @param string $pettyRelationName
|
||
|
|
* @param string $relationName
|
||
|
|
* @param ActiveRecord $relationModel
|
||
|
|
* @param ModelEvent $event
|
||
|
|
*/
|
||
|
|
private function _validateRelationModel(
|
||
|
|
$pettyRelationName,
|
||
|
|
$relationName,
|
||
|
|
ActiveRecord $relationModel,
|
||
|
|
ModelEvent $event
|
||
|
|
) {
|
||
|
|
/** @var ActiveRecord $model */
|
||
|
|
$model = $this->owner;
|
||
|
|
if (!is_null($relationModel) && ($relationModel->isNewRecord || count($relationModel->getDirtyAttributes()))) {
|
||
|
|
Yii::trace("Validating {$pettyRelationName} relation model", __METHOD__);
|
||
|
|
if (!$relationModel->validate()) {
|
||
|
|
foreach ($relationModel->errors as $attributeErrors) {
|
||
|
|
foreach ($attributeErrors as $error) {
|
||
|
|
$model->addError($relationName, "{$pettyRelationName}: {$error}");
|
||
|
|
}
|
||
|
|
$event->isValid = false;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Save the related models.
|
||
|
|
* If the models have not been changed, nothing will be done.
|
||
|
|
* Otherwise, new related records will be created, changed related records will be update and linked to the owner
|
||
|
|
* using the ActiveRecord link() method.
|
||
|
|
* Unchanged records will stay untouched.
|
||
|
|
* @param ModelEvent $event
|
||
|
|
*/
|
||
|
|
public function afterSave()
|
||
|
|
{
|
||
|
|
if ($this->_relationsSaveStarted == false) {
|
||
|
|
/** @var ActiveRecord $model */
|
||
|
|
$model = $this->owner;
|
||
|
|
$this->_relationsSaveStarted = true;
|
||
|
|
foreach ($this->relations as $relationName) {
|
||
|
|
if (array_key_exists($relationName, $this->_oldRelationValue)) { // Relation was not set, do nothing...
|
||
|
|
Yii::trace("Linking {$relationName} relation", __METHOD__);
|
||
|
|
$relation = $model->getRelation($relationName);
|
||
|
|
if ($relation->multiple === true) { // Has many relation
|
||
|
|
list($addedPks, $deletedPks) = $this->_computePkDiff($this->_oldRelationValue[$relationName],
|
||
|
|
$model->{$relationName});
|
||
|
|
// Deleted relations
|
||
|
|
$initialModels = ArrayHelper::index($this->_oldRelationValue[$relationName],
|
||
|
|
function (ActiveRecord $model) {
|
||
|
|
return implode("-", $model->getPrimaryKey(true));
|
||
|
|
});
|
||
|
|
foreach ($deletedPks as $key) {
|
||
|
|
$model->unlink($relationName, $initialModels[$key], true);
|
||
|
|
}
|
||
|
|
// Added relations
|
||
|
|
$actualModels = ArrayHelper::index($model->{$relationName}, function (ActiveRecord $model) {
|
||
|
|
return implode("-", $model->getPrimaryKey(true));
|
||
|
|
});
|
||
|
|
foreach ($addedPks as $key) {
|
||
|
|
$model->link($relationName, $actualModels[$key]);
|
||
|
|
}
|
||
|
|
} else { // Has one relation
|
||
|
|
if ($this->_oldRelationValue[$relationName] != $model->{$relationName}) {
|
||
|
|
$model->link($relationName, $model->{$relationName});
|
||
|
|
}
|
||
|
|
}
|
||
|
|
unset($this->_oldRelationValue[$relationName]);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
$model->refresh();
|
||
|
|
$this->_relationsSaveStarted = false;
|
||
|
|
if ($this->_transaction->isActive) {
|
||
|
|
$this->_transaction->commit();
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Compute the difference between two set of records using primary keys "tokens"
|
||
|
|
* @param ActiveRecord[] $initialRelations
|
||
|
|
* @param ActiveRecord[] $updatedRelations
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
private function _computePkDiff($initialRelations, $updatedRelations)
|
||
|
|
{
|
||
|
|
// Compute differences between initial relations and the current ones
|
||
|
|
$oldPks = ArrayHelper::getColumn($initialRelations, function (ActiveRecord $model) {
|
||
|
|
return implode("-", $model->getPrimaryKey(true));
|
||
|
|
});
|
||
|
|
$newPks = ArrayHelper::getColumn($updatedRelations, function (ActiveRecord $model) {
|
||
|
|
return implode("-", $model->getPrimaryKey(true));
|
||
|
|
});
|
||
|
|
$identicalPks = array_intersect($oldPks, $newPks);
|
||
|
|
$addedPks = array_values(array_diff($newPks, $identicalPks));
|
||
|
|
$deletedPks = array_values(array_diff($oldPks, $identicalPks));
|
||
|
|
return [$addedPks, $deletedPks];
|
||
|
|
}
|
||
|
|
|
||
|
|
}
|