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

Yaf_Dispatcher::flushInstantly

PHP function Edit on GitHub ✎

(Yaf >=1.0.0)

Switch on/off the instant flushing

Description

Yaf_Dispatcher::flushInstantly(bool|null $flag = null): Yaf_Dispatcher|bool

Switch on/off instant flushing. When enabled (the default), the response body is flushed to the client immediately once it is set by Yaf_Response_Abstract::setBody.

Parameters

flag

Whether to flush the response body instantly.

Note

Since Yaf 2.2.0, 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::flushInstantly example

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

$dispatcher = Yaf_Dispatcher::getInstance();

// Do not flush the response body to the client as soon as it is set
$dispatcher->flushInstantly(false);

// Since Yaf 2.2.0, calling it without arguments queries the current state
var_dump($dispatcher->flushInstantly());

$app->run();
?>

The above example will output something similar to:

output
bool(false)

See Also

  • Yaf_Dispatcher::returnResponse
  • Yaf_Response_Abstract::setBody

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