Skip to content

Navigation Menu

Sign in

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit a5698aa

Browse filesBrowse files
soyukafabpot
soyuka
authored and
fabpot
committed
[ObjectMapper] Condition to target a specific class
1 parent 7a24bdc commit a5698aa
Copy full SHA for a5698aa

File tree

11 files changed

+135
-17
lines changed
Filter options

11 files changed

+135
-17
lines changed

‎src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/ObjectMapper/TransformCallable.php

Copy file name to clipboardExpand all lines: src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/ObjectMapper/TransformCallable.php
+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
*/
1919
final class TransformCallable implements TransformCallableInterface
2020
{
21-
public function __invoke(mixed $value, object $object): mixed
21+
public function __invoke(mixed $value, object $source, ?object $target): mixed
2222
{
2323
return 'transformed';
2424
}

‎src/Symfony/Component/ObjectMapper/Condition/TargetClass.php

Copy file name to clipboard
+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <fabien@symfony.com>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace Symfony\Component\ObjectMapper\Condition;
13+
14+
use Symfony\Component\ObjectMapper\ConditionCallableInterface;
15+
16+
/**
17+
* @template T of object
18+
*
19+
* @implements ConditionCallableInterface<object, T>
20+
*/
21+
final class TargetClass implements ConditionCallableInterface
22+
{
23+
/**
24+
* @param class-string<T> $className
25+
*/
26+
public function __construct(private readonly string $className)
27+
{
28+
}
29+
30+
public function __invoke(mixed $value, object $source, ?object $target): bool
31+
{
32+
return $target instanceof $this->className;
33+
}
34+
}

‎src/Symfony/Component/ObjectMapper/ConditionCallableInterface.php

Copy file name to clipboardExpand all lines: src/Symfony/Component/ObjectMapper/ConditionCallableInterface.php
+3-1
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
* Service used by "Map::if".
1616
*
1717
* @template T of object
18+
* @template T2 of object
1819
*
1920
* @experimental
2021
*
@@ -25,6 +26,7 @@ interface ConditionCallableInterface
2526
/**
2627
* @param mixed $value The value being mapped
2728
* @param T $source The object we're working on
29+
* @param T2|null $target The target we're mapping to
2830
*/
29-
public function __invoke(mixed $value, object $source): bool;
31+
public function __invoke(mixed $value, object $source, ?object $target): bool;
3032
}

‎src/Symfony/Component/ObjectMapper/ObjectMapper.php

Copy file name to clipboardExpand all lines: src/Symfony/Component/ObjectMapper/ObjectMapper.php
+12-12
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ public function map(object $source, object|string|null $target = null): object
5050
}
5151

5252
$metadata = $this->metadataFactory->create($source);
53-
$map = $this->getMapTarget($metadata, null, $source);
53+
$map = $this->getMapTarget($metadata, null, $source, null);
5454
$target ??= $map?->target;
5555
$mappingToObject = \is_object($target);
5656

@@ -70,7 +70,7 @@ public function map(object $source, object|string|null $target = null): object
7070

