innmind / immutable
Immutable PHP primitive wrappers
5.9.0
2024-07-05 16:05 UTC
Requires
- php: ~8.2
Requires (Dev)
- innmind/black-box: ^5.5.1
- innmind/coding-standard: ~2.0
- vimeo/psalm: ~5.6
Suggests
- innmind/black-box: For property based testing
Provides
Conflicts
- innmind/black-box: <5.0|~6.0
- dev-develop
- 5.9.0
- 5.8.0
- 5.7.0
- 5.6.0
- 5.5.0
- 5.4.0
- 5.3.0
- 5.2.0
- 5.1.0
- 5.0.0
- 4.15.0
- 4.14.1
- 4.14.0
- 4.13.0
- 4.12.0
- 4.11.0
- 4.10.0
- 4.9.0
- 4.8.0
- 4.7.1
- 4.7.0
- 4.6.0
- 4.5.0
- 4.4.0
- 4.3.0
- 4.2.0
- 4.1.1
- 4.1.0
- 4.0.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.2
- 3.6.1
- 3.6.0
- 3.5.3
- 3.5.2
- 3.5.1
- 3.5.0
- 3.4.0
- 3.3.1
- 3.3.0
- 3.2.0
- 3.1.0
- 3.0.1
- 3.0.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.4
- 2.13.2
- 2.13.1
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.1
- 2.9.0
- 2.8.0
- 2.7.4
- 2.7.3
- 2.7.2
- 2.7.1
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.1
- 2.4.0
- 2.3.1
- 2.3.0
- 2.2.1
- 2.2.0
- 2.1.0
- 2.0.1
- 2.0.0
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.2
- 1.5.1
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.1
- 1.1.0
- 1.0.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- dev-master
- dev-php-84
This package is auto-updated.
Last update: 2024-11-05 17:02:04 UTC
README
A set of classes to wrap PHP primitives to build immutable data.
Installation
composer require innmind/immutable
Usage
Here are some examples of what you can do:
Sequence
To be used to wrap an ordered list of elements (elements can be of mixed types).
use Innmind\Immutable\Sequence; $seq = Sequence::of(24, 42, 'Hitchhiker', 'Magrathea'); $seq->get(2); // Maybe::just(Hitchhiker) $another = $seq->drop(2); $another->toList(); // [Hitchhiker, Magrathea] $seq->toList(); // [24, 42, Hitchhiker, Magrathea] //---- // this example demonstrates the lazyness capability of the sequence // precisely here it's able to read a file line by line and echo the lines // that are less than 42 characters long (without requiring to load the whole // file in memory) $someFile = fopen('some/file.txt', 'r'); $lines = Sequence::lazy(fn() => yield fgets($someFile)) ->filter(fn($line) => strlen($line) < 42); // at this point no reading to the file has been done because all methods // returning a new instance of a sequence will pipeline the operations to do, // allowing to chain complex logic while accessing the original data once and // without the need to keep the discarded data along the pipeline in memory $lines->foreach(fn($line) => echo($line));
For a complete list of methods check Sequence
.
Set
To be used as a collection of unordered elements (elements must be of the same type).
use Innmind\Immutable\Set; $set = Set::of(24, 42); $set->equals(Set::of(24, 42)); // true $set->add(42.0); // psalm will raise an error
For a complete list of methods check Set
.
Map
To be used as a collection of key/value pairs (both keys and values must be of the same type).
use Innmind\Immutable\Map; $map = Map::of( [new \stdClass, 42] [$key = new \stdClass, 24] ); $map->size(); // 2, because it's 2 different instances $map->values()->toList(); // [42, 24] $map = $map->put($key, 66); $map->size(); // 2 $map->values()->toList(); // [42, 66]
For a complete list of methods check Map
.
Strings
use Innmind\Immutable\Str; $var = Str::of('the hitchhiker\'s guide to the galaxy'); echo $var ->replace('galaxy', '42') // the hitchhiker's guide to the 42 ->drop(18) // guide to the 42 ->toUpper() ->toString(); // outputs: GUIDE TO THE 42 echo $var->toString(); // outputs: the hitchhiker\'s guide to the galaxy
Regular expressions
use Innmind\Immutable\{ RegExp, Str, }; $regexp = RegExp::of('/(?<i>\d+)/'); $regexp->matches(Str::of('foo123bar')); // true $regexp->matches(Str::of('foobar')); // false $regexp->capture(Str::of('foo123bar')); // Map<int|string, Str> with index `i` set to Str::of('123')
BlackBox
This library provides 2 Set
s that can be used with innmind/black-box
.
You can use them as follow:
use Innmind\BlackBox\{ PHPUnit\BlackBox, Set, }; use Fixtures\Innmind\Immutable; class SomeTest extends \PHPUnit\Framework\TestCase { use BlackBox; public function testSomeProperty() { $this ->forAll( Immutable\Set::of( Set\RealNumbers::any(), ), Immutable\Sequence::of( Set\Uuid::any(), ), ) ->then(function($set, $sequence) { // $set is an instance of \Innmind\Immutable\Set<float> // $sequence is an instance of \Innmind\Immutable\Sequence<string> // write your test here }); } }