Is there something like keypath in an associative array in PHP?

Question

I want to dissect an array like this:

[
    "ID",
    "UUID",
    "pushNotifications.sent",
    "campaigns.boundDate",
    "campaigns.endDate",
    "campaigns.pushMessages.sentDate",
    "pushNotifications.tapped"
]

To a format like this:

{
    "ID" : 1,
    "UUID" : 1,
    "pushNotifications" : 
        {
            "sent" : 1,
            "tapped" : 1
        },
    "campaigns" :
        {
            "boundDate" : 1,
            "endDate" : 1,
            "pushMessages" :
                {
                    "endDate" : 1
                }  
        }
}

It would be great if I could just set a value on an associative array in a keypath-like manner:

//To achieve this:
$dissected['campaigns']['pushMessages']['sentDate'] = 1;

//By something like this:
$keypath = 'campaigns.pushMessages.sentDate';
$dissected{$keypath} = 1;

How to do this in PHP?

To have a function like setValueForKeyPath($array, 1, 'campaigns.pushMessages.sentDate'); — Geri Borbás
– Geri Borbás, Commented May 5, 2013 at 21:18

Baba · Accepted Answer · 2013-05-05 21:36:29Z

5

You can use :

$array = [
        "ID",
        "UUID",
        "pushNotifications.sent",
        "campaigns.boundDate",
        "campaigns.endDate",
        "campaigns.pushMessages.sentDate",
        "pushNotifications.tapped"
];

// Build Data
$data = array();
foreach($array as $v) {
    setValue($data, $v, 1);
}

// Get Value
echo getValue($data, "campaigns.pushMessages.sentDate"); // output 1

Function Used

function setValue(array &$data, $path, $value) {
    $temp = &$data;
    foreach(explode(".", $path) as $key) {
        $temp = &$temp[$key];
    }
    $temp = $value;
}

function getValue($data, $path) {
    $temp = $data;
    foreach(explode(".", $path) as $ndx) {
        $temp = isset($temp[$ndx]) ? $temp[$ndx] : null;
    }
    return $temp;
}

answered May 5, 2013 at 21:36

Baba

95.3k29 gold badges172 silver badges222 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

Geri Borbás Over a year ago

Ah, and now I understand it. :D Walks into the array with the pointer, then set when there is no deeper. Nice solution, I could hardly find out such a simple one.

Baba Over a year ago

You might also want to consider Example 8 in SuperVariable which has object support and Implementing MongoDB-like Query expression object evaluation for other flexible way of working with array

EPB · Accepted Answer · 2013-05-05 21:26:11Z

function keyset(&$arr, $keypath, $value = NULL)
{
   $keys = explode('.', $keypath);
   $current = &$arr;
   while(count($keys))
   {
      $key = array_shift($keys);
      if(!isset($current[$key]) && count($keys))
      {
         $current[$key] = array();
      }
      if(count($keys))
      {
         $current = &$current[$key];
      }
   }
   $current[$key] = $value;
}

function keyget($arr, $keypath)
{
   $keys = explode('.', $keypath);
   $current = $arr;
   foreach($keys as $key)
   {
      if(!isset($current[$key]))
      {
         return NULL;
      }
      $current = $current[$key];
   }
   return $current;
}

//Testing code:
$r = array();
header('content-type: text/plain; charset-utf8');
keyset($r, 'this.is.path', 39);
echo keyget($r, 'this.is.path');
var_dump($r);

It's a little rough, I can't guarantee it functions 100%.

Edit: At first you'd be tempted to try to use variable variables, but I've tried that in the past and it doesn't work, so you have to use functions to do it. This works with some limited tests. (And I just added a minor edit to remove an unnecessary array assignment.)

Geri Borbás · Accepted Answer · 2013-05-05 22:07:28Z

In the meanwhile, I came up with (another) solution:

private function setValueForKeyPath(&$array, $value, $keyPath)
{
    $keys = explode(".", $keyPath, 2);
    $firstKey = $keys[0];
    $remainingKeys = (count($keys) == 2) ? $keys[1] : null;
    $isLeaf = ($remainingKeys == null);

    if ($isLeaf)
        $array[$firstKey] = $value;
    else
        $this->setValueForKeyPath($array[$firstKey], $value, $remainingKeys);
}

Sorry for the "long" namings, I came from the Objective-C world. :) So calling this on each keyPath, it actually gives me the output:

fields
Array
(
    [0] => ID
    [1] => UUID
    [2] => pushNotifications.sent
    [3] => campaigns.boundDate
    [4] => campaigns.endDate
    [5] => campaigns.pushMessages.endDate
    [6] => pushNotifications.tapped
)
dissectedFields
Array
(
    [ID] => 1
    [UUID] => 1
    [pushNotifications] => Array
        (
            [sent] => 1
            [tapped] => 1
        )

    [campaigns] => Array
        (
            [boundDate] => 1
            [endDate] => 1
            [pushMessages] => Array
                (
                    [endDate] => 1
                )

        )

)

Collectives™ on Stack Overflow

Is there something like keypath in an associative array in PHP?

3 Answers 3

2 Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

2 Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related