Error202
/
yii2-save-relations-behavior
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Browse Source

Enhancement #4 

- loadRelations() has been added to be able to load relations data from a data array
- SaveRelationsTrait has been added. It gives the ability to overload the load() method of the owner model to be able to load batch relations
tags/1.1.0
Alban Jubert 9 years ago
parent
c8cd72a7fa
commit
6123fa2c9a
3 changed files with 90 additions and 26 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 22
      src/SaveRelationsBehavior.php
  2. 16
      src/SaveRelationsTrait.php
  3. 76
      tests/SaveRelationsBehaviorTest.php

22
src/SaveRelationsBehavior.php
Unescape View File

@ -160,6 +160,7 @@ class SaveRelationsBehavior extends Behavior
if ($relation->multiple === false && !empty($model->{$relationName})) { if ($relation->multiple === false && !empty($model->{$relationName})) {
Yii::trace("Setting foreign keys for {$relationName}", __METHOD__); Yii::trace("Setting foreign keys for {$relationName}", __METHOD__);
foreach ($relation->link as $relatedAttribute => $modelAttribute) { foreach ($relation->link as $relatedAttribute => $modelAttribute) {
if ($model->{$modelAttribute} !== $model->{$relationName}->{$relatedAttribute}) {
$model->{$modelAttribute} = $model->{$relationName}->{$relatedAttribute}; $model->{$modelAttribute} = $model->{$relationName}->{$relatedAttribute};
} }
} }
@ -168,6 +169,7 @@ class SaveRelationsBehavior extends Behavior
} }
} }
} }
}
/** /**
* For each related model, try to save it first. * For each related model, try to save it first.
@ -358,4 +360,24 @@ class SaveRelationsBehavior extends Behavior
return [$addedPks, $deletedPks]; return [$addedPks, $deletedPks];
} }
/**
* Populates relations with input data
* @param array $data
*/
public function loadRelations($data)
{
/** @var ActiveRecord $model */
$model = $this->owner;
foreach ($this->relations as $relationName) {
$relation = $model->getRelation($relationName);
$modelClass = $relation->modelClass;
$relationalModel = new $modelClass;
$formName = $relationalModel->formName();
if (array_key_exists($formName, $data)) {
$model->{$relationName} = $data[$formName];
}
}
}
} }

16
src/SaveRelationsTrait.php
Unescape View File

@ -0,0 +1,16 @@
<?php
namespace lhs\Yii2SaveRelationsBehavior;
trait SaveRelationsTrait
{
public function load($data, $formName = null)
{
$loaded = parent::load($data, $formName);
if ($loaded) {
$this->loadRelations($data, $formName = null);
}
return $loaded;
}
}

76
tests/SaveRelationsBehaviorTest.php
Unescape View File

