If invalid callbacks are provided and 'throwable' is true.

Basic removal of null values

use function oihana\core\objects\compress;

$obj = (object)[
    'id'          => 1,
    'name'        => 'hello',
    'description' => null,
];

$result = compress($obj, [
    'conditions' => fn($v) => $v === null,
]);

// Result: { "id":1, "name":"hello" }
echo json_encode($result);

Excluding certain properties

$obj = (object)[
    'id'    => 1,
    'debug' => 'keep me',
    'temp'  => null,
];

$result = compress($obj, [
    'conditions' => fn($v) => $v === null,
    'excludes'   => ['debug'],
]);

// Result: { "id":1, "debug":"keep me" }
echo json_encode($result);

Removing properties by name

$obj = (object)[
    'id'    => 1,
    'token' => 'secret',
    'name'  => 'test',
];

$result = compress($obj, [
    'removeKeys' => ['token'],
]);

// Result: { "id":1, "name":"test" }
echo json_encode($result);

Recursive compression

$obj = (object)[
    'id'    => 1,
    'child' => (object)[
        'value' => null,
        'label' => 'ok',
    ],
];

$result = compress($obj, [
    'conditions' => fn($v) => $v === null,
    'recursive'  => true,
]);

// Result: { "id":1, "child":{ "label":"ok" } }
echo json_encode($result);

Marc Alcaraz

$data = new stdClass();
$ref =& ensureObjectPath($data, 'config');
$ref->enabled = true;
// $data now contains: (object)['config' => (object)['enabled' => true]]

Marc Alcaraz (ekameleon)

use function oihana\core\objects\filter;

$values = (object) [ 'a' => 1 , 'b' => 2 , 'c' => 3 ] ;

$result = filter( $values , fn( $v ) => $v % 2 === 1 ) ;
// (object) [ 'a' => 1 , 'c' => 3 ]

Marc Alcaraz (ekameleon)

If $flags contains CleanFlag::RETURN_NULL, or is not a valid combination of CleanFlag constants.

Basic snapshot

use function oihana\core\objects\freeze;

$thing = (object) [ '_key' => 'aeb1' , 'id' => null , 'name' => 'Alice' , 'score' => 0 ] ;

$frozen = freeze( $thing , [ 'name' , '_key' , 'id' , 'url' ] ) ;
// [ 'name' => 'Alice' , '_key' => 'aeb1' ]
// 'id' is null and 'url' does not exist : both are dropped.

Renaming properties

$frozen = freeze( $thing , [ '_key' , 'thingName' => 'name' ] ) ;
// [ '_key' => 'aeb1' , 'thingName' => 'Alice' ]

Discarding empty strings and empty arrays too

use oihana\core\arrays\CleanFlag;

$thing = (object) [ 'name' => 'Alice' , 'label' => '   ' , 'tags' => [] , 'score' => 0 ] ;

$frozen = freeze( $thing , [ 'name' , 'label' , 'tags' , 'score' ] , CleanFlag::MAIN ) ;
// [ 'name' => 'Alice' , 'score' => 0 ]

Inert snapshot of a nested object

$thing = (object) [ 'name' => 'Alice' , 'address' => (object) [ 'city' => 'Paris' ] ] ;

$frozen = freeze( $thing , [ 'name' , 'address' ] , deep : true ) ;
// [ 'name' => 'Alice' , 'address' => [ 'city' => 'Paris' ] ]
// Mutating $thing->address afterwards no longer alters $frozen.

Marc Alcaraz (ekameleon)

Usage

$doc = (object)
[
    'id'     => 123,
    'slogan' => 'Hello'
];

$props = ['id', 'slogan'];

hasAllProperties($doc, $props);        // true
hasAllProperties($doc, $props, true);  // true

$props2 = ['id', 'description'] ;
hasAllProperties($doc, $props2) ; // false (description missing)

Marc Alcaraz

Recursive compression

$doc = (object)
[
   'id'     => 123  ,
   'slogan' => null ,
];

$props = [ 'slogan' , 'description' ] ;

hasAnyProperty( $doc , $props ) ; // true  (because 'slogan' exists)
hasAnyProperty( $doc , $props , true ) ; // false (because 'slogan' is null)

Marc Alcaraz

use function oihana\core\objects\keys;

$user = (object) [ 'id' => 42 , 'name' => 'Alice' ] ;

keys( $user ) ; // [ 'id' , 'name' ]

Marc Alcaraz (ekameleon)

use function oihana\core\objects\map;

$prices = (object) [ 'a' => 10 , 'b' => 20 ] ;

