The Immutable Object library ensures that objects implementing it remain immutable after initialization. Once created, the state of the object cannot be modified. Any attempt to change properties or collection elements will throw an exception.
composer require tiny-blocks/immutable-objectThe library provides the Immutable interface and the Immutability trait to guarantee immutability. These components
prevent properties and collections from being modified or unset.
By implementing the Immutable interface and using the Immutability trait, you can ensure that object properties and
elements in collections are immutable.
<?phpnamespaceExample;
useTinyBlocks\Immutable\Immutable;
useTinyBlocks\Immutable\Immutability;
finalclass Order implements Immutable
{
use Immutability;
publicfunction__construct(publicint$id, publicProducts$products)
{
}
}The Immutability trait also prevents modifications to properties of an object. Trying to modify a property after the object is initialized will throw an exception.
$order = newOrder(id: 1, products: newProducts(array: ['item1', 'item2']);
$order->id = 2; # Throws an exception
unset($order->id); # Throws an exception The Immutability trait also prevents the modification of collection elements (e.g., arrays). Trying to modify or
remove an element will throw an exception.
$order = newOrder(id: 1, products: newProducts(array: ['item1', 'item2']);
$order->items[0] = 'item3'; # Throws an exception
unset($order->items[0]); # Throws an exceptionImmutable Object is licensed under MIT.
Please follow the contributing guidelines to contribute to the project.