Skip to content

EspoCRM – Open Source CRM Application

2.4 KB
Raw Blame
<?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\Core\Authentication\Login;

/**
 * Immutable.
 */
class MetadataParams
{
    /**
     * @internal
     */
    public function __construct(
        private string $method,
        private bool $api = false,
        private ?string $credentialsHeader = null,
        private ?string $credentialsHeaderScheme = null,
    ) {}

    /**
     * @param array<string, mixed> $data
     */
    public static function fromRaw(string $method, array $data): self
    {
        return new self(
            method: $method,
            api: $data['api'] ?? false,
            credentialsHeader: $data['credentialsHeader'] ?? null,
            credentialsHeaderScheme: $data['credentialsHeaderScheme'] ?? null,
        );
    }

    public function getMethod(): string
    {
        return $this->method;
    }

    public function getCredentialsHeader(): ?string
    {
        return $this->credentialsHeader;
    }

    public function isApi(): bool
    {
        return $this->api;
    }

    public function getCredentialsHeaderScheme(): ?string
    {
        return $this->credentialsHeaderScheme;
    }
}