$result = map( $prices , fn( $v ) => $v * 2 ) ;
// (object) [ 'a' => 20 , 'b' => 40 ]

Marc Alcaraz (ekameleon)

use function oihana\core\objects\omit;

$user = (object) [ 'id' => 42 , 'name' => 'Alice' , 'password' => 'secret' ] ;

$result = omit( $user , [ 'password' ] ) ;
// (object) [ 'id' => 42 , 'name' => 'Alice' ]

Marc Alcaraz (ekameleon)

use function oihana\core\objects\pick;

$user = (object) [ 'id' => 42 , 'name' => 'Alice' , 'email' => 'alice@example.com' ] ;

$result = pick( $user , [ 'id' , 'name' ] ) ;
// (object) [ 'id' => 42 , 'name' => 'Alice' ]

Marc Alcaraz (ekameleon)

If $classFactory is a string referencing a class that does not exist.

1. Basic usage with nested keys and default stdClass

$obj = new \stdClass();
$obj = set($obj, 'user.profile.name', 'Alice');
echo $obj->user->profile->name; // Alice

2. Replace the entire object when key is null

$original = (object)['foo' => 'bar'];
$new = set($original, null, ['x' => 123]);
echo $new->x; // 123

3. Use a custom class as intermediate objects

class Node { public string $label = ''; }
$obj = set(new Node(), 'tree.branch.leaf', 'green', '.', false, Node::class);
echo $obj->tree->branch->leaf; // green

4. Use a factory callable

$factory = fn() => new class { public string $value = ''; };
$obj = set(new \stdClass(), 'x.y.z', 99, '.', false, $factory);
echo $obj->x->y->z; // 99

5. Use an array of path => class mappings

class Address { public string $city = ''; }
class User    { public string $name = ''; }
$obj = new \stdClass();
$obj = set($obj, 'user.address.city', 'Paris', '.', false, [
'user' => User::class,
'user.address' => Address::class,
]);
echo $obj->user->address->city; // Paris

Marc Alcaraz (ekameleon)

$obj = (object)['name' => 'Alice'];
$updated = setObjectValue($obj, 'age', 30);
// $updated = (object)['name' => 'Alice', 'age' => 30];

Marc Alcaraz (ekameleon)

Convert an object :

// Define some classes for the example.
class Address
{
    public string $street = '123 PHP Avenue';
    public string $city = 'Codeville';
}

class User
{
    public int $id = 42;
    public string $name = 'John Doe';
    public Address $address;
    private string $sessionToken = 'a-very-secret-token'; // This will be ignored.

    public function __construct()
    {
        $this->address = new Address();
    }
}

$userObject = new User();

$userArray = toAssociativeArray($userObject);

print_r($userArray);
// Output:
// Array
// (
//     [id] => 42
//     [name] => John Doe
//     [address] => Array
//      (
//          [street] => 123 PHP Avenue
//          [city] => Codeville
//      )
// )
// Note that the private property 'sessionToken' is not present.

Convert an array with sub-objects:

$data = (object)
[
    'id' => 123,
    'name' => 'Project Alpha',
    'provider' => (object)
    [
       'name' => 'Alice',
       'role' => 'Chef de projet'
    ],
    'team' =>
     [
        (object) ['name' => 'Bob'     ] ,
        (object) ['name' => 'Charlie' ]
     ]
];

$arrayAssoc = toAssociativeArray($data);

print_r($arrayAssoc);

Convert using a custom JSON encoder (Closure):

$encoder = function (mixed $data): string
{
    // Example: pretty-print JSON and remove null values
    return json_encode($data, JSON_PRETTY_PRINT);
};

$result = toAssociativeArray($userObject, $encoder);

print_r($result);

Convert using a static serializer method:

use oihana\reflect\utils\JsonSerializer;
use oihana\core\options\ArrayOption;

$result = toAssociativeArray
(
$userObject,
   fn(mixed $data): string =>
       JsonSerializer::encode( $data , jsonFlags: 0 , options: [ArrayOption::REDUCE => true] )
);

print_r($result);

Convert using a named function or static method string:

// Using a named function
function my_json_encoder(mixed $data): string
{
    return json_encode($data, JSON_UNESCAPED_SLASHES);
}

$result1 = toAssociativeArray($userObject, 'my_json_encoder');

// Using a static method string
$result2 = toAssociativeArray($userObject, 'MyJsonHelper::encode');

print_r($result1);
print_r($result2);

Marc Alcaraz (ekameleon)

use function oihana\core\objects\values;

$user = (object) [ 'id' => 42 , 'name' => 'Alice' ] ;

values( $user ) ; // [ 42 , 'Alice' ]

Marc Alcaraz (ekameleon)