class.ilUserPasswordEncoderFactory.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2014 ILIAS open source, Extended GPL, see docs/LICENSE */

require_once 'Services/User/exceptions/class.ilUserException.php';

class ilUserPasswordEncoderFactory
{
        protected $default_encoder;

        protected $encoders = array();

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

                $this->initEncoders($config);
        }

        protected function initEncoders(array $config)
        {
                $encoder_directory = 'Services/Password/classes/encoders';
                foreach(new DirectoryIterator($encoder_directory) as $file)
                {
                        if($file->isDir())
                        {
                                continue;
                        }

                        require_once $file->getPathname();
                        $class_name = preg_replace('/(class\.)(.*?)(\.php)/', '$2', $file->getBasename());
                        if(class_exists($class_name))
                        {
                                $reflection = new ReflectionClass($class_name);
                                $encoder    = $reflection->newInstanceArgs(array($config));
                                if($encoder instanceof ilPasswordEncoder && $encoder->isSupportedByRuntime())
                                {
                                        $this->encoders[$encoder->getName()] = $encoder;
                                }
                        }
                }
        }

        public function getDefaultEncoder()
        {
                return $this->default_encoder;
        }

        public function setDefaultEncoder($default_encoder)
        {
                $this->default_encoder = $default_encoder;
        }

        public function getEncoders()
        {
                return $this->encoders;
        }

        public function setEncoders(array $encoders)
        {
                $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;
                }
        }

        public function getSupportedEncoderNames()
        {
                return array_keys($this->getEncoders());
        }

        public function getEncoderByName($name, $get_default_on_mismatch = false)
        {
                if(!isset($this->encoders[$name]))
                {
                        if(!$get_default_on_mismatch)
                        {
                                throw new ilUserException(sprintf('The encoder "%s" was not configured.', $name));
                        }
                        else if(!$this->getDefaultEncoder())
                        {
                                throw new ilUserException('No default encoder specified, fallback not possible.');
                        }
                        else if(!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];
        }
}