BenGorUser\User\Domain\Model\UserRole

Complexity

Total Complexity

5

Size/Duplication

Total Lines	56
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	2
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	role()	0	4	1
A	equals()	0	4	1
A	__toString()	0	4	1
A	__construct()	0	7	2

<?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\UserRoleInvalidException;

/**
 * User role domain class.
 *
 * @author Beñat Espiña <benatespina@gmail.com>
 */
final class UserRole
{
    /**
     * The role in plain string.
     *
     * @var string
     */
    private $role;

    /**
     * Constructor.
     *
     * @param string $aRole A role in primitive string
     *
     * @throws UserRoleInvalidException when the role is not a string
     */
    public function __construct($aRole)
    {
        if (!is_string($aRole)) {
            throw new UserRoleInvalidException();
        }
        $this->role = $aRole;
    }

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

    /**
     * Method that checks if the user role given is equal to the current.
     *
     * @param UserRole $aRole The user role
     *
     * @return bool
     */
    public function equals(UserRole $aRole)
    {
        return strtolower($this->role) === strtolower($aRole->role());
    }

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