7171
$mappedTarget = $mappingToObject ? $target : $targetRefl->newInstanceWithoutConstructor();
7272
if ($map && $map->transform) {
73-
$mappedTarget = $this->applyTransforms($map, $mappedTarget, $mappedTarget);
73+
$mappedTarget = $this->applyTransforms($map, $mappedTarget, $mappedTarget, null);
7474

7575
if (!\is_object($mappedTarget)) {
7676
throw new MappingTransformException(\sprintf('Cannot map "%s" to a non-object target of type "%s".', get_debug_type($source), get_debug_type($mappedTarget)));
@@ -123,7 +123,7 @@ public function map(object $source, object|string|null $target = null): object
123123
}
124124

125125
$value = $this->getRawValue($source, $sourcePropertyName);
126-
if (($if = $mapping->if) && ($fn = $this->getCallable($if, $this->conditionCallableLocator)) && !$this->call($fn, $value, $source)) {
126+
if (($if = $mapping->if) && ($fn = $this->getCallable($if, $this->conditionCallableLocator)) && !$this->call($fn, $value, $source, $mappedTarget)) {
127127
continue;
128128
}
129129

@@ -173,16 +173,16 @@ private function getRawValue(object $source, string $propertyName): mixed
173173
private function getSourceValue(object $source, object $target, mixed $value, \SplObjectStorage $objectMap, ?Mapping $mapping = null): mixed
174174
{
175175
if ($mapping?->transform) {
176-
$value = $this->applyTransforms($mapping, $value, $source);
176+
$value = $this->applyTransforms($mapping, $value, $source, $target);
177177
}
178178

179179
if (
180180
\is_object($value)
181181
&& ($innerMetadata = $this->metadataFactory->create($value))
182-
&& ($mapTo = $this->getMapTarget($innerMetadata, $value, $source))
182+
&& ($mapTo = $this->getMapTarget($innerMetadata, $value, $source, $target))
183183
&& (\is_string($mapTo->target) && class_exists($mapTo->target))
184184
) {
185-
$value = $this->applyTransforms($mapTo, $value, $source);
185+
$value = $this->applyTransforms($mapTo, $value, $source, $target);
186186

187187
if ($value === $source) {
188188
$value = $target;
@@ -216,23 +216,23 @@ private function storeValue(string $propertyName, array &$mapToProperties, array
216216
/**
217217
* @param callable(): mixed $fn
218218
*/
219-
private function call(callable $fn, mixed $value, object $object): mixed
219+
private function call(callable $fn, mixed $value, object $source, ?object $target = null): mixed
220220
{
221221
if (\is_string($fn)) {
222222
return \call_user_func($fn, $value);
223223
}
224224

225-
return $fn($value, $object);
225+
return $fn($value, $source, $target);
226226
}
227227

228228
/**
229229
* @param Mapping[] $metadata
230230
*/
231-
private function getMapTarget(array $metadata, mixed $value, object $source): ?Mapping
231+
private function getMapTarget(array $metadata, mixed $value, object $source, ?object $target): ?Mapping
232232
{
233233
$mapTo = null;
234234
foreach ($metadata as $mapAttribute) {
235-
if (($if = $mapAttribute->if) && ($fn = $this->getCallable($if, $this->conditionCallableLocator)) && !$this->call($fn, $value, $source)) {
235+
if (($if = $mapAttribute->if) && ($fn = $this->getCallable($if, $this->conditionCallableLocator)) && !$this->call($fn, $value, $source, $target)) {
236236
continue;
237237
}
238238

@@ -242,7 +242,7 @@ private function getMapTarget(array $metadata, mixed $value, object $source): ?M
242242
return $mapTo;
243243
}
244244

245-
private function applyTransforms(Mapping $map, mixed $value, object $object): mixed
245+
private function applyTransforms(Mapping $map, mixed $value, object $source, ?object $target): mixed
246246
{
247247
if (!$transforms = $map->transform) {
248248
return $value;
@@ -256,7 +256,7 @@ private function applyTransforms(Mapping $map, mixed $value, object $object): mi
256256

257257
foreach ($transforms as $transform) {
258258
if ($fn = $this->getCallable($transform, $this->transformCallableLocator)) {
259-
$value = $this->call($fn, $value, $object);
259+
$value = $this->call($fn, $value, $source, $target);
260260
}
261261
}
262262

‎src/Symfony/Component/ObjectMapper/Tests/Fixtures/MultipleTargetProperty/A.php

Copy file name to clipboard
+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <fabien@symfony.com>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace Symfony\Component\ObjectMapper\Tests\Fixtures\MultipleTargetProperty;
13+
14+
use Symfony\Component\ObjectMapper\Attribute\Map;
15+
use Symfony\Component\ObjectMapper\Condition\TargetClass;
16+
17+
#[Map(target: B::class)]
18+
#[Map(target: C::class)]
19+
class A
20+
{
21+
#[Map(target: 'foo', transform: 'strtoupper', if: new TargetClass(B::class))]
22+
#[Map(target: 'bar')]
23+
public string $something = 'test';
24+
25+
public string $doesNotExistInTargetB = 'foo';
26+
}

‎src/Symfony/Component/ObjectMapper/Tests/Fixtures/MultipleTargetProperty/B.php

Copy file name to clipboard
+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <fabien@symfony.com>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace Symfony\Component\ObjectMapper\Tests\Fixtures\MultipleTargetProperty;
13+
14+
class B
15+
{
16+
public string $foo;
17+
}

‎src/Symfony/Component/ObjectMapper/Tests/Fixtures/MultipleTargetProperty/C.php

Copy file name to clipboard
+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <fabien@symfony.com>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace Symfony\Component\ObjectMapper\Tests\Fixtures\MultipleTargetProperty;
13+
14+
class C
15+
{
16+
public string $foo = 'donotmap';
17+
public string $bar;
18+
public string $doesNotExistInTargetB;
19+
}

‎src/Symfony/Component/ObjectMapper/Tests/Fixtures/ServiceLocator/ConditionCallable.php

Copy file name to clipboardExpand all lines: src/Symfony/Component/ObjectMapper/Tests/Fixtures/ServiceLocator/ConditionCallable.php
+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
*/
1919
class ConditionCallable implements ConditionCallableInterface
2020
{
21-
public function __invoke(mixed $value, object $object): bool
21+
public function __invoke(mixed $value, object $source, ?object $target): bool
2222
{
2323
return 'ok' === $value;
2424
}

‎src/Symfony/Component/ObjectMapper/Tests/Fixtures/ServiceLocator/TransformCallable.php

Copy file name to clipboardExpand all lines: src/Symfony/Component/ObjectMapper/Tests/Fixtures/ServiceLocator/TransformCallable.php
+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
*/
1919
class TransformCallable implements TransformCallableInterface
2020
{
21-
public function __invoke(mixed $value, object $object): mixed
21+
public function __invoke(mixed $value, object $source, ?object $target): mixed
2222
{
2323
return "transformed$value";
2424
}

‎src/Symfony/Component/ObjectMapper/Tests/ObjectMapperTest.php

Copy file name to clipboardExpand all lines: src/Symfony/Component/ObjectMapper/Tests/ObjectMapperTest.php
+18
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,9 @@
4040
use Symfony\Component\ObjectMapper\Tests\Fixtures\MapStruct\Target;
4141
use Symfony\Component\ObjectMapper\Tests\Fixtures\MapTargetToSource\A as MapTargetToSourceA;
4242
use Symfony\Component\ObjectMapper\Tests\Fixtures\MapTargetToSource\B as MapTargetToSourceB;
43+
use Symfony\Component\ObjectMapper\Tests\Fixtures\MultipleTargetProperty\A as MultipleTargetPropertyA;
44+
use Symfony\Component\ObjectMapper\Tests\Fixtures\MultipleTargetProperty\B as MultipleTargetPropertyB;
45+
use Symfony\Component\ObjectMapper\Tests\Fixtures\MultipleTargetProperty\C as MultipleTargetPropertyC;
4346
use Symfony\Component\ObjectMapper\Tests\Fixtures\MultipleTargets\A as MultipleTargetsA;
4447
use Symfony\Component\ObjectMapper\Tests\Fixtures\MultipleTargets\C as MultipleTargetsC;
4548
use Symfony\Component\ObjectMapper\Tests\Fixtures\Recursion\AB;
@@ -273,4 +276,19 @@ public function testMapTargetToSource()
273276
$this->assertInstanceOf(MapTargetToSourceB::class, $b);
274277
$this->assertSame('str', $b->target);
275278
}
279+
280+
public function testMultipleTargetMapProperty()
281+
{
282+
$u = new MultipleTargetPropertyA();
283+
284+
$mapper = new ObjectMapper();
285+
$b = $mapper->map($u, MultipleTargetPropertyB::class);
286+
$this->assertInstanceOf(MultipleTargetPropertyB::class, $b);
287+
$this->assertEquals($b->foo, 'TEST');
288+
$c = $mapper->map($u, MultipleTargetPropertyC::class);
289+
$this->assertInstanceOf(MultipleTargetPropertyC::class, $c);
290+
$this->assertEquals($c->bar, 'test');
291+
$this->assertEquals($c->foo, 'donotmap');
292+
$this->assertEquals($c->doesNotExistInTargetB, 'foo');
293+
}
276294
}

‎src/Symfony/Component/ObjectMapper/TransformCallableInterface.php

Copy file name to clipboardExpand all lines: src/Symfony/Component/ObjectMapper/TransformCallableInterface.php
+3-1
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
* Service used by "Map::transform".
1616
*
1717
* @template T of object
18+
* @template T2 of object
1819
*
1920
* @experimental
2021
*
@@ -25,6 +26,7 @@ interface TransformCallableInterface
2526
/**
2627
* @param mixed $value The value being mapped
2728
* @param T $source The object we're working on
29+
* @param T2|null $target The target we're mapping to
2830
*/
29-
public function __invoke(mixed $value, object $source): mixed;
31+
public function __invoke(mixed $value, object $source, ?object $target): mixed;
3032
}

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.