Request.php

Go to the documentation of this file.

<?php

namespace Elgg;

use Elgg\Di\PublicContainer;
use Elgg\Http\Request as HttpRequest;
use Elgg\Validation\ValidationResults;

class Request {

    protected $validation;

    public function __construct(protected PublicContainer $dic, protected HttpRequest $http_request) {
        $this->validation = new ValidationResults();
    }

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

    public function getRoute() {
        return $this->getParam('_route');
    }

    public function getParams($filter = true) {
        return $this->http_request->getParams($filter);
    }

    public function getParam($key, $default = null, $filter = true) {
        return $this->http_request->getParam($key, $default, $filter);
    }

    public function setParam($key, $value = null) {
        $this->http_request->setParam($key, $value);
    }

    public function getEntityParam(string $key = 'guid'): ?\ElggEntity {
        $guid = (int) $this->http_request->getParam($key);
        if (empty($guid)) {
            return null;
        }
        
        return get_entity($guid);
    }

    public function getUserParam(string $key = 'user_guid'): ?\ElggUser {
        $prop = $this->http_request->getParam($key);
        if (elgg_is_empty($prop)) {
            return null;
        }
        
        if ($key === 'username') {
            return elgg_get_user_by_username((string) $prop);
        }

        return get_user((int) $prop);
    }

    public function elgg() {
        return $this->dic;
    }

    public function getURL() {
        return $this->http_request->getCurrentURL();
    }

    public function getPath() {
        return implode('/', $this->http_request->getUrlSegments());
    }

    public function isXhr() {
        return $this->http_request->isXmlHttpRequest();
    }

    public function getMethod() {
        return $this->http_request->getMethod();
    }

    public function getHttpRequest() {
        return $this->http_request;
    }
}