Resolves a username by selecting the first provider (by descending priority) that returns a non-empty/non-null value for getUsername(). More...

Collaboration diagram for ILIAS\ApacheAuth\UsernameProvider\UsernameResolver:

Public Member Functions
	__construct (array $providers, private readonly \ilLogger $logger)

	resolve (ServerRequestInterface $request)

Private Attributes
array	$providers

Detailed Description

Resolves a username by selecting the first provider (by descending priority) that returns a non-empty/non-null value for getUsername().

Definition at line 29 of file UsernameResolver.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\ApacheAuth\UsernameProvider\UsernameResolver::__construct	(	array	$providers,
		private readonly \ilLogger	$logger
	)

Parameters

list<UsernameProvider> $providers

Definition at line 37 of file UsernameResolver.php.

    {
        if (!array_is_list($providers)) {
            throw new \InvalidArgumentException('Providers must be passed as list');
        }
 
        $this->providers = $providers;
 
        // Sort by descending priority, this also ensures the expected type of the elements
        usort(
            $this->providers,
            static fn(UsernameProvider $a, UsernameProvider $b): int => $b->getPriority() <=> $a->getPriority()
        );
    }

References Vendor\Package\$a, Vendor\Package\$b, and ILIAS\ApacheAuth\UsernameProvider\UsernameResolver\$providers.

Member Function Documentation

◆ resolve()

ILIAS\ApacheAuth\UsernameProvider\UsernameResolver::resolve ( ServerRequestInterface $request )

Definition at line 52 of file UsernameResolver.php.

                                                            : UsernameInterface
    {
        foreach ($this->providers as $provider) {
            $this->logger->debug('Trying to resolve username using provider {provider} with prio {priority}', [
                'provider' => $provider::class,
                'priority' => $provider->getPriority(),
            ]);
 
            $username = $provider->getUsername($request);
 
            if (!$username->isEmpty()) {
                $this->logger->debug('Username resolved to {username} by provider {provider}', [
                    'username' => $username->asString(),
                    'provider' => $provider::class,
                ]);
 
                return $username;
            }
 
            $this->logger->debug('Provider {provider} could not resolve a username', [
                'provider' => $provider::class,
            ]);
        }
 
        $this->logger->debug('No username could be resolved by any provider, returning NullUsername');
 
        return new NullUsername();
    }