The Yaf_Request_Http class

(Yaf >=1.0.0)

Introduction

Any request from client is initialized as a Yaf_Request_Http. you can get the request information like, uri query and post parameters via methods of this class.

Note:

For security, $_GET/$_POST are readonly in Yaf, which means if you set a value to these global variables, you can not get it from Yaf_Request_Http::getQuery() or Yaf_Request_Http::getPost().

But there do is some usage need such feature, like unit testing. thus Yaf can be built with --enable-yaf-debug, which will allow Yaf read the value user set via script.

in such case, Yaf will throw a E_STRICT warning to remind you about that: Strict Standards: you are running yaf in debug mode

Class synopsis

class Yaf_Request_Http extends Yaf_Request_Abstract {
/* Properties */
/* Methods */
public function __construct(string $request_uri = ?, string $base_uri = ?)
/* Inherited methods */
public function Yaf_Request_Abstract::clearParams(): ?Yaf_Request_Abstract
public function Yaf_Request_Abstract::get(string $name, mixed $default = ?): mixed
public function Yaf_Request_Abstract::getActionName(): ?string
public function Yaf_Request_Abstract::getBaseUri(): ?string
public function Yaf_Request_Abstract::getControllerName(): ?string
public function Yaf_Request_Abstract::getCookie(string $name = ?, mixed $default = ?): mixed
public function Yaf_Request_Abstract::getEnv(string $name, mixed $default = ?): mixed
public function Yaf_Request_Abstract::getException(): ?Exception
public function Yaf_Request_Abstract::getFiles(string $name = ?, mixed $default = ?): mixed
public function Yaf_Request_Abstract::getLanguage(): ?string
public function Yaf_Request_Abstract::getMethod(): ?string
public function Yaf_Request_Abstract::getModuleName(): ?string
public function Yaf_Request_Abstract::getParam(string $name, mixed $default = ?): mixed
public function Yaf_Request_Abstract::getParams(): ?array
public function Yaf_Request_Abstract::getPost(string $name = ?, mixed $default = ?): mixed
public function Yaf_Request_Abstract::getQuery(string $name = ?, mixed $default = ?): mixed
public function Yaf_Request_Abstract::getRaw(): ?string
public function Yaf_Request_Abstract::getRequest(string $name = ?, mixed $default = ?): mixed
public function Yaf_Request_Abstract::getRequestUri(): ?string
public function Yaf_Request_Abstract::getServer(string $name, mixed $default = ?): mixed
public function Yaf_Request_Abstract::isCli(): bool
public function Yaf_Request_Abstract::isDelete(): bool
public function Yaf_Request_Abstract::isDispatched(): bool
public function Yaf_Request_Abstract::isGet(): bool
public function Yaf_Request_Abstract::isHead(): bool
public function Yaf_Request_Abstract::isOptions(): bool
public function Yaf_Request_Abstract::isPatch(): bool
public function Yaf_Request_Abstract::isPost(): bool
public function Yaf_Request_Abstract::isPut(): bool
public function Yaf_Request_Abstract::isRouted(): bool
public function Yaf_Request_Abstract::isXmlHttpRequest(): bool
public function Yaf_Request_Abstract::setActionName(string $action, bool $format_name = true): ?Yaf_Request_Abstract
public function Yaf_Request_Abstract::setBaseUri(string $uir): Yaf_Request_Abstract|false
public function Yaf_Request_Abstract::setControllerName(string $controller, bool $format_name = true): ?Yaf_Request_Abstract
final public function Yaf_Request_Abstract::setDispatched(bool $flag = true): Yaf_Request_Abstract
public function Yaf_Request_Abstract::setModuleName(string $module, bool $format_name = true): ?Yaf_Request_Abstract
public function Yaf_Request_Abstract::setParam(mixed $name, mixed $value = ?): Yaf_Request_Abstract|bool|null
public function Yaf_Request_Abstract::setRequestUri(string $uri): Yaf_Request_Abstract
final public function Yaf_Request_Abstract::setRouted(bool $flag = true): Yaf_Request_Abstract
}

Properties

module

controller

action

method

params

language

_exception

_base_uri

uri

dispatched

routed

Table of Contents

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug
＋add a note

User Contributed Notes

There are no user contributed notes for this page.