generated from michael-rubel/laravel-package-template
-
-
Notifications
You must be signed in to change notification settings - Fork 13
/
Name.php
56 lines (49 loc) · 1.47 KB
/
Name.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
<?php
declare(strict_types=1);
/**
* This file is part of michael-rubel/laravel-value-objects. (https://github.com/michael-rubel/laravel-value-objects)
*
* @link https://github.com/michael-rubel/laravel-value-objects for the canonical source repository
* @copyright Copyright (c) 2022 Michael Rubél. (https://github.com/michael-rubel/)
* @license https://raw.githubusercontent.com/michael-rubel/laravel-value-objects/main/LICENSE.md MIT
*/
namespace MichaelRubel\ValueObjects\Collection\Complex;
use Illuminate\Support\Stringable;
use MichaelRubel\Formatters\Collection\NameFormatter;
use MichaelRubel\ValueObjects\Collection\Primitive\Text;
/**
* "Name" object presenting a generic name.
*
* @author Michael Rubél <michael@laravel.software>
*
* @template TKey of array-key
* @template TValue
*
* @method static static make(string|Stringable $value)
* @method static static from(string|Stringable $value)
* @method static static makeOrNull(string|Stringable|null $value)
*
* @extends Text<TKey, TValue>
*/
class Name extends Text
{
/**
* Create a new instance of the value object.
*
* @param string|Stringable $value
*/
public function __construct(string|Stringable $value)
{
parent::__construct($value);
$this->sanitize();
}
/**
* Sanitize the value.
*
* @return void
*/
protected function sanitize(): void
{
$this->value = format(NameFormatter::class, $this->value());
}
}