php8.5
Home/ Manual/ yaf / yaf_dispatcher/ Yaf_Dispatcher::returnResponse

Yaf_Dispatcher::returnResponse

PHP function Edit on GitHub ✎

(Yaf >=1.0.0)

Switch on/off returning the response

Description

Yaf_Dispatcher::returnResponse(bool $flag = false): Yaf_Dispatcher|bool

Switch whether Yaf_Application::run returns the response object instead of sending it to the client directly. When enabled, $response = $app->run() gives you the Yaf_Response_Abstract instance so it can be further manipulated. Available since Yaf 3.2.2.

Parameters

flag

Whether to return the response instead of sending it.

Note

If this parameter is not given, the current state is returned instead.

Return Values

Returns the Yaf_Dispatcher object itself when flag is given, or a Boolean indicating the current state when it is not.

Examples

Yaf_Dispatcher::returnResponse example

php
<?php
$app = new Yaf_Application(dirname(__FILE__) . "/conf/application.ini");

Yaf_Dispatcher::getInstance()->returnResponse(true);

// $app->run() now returns the response instead of flushing it
$response = $app->run();

$response->setHeader("X-Generator", "Yaf");
$response->response();
?>

See Also

  • Yaf_Application::run
  • Yaf_Response_Abstract

Source: reference/yaf/yaf_dispatcher/returnresponse.xml · from the official PHP manual (php/doc-en)