WebHemi\Auth\Result\Result

Complexity

Total Complexity

5

Size/Duplication

Total Lines	62
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	isValid()	0	4	1
A	setCode()	0	10	2
A	getCode()	0	4	1
A	getMessage()	0	4	1

<?php
/**
 * WebHemi.
 *
 * PHP version 7.1
 *
 * @copyright 2012 - 2017 Gixx-web (http://www.gixx-web.com)
 * @license   https://opensource.org/licenses/MIT The MIT License (MIT)
 *
 * @link      http://www.gixx-web.com
 */
declare(strict_types = 1);

namespace WebHemi\Auth\Result;

use WebHemi\Auth\ResultInterface;

/**
 * Class Result.
 */
class Result implements ResultInterface
{
    /** @var int */
    private $code;
    /** @var array */
    private $messages = [
        self::FAILURE => 'Authentication failed.',
        self::FAILURE_IDENTITY_NOT_FOUND => 'User is not found.',
        self::FAILURE_IDENTITY_DISABLED => 'The given user is disabled.',
        self::FAILURE_IDENTITY_INACTIVE => 'The given user is in inactive state.',
        self::FAILURE_CREDENTIAL_INVALID => 'The provided credentials are not valid.',
        self::FAILURE_OTHER => 'Authentication failed because of unknown reason.',
        self::SUCCESS => 'Authenticated.',
    ];

    /**
     * Checks the authentication result.
     *
     * @return bool
     */
    public function isValid() : bool
    {
        return $this->code == 1;
    }

    /**
     * Sets the result code.
     *
     * @param int $code
     * @return ResultInterface
     */
    public function setCode(int $code) : ResultInterface
    {
        if (!isset($this->messages[$code])) {
            $code = self::FAILURE_OTHER;
        }

        $this->code = $code;

        return $this;
    }

    /**
     * Gets the result code.
     *
     * @return int
     */
    public function getCode() : int
    {
        return $this->code;
    }

    /**
     * Gets the result message.
     *
     * @return string
     */
    public function getMessage() : string
    {
        return $this->messages[$this->code];
    }
}