upstream-espocrm/application/Espo/Entities/AuthToken.php

<?php
/************************************************************************
 * This file is part of EspoCRM.
 *
 * EspoCRM – Open Source CRM application.
 * Copyright (C) 2014-2026 EspoCRM, Inc.
 * Website: https://www.espocrm.com
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 *
 * The interactive user interfaces in modified source and object code versions
 * of this program must display Appropriate Legal Notices, as required under
 * Section 5 of the GNU Affero General Public License version 3.
 *
 * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
 * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
 ************************************************************************/

namespace Espo\Entities;

use Espo\Core\Authentication\AuthToken\AuthToken as AuthTokenInterface;
use Espo\Core\Field\DateTime;
use Espo\Core\ORM\Entity as BaseEntity;

class AuthToken extends BaseEntity implements AuthTokenInterface
{
    public const string ENTITY_TYPE = 'AuthToken';

    /** @since 10.0.0 */
    public const string FIELD_PASSWORD_VERSION = 'passwordVersion';

    /** @since 10.1.0 */
    public const string FIELD_IS_ACTIVE = 'isActive';

    /** @since 10.1.0 */
    public const string FIELD_TOKEN = 'token';

    /** @since 10.1.0 */
    public const string ATTR_USER_ID = 'userId';

    public function getToken(): string
    {
        return $this->get(self::FIELD_TOKEN);
    }

    public function getUserId(): string
    {
        return $this->get(self::ATTR_USER_ID);
    }

    public function getPortalId(): ?string
    {
        return $this->get('portalId');
    }

    public function getSecret(): ?string
    {
        return $this->get('secret');
    }

    public function isActive(): bool
    {
        return $this->get(self::FIELD_IS_ACTIVE);
    }

    public function getPasswordVersion(): ?int
    {
        return $this->get(self::FIELD_PASSWORD_VERSION);
    }

    /**
     * @since 10.0.0
     */
    public function setPasswordVersion(?int $version): self
    {
        $this->set(self::FIELD_PASSWORD_VERSION, $version);

        return $this;
    }

    public function setIsActive(bool $isActive): self
    {
        $this->set(self::FIELD_IS_ACTIVE, $isActive);

        return $this;
    }

    public function setUserId(string $userId): self
    {
        $this->set(self::ATTR_USER_ID, $userId);

        return $this;
    }

    public function setPortalId(?string $portalId): self
    {
        $this->set('portalId', $portalId);

        return $this;
    }

    public function setToken(string $token): self
    {
        $this->set(self::FIELD_TOKEN, $token);

        return $this;
    }

    public function setSecret(string $secret): self
    {
        $this->set('secret', $secret);

        return $this;
    }

    public function setIpAddress(?string $ipAddress): self
    {
        $this->set('ipAddress', $ipAddress);

        return $this;
    }

    public function setLastAccessNow(): self
    {
        $this->set('lastAccess', DateTime::createNow()->toString());

        return $this;
    }
}