Inheritance diagram for ilUserPasswordEncoderFactory:

Collaboration diagram for ilUserPasswordEncoderFactory:

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

	getDefaultEncoder ()

	setDefaultEncoder (string $defaultEncoder)

	getEncoders ()

	setEncoders (array $encoders)

	getSupportedEncoderNames ()

	getEncoderByName ($name, $get_default_on_mismatch=false)

	getFirstEncoderForEncodedPasswordAndMatchers (string $encoded, array $matchers)

Protected Member Functions
	getValidEncoders ($config)

	initEncoders (array $config)

Protected Attributes
	$defaultEncoder

	$encoders = array()

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

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

Parameters

array $config

Exceptions

ilPasswordException

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

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

References $config, initEncoders(), and setDefaultEncoder().

Here is the call graph for this function:

Member Function Documentation

◆ getDefaultEncoder()

ilUserPasswordEncoderFactory::getDefaultEncoder ( )

Returns: string

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

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

References $defaultEncoder.

Referenced by getEncoderByName(), and getFirstEncoderForEncodedPasswordAndMatchers().

Here is the caller graph for this function:

◆ getEncoderByName()

ilUserPasswordEncoderFactory::getEncoderByName	(	$name,
		$get_default_on_mismatch = `false`
	)

Parameters

string	$name
bool	$get_default_on_mismatch

Returns: ilPasswordEncoder

Exceptions

ilUserException

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

                                                                              : ilPasswordEncoder
    {
        if (!isset($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()];
        }
 
        return $this->encoders[$name];
    }

References $name, and getDefaultEncoder().

Referenced by getFirstEncoderForEncodedPasswordAndMatchers().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getEncoders()

ilUserPasswordEncoderFactory::getEncoders ( )

Returns: ilPasswordEncoder[]

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

                                  : array
    {
        return $this->encoders;
    }

References $encoders.

Referenced by getFirstEncoderForEncodedPasswordAndMatchers(), and getSupportedEncoderNames().

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 150 of file class.ilUserPasswordEncoderFactory.php.

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

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

Here is the call graph for this function:

◆ getSupportedEncoderNames()

ilUserPasswordEncoderFactory::getSupportedEncoderNames ( )

Returns: string[]

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

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

References getEncoders().

Here is the call graph for this function:

◆ getValidEncoders()

ilUserPasswordEncoderFactory::getValidEncoders ( $config )

protected

Parameters

array $config

Returns: ilPasswordEncoder[]

Exceptions

ilPasswordException

Reimplemented in ilSetupPasswordEncoderFactory.

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

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

References $config.

Referenced by initEncoders().

Here is the caller graph for this function:

◆ initEncoders()

ilUserPasswordEncoderFactory::initEncoders ( array $config )

protected

Parameters

array $config

Exceptions

ilPasswordException

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

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

References $encoders, and getValidEncoders().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDefaultEncoder()

ilUserPasswordEncoderFactory::setDefaultEncoder ( string $defaultEncoder )

Parameters

string $defaultEncoder

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

    {
        $this->defaultEncoder = $defaultEncoder;
    }

References $defaultEncoder.

Referenced by __construct().

Here is the caller graph for this function:

◆ setEncoders()

ilUserPasswordEncoderFactory::setEncoders ( array $encoders )

Parameters

ilPasswordEncoder[] $encoders

Exceptions

ilUserException

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

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