pagehandler.php

Go to the documentation of this file.

<?php
function elgg_register_route(string $name, array $params = []): \Elgg\Router\Route {
    return _elgg_services()->routes->register($name, $params);
}

function elgg_unregister_route(string $name): void {
    _elgg_services()->routes->unregister($name);
}

function elgg_get_route(string $name): ?\Elgg\Router\Route {
    return _elgg_services()->routes->get($name);
}

function elgg_get_route_for_url(string $url): ?\Elgg\Router\Route {
    $url = elgg_normalize_url($url);
    
    $path = parse_url($url, PHP_URL_PATH);
    try {
        $route_info = _elgg_services()->urlMatcher->match($path);
        if (!isset($route_info['_route'])) {
            return null;
        }
        
        $route = _elgg_services()->routes->get($route_info['_route']);
        $route->setMatchedParameters($route_info);
        
        return $route;
    } catch (\Symfony\Component\Routing\Exception\ExceptionInterface $e) {
        // route matcher exception
        return null;
    }
}

function elgg_get_current_route(): ?\Elgg\Router\Route {
    return _elgg_services()->request->getRoute();
}

function elgg_get_current_route_name(): string {
    $route = _elgg_services()->request->getRoute();
    return isset($route) ? $route->getName() : '';
}

function elgg_route_exists(string $name): bool {
    return _elgg_services()->routes->get($name) instanceof \Elgg\Router\Route;
}

function elgg_get_current_url(): string {
    return _elgg_services()->request->getCurrentURL();
}

function elgg_generate_url(string $name, array $parameters = []): ?string {
    return _elgg_services()->routes->generateUrl($name, $parameters);
}

function elgg_generate_entity_url(ElggEntity $entity, string $resource = 'view', string $subresource = null, array $parameters = []): ?string {

    $make_route_name = function ($type, $subtype) use ($resource, $subresource) {
        $route_parts = [
            $resource,
            $type,
            $subtype,
            $subresource,
        ];

        return implode(':', array_filter($route_parts));
    };

    $pairs = [
        [$entity->type, $entity->subtype],
        [$entity->type, null],
    ];

    foreach ($pairs as $pair) {
        $route_name = $make_route_name($pair[0], $pair[1]);
        $params = _elgg_services()->routes->resolveRouteParameters($route_name, $entity, $parameters);
        if ($params !== false) {
            return elgg_generate_url($route_name, $params);
        }
    }

    return null;
}

function elgg_generate_action_url(string $action, array $query = [], bool $add_csrf_tokens = true): string {

    $url = elgg_http_add_url_query_elements("action/{$action}", $query);
    $url = elgg_normalize_url($url);

    if ($add_csrf_tokens) {
        $url = elgg_add_action_tokens_to_url($url);
    }

    return $url;
}

function elgg_ok_response($content = '', string|array $message = '', string $forward_url = null, int $status_code = ELGG_HTTP_OK): \Elgg\Http\OkResponse {
    if ($message) {
        elgg_register_success_message($message);
    }

    return new \Elgg\Http\OkResponse($content, $status_code, $forward_url);
}

function elgg_error_response(string|array $message = '', string $forward_url = REFERRER, int $status_code = ELGG_HTTP_BAD_REQUEST): \Elgg\Http\ErrorResponse {
    if ($message) {
        elgg_register_error_message($message);
        
        // needed to convert the error message back to a string as the ErrorResponse does not support an array of \ElggSystemMessage options
        $message = is_array($message) ? $message['message'] : $message;
    }

    return new \Elgg\Http\ErrorResponse($message, $status_code, $forward_url);
}

function elgg_redirect_response(string $forward_url = REFERRER, int $status_code = ELGG_HTTP_FOUND, bool $secure_forward_url = true): \Elgg\Http\RedirectResponse {
    return new Elgg\Http\RedirectResponse($forward_url, $status_code, $secure_forward_url);
}

function elgg_download_response(string $content, string $filename = '', bool $inline = false, array $headers = []): \Elgg\Http\DownloadResponse {
    $response = new \Elgg\Http\DownloadResponse($content);
    $response->setHeaders($headers);
    $response->setFilename($filename, $inline);
    
    return $response;
}