php-doc-en/reference/misc/functions/ignore-user-abort.xml
2007-10-02 18:42:57 +00:00

86 lines
2.3 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.ignore-user-abort" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ignore_user_abort</refname>
<refpurpose>Set whether a client disconnect should abort script execution</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>ignore_user_abort</methodname>
<methodparam choice="opt"><type>bool</type><parameter>setting</parameter></methodparam>
</methodsynopsis>
<para>
Sets whether a client disconnect should cause a script to be aborted.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>setting</parameter></term>
<listitem>
<para>
If not set, the function will only return the current setting.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the previous setting, as a boolean.
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<para>
PHP will not detect that the user has aborted the connection until
an attempt is made to send information to the client. Simply using
an echo statement does not guarantee that information is sent, see
<function>flush</function>.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>connection_aborted</function></member>
<member><function>connection_status</function></member>
<member>
<link linkend="features.connection-handling">Connection Handling</link>
for a complete description of connection handling in PHP.
</member>
</simplelist>
</para>
</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:"../../../../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
-->