ilUserPasswordEncoderFactory Class Reference

Collaboration diagram for ilUserPasswordEncoderFactory:

Public Member Functions
	__construct (array $config=[])
	getDefaultEncoder ()
	setDefaultEncoder (string $defaultEncoder)
	getEncoders ()
	setEncoders (array $encoders)
	getSupportedEncoderNames ()
	getEncoderByName (?string $name, bool $get_default_on_mismatch=false)
	getFirstEncoderForEncodedPasswordAndMatchers (string $encoded, array $matchers)

Protected Member Functions
	getValidEncoders (array $config)
	initEncoders (array $config)

Protected Attributes
string	$defaultEncoder = null
array	$encoders = []

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilUserPasswordEncoderFactory::__construct

(

array

$config = []

)

Parameters

array

$config

Exceptions

ilPasswordException

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

References $config, 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 81 of file class.ilUserPasswordEncoderFactory.php.

References $defaultEncoder.

Referenced by getEncoderByName(), and getFirstEncoderForEncodedPasswordAndMatchers().

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

Here is the caller graph for this function:

getEncoderByName()

ilUserPasswordEncoderFactory::getEncoderByName	(	?string	$name,
		bool	$get_default_on_mismatch = false
	)

Parameters

string	$name
bool	$get_default_on_mismatch

Returns

ilPasswordEncoder

Exceptions

ilUserException

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

References $name, and getDefaultEncoder().

Referenced by getFirstEncoderForEncodedPasswordAndMatchers().

                                                                                          : ilPasswordEncoder
    {
        if ($name !== null && isset($this->encoders[$name])) {
            return $this->encoders[$name];
        }

        if (!$get_default_on_mismatch) {
            throw new ilUserException(sprintf('The encoder "%s" was not configured.', $name));
        } elseif (!$this->getDefaultEncoder()) {
            throw new ilUserException('No default encoder specified, fallback not possible.');
        } elseif (!isset($this->encoders[$this->getDefaultEncoder()])) {
            throw new ilUserException("No default encoder found for name: '{$this->getDefaultEncoder()}'.");
        }

        return $this->encoders[$this->getDefaultEncoder()];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getEncoders()

ilUserPasswordEncoderFactory::getEncoders

(

)

Returns

array<string, ilPasswordEncoder>

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

References $encoders.

Referenced by getFirstEncoderForEncodedPasswordAndMatchers(), and getSupportedEncoderNames().

                                 : array
    {
        return $this->encoders;
    }

Here is the caller graph for this function:

getFirstEncoderForEncodedPasswordAndMatchers()

ilUserPasswordEncoderFactory::getFirstEncoderForEncodedPasswordAndMatchers	(	string	$encoded,
		array	$matchers
	)

Parameters

string	$encoded
array	$matchers	An key/value pair callback functions (accepting the encoded password) assigned to the respective encoder name

Returns

ilPasswordEncoder

Exceptions

ilUserException

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

References getDefaultEncoder(), getEncoderByName(), and getEncoders().

                                                                                                  : ilPasswordEncoder
    {
        foreach ($this->getEncoders() as $encoder) {
            foreach ($matchers as $encoderName => $callback) {
                if (
                    is_callable($callback) &&
                    $encoder->getName() === $encoderName &&
                    $callback($encoded) === true
                ) {
                    return $encoder;
                }
            }
        }

        return $this->getEncoderByName($this->getDefaultEncoder());
    }

Here is the call graph for this function:

getSupportedEncoderNames()

ilUserPasswordEncoderFactory::getSupportedEncoderNames

(

)

Returns

string[]

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

References getEncoders().

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

Here is the call graph for this function:

getValidEncoders()

ilUserPasswordEncoderFactory::getValidEncoders ( array  $config )

protected

Parameters

array

$config

Returns

ilPasswordEncoder[]

Exceptions

ilPasswordException

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

Referenced by initEncoders().

                                                      : array // Missing array type.
    {
        return [
            new ilBcryptPhpPasswordEncoder($config),
            new ilBcryptPasswordEncoder($config),
            new ilMd5PasswordEncoder(),
        ];
    }

Here is the caller graph for this function:

initEncoders()

ilUserPasswordEncoderFactory::initEncoders ( array  $config )

protected

Parameters

array

$config

Exceptions

ilPasswordException

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

References getValidEncoders().

Referenced by __construct().

                                                  : void // Missing array type.
    {
        $this->encoders = [];

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

Here is the call graph for this function:

Here is the caller graph for this function:

setDefaultEncoder()

ilUserPasswordEncoderFactory::setDefaultEncoder

(

string

$defaultEncoder

)

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

References $defaultEncoder.

Referenced by __construct().

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

Here is the caller graph for this function:

setEncoders()

ilUserPasswordEncoderFactory::setEncoders

(

array

$encoders

)

Parameters

ilPasswordEncoder[]

$encoders

Exceptions

ilUserException

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

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

Field Documentation

$defaultEncoder

string ilUserPasswordEncoderFactory::$defaultEncoder = null

protected

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

Referenced by getDefaultEncoder(), and setDefaultEncoder().

$encoders

array ilUserPasswordEncoderFactory::$encoders = []

protected

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

Referenced by getEncoders().

---

The documentation for this class was generated from the following file:

• Services/User/classes/class.ilUserPasswordEncoderFactory.php