external_files.php

Go to the documentation of this file.

<?php
function elgg_define_js($name, $config) {
    $src = elgg_extract('src', $config);

    if ($src) {
        $url = elgg_normalize_url($src);
        _elgg_services()->amdConfig->addPath($name, $url);
    }

    // shimmed module
    if (isset($config['deps']) || isset($config['exports'])) {
        _elgg_services()->amdConfig->addShim($name, $config);
    }
}

function elgg_require_js($name) {
    _elgg_services()->amdConfig->addDependency($name);
}

function elgg_unrequire_js($name) {
    _elgg_services()->amdConfig->removeDependency($name);
}

function elgg_require_css(string $view) {
    $view_name = "{$view}.css";
    if (!elgg_view_exists($view_name)) {
        $view_name = $view;
    }
    
    elgg_register_external_file('css', $view, elgg_get_simplecache_url($view_name));
    elgg_load_external_file('css', $view);
}

function elgg_unrequire_css(string $view) {
    elgg_unregister_external_file('css', $view);
}

function elgg_register_external_file(string $type, string $name, string $url, string $location = ''): bool {
    if (empty($location)) {
        $location = $type === 'js' ? 'footer' : 'head';
    }
    
    return _elgg_services()->externalFiles->register($type, $name, $url, $location);
}

function elgg_unregister_external_file(string $type, string $name): bool {
    return _elgg_services()->externalFiles->unregister($type, $name);
}

function elgg_load_external_file(string $type, string $name): void {
    _elgg_services()->externalFiles->load($type, $name);
}

function elgg_get_loaded_external_resources(string $type, string $location): array {
    return _elgg_services()->externalFiles->getLoadedResources($type, $location);
}