Nu-Coder Manual

PhpExpress Manual

PHP Joomla
Development

Yaf_Registry::set	Yaf_Request_Abstract::clearParams

Yaf	Last updated: Mon, 26 Oct 2026

The Yaf_Request_Abstract class

(Yaf >=1.0.0)

Introduction

Yaf_Request_Abstract is the base class of the request objects. It encapsulates the request environment: the module, controller and action resolved by routing, the request parameters, and accessors for the superglobals (query string, POST, cookie, server, environment and uploaded files).

Two concrete implementations are provided: Yaf_Request_Http, initialized from an actual web request, and Yaf_Request_Simple, a synthetic request used in tests and CLI scripts.

Class synopsis

class Yaf_Request_Abstract {

/* Constants */

const string SCHEME_HTTP = http;

const string SCHEME_HTTPS = https;

/* Properties */

public $module;

public $controller;

public $action;

public $method;

protected $params;

protected $language;

protected $_exception;

protected $_base_uri;

protected $uri;

protected $dispatched;

protected $routed;

/* Methods */

public function clearParams(): ?Yaf_Request_Abstract

public function get(string $name, mixed $default = ?): mixed

public function getActionName(): ?string

public function getBaseUri(): ?string

public function getControllerName(): ?string

public function getCookie(string $name = ?, mixed $default = ?): mixed

public function getEnv(string $name, mixed $default = ?): mixed

public function getException(): ?Exception

public function getFiles(string $name = ?, mixed $default = ?): mixed

public function getLanguage(): ?string

public function getMethod(): ?string

public function getModuleName(): ?string

public function getParam(string $name, mixed $default = ?): mixed

public function getParams(): ?array

public function getPost(string $name = ?, mixed $default = ?): mixed

public function getQuery(string $name = ?, mixed $default = ?): mixed

public function getRaw(): ?string

public function getRequest(string $name = ?, mixed $default = ?): mixed

public function getRequestUri(): ?string

public function getServer(string $name, mixed $default = ?): mixed

public function isCli(): bool

public function isDelete(): bool

public function isDispatched(): bool

public function isGet(): bool

public function isHead(): bool

public function isOptions(): bool

public function isPatch(): bool

public function isPost(): bool

public function isPut(): bool

public function isRouted(): bool

public function isXmlHttpRequest(): bool

public function setActionName(string $action, bool $format_name = true): ?Yaf_Request_Abstract

public function setBaseUri(string $uir): Yaf_Request_Abstract|false

public function setControllerName(string $controller, bool $format_name = true): ?Yaf_Request_Abstract

final public function setDispatched(bool $flag = true): Yaf_Request_Abstract

public function setModuleName(string $module, bool $format_name = true): ?Yaf_Request_Abstract

public function setParam(mixed $name, mixed $value = ?): Yaf_Request_Abstract|bool|null

public function setRequestUri(string $uri): Yaf_Request_Abstract

final public function setRouted(bool $flag = true): Yaf_Request_Abstract

}

Properties

module
controller
action
method
params
language
_exception
_base_uri
uri
dispatched
routed

Predefined Constants

Yaf_Request_Abstract::SCHEME_HTTP
Yaf_Request_Abstract::SCHEME_HTTPS

Table of Contents

Yaf_Request_Abstract::clearParams — Remove all parameters
Yaf_Request_Abstract::get — Retrieve a variable from the request
Yaf_Request_Abstract::getActionName — Retrieve the action name
Yaf_Request_Abstract::getBaseUri — Retrieve the base URI
Yaf_Request_Abstract::getControllerName — Retrieve the controller name
Yaf_Request_Abstract::getCookie — Fetch a COOKIE variable
Yaf_Request_Abstract::getEnv — Retrieve an ENV variable
Yaf_Request_Abstract::getException — Retrieve the exception
Yaf_Request_Abstract::getFiles — Fetch uploaded files
Yaf_Request_Abstract::getLanguage — Retrieve the client's preferred language
Yaf_Request_Abstract::getMethod — Retrieve the request method
Yaf_Request_Abstract::getModuleName — Retrieve the module name
Yaf_Request_Abstract::getParam — Retrieve a parameter
Yaf_Request_Abstract::getParams — Retrieve all parameters
Yaf_Request_Abstract::getPost — Fetch a POST parameter
Yaf_Request_Abstract::getQuery — Fetch a query parameter
Yaf_Request_Abstract::getRaw — Retrieve the raw request body
Yaf_Request_Abstract::getRequest — Fetch a REQUEST variable
Yaf_Request_Abstract::getRequestUri — Retrieve the request URI
Yaf_Request_Abstract::getServer — Retrieve a SERVER variable
Yaf_Request_Abstract::isCli — Determine if the request is a CLI request
Yaf_Request_Abstract::isDelete — Determine if the request is a DELETE request
Yaf_Request_Abstract::isDispatched — Determine if the request is dispatched
Yaf_Request_Abstract::isGet — Determine if the request is a GET request
Yaf_Request_Abstract::isHead — Determine if the request is a HEAD request
Yaf_Request_Abstract::isOptions — Determine if the request is a OPTIONS request
Yaf_Request_Abstract::isPatch — Determine if the request is a PATCH request
Yaf_Request_Abstract::isPost — Determine if the request is a POST request
Yaf_Request_Abstract::isPut — Determine if the request is a PUT request
Yaf_Request_Abstract::isRouted — Determine if the request has been routed
Yaf_Request_Abstract::isXmlHttpRequest — Determine if the request is an Ajax request
Yaf_Request_Abstract::setActionName — Set action name
Yaf_Request_Abstract::setBaseUri — Set base URI
Yaf_Request_Abstract::setControllerName — Set controller name
Yaf_Request_Abstract::setDispatched — Mark the request as dispatched
Yaf_Request_Abstract::setModuleName — Set module name
Yaf_Request_Abstract::setParam — Set a parameter to the request
Yaf_Request_Abstract::setRequestUri — Set the request URI
Yaf_Request_Abstract::setRouted — Mark the request as routed

Yaf_Registry::set	Yaf_Request_Abstract::clearParams

Yaf	Last updated: Mon, 26 Oct 2026