Yaf_Dispatcher::flushInstantly

(Yaf >=1.0.0)

Yaf_Dispatcher::flushInstantlySwitch on/off the instant flushing

Description

public function Yaf_Dispatcher::flushInstantly(?bool $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 bool indicating the current state when it is not.

Examples

Example #1 Yaf_Dispatcher::flushInstantly() example

<?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:

bool(false)

See Also

add a note

User Contributed Notes

There are no user contributed notes for this page.