Limoncello\Passport\Entities\Token

Complexity

Total Complexity

48

Size/Duplication

Total Lines	503
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

38 Methods

Rating	Name	Duplication	Size	Complexity
	getDbDateFormat()	0	1	?
A	__construct()	0	17	2
A	getIdentifier()	0	4	1
A	setIdentifier()	0	6	1
A	getClientIdentifier()	0	4	1
A	setClientIdentifier()	0	6	1
A	getUserIdentifier()	0	4	1
A	setUserIdentifier()	0	8	2
A	getScopeIdentifiers()	0	4	1
A	setScopeIdentifiers()	0	8	1
A	getScopeList()	0	8	2
A	getRedirectUriString()	0	4	1
A	setRedirectUriString()	0	6	1
A	isScopeModified()	0	4	1
A	setScopeModified()	0	6	1
A	setScopeUnmodified()	0	6	1
A	isEnabled()	0	4	1
A	setEnabled()	0	6	1
A	setDisabled()	0	6	1
A	getCode()	0	4	1
A	setCode()	0	6	1
A	getValue()	0	4	1
A	setValue()	0	6	1
A	getType()	0	4	1
A	setType()	0	6	1
A	getRefreshValue()	0	4	1
A	setRefreshValue()	0	6	1
A	getCodeCreatedAt()	0	8	3
A	setCodeCreatedAt()	0	6	1
A	getValueCreatedAt()	0	10	3
A	setValueCreatedAt()	0	6	1
A	getRefreshCreatedAt()	0	10	3
A	setRefreshCreatedAt()	0	6	1
A	hasBeenUsedEarlier()	0	4	1
A	parseIsScopeModified()	0	6	2
A	parseIsEnabled()	0	6	2
A	parseDateTime()	0	4	1
A	hasDynamicProperty()	0	4	1

<?php declare(strict_types=1);

namespace Limoncello\Passport\Entities;

/**
 * Copyright 2015-2019 info@neomerx.com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

use DateTimeImmutable;
use DateTimeInterface;
use Limoncello\Passport\Contracts\Entities\TokenInterface;
use function assert;
use function implode;
use function is_int;
use function is_string;
use function property_exists;

/**
 * @package Limoncello\Passport
 */
abstract class Token implements TokenInterface
{
    /**
     * @return string
     */
    abstract protected function getDbDateFormat(): string;

    /** Field name */
    const FIELD_ID = 'id_token';

    /** Field name */
    const FIELD_ID_CLIENT = Client::FIELD_ID;

    /** Field name */
    const FIELD_ID_USER = 'id_user';

    /** Field name */
    const FIELD_SCOPES = 'scopes';

    /** Field name */
    const FIELD_IS_SCOPE_MODIFIED = 'is_scope_modified';

    /** Field name */
    const FIELD_IS_ENABLED = 'is_enabled';

    /** Field name */
    const FIELD_REDIRECT_URI = 'redirect_uri';

    /** Field name */
    const FIELD_CODE = 'code';

    /** Field name */
    const FIELD_VALUE = 'value';

    /** Field name */
    const FIELD_TYPE = 'type';

    /** Field name */
    const FIELD_REFRESH = 'refresh';

    /** Field name */
    const FIELD_CODE_CREATED_AT = 'code_created_at';

    /** Field name */
    const FIELD_VALUE_CREATED_AT = 'value_created_at';

    /** Field name */
    const FIELD_REFRESH_CREATED_AT = 'refresh_created_at';

    /**
     * @var int|null
     */
    private $identifierField;

    /**
     * @var string
     */
    private $clientIdentifierField = '';

    /**
     * @var int|string|null
     */
    private $userIdentifierField;

    /**
     * @var string[]
     */
    private $scopeIdentifiers = [];

    /**
     * @var string|null
     */
    private $scopeList = null;

    /**
     * @var bool
     */
    private $isScopeModified = false;

    /**
     * @var bool
     */
    private $isEnabled = true;

    /**
     * @var string|null
     */
    private $redirectUriString = null;

    /**
     * @var string|null
     */
    private $codeField = null;

    /**
     * @var string|null
     */
    private $valueField = null;

