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

Yaf_Dispatcher::autoRender

PHP function Edit on GitHub ✎

(Yaf >=1.0.0)

Switch on/off autorendering

Description

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

Yaf_Dispatcher will render the view automatically after dispatching an incoming request. You can prevent the rendering by calling this method with flag false.

Note

You can also simply return false in an action to prevent the auto-rendering of that action only.

Parameters

flag

Whether to enable auto-rendering.

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 whether auto-rendering is enabled when it is not.

Examples

Yaf_Dispatcher::autoRender() example

php
<?php
class IndexController extends Yaf_Controller_Abstract {
     /* init method will be called as soon as a controller is initialized */
     public function init() {
         if ($this->getRequest()->isXmlHttpRequest()) {
             //do not call render for ajax request
             //we will output a json string
             Yaf_Dispatcher::getInstance()->autoRender(FALSE);
         }
     }
}
?>

See Also

  • Yaf_Dispatcher::flushInstantly

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