Get multiple custom properties at the same time

[timgavin]

I found myself needing to retrieve several custom properties at the same time, and it just felt yucky to have so many calls to getCustomProperty()

Instead of doing this

$mediaDimensions = [
    'sm_width' => $transaction->media[0]->getCustomProperty('sm_width'),
    'sm_height' => $transaction->media[0]->getCustomProperty('sm_height'),
    'md_width' => $transaction->media[0]->getCustomProperty('md_width'),
    'md_height' => $transaction->media[0]->getCustomProperty('md_height'),
    'lg_width' => $transaction->media[0]->getCustomProperty('lg_width'),
    'lg_height' => $transaction->media[0]->getCustomProperty('lg_height'),
];

It just feels better to do this

$mediaDimensions = $transaction->media[0]->getCustomProperties([
    'sm_width', 'sm_height', 'md_width', 'md_height', 'lg_width', 'lg_height'
]);

This is such a small function (and I didn't see any tests for getCustomProperty()) that I didn't want to go through the process of creating a PR, so I thought I'd offer it here. Hope you find it useful.

/**
 * Get the values of multiple custom properties with the given names.
 * @param  array  $propertyNames
 * @return array
 */
public function getCustomProperties(array $propertyNames): array
{
    return array_intersect_key(
        $this->custom_properties,
        array_flip($propertyNames)
    );
}

returns

array:6 [▼
  "lg_width" => 1280
  "md_width" => 720
  "sm_width" => 300
  "lg_height" => 789
  "md_height" => 444
  "sm_height" => 185
]

Edit: I guess you could also do this?

public function getCustomProperty(array|string $propertyName, $default = null): mixed
{
    if (is_array($propertyName)) {
        return array_intersect_key(
            $this->custom_properties,
            array_flip($propertyNames)
        );
    }
    
    return Arr::get($this->custom_properties, $propertyName, $default);
}