mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-15 16:38:54 +00:00
106 lines
2.6 KiB
XML
106 lines
2.6 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<refentry xml:id="yaf-dispatcher.autorender" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>Yaf_Dispatcher::autoRender</refname>
|
|
<refpurpose>Switch on/off autorendering</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>public</modifier> <type>Yaf_Dispatcher</type><methodname>Yaf_Dispatcher::autoRender</methodname>
|
|
<methodparam choice="opt"><type>bool</type><parameter>flag</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<classname>Yaf_Dispatcher</classname> will render automatically after
|
|
dispatches a incoming request, you can prevent the rendering by calling
|
|
this method with <parameter>flag</parameter> &true;
|
|
<note>
|
|
<para>
|
|
you can simply return &false; in a action to prevent the auto-rendering of
|
|
that action
|
|
</para>
|
|
</note>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>flag</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
bool
|
|
<note>
|
|
<para>
|
|
since 2.2.0, if this parameter is not given, then the current state
|
|
will be returned
|
|
</para>
|
|
</note>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<example>
|
|
<title><function>Yaf_Dispatcher::autoRender</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?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 outpu a json string
|
|
Yaf_Dispatcher::getInstance()->autoRender(FALSE);
|
|
}
|
|
}
|
|
|
|
}
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</refsect1>
|
|
|
|
</refentry>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|