EdmondsCommerce\DoctrineStaticMeta\Entity\Fields\Traits\PrimaryKey\NonBinaryUuidFieldTrait

Complexity

Total Complexity

4

Size/Duplication

Total Lines	44
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	metaForId()	0	9	1
A	getId()	0	3	1
A	setId()	0	11	2

<?php declare(strict_types=1);

namespace EdmondsCommerce\DoctrineStaticMeta\Entity\Fields\Traits\PrimaryKey;

use Doctrine\ORM\Mapping\Builder\ClassMetadataBuilder;
use EdmondsCommerce\DoctrineStaticMeta\MappingHelper;
use Ramsey\Uuid\Doctrine\UuidGenerator;
use Ramsey\Uuid\UuidInterface;

/**
 * This trait implements a text based UUID primary key which will then be stored as a string
 */
trait NonBinaryUuidFieldTrait
{
    /**
     * @var UuidInterface
     */
    private $id;

    /**
     * @param ClassMetadataBuilder $builder
     *
     * @see https://github.com/ramsey/uuid-doctrine#usage
     */
    protected static function metaForId(ClassMetadataBuilder $builder): void
    {
        $builder->createField('id', MappingHelper::TYPE_NON_BINARY_UUID)
                ->makePrimaryKey()
                ->nullable(false)
                ->unique(true)
                ->generatedValue('CUSTOM')
                ->setCustomIdGenerator(UuidGenerator::class)
                ->build();
    }

    public function getId(): ?UuidInterface
    {
        return $this->id;
    }

    /**
     * @param UuidInterface $id
     *
     * @return UuidFieldTrait
     */
    public function setId(UuidInterface $id)
    {
        if (null !== $this->id) {
            throw new \RuntimeException(
                'You can not overwrite a UUID that has alreasy been set.' .
                ' This method should only be used for setting the ID on newly created Entities'
            );
        }
        $this->id = $id;

        return $this;

The expression return $this returns the type EdmondsCommerce\DoctrineStaticMeta\Entity\Fields\Traits\PrimaryKey\NonBinaryUuidFieldTrait which is incompatible with the documented return type EdmondsCommerce\DoctrineStaticMeta\Entity\Fields\Traits\PrimaryKey\UuidFieldTrait.

    }
}