Skip to content

[12.x] Add data_map helper #56007

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
+77 −10
Closed

[12.x] Add data_map helper #56007

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 37 additions & 10 deletions src/Illuminate/Collections/helpers.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,24 @@ function data_get($target, $key, $default = null)
*/
function data_set(&$target, $key, $value, $overwrite = true)
{
return data_map($target, $key, fn () => $value, $overwrite);
}
}

if (! function_exists('data_map')) {
/**
* Run a map over an array or object using dot notation.
*
* @param mixed $target
* @param string|array $key
* @param callable $callback
* @param bool $overwrite
* @return mixed
*/
function data_map(&$target, $key, callable $callback, bool $overwrite = true)
{
static $fullKey = '';

$segments = is_array($key) ? $key : explode('.', $key);

if (($segment = array_shift($segments)) === '*') {
Expand All @@ -116,12 +134,16 @@ function data_set(&$target, $key, $value, $overwrite = true)
}

if ($segments) {
foreach ($target as &$inner) {
data_set($inner, $segments, $value, $overwrite);
$loopKey = $fullKey;
foreach ($target as $i => &$inner) {
$fullKey = trim($loopKey.'.'.$i, '.');
data_map($inner, $segments, $callback, $overwrite);
}
} elseif ($overwrite) {
foreach ($target as &$inner) {
$inner = $value;
$loopKey = $fullKey;
foreach ($target as $i => &$inner) {
$fullKey = trim($loopKey.'.'.$i, '.');
$inner = $callback($inner, $fullKey);
}
}
} elseif (Arr::accessible($target)) {
Expand All @@ -130,30 +152,35 @@ function data_set(&$target, $key, $value, $overwrite = true)
$target[$segment] = [];
}

data_set($target[$segment], $segments, $value, $overwrite);
$fullKey = trim($fullKey.'.'.$segment, '.');
data_map($target[$segment], $segments, $callback, $overwrite);
} elseif ($overwrite || ! Arr::exists($target, $segment)) {
$target[$segment] = $value;
$target[$segment] = $callback(Arr::get($target, $segment), $fullKey);
}
} elseif (is_object($target)) {
if ($segments) {
if (! isset($target->{$segment})) {
$target->{$segment} = [];
}

data_set($target->{$segment}, $segments, $value, $overwrite);
$fullKey = trim($fullKey.'.'.$segment, '.');
data_map($target->{$segment}, $segments, $callback, $overwrite);
} elseif ($overwrite || ! isset($target->{$segment})) {
$target->{$segment} = $value;
$target->{$segment} = $callback($target->{$segment} ?? null, $fullKey);
}
} else {
$target = [];

if ($segments) {
data_set($target[$segment], $segments, $value, $overwrite);
$fullKey = trim($fullKey.'.'.$segment, '.');
data_map($target[$segment], $segments, $callback, $overwrite);
} elseif ($overwrite) {
$target[$segment] = $value;
$target[$segment] = $callback($target[$segment] ?? null, $fullKey);
}
}

$fullKey = '';

return $target;
}
}
Expand Down
40 changes: 40 additions & 0 deletions tests/Support/SupportHelpersTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -622,6 +622,46 @@ public function testDataSetWithDoubleStar()
], $data);
}

public function testDataMap()
{
$data = [
'posts' => [
(object) [
'comments' => [
(object) ['order' => 1],
(object) [],
],
],
(object) [
'comments' => [
(object) [],
(object) ['order' => 2],
],
],
],
];

data_map($data, 'posts.*.comments.*.key', fn ($old, $key) => $key);
data_map($data, 'posts.*.comments.*.order', fn ($old) => isset($old) ? ++$old : null);

$this->assertEquals([
'posts' => [
(object) [
'comments' => [
(object) ['key' => 'posts.0.comments.0', 'order' => 2],
(object) ['key' => 'posts.0.comments.1', 'order' => null],
],
],
(object) [
'comments' => [
(object) ['key' => 'posts.1.comments.0', 'order' => null],
(object) ['key' => 'posts.1.comments.1', 'order' => 3],
],
],
],
], $data);
}

public function testDataRemove()
{
$data = ['foo' => 'bar', 'hello' => 'world'];
Expand Down