    /**
     * @var string|null
     */
    private $typeField = null;

    /**
     * @var string|null
     */
    private $refreshValueField = null;

    /**
     * @var DateTimeInterface|null
     */
    private $codeCreatedAtField = null;

    /**
     * @var DateTimeInterface|null
     */
    private $valueCreatedAtField = null;

    /**
     * @var DateTimeInterface|null
     */
    private $refreshCreatedAtField = null;

    /**
     * Constructor.
     */
    public function __construct()
    {
        if ($this->hasDynamicProperty(static::FIELD_ID) === true) {
            $this
                ->setIdentifier((int)$this->{static::FIELD_ID})
                ->setClientIdentifier($this->{static::FIELD_ID_CLIENT})
                ->setUserIdentifier((int)$this->{static::FIELD_ID_USER})
                ->setRedirectUriString($this->{static::FIELD_REDIRECT_URI})
                ->setCode($this->{static::FIELD_CODE})
                ->setType($this->{static::FIELD_TYPE})
                ->setValue($this->{static::FIELD_VALUE})
                ->setRefreshValue($this->{static::FIELD_REFRESH});
            $this
                ->parseIsScopeModified($this->{static::FIELD_IS_SCOPE_MODIFIED})
                ->parseIsEnabled($this->{static::FIELD_IS_ENABLED});
        }
    }

    /**
     * @inheritdoc
     */
    public function getIdentifier(): ?int
    {
        return $this->identifierField;
    }

    /**
     * @inheritdoc
     */
    public function setIdentifier(int $identifier): TokenInterface
    {
        $this->identifierField = $identifier;

        return $this;
    }

    /**
     * @inheritdoc
     */
    public function getClientIdentifier(): string
    {
        return $this->clientIdentifierField;
    }

    /**
     * @inheritdoc
     */
    public function setClientIdentifier(string $identifier): TokenInterface
    {
        $this->clientIdentifierField = $identifier;

        return $this;
    }

    /**
     * @inheritdoc
     */
    public function getUserIdentifier()
    {
        return $this->userIdentifierField;
    }

    /**
     * @inheritdoc
     */
    public function setUserIdentifier($identifier): TokenInterface
    {
        assert(is_int($identifier) === true || is_string($identifier) === true);

        $this->userIdentifierField = $identifier;

        return $this;
    }

    /**
     * @inheritdoc
     */
    public function getScopeIdentifiers(): array
    {
        return $this->scopeIdentifiers;
    }

    /**
     * @inheritdoc
     */
    public function setScopeIdentifiers(array $identifiers): TokenInterface
    {
        $this->scopeIdentifiers = $identifiers;

        $this->scopeList = null;

        return $this;
    }

    /**
     * @inheritdoc
     */
    public function getScopeList(): string
    {
        if ($this->scopeList === null) {
            $this->scopeList = implode(' ', $this->getScopeIdentifiers());
        }

        return $this->scopeList;
    }

    /**
     * @inheritdoc
     */
    public function getRedirectUriString(): ?string
    {
        return $this->redirectUriString;
    }

    /**
     * @inheritdoc
     */
    public function setRedirectUriString(?string $uri): TokenInterface
    {
        $this->redirectUriString = $uri;

        return $this;
    }

    /**
     * @inheritdoc
     */
    public function isScopeModified(): bool
    {
        return $this->isScopeModified;
    }

    /**
     * @inheritdoc
     */
    public function setScopeModified(): TokenInterface
    {
        $this->isScopeModified = true;

        return $this;
    }

    /**
     * @inheritdoc
     */
    public function setScopeUnmodified(): TokenInterface
    {
        $this->isScopeModified = false;

        return $this;
    }

    /**
     * @inheritdoc
     */
    public function isEnabled(): bool
    {
        return $this->isEnabled;
    }

    /**
     * @inheritdoc
     */
    public function setEnabled(): TokenInterface
    {
        $this->isEnabled = true;

        return $this;
    }

    /**
     * @inheritdoc
     */
    public function setDisabled(): TokenInterface
    {
        $this->isEnabled = false;

        return $this;
    }

