mirror of
https://github.com/macintoshplus/doc-en.git
synced 2026-03-24 00:42:18 +01:00
227 lines
6.7 KiB
XML
227 lines
6.7 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<appendix xml:id="outcontrol.constants" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
&reftitle.constants;
|
|
&extension.constants.core;
|
|
<variablelist xml:id="outcontrol.constants.flags-passed-to-handler">
|
|
<title>Status flags passed to output handler</title>
|
|
<para>
|
|
The following flags are passed to the second (<parameter>phase</parameter>) parameter of the output handler set by <function>ob_start</function> as part of a bitmask:
|
|
</para>
|
|
<varlistentry xml:id="constant.php-output-handler-start">
|
|
<term>
|
|
<constant>PHP_OUTPUT_HANDLER_START</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
Indicates that output buffering has begun.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="constant.php-output-handler-write">
|
|
<term>
|
|
<constant>PHP_OUTPUT_HANDLER_WRITE</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
Indicates that the output buffer is being flushed, and had data to output.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="constant.php-output-handler-flush">
|
|
<term>
|
|
<constant>PHP_OUTPUT_HANDLER_FLUSH</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
Indicates that the buffer has been flushed.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="constant.php-output-handler-clean">
|
|
<term>
|
|
<constant>PHP_OUTPUT_HANDLER_CLEAN</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
Indicates that the output buffer has been cleaned.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="constant.php-output-handler-final">
|
|
<term>
|
|
<constant>PHP_OUTPUT_HANDLER_FINAL</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
Indicates that this is the final output buffering operation.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="constant.php-output-handler-cont">
|
|
<term>
|
|
<constant>PHP_OUTPUT_HANDLER_CONT</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
Indicates that the buffer has been flushed, but output buffering will
|
|
continue.
|
|
</para>
|
|
<para>
|
|
This is an alias for
|
|
<constant>PHP_OUTPUT_HANDLER_WRITE</constant>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="constant.php-output-handler-end">
|
|
<term>
|
|
<constant>PHP_OUTPUT_HANDLER_END</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
Indicates that output buffering has ended.
|
|
</para>
|
|
<para>
|
|
This is an alias for
|
|
<constant>PHP_OUTPUT_HANDLER_FINAL</constant>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist xml:id="outcontrol.constants.buffer-control-flags">
|
|
<title>Output buffer control flags</title>
|
|
<para>
|
|
The following flags can be passed to the third (<parameter>flags</parameter>) parameter of the output handler set by <function>ob_start</function> as a bitmask:
|
|
</para>
|
|
<varlistentry xml:id="constant.php-output-handler-cleanable">
|
|
<term>
|
|
<constant>PHP_OUTPUT_HANDLER_CLEANABLE</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
Controls whether an output buffer created by
|
|
<function>ob_start</function> can be cleaned
|
|
by <function>ob_clean</function>.
|
|
This flag does not control the behaviour of
|
|
<function>ob_end_clean</function> or <function>ob_get_clean</function>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="constant.php-output-handler-flushable">
|
|
<term>
|
|
<constant>PHP_OUTPUT_HANDLER_FLUSHABLE</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
Controls whether an output buffer created by
|
|
<function>ob_start</function> can be flushed
|
|
by <function>ob_flush</function>.
|
|
This flag does not control the behaviour of
|
|
<function>ob_end_flush</function> or <function>ob_get_flush</function>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="constant.php-output-handler-removable">
|
|
<term>
|
|
<constant>PHP_OUTPUT_HANDLER_REMOVABLE</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
Controls whether an output buffer created by
|
|
<function>ob_start</function> can be removed before the end of the script
|
|
or when calling <function>ob_end_clean</function>, <function>ob_end_flush</function>,
|
|
<function>ob_get_clean</function> or <function>ob_get_flush</function>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="constant.php-output-handler-stdflags">
|
|
<term>
|
|
<constant>PHP_OUTPUT_HANDLER_STDFLAGS</constant>
|
|
(<type>int</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>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist xml:id="outcontrol.constants.flags-returned-by-handler">
|
|
<title>Output handler status flags</title>
|
|
<para>
|
|
The following flags are part of the <literal>flags</literal> bitmask
|
|
returned by <function>ob_get_status</function>:
|
|
</para>
|
|
<varlistentry xml:id="constant.php-output-handler-started">
|
|
<term>
|
|
<constant>PHP_OUTPUT_HANDLER_STARTED</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
Indicates that the output handler was called.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="constant.php-output-handler-disabled">
|
|
<term>
|
|
<constant>PHP_OUTPUT_HANDLER_DISABLED</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
Indicates that the output handler is disabled.
|
|
This flag is set when the output handler returns &false;
|
|
or fails while processing the buffer.
|
|
Prior to PHP 8.4.0, this flag could be set when starting an output buffer.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="constant.php-output-handler-processed">
|
|
<term>
|
|
<constant>PHP_OUTPUT_HANDLER_PROCESSED</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
Indicates that the output handler successfully processed the buffer.
|
|
Available as of PHP 8.4.0.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</appendix>
|
|
<!-- 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
|
|
-->
|