Config.php

Go to the documentation of this file.

<?php

namespace Elgg\Amd;

use Elgg\Exceptions\InvalidArgumentException;

class Config {
    
    private $baseUrl = '';
    
    private $paths = [];
    
    private $shim = [];
    
    private $dependencies = [];

    protected $events;
    
    public function __construct(\Elgg\EventsService $events) {
        $this->events = $events;
    }
    
    public function setBaseUrl($url) {
        $this->baseUrl = $url;
    }

    public function addPath(string $name, string $path): void {
        if (preg_match('/\.js$/', $path)) {
            $path = preg_replace('/\.js$/', '', $path);
        }

        if (!isset($this->paths[$name])) {
            $this->paths[$name] = [];
        }

        array_unshift($this->paths[$name], $path);
    }

    public function removePath($name, $path = null) {
        if (!$path) {
            unset($this->paths[$name]);
        } else {
            if (preg_match('/\.js$/', $path)) {
                $path = preg_replace('/\.js$/', '', $path);
            }

            $key = array_search($path, $this->paths[$name]);
            unset($this->paths[$name][$key]);

            if (empty($this->paths[$name])) {
                unset($this->paths[$name]);
            }
        }
    }

    public function addShim(string $name, array $config): void {
        $deps = elgg_extract('deps', $config, []);
        $exports = elgg_extract('exports', $config);

        if (empty($deps) && empty($exports)) {
            throw new InvalidArgumentException('Shimmed modules must have deps or exports');
        }

        $this->shim[$name] = [];

        if (!empty($deps)) {
            $this->shim[$name]['deps'] = $deps;
        }

        if (!empty($exports)) {
            $this->shim[$name]['exports'] = $exports;
        }
    }

    public function hasShim($name) {
        return isset($this->shim[$name]);
    }

    public function removeShim($name) {
        unset($this->shim[$name]);
    }

    public function addDependency(string $name): void {
        $this->dependencies[$name] = true;
    }

    public function removeDependency(string $name): void {
        unset($this->dependencies[$name]);
    }

    public function getDependencies() {
        return array_keys($this->dependencies);
    }

    public function hasDependency($name) {
        return isset($this->dependencies[$name]);
    }

    public function addModule($name, array $config = []) {
        $url = elgg_extract('url', $config);
        $deps = elgg_extract('deps', $config, []);
        $exports = elgg_extract('exports', $config);

        if (!empty($url)) {
            $this->addPath($name, $url);
        }

        // this is a shimmed module
        // some jQuery modules don't need to export anything when shimmed,
        // so check for deps too
        if (!empty($deps) || !empty($exports)) {
            $this->addShim($name, $config);
        } else {
            $this->addDependency($name);
        }
    }

    public function removeModule($name) {
        $this->removeDependency($name);
        $this->removeShim($name);
        $this->removePath($name);
    }

    public function hasModule($name) {
        if (in_array($name, $this->getDependencies())) {
            return true;
        }

        if (isset($this->shim[$name])) {
            return true;
        }

        if (isset($this->paths[$name])) {
            return true;
        }

        return false;
    }

    public function getConfig() {
        $defaults = [
            'baseUrl' => $this->baseUrl,
            'paths' => $this->paths,
            'shim' => $this->shim,
            'deps' => $this->getDependencies(),
            'waitSeconds' => 20,
        ];
        
        $params = [
            'defaults' => $defaults
        ];
        
        return $this->events->triggerResults('config', 'amd', $params, $defaults);
    }
}