mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 00:48:54 +00:00
Document the ob_start() changes in PHP 5.4.
Mostly fixes doc bug #64977 (ob_start() fails when passed default parameters). git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@331632 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Adam Harvey
parent
c1e7ce248f
commit
be1c862bab
3 changed files with 158 additions and 7 deletions
|
|
@ -158,6 +158,17 @@
|
|||
level error is emitted.
|
||||
</simpara>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<simpara>
|
||||
The third parameter of <function>ob_start</function> has changed from
|
||||
<type>boolean</type> <parameter>erase</parameter> to <type>integer</type>
|
||||
<parameter>flags</parameter>. Note that code that explicitly set
|
||||
<parameter>erase</parameter> to &false; will no longer behave as expected
|
||||
in PHP 5.4: please follow
|
||||
<link linkend="function.ob-start.flags-bc">this example</link> to write
|
||||
code that is compatible with PHP 5.3 and 5.4.
|
||||
</simpara>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
<simpara>
|
||||
The following keywords are now <link linkend="reserved">reserved</link>, and may not be used
|
||||
|
|
|
|||
|
|
@ -102,6 +102,68 @@
|
|||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.php-output-handler-cleanable">
|
||||
<term>
|
||||
<constant>PHP_OUTPUT_HANDLER_CLEANABLE</constant>
|
||||
(<type>integer</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Controls whether an output buffer created by
|
||||
<function>ob_start</function> can be cleaned.
|
||||
</para>
|
||||
<para>
|
||||
Available since PHP 5.4.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.php-output-handler-flushable">
|
||||
<term>
|
||||
<constant>PHP_OUTPUT_HANDLER_FLUSHABLE</constant>
|
||||
(<type>integer</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Controls whether an output buffer created by
|
||||
<function>ob_start</function> can be flushed.
|
||||
</para>
|
||||
<para>
|
||||
Available since PHP 5.4.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.php-output-handler-removable">
|
||||
<term>
|
||||
<constant>PHP_OUTPUT_HANDLER_REMOVABLE</constant>
|
||||
(<type>integer</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Controls whether an output buffer created by
|
||||
<function>ob_start</function> can be removed before the end of the script.
|
||||
</para>
|
||||
<para>
|
||||
Available since PHP 5.4.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.php-output-handler-stdflags">
|
||||
<term>
|
||||
<constant>PHP_OUTPUT_HANDLER_STDFLAGS</constant>
|
||||
(<type>integer</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
The default set of output buffer flags; currently equivalent to
|
||||
<constant>PHP_OUTPUT_HANDLER_CLEANABLE</constant> |
|
||||
<constant>PHP_OUTPUT_HANDLER_FLUSHABLE</constant> |
|
||||
<constant>PHP_OUTPUT_HANDLER_REMOVABLE</constant>.
|
||||
</para>
|
||||
<para>
|
||||
Available since PHP 5.4.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</appendix>
|
||||
|
||||
|
|
|
|||
|
|
@ -10,9 +10,9 @@
|
|||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>ob_start</methodname>
|
||||
<methodparam choice="opt"><type>callable</type><parameter>output_callback</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>callable</type><parameter>output_callback</parameter><initializer>&null;</initializer></methodparam>
|
||||
<methodparam choice="opt"><type>int</type><parameter>chunk_size</parameter><initializer>0</initializer></methodparam>
|
||||
<methodparam choice="opt"><type>bool</type><parameter>erase</parameter><initializer>true</initializer></methodparam>
|
||||
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer><constant>PHP_OUTPUT_HANDLER_STDFLAGS</constant></initializer></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
This function will turn output buffering on. While output buffering is
|
||||
|
|
@ -140,13 +140,56 @@
|
|||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>erase</parameter></term>
|
||||
<term><parameter>flags</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
If the optional parameter <parameter>erase</parameter> is set to &false;,
|
||||
the buffer will not be deleted until the script finishes.
|
||||
This causes that flushing and cleaning functions would issue a notice
|
||||
and return &false; if called.
|
||||
The <parameter>flags</parameter> parameter is a bitmask that controls
|
||||
the operations that can be performed on the output buffer. The default
|
||||
is to allow output buffers to be cleaned, flushed and removed, which
|
||||
can be set explicitly via
|
||||
<constant>PHP_OUTPUT_HANDLER_CLEANABLE</constant> |
|
||||
<constant>PHP_OUTPUT_HANDLER_FLUSHABLE</constant> |
|
||||
<constant>PHP_OUTPUT_HANDLER_REMOVABLE</constant>, or
|
||||
<constant>PHP_OUTPUT_HANDLER_STDFLAGS</constant> as shorthand.
|
||||
</para>
|
||||
<para>
|
||||
Each flag controls access to a set of functions, as described below:
|
||||
<informaltable>
|
||||
<tgroup cols="2">
|
||||
<thead>
|
||||
<row>
|
||||
<entry>Constant</entry>
|
||||
<entry>Functions</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry><constant>PHP_OUTPUT_HANDLER_CLEANABLE</constant></entry>
|
||||
<entry>
|
||||
<function>ob_clean</function>,
|
||||
<function>ob_end_clean</function>, and
|
||||
<function>ob_get_clean</function>.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><constant>PHP_OUTPUT_HANDLER_FLUSHABLE</constant></entry>
|
||||
<entry>
|
||||
<function>ob_end_flush</function>,
|
||||
<function>ob_flush</function>, and
|
||||
<function>ob_get_flush</function>.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry><constant>PHP_OUTPUT_HANDLER_REMOVABLE</constant></entry>
|
||||
<entry>
|
||||
<function>ob_end_clean</function>,
|
||||
<function>ob_end_flush</function>, and
|
||||
<function>ob_get_flush</function>.
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</informaltable>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
|
@ -173,6 +216,21 @@
|
|||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>5.4.0</entry>
|
||||
<entry>
|
||||
The third parameter of <function>ob_start</function> changed from a
|
||||
<type>boolean</type> parameter called <parameter>erase</parameter>
|
||||
(which, if set to &false;, would prevent the output buffer from being
|
||||
deleted until the script finished executing) to an
|
||||
<type>integer</type> parameter called <parameter>flags</parameter>.
|
||||
Unfortunately, this results in an API compatibility break for code
|
||||
written prior to PHP 5.4.0 that uses the third parameter. See
|
||||
<link linkend="function.ob-start.flags-bc">the flags example</link>
|
||||
for an example of how to handle this with code that needs to be
|
||||
compatible with both.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>5.4.0</entry>
|
||||
<entry>
|
||||
|
|
@ -241,6 +299,26 @@ ob_end_flush();
|
|||
</screen>
|
||||
</example>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
<example xml:id="function.ob-start.flags-bc">
|
||||
<title>Creating an uneraseable output buffer in a way compatible with both PHP 5.3 and 5.4</title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
|
||||
if (version_compare(PHP_VERSION, '5.4.0', '>=')) {
|
||||
ob_start(null, 0, PHP_OUTPUT_HANDLER_STDFLAGS ^
|
||||
PHP_OUTPUT_HANDLER_REMOVABLE);
|
||||
} else {
|
||||
ob_start(null, 0, false);
|
||||
}
|
||||
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
|
|
|
|||
Loading…
Reference in a new issue