<?php
/**
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; under version 2
 * of the License (non-upgradable).
 *
 * 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 * Copyright (c) 2020 (original work) Open Assessment Technologies SA;
 */

declare(strict_types=1);

namespace OAT\Library\Lti1p3Core\User;

use OAT\Library\Lti1p3Core\Util\Collection\CollectionInterface;

/**
 * @see http://www.imsglobal.org/spec/lti/v1p3/#user-identity-claims-0
 */
interface UserIdentityInterface
{
    public function getIdentifier(): string;

    public function getName(): ?string;

    public function getEmail(): ?string;

    public function getGivenName(): ?string;

    public function getFamilyName(): ?string;

    public function getMiddleName(): ?string;

    public function getLocale(): ?string;

    public function getPicture(): ?string;

    public function getAdditionalProperties(): CollectionInterface;

    public function normalize(): array;
}