elgglib.php

Go to the documentation of this file.

<?php
function elgg() {
    return \Elgg\Application::$_instance->public_services;
}

function elgg_set_http_header($header, $replace = true) {
    if (!preg_match('~^HTTP/\\d\\.\\d~', $header)) {
        list($name, $value) = explode(':', $header, 2);
        _elgg_services()->responseFactory->setHeader($name, ltrim($value), $replace);
    }
}

function elgg_register_success_message($options): void {
    if (!is_array($options)) {
        $options = ['message' => $options];
    }
    
    $options['type'] = 'success';
    _elgg_services()->system_messages->addMessage($options);
}

function elgg_register_error_message($options): void {
    if (!is_array($options)) {
        $options = ['message' => $options];
    }
    
    $options['type'] = 'error';
    _elgg_services()->system_messages->addMessage($options);
}

function elgg_register_event_handler($event, $object_type, $callback, $priority = 500) {
    return _elgg_services()->events->registerHandler($event, $object_type, $callback, $priority);
}

function elgg_unregister_event_handler($event, $object_type, $callback) {
    return _elgg_services()->events->unregisterHandler($event, $object_type, $callback);
}

function elgg_clear_event_handlers($event, $object_type) {
    _elgg_services()->events->clearHandlers($event, $object_type);
}

function elgg_trigger_event($event, $object_type, $object = null) {
    return _elgg_services()->events->trigger($event, $object_type, $object);
}

function elgg_trigger_before_event($event, $object_type, $object = null) {
    return _elgg_services()->events->triggerBefore($event, $object_type, $object);
}

function elgg_trigger_after_event($event, $object_type, $object = null) {
    return _elgg_services()->events->triggerAfter($event, $object_type, $object);
}

function elgg_register_plugin_hook_handler($hook, $type, $callback, $priority = 500) {
    return _elgg_services()->hooks->registerHandler($hook, $type, $callback, $priority);
}

function elgg_unregister_plugin_hook_handler($hook, $entity_type, $callback) {
    _elgg_services()->hooks->unregisterHandler($hook, $entity_type, $callback);
}

function elgg_clear_plugin_hook_handlers($hook, $type) {
    _elgg_services()->hooks->clearHandlers($hook, $type);
}

function elgg_trigger_plugin_hook($hook, $type, $params = null, $returnvalue = null) {
    return _elgg_services()->hooks->trigger($hook, $type, $params, $returnvalue);
}

function elgg_log($message, $level = \Psr\Log\LogLevel::NOTICE) {
    return _elgg_services()->logger->log($level, $message);
}

function elgg_dump($value) {
    _elgg_services()->logger->dump($value);
}

function elgg_http_build_url(array $parts, $html_encode = true): string {
    return _elgg_services()->urls->buildUrl($parts, (bool) $html_encode);
}

function elgg_add_action_tokens_to_url($url, $html_encode = false): string {
    return _elgg_services()->urls->addActionTokensToUrl((string) $url, (bool) $html_encode);
}

function elgg_http_remove_url_query_element($url, $element): string {
    return _elgg_services()->urls->addQueryElementsToUrl((string) $url, [(string) $element => null]);
}

function elgg_http_add_url_query_elements($url, array $elements): string {
    return _elgg_services()->urls->addQueryElementsToUrl((string) $url, $elements);
}

function elgg_http_url_is_identical($url1, $url2, $ignore_params = ['offset', 'limit']): bool {
    if (!is_string($url1) || !is_string($url2)) {
        return false;
    }
    
    return _elgg_services()->urls->isUrlIdentical($url1, $url2, (array) $ignore_params);
}

function elgg_http_get_signed_url($url, $expires = false) {
    return _elgg_services()->urlSigner->sign($url, $expires);
}

function elgg_http_validate_signed_url($url) {
    return _elgg_services()->urlSigner->isValid($url);
}

function elgg_extract($key, $array, $default = null, $strict = true) {
    if (!is_array($array) && !$array instanceof ArrayAccess) {
        return $default;
    }

    if ($strict) {
        return (isset($array[$key])) ? $array[$key] : $default;
    } else {
        return (isset($array[$key]) && !empty($array[$key])) ? $array[$key] : $default;
    }
}

function elgg_extract_class(array $array, $existing = [], $extract_key = 'class') {
    $existing = empty($existing) ? [] : (array) $existing;

    $merge = (array) elgg_extract($extract_key, $array, []);

    array_splice($existing, count($existing), 0, $merge);

    return array_values(array_unique($existing));
}

function elgg_call(int $flags, Closure $closure) {
    return _elgg_services()->invoker->call($flags, $closure);
}

function elgg_get_ini_setting_in_bytes($setting) {
    // retrieve INI setting
    $val = ini_get($setting);

    // convert INI setting when shorthand notation is used
    $last = strtolower($val[strlen($val) - 1]);
    if (in_array($last, ['g', 'm', 'k'])) {
        $val = substr($val, 0, -1);
    }
    $val = (int) $val;
    switch ($last) {
        case 'g':
            $val *= 1024;
            // fallthrough intentional
        case 'm':
            $val *= 1024;
            // fallthrough intentional
        case 'k':
            $val *= 1024;
    }

    // return byte value
    return $val;
}

function _elgg_services() {
    // This yields a more shallow stack depth in recursive APIs like views. This aids in debugging and
    // reduces false positives in xdebug's infinite recursion protection.
    return \Elgg\Application::$_instance->internal_services;
}