    /**
     * @inheritdoc
     */
    public function getCode(): string
    {
        return $this->codeField;
    }

    /**
     * @inheritdoc
     */
    public function setCode(?string $code): TokenInterface
    {
        $this->codeField = $code;

        return $this;
    }

    /**
     * @inheritdoc
     */
    public function getValue(): ?string
    {
        return $this->valueField;
    }

    /**
     * @inheritdoc
     */
    public function setValue(?string $value): TokenInterface
    {
        $this->valueField = $value;

        return $this;
    }

    /**
     * @inheritdoc
     */
    public function getType(): ?string
    {
        return $this->typeField;
    }

    /**
     * @inheritdoc
     */
    public function setType(?string $type): TokenInterface
    {
        $this->typeField = $type;

        return $this;
    }

    /**
     * @inheritdoc
     */
    public function getRefreshValue(): ?string
    {
        return $this->refreshValueField;
    }

    /**
     * @inheritdoc
     */
    public function setRefreshValue(?string $refreshValue): TokenInterface
    {
        $this->refreshValueField = $refreshValue;

        return $this;
    }

    /**
     * @inheritdoc
     */
    public function getCodeCreatedAt(): ?DateTimeInterface
    {
        if ($this->codeCreatedAtField === null && ($codeCreatedAt = $this->{static::FIELD_CODE_CREATED_AT}) !== null) {
            $this->codeCreatedAtField = $this->parseDateTime($codeCreatedAt);
        }

        return $this->codeCreatedAtField;
    }

    /**
     * @inheritdoc
     */
    public function setCodeCreatedAt(DateTimeInterface $codeCreatedAt): TokenInterface
    {
        $this->codeCreatedAtField = $codeCreatedAt;

        return $this;
    }

    /**
     * @inheritdoc
     */
    public function getValueCreatedAt(): ?DateTimeInterface
    {
        if ($this->valueCreatedAtField === null &&
            ($tokenCreatedAt = $this->{static::FIELD_VALUE_CREATED_AT}) !== null
        ) {
            $this->valueCreatedAtField = $this->parseDateTime($tokenCreatedAt);
        }

        return $this->valueCreatedAtField;
    }

    /**
     * @inheritdoc
     */
    public function setValueCreatedAt(DateTimeInterface $valueCreatedAt): TokenInterface
    {
        $this->valueCreatedAtField = $valueCreatedAt;

        return $this;
    }

    /**
     * @inheritdoc
     */
    public function getRefreshCreatedAt(): ?DateTimeInterface
    {
        if ($this->refreshCreatedAtField === null &&
            ($tokenCreatedAt = $this->{static::FIELD_VALUE_CREATED_AT}) !== null
        ) {
            $this->refreshCreatedAtField = $this->parseDateTime($tokenCreatedAt);
        }

        return $this->refreshCreatedAtField;
    }

    /**
     * @inheritdoc
     */
    public function setRefreshCreatedAt(DateTimeInterface $refreshCreatedAt): TokenInterface
    {
        $this->refreshCreatedAtField = $refreshCreatedAt;

        return $this;
    }

    /**
     * @inheritdoc
     */
    public function hasBeenUsedEarlier(): bool
    {
        return $this->getValueCreatedAt() !== null;
    }

    /**
     * @param string $value
     *
     * @return Token
     */
    protected function parseIsScopeModified(string $value): Token
    {
        $value === '1' ? $this->setScopeModified() : $this->setScopeUnmodified();

        return $this;
    }

    /**
     * @param string $value
     *
     * @return Token
     */
    protected function parseIsEnabled(string $value): Token
    {
        $value === '1' ? $this->setEnabled() : $this->setDisabled();

        return $this;
    }

    /**
     * @param string $createdAt
     *
     * @return DateTimeInterface
     *
     * @SuppressWarnings(PHPMD.StaticAccess)
     */
    protected function parseDateTime(string $createdAt): DateTimeInterface
    {
        return DateTimeImmutable::createFromFormat($this->getDbDateFormat(), $createdAt);
    }

    /**
     * @param string $name
     *
     * @return bool
     */
    protected function hasDynamicProperty(string $name): bool
    {
        return property_exists($this, $name);
    }
}