sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 08:58:56 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

added documentation for output buffering functions ob_*()

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@27286 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Hartmut Holzgraefe 2000-06-28 13:09:33 +00:00
parent 8f6155f3d2
commit 5cd1e3fa26
1 changed files with 162 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

162
functions/strings.xml
View file

@ -943,6 +943,160 @@ $colon_separated = implode (":", $array);
</refsect1>
</refentry>
<refentry id="function.ob-start">
<refnamediv>
<refname>ob_start</refname>
<refpurpose>
Turn on output buffering
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>void <function>ob_start</function></funcdef>
<void/>
</funcprototype>
</funcsynopsis>
<para>
This function will turn output buffering. While output buffering
is active there will be no rel output from the script, the output
is appended to an internal buffer instead.
</para>
<para>
The contents of this internal buffer may be copied into a string
variable using <function>ob_get_contents</function>.
Real output happens when <function>ob_end_flush</function> is
called and <function>ob_end_clean</function> will just silently
discard the buffer contents.
</para>
<para>
See also <function>ob_get_contents</function>,
<function>ob_end_flush</function>,
<function>ob_end_clean</function>
and <function>ob_implicit_flush</function>
</para>
</refsect1>
</refentry>
<refentry id="function.ob-get-contents">
<refnamediv>
<refname>ob_get_contents</refname>
<refpurpose>
Return the contents of the output buffer
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>string <function>ob_get_contents</function></funcdef>
<void/>
</funcprototype>
</funcsynopsis>
<para>
This will return the content of the output buffer
or FALSE, if output buffering isn't active.
</para>
<para>
See also <function>ob_start</function>,
<function>ob_end_flush</function>,
and <function>ob_end_clean</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.ob-end-flush">
<refnamediv>
<refname>ob_end_flush</refname>
<refpurpose>
Flush (send) the output buffer and turn off output buffering
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>void <function>ob_end_flush</function></funcdef>
<void/>
</funcprototype>
</funcsynopsis>
<para>
This function will send the contents of the output buffer
(if any) and turn output buffering off.
If you want to further process the buffers content you have
to call <function>ob_get_contents</function> before
<function>ob_end_flush</function> as the buffer contents
get discarded after output.
</para>
<para>
See also <function>ob_start</function>,
<function>ob_get_contents</function>,
and <function>ob_end_clean</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.ob-end-clean">
<refnamediv>
<refname>ob_end_clean</refname>
<refpurpose>
Clean (erase) the output buffer and turn off output buffering
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>void <function>ob_end_clean</function></funcdef>
<void/>
</funcprototype>
</funcsynopsis>
<para>
This function discards the content of the output buffer and
turns off output buffering.
</para>
<para>
See also <function>ob_start</function>
and <function>ob_end_flush</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.ob-implicit-flush">
<refnamediv>
<refname>ob_implicit_flush</refname>
<refpurpose>
Turn implicit flush on/off
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>void <function>ob_implicit_flush</function></funcdef>
<paramdef>int <parameter><optional>flag</optional></parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
<function>ob_implicit_flush</function> will turn implicit flushing on or off
(if no <parameter>flag</parameter> is given, it defaults to on).
Implicit flushing will result in a flush operation after every output call,
so that explicit calls to <function>flush</function> will no longer be needed.
</para>
<para>
Turning implicit flushing on will disable output buffering, the output buffers
current output will be sent as if <function>ob_end_flush</function> had been
called.
</para>
<para>
See also <function>flush</function>,
<function>ob_start</function>
and <function>ob_end_flush</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.ord">
<refnamediv>
<refname>Ord</refname>
@ -1978,6 +2132,14 @@ echo str_repeat ("-=", 10);
<parameter>str1</parameter> which consists entirely of characters
in <parameter>str2</parameter>.
</simpara>
<para>
<informalexample>
<programlisting role="php">
strspn("42 is the answer, what is the question ...","1234567890");
</programlisting>
will return 2 as result.
</informalexample>
</para>
<simpara>
See also <function>strcspn</function>.
</simpara>