DavidGarcia\ValueObject\Primitive\StringValue

Complexity

Total Complexity

9

Size/Duplication

Total Lines	72
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	create()	0	17	4
A	__construct()	0	6	2
A	equals()	0	3	1
A	getValue()	0	3	1
A	__toString()	0	3	1

<?php

declare(strict_types=1);

namespace DavidGarcia\ValueObject\Primitive;

use DavidGarcia\ValueObject\Exception\InvalidValueException;
use InvalidArgumentException;
use Webmozart\Assert\Assert;

class StringValue extends AbstractValue
{
    private string $value;

    private function __construct(string $value, bool $cache)
    {
        $this->value = $value;

        if ($cache) {
            self::cacheStore($value, $this);
        }
    }

    /**
     * Exposes the stored string value.
     *
     * @return string The string value
     */
    public function __toString(): string
    {
        return $this->getValue();
    }

    /**
     * Creates the value object.
     *
     * @param string $value The string value
     * @param bool   $cache Cache the value so we reuse the same object
     *
     * @throws InvalidValueException The initial validation of the value has failed
     *
     * @return StringValue The value object
     */
    public static function create(string $value, bool $cache = false): self
    {
        $trimmed = trim($value);

        try {
            Assert::stringNotEmpty($trimmed, 'String value cannot be empty');
        } catch (InvalidArgumentException $exception) {
            throw new InvalidValueException($exception->getMessage(), $exception);
        }

        $object = $cache ? parent::cacheRetrieve($trimmed) : null;

        if (null === $object) {
            $object = new self($trimmed, $cache);
        }

        return $object;
    }

    /**
     * Exposes the stored string value.
     *
     * @return string The string value
     */
    public function getValue(): string
    {
        return $this->value;
    }

    /**
     * Compares if the value of a given object matches with this object.
     *
     * @param StringValue $object The input object to be compared
     *
     * @return bool TRUE if the value matches; FALSE otherwise
     */
    public function equals(StringValue $object): bool
    {
        return $this->getValue() === $object->getValue();
    }
}