LazySec\Entity\DisableAccountTrait

Complexity

Total Complexity

5

Size/Duplication

Total Lines	45
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	canAccountBeDisabled()	0	3	1
A	isEnabled()	0	3	2
A	setEnabled()	0	7	2

<?php

//----------------------------------------------------------------------
//
//  Copyright (C) 2017-2018 Artem Rodygin
//
//  You should have received a copy of the MIT License along with
//  this file. If not, see <http://opensource.org/licenses/MIT>.
//
//----------------------------------------------------------------------

namespace LazySec\Entity;

use Doctrine\ORM\Mapping as ORM;

/**
 * Trait for "disable account" feature.
 */
trait DisableAccountTrait
{
    /**
     * @var bool Whether account is enabled.
     *
     * @ORM\Column(name="enabled", type="boolean", nullable=false)
     */
    protected $isEnabled = true;

    /**
     * Checks whether the user is enabled.
     *
     * Inherited from '\Symfony\Component\Security\Core\User\AdvancedUserInterface'.
     *
     * @return bool TRUE if the user is enabled, FALSE otherwise.
     */
    public function isEnabled(): bool
    {
        return $this->canAccountBeDisabled() ? $this->isEnabled : true;
    }

    /**
     * Disables or enables the account.
     *
     * @param bool $isEnabled New status of the account.
     *
     * @return self
     */
    public function setEnabled(bool $isEnabled): self
    {
        if ($this->canAccountBeDisabled()) {
            $this->isEnabled = $isEnabled;
        }

        return $this;
    }

    /**
     * Specifies whether the "disable account" feature is available for this user.
     *
     * @return bool
     */
    protected function canAccountBeDisabled(): bool
    {
        return true;
    }
}