ClaimAccessTrait.php

<?php

declare(strict_types=1);

/**
 * Trait to access the claims of a JWT token.
 *
 * @category  Token
 * @copyright 2017-2025 Staffbase SE.
 * @author    Daniel Grosse
 * @license   http://www.apache.org/licenses/LICENSE-2.0
 * @link      https://github.com/staffbase/plugins-sdk-php
 */

namespace Staffbase\plugins\sdk\SSOData;

/**
 * Trait to access the claims of a JWT token.
 */
trait ClaimAccessTrait
{
    /**
     * Test if a claim is set.
     *
     * @param string $claim name.
     *
     * @return boolean
     */
    abstract protected function hasClaim(string $claim): bool;

    /**
     * Get a claim without checking for existence.
     *
     * @param string $claim name.
     *
     * @return mixed
     */
    abstract protected function getClaim(string $claim);

    /**
     * Get an array of all available claims and their values.
     *
     * @return array<string, mixed>
     */
    abstract protected function getAllClaims(): array;

    /**
     * Internal getter for all token properties.
     *
     * Has a check for undefined claims to make getter calls always valid.
     *
     * @param string $name Name of the claim.
     *
     * @return mixed
     */
    protected function getClaimSafe(string $name)
    {

        if ($this->hasClaim($name)) {
            return $this->getClaim($name);
        }

        return null;
    }
}