@ -214,66 +214,66 @@ class SaveRelationsBehaviorTest extends \PHPUnit_Framework_TestCase
{ {
$project = Project::findOne(1); $project = Project::findOne(1);
$user = User::findOne(3); $user = User::findOne(3);
$this->assertEquals(2, count($project->users), 'Project should have 2 users before save'); $this->assertCount(2, $project->users, 'Project should have 2 users before save');
$project->users = array_merge($project->users, [$user]); // Add new user to the existing list $project->users = array_merge($project->users, [$user]); // Add new user to the existing list
$this->assertEquals(3, count($project->users), 'Project should have 3 users after assignment'); $this->assertCount(3, $project->users, 'Project should have 3 users after assignment');
$this->assertTrue($project->save(), 'Project could not be saved'); $this->assertTrue($project->save(), 'Project could not be saved');
$this->assertEquals(3, count($project->users), 'Project should have 3 users after save'); $this->assertCount(3, $project->users, 'Project should have 3 users after save');
} }
public function testSaveAddedExistingHasManyRelationAsArrayShouldSucceed() public function testSaveAddedExistingHasManyRelationAsArrayShouldSucceed()
{ {
$project = Project::findOne(1); $project = Project::findOne(1);
$user = ['id' => 3]; $user = ['id' => 3];
$this->assertEquals(2, count($project->users), 'Project should have 2 users before save'); $this->assertCount(2, $project->users, 'Project should have 2 users before save');
$project->users = array_merge($project->users, [$user]); // Add new user to the existing list $project->users = array_merge($project->users, [$user]); // Add new user to the existing list
$this->assertEquals(3, count($project->users), 'Project should have 3 users after assignment'); $this->assertCount(3, $project->users, 'Project should have 3 users after assignment');
$this->assertTrue($project->save(), 'Project could not be saved'); $this->assertTrue($project->save(), 'Project could not be saved');
$this->assertEquals(3, count($project->users), 'Project should have 3 users after save'); $this->assertCount(3, $project->users, 'Project should have 3 users after save');
} }
public function testSaveAddedExistingHasManyRelationAsIDShouldSucceed() public function testSaveAddedExistingHasManyRelationAsIDShouldSucceed()
{ {
$project = Project::findOne(1); $project = Project::findOne(1);
$user = 3; $user = 3;
$this->assertEquals(2, count($project->users), 'Project should have 2 users before save'); $this->assertCount(2, $project->users, 'Project should have 2 users before save');
$project->users = array_merge($project->users, [$user]); // Add new user to the existing list $project->users = array_merge($project->users, [$user]); // Add new user to the existing list
$this->assertEquals(3, count($project->users), 'Project should have 3 users after assignment'); $this->assertCount(3, $project->users, 'Project should have 3 users after assignment');
$this->assertTrue($project->save(), 'Project could not be saved'); $this->assertTrue($project->save(), 'Project could not be saved');
$this->assertEquals(3, count($project->users), 'Project should have 3 users after save'); $this->assertCount(3, $project->users, 'Project should have 3 users after save');
} }
public function testSaveDeletedExistingHasManyRelationShouldSucceed() public function testSaveDeletedExistingHasManyRelationShouldSucceed()
{ {
$project = Project::findOne(1); $project = Project::findOne(1);
$this->assertEquals(2, count($project->users), 'Project should have 2 users before save'); $this->assertCount(2, $project->users, 'Project should have 2 users before save');
$project->users = User::findAll([1]); // Change users by removing one $project->users = User::findAll([1]); // Change users by removing one
$this->assertEquals(1, count($project->users), 'Project should have 1 user after assignment'); $this->assertCount(1, $project->users, 'Project should have 1 user after assignment');
$this->assertTrue($project->save(), 'Project could not be saved'); $this->assertTrue($project->save(), 'Project could not be saved');
$this->assertEquals(1, count($project->users), 'Project should have 1 user after save'); $this->assertCount(1, $project->users, 'Project should have 1 user after save');
} }
public function testSaveNewHasManyRelationAsModelShouldSucceed() public function testSaveNewHasManyRelationAsModelShouldSucceed()
{ {
$project = Project::findOne(2); $project = Project::findOne(2);
$this->assertEquals(1, count($project->users), 'Project should have 1 user before save'); $this->assertCount(1, $project->users, 'Project should have 1 user before save');
$user = new User(); $user = new User();
$user->username = "Steve Balmer"; $user->username = "Steve Balmer";
$project->users = array_merge($project->users, [$user]); // Add a fresh new user $project->users = array_merge($project->users, [$user]); // Add a fresh new user
$this->assertEquals(2, count($project->users), 'Project should have 2 users after assignment'); $this->assertCount(2, $project->users, 'Project should have 2 users after assignment');
$this->assertTrue($project->save(), 'Project could not be saved'); $this->assertTrue($project->save(), 'Project could not be saved');
$this->assertEquals(2, count($project->users), 'Project should have 2 users after save'); $this->assertCount(2, $project->users, 'Project should have 2 users after save');
} }
public function testSaveNewHasManyRelationAsArrayShouldSucceed() public function testSaveNewHasManyRelationAsArrayShouldSucceed()
{ {
$project = Project::findOne(2); $project = Project::findOne(2);
$this->assertEquals(1, count($project->users), 'Project should have 1 user before save'); $this->assertCount(1, $project->users, 'Project should have 1 user before save');
$user = ['username' => "Steve Balmer"]; $user = ['username' => "Steve Balmer"];
$project->users = array_merge($project->users, [$user]); // Add a fresh new user $project->users = array_merge($project->users, [$user]); // Add a fresh new user
$this->assertEquals(2, count($project->users), 'Project should have 2 users after assignment'); $this->assertCount(2, $project->users, 'Project should have 2 users after assignment');
$this->assertTrue($project->save(), 'Project could not be saved'); $this->assertTrue($project->save(), 'Project could not be saved');
$this->assertEquals(2, count($project->users), 'Project should have 2 users after save'); $this->assertCount(2, $project->users, 'Project should have 2 users after save');
$this->assertEquals("Steve Balmer", $project->users[1]->username, 'Second user should be Steve Balmer'); $this->assertEquals("Steve Balmer", $project->users[1]->username, 'Second user should be Steve Balmer');
$this->assertNotEmpty($project->users[1]->id, 'Second user should have an ID'); $this->assertNotEmpty($project->users[1]->id, 'Second user should have an ID');
} }
@ -287,9 +287,9 @@ class SaveRelationsBehaviorTest extends \PHPUnit_Framework_TestCase
$link->name = 'windows10'; $link->name = 'windows10';
$link->link = 'https://www.microsoft.com/fr-fr/windows/features'; $link->link = 'https://www.microsoft.com/fr-fr/windows/features';
$project->links = array_merge($project->links, [$link]); $project->links = array_merge($project->links, [$link]);
$this->assertEquals(3, count($project->links), 'Project should have 3 links after assignment'); $this->assertCount(3, $project->links, 'Project should have 3 links after assignment');
$this->assertTrue($project->save(), 'Project could not be saved'); $this->assertTrue($project->save(), 'Project could not be saved');
$this->assertEquals(3, count($project->links), 'Project should have 3 links after save'); $this->assertCount(3, $project->links, 'Project should have 3 links after save');
$this->assertEquals("https://www.microsoft.com/fr-fr/windows/features", $project->links[2]->link, $this->assertEquals("https://www.microsoft.com/fr-fr/windows/features", $project->links[2]->link,
'Second link should be https://www.microsoft.com/fr-fr/windows/features'); 'Second link should be https://www.microsoft.com/fr-fr/windows/features');
} }
@ -303,9 +303,9 @@ class SaveRelationsBehaviorTest extends \PHPUnit_Framework_TestCase
['language' => 'en', 'name' => 'windows10', 'link' => 'https://www.microsoft.com/en-us/windows/features'] ['language' => 'en', 'name' => 'windows10', 'link' => 'https://www.microsoft.com/en-us/windows/features']
]; ];
$project->links = array_merge($project->links, $links); $project->links = array_merge($project->links, $links);
$this->assertEquals(4, count($project->links), 'Project should have 4 links after assignment'); $this->assertCount(4, $project->links, 'Project should have 4 links after assignment');
$this->assertTrue($project->save(), 'Project could not be saved'); $this->assertTrue($project->save(), 'Project could not be saved');
$this->assertEquals(4, count($project->links), 'Project should have 4 links after save'); $this->assertCount(4, $project->links, 'Project should have 4 links after save');
$this->assertEquals("https://www.microsoft.com/fr-fr/windows/features", $project->links[2]->link, $this->assertEquals("https://www.microsoft.com/fr-fr/windows/features", $project->links[2]->link,
'Second link should be https://www.microsoft.com/fr-fr/windows/features'); 'Second link should be https://www.microsoft.com/fr-fr/windows/features');
$this->assertEquals("https://www.microsoft.com/en-us/windows/features", $project->links[3]->link, $this->assertEquals("https://www.microsoft.com/en-us/windows/features", $project->links[3]->link,
@ -320,7 +320,7 @@ class SaveRelationsBehaviorTest extends \PHPUnit_Framework_TestCase
$links[1]->link = "http://www.otherlink.com/"; $links[1]->link = "http://www.otherlink.com/";
$project->links = $links; $project->links = $links;
$this->assertTrue($project->save(), 'Project could not be saved'); $this->assertTrue($project->save(), 'Project could not be saved');
$this->assertEquals(2, count($project->links), 'Project should have 2 links before save'); $this->assertCount(2, $project->links, 'Project should have 2 links before save');
$this->assertEquals("http://www.otherlink.com/", $project->links[1]->link, $this->assertEquals("http://www.otherlink.com/", $project->links[1]->link,
'Second link "Link" attribute should be "http://www.otherlink.com/"'); 'Second link "Link" attribute should be "http://www.otherlink.com/"');
} }
@ -331,11 +331,11 @@ class SaveRelationsBehaviorTest extends \PHPUnit_Framework_TestCase
$project->name = "New project"; $project->name = "New project";
$project->company = Company::findOne(2); $project->company = Company::findOne(2);
$users = User::findAll([1, 3]); $users = User::findAll([1, 3]);
$this->assertEquals(0, count($project->users), 'Project should have 0 users before save'); $this->assertCount(0, $project->users, 'Project should have 0 users before save');
$project->users = $users; // Add users $project->users = $users; // Add users
$this->assertEquals(2, count($project->users), 'Project should have 2 users after assignment'); $this->assertEquals(2, count($project->users), 'Project should have 2 users after assignment');
$this->assertTrue($project->save(), 'Project could not be saved'); $this->assertTrue($project->save(), 'Project could not be saved');
$this->assertEquals(2, count($project->users), 'Project should have 2 users after save'); $this->assertCount(2, $project->users, 'Project should have 2 users after save');
$this->assertEquals(2, $project->company_id, 'Company ID is not the one expected'); $this->assertEquals(2, $project->company_id, 'Company ID is not the one expected');
} }
@ -361,5 +361,31 @@ class SaveRelationsBehaviorTest extends \PHPUnit_Framework_TestCase
$this->assertNull($link->link_type_id, "Link type id should be null"); $this->assertNull($link->link_type_id, "Link type id should be null");
} }
public function testLoadRelationsShouldSucceed()
{
$project = Project::findOne(1);
$data = [
'Company' => [
'name' => 'YiiSoft'
],
'ProjectLink' => [
[
'language' => 'en',
'name' => 'yii',
'link' => 'http://www.yiiframework.com'
],
[
'language' => 'fr',
'name' => 'yii',
'link' => 'http://www.yiiframework.fr'
]
]
];
$project->loadRelations($data);
$this->assertTrue($project->save(), 'Project could not be saved');
$this->assertEquals('YiiSoft', $project->company->name, "Company name should be YiiSoft");
$this->assertCount(2, $project->projectLinks, "Project should have 2 links");
}
} }

Write Preview
Loading…
Cancel
Save