LazySec\Entity\LockAccountTrait

Complexity

Total Complexity

11

Size/Duplication

Total Lines	79
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	incAuthFailures()	0	3	2
A	canAccountBeLocked()	0	3	1
A	isAccountNonLocked()	0	5	4
A	unlockAccount()	0	6	1
A	lockAccount()	0	8	3

<?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 "lock account" feature.
 */
trait LockAccountTrait
{
    /**
     * @var int Number of consecutive unsuccessful attempts to authenticate.
     *
     * @ORM\Column(name="auth_failures", type="integer", nullable=true)
     */
    protected $authFailures;

    /**
     * @var int Unix Epoch timestamp which the account is locked till.
     *          When zero, the account is considered as locked for permanent.
     *
     * @ORM\Column(name="locked_until", type="integer", nullable=true)
     */
    protected $lockedUntil;

    /**
     * Checks whether the user is locked.
     *
     * Inherited from '\Symfony\Component\Security\Core\User\AdvancedUserInterface'.
     *
     * @return bool TRUE if the user is not locked, FALSE otherwise.
     */
    public function isAccountNonLocked(): bool
    {
        return $this->canAccountBeLocked()
            ? $this->lockedUntil === null || $this->lockedUntil !== 0 && $this->lockedUntil <= time()
            : true;
    }

    /**
     * Increases number of authentication failures.
     *
     * @return null|int New authentication failures number.
     */
    public function incAuthFailures(): ?int
    {
        return $this->canAccountBeLocked() ? ++$this->authFailures : null;
    }

    /**
     * Locks the account until specified moment of time (NULL for permanent lock).
     *
     * @param \DateTime $time
     *
     * @return self
     */
    public function lockAccount(\DateTime $time = null): self
    {
        if ($this->canAccountBeLocked()) {
            $this->authFailures = null;
            $this->lockedUntil  = $time === null ? 0 : $time->getTimestamp();
        }

        return $this;
    }

    /**
     * Unlocks the account.
     *
     * @return self
     */
    public function unlockAccount(): self
    {
        $this->authFailures = null;
        $this->lockedUntil  = null;

        return $this;
    }

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