Router.php

Go to the documentation of this file.

<?php

class Elgg_Router {
    private $handlers = array();
    private $hooks;

    public function __construct(Elgg_PluginHooksService $hooks) {
        $this->hooks = $hooks;
    }

    public function route(Elgg_Http_Request $request) {
        $segments = $request->getUrlSegments();
        if ($segments) {
            $identifier = array_shift($segments);
        } else {
            $identifier = '';

            // this plugin hook is deprecated. Use elgg_register_page_handler()
            // to register for the '' (empty string) handler.
            // allow plugins to override the front page (return true to indicate
            // that the front page has been served)
            $result = elgg_trigger_plugin_hook('index', 'system', null, false);
            if ($result === true) {
                elgg_deprecated_notice("The 'index', 'system' plugin has been deprecated. See elgg_front_page_handler()", 1.9);
                exit;
            }
        }

        // return false to stop processing the request (because you handled it)
        // return a new $result array if you want to route the request differently
        $result = array(
            'identifier' => $identifier,
            'handler' => $identifier, // backward compatibility
            'segments' => $segments,
        );
        $result = $this->hooks->trigger('route', $identifier, null, $result);
        if ($result === false) {
            return true;
        }

        if ($identifier != $result['identifier']) {
            $identifier = $result['identifier'];
        } else if ($identifier != $result['handler']) {
            $identifier = $result['handler'];
        }

        $segments = $result['segments'];

        $handled = false;
        if (isset($this->handlers[$identifier]) && is_callable($this->handlers[$identifier])) {
            $function = $this->handlers[$identifier];
            $handled = call_user_func($function, $segments, $identifier);
        }

        return $handled || headers_sent();
    }

    public function registerPageHandler($identifier, $function) {
        if (is_callable($function, true)) {
            $this->handlers[$identifier] = $function;
            return true;
        }

        return false;
    }

    public function unregisterPageHandler($identifier) {
        unset($this->handlers[$identifier]);
    }

    public function getPageHandlers() {
        return $this->handlers;
    }
}