Laravel Value Objects
A bunch of general-purpose value objects you can use in your Laravel application.
The package requires PHP ^8.0 and Laravel ^9.7.
#StandWithUkraine
Installation
Install the package using composer:
composer require michael-rubel/laravel-value-objects
Built-in value objects
Artisan command
You can generate custom value objects with Artisan command:
php artisan make:value-object YourNameValueObject
Usage
Boolean
$bool = new Boolean('1');
$bool = Boolean::make('1');
$bool = Boolean::from('1');
$bool->value(); // true
(string) $bool; // 'true'
$bool->toArray(); // ['true']
Decimal
$decimal = new Decimal('10.20999', scale: 2);
$decimal = Decimal::make('10.20999', scale: 2);
$decimal = Decimal::from('10.20999', scale: 2);
$decimal->value(); // '10.20'
(string) $decimal; // '10.20'
$decimal->toArray(); // ['10.20']
Integer
$integer = new Integer(10);
$integer = Integer::make(10);
$integer = Integer::from(10);
$integer->value(); // 10
(string) $integer; // '10'
$integer->toArray(); // [10]
Text
$text = new Text('Lorem Ipsum is simply dummy text.');
$text = Text::make('Lorem Ipsum is simply dummy text.');
$text = Text::from('Lorem Ipsum is simply dummy text.');
$text->value(); // 'Lorem Ipsum is simply dummy text.'
(string) $text; // 'Lorem Ipsum is simply dummy text.'
$text->toArray(); // ['Lorem Ipsum is simply dummy text.']
ClassString
$classString = new ClassString('\Exception');
$classString = ClassString::make('\Exception');
$classString = ClassString::from('\Exception');
$classString->value(); // '\Exception'
(string) $classString; // '\Exception'
$name->toArray(); // ['\Exception']
$classString->classExists(); // true
$classString->interfaceExists(); // false
$classString->instantiate(); // Exception { ... }
$classString->instantiateWith(['message' => 'My message.']); // Exception { #message: "test" ... }
FullName
$name = new FullName(' Taylor Otwell ');
$name = FullName::make(' Taylor Otwell ');
$name = FullName::from(' Taylor Otwell ');
$name->value(); // 'Taylor Otwell'
(string) $name; // 'Taylor Otwell'
$name->toArray(); // ['fullName' => 'Taylor Otwell', 'firstName' => 'Taylor', 'lastName' => 'Otwell']
$name->fullName(); // 'Taylor Otwell'
$name->firstName(); // 'Taylor'
$name->lastName(); // 'Otwell'
Name
$name = new Name(' Company name! ');
$name = Name::make(' Company name! ');
$name = Name::from(' Company name! ');
$name->value(); // 'Company name!'
(string) $name; // 'Company name!'
$name->toArray(); // ['Company name!']
TaxNumber
$taxNumber = new TaxNumber('0123456789', 'PL');
$taxNumber = TaxNumber::make('0123456789', 'PL');
$taxNumber = TaxNumber::from('0123456789', 'PL');
$taxNumber->value(); // 'PL0123456789'
(string) $taxNumber; // 'PL0123456789'
$taxNumber->toArray(); // ['fullTaxNumber' => 'PL0123456789', 'taxNumber' => '0123456789', 'prefix' => 'PL']
$taxNumber->fullTaxNumber(); // 'PL0123456789'
$taxNumber->taxNumber(); // '0123456789'
$taxNumber->prefix(); // 'PL'
Uuid
$uuid = new Uuid('8547d10c-7a37-492a-8d33-be0e5ae6119b', 'Optional name');
$uuid = Uuid::make('8547d10c-7a37-492a-8d33-be0e5ae6119b', 'Optional name');
$uuid = Uuid::from('8547d10c-7a37-492a-8d33-be0e5ae6119b', 'Optional name');
$uuid->value(); // '8547d10c-7a37-492a-8d33-be0e5ae6119b'
(string) $uuid; // '8547d10c-7a37-492a-8d33-be0e5ae6119b'
$uuid->toArray(); // ['name' => 'Optional name', 'value' => '8547d10c-7a37-492a-8d33-be0e5ae6119b']
$uuid->uuid(); // '8547d10c-7a37-492a-8d33-be0e5ae6119b'
$uuid->name(); // 'Optional name'
Handle failed validation
If you want to avoid try/catching your value object when the validation fails, you can use makeOrNull method:
$bool = Boolean::makeOrNull('bad input'); // null
$bool?->value(); // null
Extending functionality
All value objects are Macroable. This way you can add new methods dynamically. If you need to extend existing methods, you can create a value object locally with make:value-object command and use inheritance.
For example:
ValueObject::macro('str', function () {
return str($this->value());
});
$name = new Text('Lorem ipsum');
$name->str()->is('Lorem ipsum'); // true
Conditionable
Value objects utilize a Conditionable trait. You can use when and unless methods.
TaxNumber::from('PL0123456789')->when(function ($number) {
return $number->prefix() !== null;
})->prefix();
Testing
composer test
License
The MIT License (MIT). Please see License File for more information.
82 Dec 31, 2022
17 Sep 12, 2022
20 Dec 8, 2018
77 Dec 13, 2022
5 Jun 20, 2022
1.4k Dec 28, 2022
1.1k Dec 29, 2022
56 Dec 16, 2022
3 Aug 9, 2022
2 Aug 21, 2022
2 Jul 31, 2022
2 Sep 30, 2022
4 Feb 12, 2022
8 Jun 8, 2023
2 Jun 6, 2022
2 Aug 22, 2022
20 Aug 4, 2022
2 Aug 10, 2022
1 Dec 3, 2021