BenGorUser\User\Domain\Model\UserEmail

Complexity

Total Complexity

7

Size/Duplication

Total Lines	92
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	2
A	email()	0	4	1
A	localPart()	0	4	1
A	domain()	0	4	1
A	equals()	0	4	1
A	__toString()	0	4	1

<?php

/*
 * This file is part of the BenGorUser package.
 *
 * (c) Beñat Espiña <benatespina@gmail.com>
 * (c) Gorka Laucirica <gorka.lauzirika@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace BenGorUser\User\Domain\Model;

use BenGorUser\User\Domain\Model\Exception\UserEmailInvalidException;

/**
 * User email domain class.
 *
 * @author Beñat Espiña <benatespina@gmail.com>
 * @author Gorka Laucirica <gorka.lauzirika@gmail.com>
 */
final class UserEmail
{
    /**
     * The email in plain string.
     *
     * @var string
     */
    private $email;

    /**
     * The domain of email, for example: "gmail.com".
     *
     * @var string
     */
    private $domain;

    /**
     * The part that exists before the @.
     *
     * @var string
     */
    private $localPart;

    /**
     * Constructor.
     *
     * @param string $anEmail An email in primitive string
     *
     * @throws UserEmailInvalidException when the email is not valid
     */
    public function __construct($anEmail)
    {
        if (!filter_var($anEmail, FILTER_VALIDATE_EMAIL)) {
            throw new UserEmailInvalidException();
        }
        $this->email = $anEmail;
        $this->localPart = implode(explode('@', $this->email, -1), '@');
        $this->domain = str_replace($this->localPart . '@', '', $this->email);
    }

    /**
     * Gets the email.
     *
     * @return string
     */
    public function email()
    {
        return $this->email;
    }

    /**
     * Gets the local part of email address, for example: "info" into "info@kreta.com".
     *
     * @return string
     */
    public function localPart()
    {
        return $this->localPart;
    }

    /**
     * Gets the domain of email address, for example: "gmail.com".
     *
     * @return string
     */
    public function domain()
    {
        return $this->domain;
    }

    /**
     * Method that checks if the email given is equal to the current.
     *
     * @param UserEmail $anEmail The email
     *
     * @return bool
     */
    public function equals(UserEmail $anEmail)
    {
        return strtolower((string) $this) === strtolower((string) $anEmail);
    }

    /**
     * Magic method that represents the user email in string format.
     *
     * @return string
     */
    public function __toString()
    {
        return $this->email;
    }
}