Files
doc-fr/reference/outcontrol/functions/ob-end-clean.xml
T
2021-09-24 04:13:47 +01:00

112 lines
3.0 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 6ab6ea465889620fc2a8cdaf7b008cbaed83c523 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.ob-end-clean">
<refnamediv>
<refname>ob_end_clean</refname>
<refpurpose>Détruit les données du tampon de sortie et éteint la temporisation de sortie</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ob_end_clean</methodname>
<void/>
</methodsynopsis>
<para>
Cette fonction efface le contenu du premier
tampon de sortie et désactive la temporisation de sortie.
Si vous voulez traiter le contenu du tampon, vous devrez
appeler <function>ob_get_contents</function> avant
<function>ob_end_clean</function>, car le tampon est
détruit par <function>ob_end_clean</function>.
</para>
<para>
Le tampon de sortie doit avoir été démarré avec la fonction
<function>ob_start</function> et les drapeaux <link
linkend="constant.php-output-handler-cleanable">PHP_OUTPUT_HANDLER_CLEANABLE</link>
et <link
linkend="constant.php-output-handler-removable">PHP_OUTPUT_HANDLER_REMOVABLE</link>.
Sinon, la fonction <function>ob_end_clean</function> ne fonctionnera pas.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success; Les raisons d'un tel échec sont que la
temporisation de sortie pouvait ne pas être activée, ou que, pour
une raison quelconque, le tampon n'a pu être détruit.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Si la fonction échoue, elle génère une note <constant>E_NOTICE</constant>.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
L'exemple suivant montre comment se débarrasser de tous les
tampons de sortie :
</para>
<para>
<example>
<title>Exemple avec <function>ob_end_clean</function></title>
<programlisting role="php">
<![CDATA[
<?php
ob_start();
echo 'Texte qui ne sera pas affiché.';
ob_end_clean();
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ob_start</function></member>
<member><function>ob_get_contents</function></member>
<member><function>ob_flush</function></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:"~/.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
-->