ClassLoader.php

Go to the documentation of this file.

<?php

namespace Elgg;

class ClassLoader {

    protected array $namespaces = [];
    
    protected array $prefixes = [];
    
    protected array $fallbacks = [];
    
    protected $map;

    protected array $missing = [];

    public function __construct(protected Config $config) {
        $this->map = new \Elgg\ClassMap();
        
        $this->register();
    }

    public function getClassMap() {
        return $this->map;
    }

    public function getNamespaces() {
        return $this->namespaces;
    }

    public function getPrefixes() {
        return $this->prefixes;
    }

    public function registerNamespaces(array $namespaces) {
        foreach ($namespaces as $namespace => $locations) {
            $this->namespaces[$namespace] = (array) $locations;
        }
    }

    public function registerNamespace($namespace, $paths) {
        $this->namespaces[$namespace] = (array) $paths;
    }

    public function registerPrefixes(array $classes) {
        foreach ($classes as $prefix => $locations) {
            $this->prefixes[$prefix] = (array) $locations;
        }
    }

    public function registerPrefix($prefix, $paths) {
        $this->prefixes[$prefix] = (array) $paths;
    }

    public function addFallback($path) {
        $this->fallbacks[] = rtrim($path, '/\\');
    }

    public function register() {
        spl_autoload_register([$this, 'loadClass']);
    }

    public function loadClass($class) {
        // is missing? return
        if (isset($this->missing[$class])) {
            return;
        }
        
        $file = $this->map->getPath($class);
        if (!empty($file) && (!$this->config->class_loader_verify_file_existence || is_file($file))) {
            require $file;
            return;
        }

        $file = $this->findFile($class);
        if (!empty($file)) {
            $this->map->setPath($class, $file);
            $this->map->setAltered(true);
            require $file;
        }
        
        // add to missing
        $this->missing[$class] = true;
    }

    public function findFile($class) {
        if ($class[0] === '\\') {
            $class = substr($class, 1);
        }

        $pos = strrpos($class, '\\');
        if ($pos !== false) {
            // namespaced class name
            $namespace = substr($class, 0, $pos);
            $className = substr($class, $pos + 1);
            $normalizedClass = str_replace('\\', DIRECTORY_SEPARATOR, $namespace)
                . DIRECTORY_SEPARATOR
                . str_replace('_', DIRECTORY_SEPARATOR, $className) . '.php';
            foreach ($this->namespaces as $ns => $dirs) {
                if (!str_starts_with($namespace, $ns)) {
                    continue;
                }

                foreach ($dirs as $dir) {
                    $file = $dir . DIRECTORY_SEPARATOR . $normalizedClass;
                    if (is_file($file)) {
                        return $file;
                    }
                }
            }
        } else {
            // PEAR-like class name
            $normalizedClass = str_replace('_', DIRECTORY_SEPARATOR, $class) . '.php';
            foreach ($this->prefixes as $prefix => $dirs) {
                if (!str_starts_with($class, $prefix)) {
                    continue;
                }

                foreach ($dirs as $dir) {
                    $file = $dir . DIRECTORY_SEPARATOR . $normalizedClass;
                    if (is_file($file)) {
                        return $file;
                    }
                }
            }
        }

        foreach ($this->fallbacks as $dir) {
            $file = $dir . DIRECTORY_SEPARATOR . $normalizedClass;
            if (is_file($file)) {
                return $file;
            }
        }
    }
}