Collaboration diagram for ilUserPasswordEncoderFactory:

Public Member Functions
	__construct (array $config=[])

	getDefaultEncoder ()

	setDefaultEncoder (string $default_encoder)

	getSupportedEncoders ()

	setSupportedEncoders (array $supported_encoders)

	getSupportedEncoderNames ()

	getEncoderByName (?string $name)

Private Member Functions
	getEncoders (array $config)

	initEncoders (array $config)

Private Attributes
string	$default_encoder = null

array	$supported_encoders = []

Detailed Description

Definition at line 21 of file class.ilUserPasswordEncoderFactory.php.

Constructor & Destructor Documentation

◆ __construct()

ilUserPasswordEncoderFactory::__construct ( array $config = [] )

Parameters

array<string,mixed> $config

Exceptions

ilPasswordException

Definition at line 31 of file class.ilUserPasswordEncoderFactory.php.

References ILIAS\LTI\ToolProvider\$key, initEncoders(), and setDefaultEncoder().

     {
         if (!empty($config)) {
             foreach ($config as $key => $value) {
                 switch (strtolower($key)) {
                     case 'default_password_encoder':
                         $this->setDefaultEncoder($value);
                         break;
                 }
             }
         }
 
         $this->initEncoders($config);
     }

Here is the call graph for this function:

Member Function Documentation

◆ getDefaultEncoder()

ilUserPasswordEncoderFactory::getDefaultEncoder ( )

Definition at line 77 of file class.ilUserPasswordEncoderFactory.php.

References $default_encoder.

Referenced by getEncoderByName().

                                        : ?string
     {
         return $this->default_encoder;
     }

Here is the caller graph for this function:

◆ getEncoderByName()

ilUserPasswordEncoderFactory::getEncoderByName ( ?string $name )

Exceptions

ilUserException

Definition at line 124 of file class.ilUserPasswordEncoderFactory.php.

References getDefaultEncoder().

                                                    : ilPasswordEncoder
     {
         if ($name !== null && isset($this->supported_encoders[$name])) {
             return $this->supported_encoders[$name];
         }
 
         if (!$this->getDefaultEncoder()) {
             throw new ilUserException('No default encoder specified, fallback not possible.');
         } elseif (!isset($this->supported_encoders[$this->getDefaultEncoder()])) {
             throw new ilUserException("No default encoder found for name: '{$this->getDefaultEncoder()}'.");
         }
 
         return $this->supported_encoders[$this->getDefaultEncoder()];
     }

Here is the call graph for this function:

◆ getEncoders()

ilUserPasswordEncoderFactory::getEncoders ( array $config )

private

Parameters

array<string,mixed> $config

Returns: list<ilPasswordEncoder>

Exceptions

ilPasswordException

Definition at line 51 of file class.ilUserPasswordEncoderFactory.php.

Referenced by initEncoders().

                                                : array
     {
         return [
             new ilArgon2idPasswordEncoder($config),
             new ilBcryptPhpPasswordEncoder($config),
             new ilBcryptPasswordEncoder($config),
             new ilMd5PasswordEncoder(),
         ];
     }

Here is the caller graph for this function:

◆ getSupportedEncoderNames()

ilUserPasswordEncoderFactory::getSupportedEncoderNames ( )

Returns: list<string>

Definition at line 116 of file class.ilUserPasswordEncoderFactory.php.

References getSupportedEncoders().

                                               : array
     {
         return array_keys($this->getSupportedEncoders());
     }

Here is the call graph for this function:

◆ getSupportedEncoders()

ilUserPasswordEncoderFactory::getSupportedEncoders ( )

Returns: array<string, ilPasswordEncoder>

Definition at line 90 of file class.ilUserPasswordEncoderFactory.php.

References $supported_encoders.

Referenced by getSupportedEncoderNames().

                                           : array
     {
         return $this->supported_encoders;
     }

Here is the caller graph for this function:

◆ initEncoders()

ilUserPasswordEncoderFactory::initEncoders ( array $config )

private

Parameters

array<string,mixed> $config

Exceptions

ilPasswordException

Definition at line 65 of file class.ilUserPasswordEncoderFactory.php.

References getEncoders().

Referenced by __construct().

                                                 : void
     {
         $this->supported_encoders = [];
 
         $encoders = $this->getEncoders($config);
         foreach ($encoders as $encoder) {
             if ($encoder->isSupportedByRuntime()) {
                 $this->supported_encoders[$encoder->getName()] = $encoder;
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDefaultEncoder()

ilUserPasswordEncoderFactory::setDefaultEncoder ( string $default_encoder )

Definition at line 82 of file class.ilUserPasswordEncoderFactory.php.

References $default_encoder.

Referenced by __construct().

                                                               : void
     {
         $this->default_encoder = $default_encoder;
     }

Here is the caller graph for this function:

◆ setSupportedEncoders()

ilUserPasswordEncoderFactory::setSupportedEncoders ( array $supported_encoders )

Parameters

list<ilPasswordEncoder> $supported_encoders

Exceptions

ilUserException

Definition at line 99 of file class.ilUserPasswordEncoderFactory.php.

Referenced by ilObjUserPasswordTest\testFactoryReturnsCorrectEncoderIfAMatchingEncoderWasFound(), and ilObjUserPasswordTest\testFactoryReturnsTheDefaultEncoderIfAnUnsupportedEncoderIsRequestedAndASupportedDefaultEncoderWasSpecifiedInFallbackMode().

                                                                    : void
     {
         $this->supported_encoders = [];
         foreach ($supported_encoders as $encoder) {
             if (!($encoder instanceof ilPasswordEncoder) || !$encoder->isSupportedByRuntime()) {
                 throw new ilUserException(sprintf(
                     'One of the passed encoders is not valid: %s.',
                     print_r($encoder, true)
                 ));
             }
             $this->supported_encoders[$encoder->getName()] = $encoder;
         }
     }