<?xml version="1.0" encoding="utf-8"?>

<!-- $Revision$ -->

<!-- EN-Revision: 86b976d5afaf037868174fe5c242e886eb69baa4 Maintainer: takagi Status: ready -->

<refentry xml:id="function.ob-get-clean" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>ob_get_clean</refname>

<refpurpose>アクティブな出力バッファの内容を取得し、そのバッファをオフにする</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type class="union"><type>string</type><type>false</type></type><methodname>ob_get_clean</methodname>

<void/>

</methodsynopsis>

<para>

この関数は、

(<constant>PHP_OUTPUT_HANDLER_CLEAN</constant> と

<constant>PHP_OUTPUT_HANDLER_FINAL</constant> フラグを指定して)

出力ハンドラをコールし、その戻り値を破棄するとともに、

アクティブな出力バッファの内容を返しつつ、

かつそれをオフにします。

</para>

<para>

<constant>PHP_OUTPUT_HANDLER_REMOVABLE</constant> を指定して

アクティブな出力バッファを開始しないと、

<function>ob_get_clean</function> は失敗します。

</para>

<para>

<function>ob_get_clean</function>

は、<constant>PHP_OUTPUT_HANDLER_CLEANABLE</constant>

を指定せずにアクティブな出力バッファを開始したとしても、

そのバッファの内容をクリアします。

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

&no.function.parameters;

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

成功した場合、アクティブな出力バッファの内容を返します。

失敗した場合は、&false; を返します。

</para>

<caution>

<simpara>

アクティブな出力バッファがない場合、

　<function>ob_get_clean</function> は &false; を返しますが

<constant>E_NOTICE</constant> は発生しません。

</simpara>

</caution>

</refsect1>

<refsect1 role="errors">

&reftitle.errors;

<para>

この関数が失敗すると、

<constant>E_NOTICE</constant> が発生します。

</para>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title>単純な <function>ob_get_clean</function> の例</title>

<programlisting role="php">

<![CDATA[

<?php

ob_start();

echo "Hello World";

$out = ob_get_clean();

$out = strtolower($out);

var_dump($out);

?>

]]>

</programlisting>

&example.outputs;

<screen>

<![CDATA[

string(11) "hello world"

]]>

</screen>

</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_clean</function></member>

<member><function>ob_end_clean</function></member>

<member><function>ob_get_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

-->