mpyw / sharable-value-objects
Share value objects that contain the same primitive value as a singleton.
Installs: 83 483
Dependents: 0
Suggesters: 0
Security: 0
Stars: 7
Watchers: 2
Forks: 0
Open Issues: 0
Requires
- php: >=8.0 <8.3.2 || >=8.3.3
Requires (Dev)
- phpunit/phpunit: >=9.5
This package is auto-updated.
Last update: 2024-10-22 08:30:54 UTC
README
Share value objects that contain the same primitive value as a singleton.
Important
Singleton objects are kept under WeakReference
.
Tip
You can compare objects like primitives through ===
operator!
Value::create('one') === Value::create('one') // This should be true Value::create('one') === Value::create('two') // This should be false
Installing
composer require mpyw/sharable-value-objects
Caution
PHP 8.3.2 is incompatible due to the bug in the PHP core.
Usage
class ScreenName { // 1. Mixin Sharable trait family use SharableString; // 2. Write your instantiation logic here public static function create(string $value): static { // Validation/Assertion if (!preg_match('/\A@\w{4,15}\z/', $value)) { throw new \InvalidArgumentException("invalid screen_name: $value"); } // ** Call static::acquire() to get instance ** return static::acquire($value); } // 3. Write your raw presentation logic here public function value(): string { // ** Call $this->getOriginalValue() to retrieve original value ** return $this->getOriginalValue(); } }
class ScreenNameTest extends TestCase { public function testSame(): void { // Same parameters yield the same instance $this->assertSame( ScreenName::create('@mpyw'), ScreenName::create('@mpyw'), ); } public function testDifferent(): void { // Different parameters yield different instances $this->assertNotSame( ScreenName::create('@mpyw'), ScreenName::create('@X'), ); } }