EdmondsCommerce\DoctrineStaticMeta\Entity\Fields\Traits\String\EmailAddressFieldTrait

Complexity

Total Complexity

5

Size/Duplication

Total Lines	76
Duplicated Lines	0 %

Test Coverage

Coverage

95.83%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	validatorMetaForPropertyEmailAddress()	0	10	1
A	setEmailAddress()	0	8	1
A	getEmailAddress()	0	7	2
A	metaForEmailAddress()	0	7	1

<?php declare(strict_types=1);

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

use Doctrine\ORM\Mapping\Builder\ClassMetadataBuilder;
use EdmondsCommerce\DoctrineStaticMeta\Entity\Fields\Interfaces\String\EmailAddressFieldInterface;
use EdmondsCommerce\DoctrineStaticMeta\MappingHelper;
use EdmondsCommerce\DoctrineStaticMeta\Schema\Database;
use Symfony\Component\Validator\Constraints\Email;
use Symfony\Component\Validator\Constraints\Length;
use Symfony\Component\Validator\Exception\ConstraintDefinitionException;
use Symfony\Component\Validator\Exception\InvalidOptionsException;
use Symfony\Component\Validator\Exception\MissingOptionsException;
use Symfony\Component\Validator\Mapping\ClassMetadata as ValidatorClassMetaData;

trait EmailAddressFieldTrait
{

    /**
     * @var string|null
     */
    private $emailAddress;

    /**
     * @SuppressWarnings(PHPMD.StaticAccess)
     * @param ClassMetadataBuilder $builder
     */
    public static function metaForEmailAddress(ClassMetadataBuilder $builder): void
    {
        MappingHelper::setSimpleStringFields(
            [EmailAddressFieldInterface::PROP_EMAIL_ADDRESS],
            $builder,
            EmailAddressFieldInterface::DEFAULT_EMAIL_ADDRESS,
            true
        );
    }

    /**
     * This method sets the validation for this field.
     *
     * You should add in as many relevant property constraints as you see fit.
     *
     * @see https://symfony.com/doc/current/validation.html#supported-constraints
     *
     * @param ValidatorClassMetaData $metadata
     *
     * @throws MissingOptionsException
     * @throws InvalidOptionsException
     * @throws ConstraintDefinitionException
     */
    protected static function validatorMetaForPropertyEmailAddress(ValidatorClassMetaData $metadata): void
    {
        $metadata->addPropertyConstraints(
            EmailAddressFieldInterface::PROP_EMAIL_ADDRESS,
            [
                new Email(),
                new Length(
                    [
                        'min' => 0,
                        'max' => Database::MAX_VARCHAR_LENGTH,
                    ]
                ),
            ]
        );
    }

    /**
     * @return string|null
     */
    public function getEmailAddress(): ?string
    {
        if (null === $this->emailAddress) {
            return EmailAddressFieldInterface::DEFAULT_EMAIL_ADDRESS;
        }

        return $this->emailAddress;
    }

    /**
     * @param string|null $emailAddress
     *
     * @return self
     */
    private function setEmailAddress(?string $emailAddress): self
    {
        $this->updatePropertyValue(

It seems like updatePropertyValue() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            EmailAddressFieldInterface::PROP_EMAIL_ADDRESS,
            $emailAddress
        );

        return $this;
    }
}