Skip to content

safer work with magic properties #6

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

Merged
light-source merged 2 commits into from
Sep 13, 2025
Merged

safer work with magic properties #6

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
57e2b0d
todo
light-source Sep 13, 2025
2edd1fe
safer work with magic properties (__get() based)
light-source Sep 13, 2025
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
138 changes: 123 additions & 15 deletions src/Typed.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ final class Typed
*/
public static function any($source, $keys = null, $default = null)
{
return self::anyAsReference($source, $keys, $default);
return self::resolveAny($source, $keys, $default);
}

/**
Expand Down Expand Up @@ -346,36 +346,81 @@ public static function setItem(&$target, $keys, $value): bool
return false;
}

$parentItemReference = &self::anyAsReference($target, $keys);
$parentItemReference = &self::resolveAnyAsReference($target, $keys);

if (is_array($parentItemReference)) {
$parentItemReference[$itemKey] = $value;

return true;
}

$stringItemKey = (string) $itemKey;

if (is_object($parentItemReference)) {
try {
// @phpstan-ignore-next-line
$parentItemReference->{$itemKey} = $value;
} catch (Throwable $e) {
return false;
}
return self::setObjectProperty($parentItemReference, $stringItemKey, $value);
}

return true;
// fallback: if the parent element wasn't resolved as a reference,
// e.g. somewhere in the key chain there is __get(),
// we try to resolve it as a plain value,
// and if the resolved plain value is an object, then we assign, since any object is a link itself
if (is_null($parentItemReference)) {
$parentItem = self::resolveAny($target, $keys);

if (is_object($parentItem)) {
return self::setObjectProperty($parentItem, $stringItemKey, $value);
}
}

return false;
}

/**
* @param mixed $value
*/
protected static function setObjectProperty(object $object, string $property, $value): bool
{
try {
// @phpstan-ignore-next-line
$object->{$property} = $value;
} catch (Throwable $e) {
return false;
}

return true;
}

/**
* @param mixed $source
* @param int|string|array<int,int|string>|null $keys
* @param mixed $default
*
* @return mixed
*/
protected static function &anyAsReference(&$source, $keys = null, $default = null)
protected static function &resolveAnyAsReference(&$source, $keys = null, $default = null)
{
if (null === $keys) {
return $source;
}

if (
is_string($keys) ||
is_numeric($keys)
) {
$keys = explode('.', (string) $keys);
}

return self::resolveKeysAsReference($source, $keys, $default);
}

/**
* @param mixed $source
* @param int|string|array<int,int|string>|null $keys
* @param mixed $default
*
* @return mixed
*/
protected static function resolveAny($source, $keys = null, $default = null)
{
if (null === $keys) {
return $source;
Expand All @@ -397,19 +442,55 @@ protected static function &anyAsReference(&$source, $keys = null, $default = nul
*
* @return mixed
*/
protected static function &resolveKey(&$source, $key, bool &$isResolved = false)
protected static function &resolveKeyAsReference(&$source, $key, bool &$isResolved = false)
{
$value = null;
$stringKey = (string) $key;

if (
is_object($source) &&
// for taking a reference property must exist, case with __get() based won't work:
// "Indirect modification of overloaded property ... has no effect"
property_exists($source, $stringKey)
) {
$isResolved = true;

// @phpstan-ignore-next-line
$value = &$source->{$stringKey};
}

if (
is_array($source) &&
key_exists($key, $source)
) {
$isResolved = true;

$value = &$source[$key];
}

return $value;
}

/**
* @param mixed $source
* @param int|string $key
*
* @return mixed
*/
protected static function resolveKey($source, $key, bool &$isResolved = false)
{
$value = null;

if (
is_object($source) &&
// using isset() we support __get() based properties
// @phpstan-ignore-next-line
isset($source->{$key})
) {
$isResolved = true;

// @phpstan-ignore-next-line
$value = &$source->{$key};
$value = $source->{$key};
}

if (
Expand All @@ -418,7 +499,7 @@ protected static function &resolveKey(&$source, $key, bool &$isResolved = false)
) {
$isResolved = true;

$value = &$source[$key];
$value = $source[$key];
}

return $value;
Expand All @@ -431,14 +512,14 @@ protected static function &resolveKey(&$source, $key, bool &$isResolved = false)
*
* @return mixed
*/
protected static function &resolveKeys(&$source, array $keys, $default)
protected static function &resolveKeysAsReference(&$source, array $keys, $default)
{
$origin = &$source;

foreach ($keys as $key) {
$isResolved = false;

$value = &self::resolveKey($origin, $key, $isResolved);
$value = &self::resolveKeyAsReference($origin, $key, $isResolved);

if ($isResolved) {
$origin = &$value;
Expand All @@ -450,4 +531,31 @@ protected static function &resolveKeys(&$source, array $keys, $default)

return $origin;
}

/**
* @param mixed $source
* @param array<int,int|string> $keys
* @param mixed $default
*
* @return mixed
*/
protected static function resolveKeys($source, array $keys, $default)
{
$origin = $source;

foreach ($keys as $key) {
$isResolved = false;

$value = self::resolveKey($origin, $key, $isResolved);

if ($isResolved) {
$origin = $value;
continue;
}

return $default;
}

return $origin;
}
}