cvs: phpdoc /en/reference/outcontrol/functions flush.xml ob-clean.xml ob-end-clean.xml ob-end-flush.xml ob-flush.xml ob-get-clean.xml
ob-get-contents.xml ob-get-flush.xml ob-get-length.xml ob-get-level.xml ob-get-status.xml ob-gzhandler.xml ob-implicit-flush.xml ob-list-handlers.xml
ob-start.xml output-add-rewrite-var.xml output-reset-rewrite-vars.xml

From:	Mehdi Achour	Date:	Fri, 15 Jun 2007 19:08:56 +0000
Subject:	cvs: phpdoc /en/reference/outcontrol/functions flush.xml ob-clean.xml ob-end-clean.xml ob-end-flush.xml ob-flush.xml ob-get-clean.xml ob-get-contents.xml ob-get-flush.xml ob-get-length.xml ob-get-level.xml ob-get-status.xml ob-gzhandler.xml ob-implicit-flush.xml ob-list-handlers.xml ob-start.xml output-add-rewrite-var.xml output-reset-rewrite-vars.xml
Groups:	php.doc
Request:	Send a blank email to phpdoc+get-969376716@lists.php.net to get a copy of this message

didou Fri Jun 15 19:08:56 2007 UTC Modified files: /phpdoc/en/reference/outcontrol/functions flush.xml ob-clean.xml ob-end-clean.xml ob-end-flush.xml ob-flush.xml ob-get-clean.xml ob-get-contents.xml ob-get-flush.xml ob-get-length.xml ob-get-level.xml ob-get-status.xml ob-gzhandler.xml ob-implicit-flush.xml ob-list-handlers.xml ob-start.xml output-add-rewrite-var.xml output-reset-rewrite-vars.xml Log: WS, prepare for new doc style

http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/outcontrol/functions/flush.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/outcontrol/functions/flush.xml diff -u phpdoc/en/reference/outcontrol/functions/flush.xml:1.5 phpdoc/en/reference/outcontrol/functions/flush.xml:1.6 --- phpdoc/en/reference/outcontrol/functions/flush.xml:1.5 Thu Feb 15 09:24:36 2007 +++ phpdoc/en/reference/outcontrol/functions/flush.xml Fri Jun 15 19:08:56 2007 @@ -1,54 +1,54 @@ <?xml version="1.0" encoding="iso-8859-1"?> - +  - <refentry id="function.flush"> - <refnamediv> - <refname>flush</refname> - <refpurpose>Flush the output buffer</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>void</type><methodname>flush</methodname> - <void/> - </methodsynopsis> - <simpara> - Flushes the output buffers of PHP and whatever backend PHP is - using (CGI, a web server, etc). This effectively tries to push - all the output so far to the user's browser. - </simpara> - <para> - <function>flush</function> has no effect on the buffering - scheme of your web server or the browser on the client - side. - Thus you need to call both <function>ob_flush</function> and - <function>flush</function> to flush the output buffers. - </para> - <para> - Several servers, especially on Win32, will still buffer - the output from your script until it terminates before - transmitting the results to the browser. - </para> - <para> - Server modules for Apache like mod_gzip may do buffering of their own - that will cause <function>flush</function> to not result in data being - sent immediately to the client. - </para> - <para> - Even the browser may buffer its input before displaying it. - Netscape, for example, buffers text until it receives an - end-of-line or the beginning of a tag, and it won't render - tables until the </table> tag of the outermost table is - seen. - </para> - <para> - Some versions of Microsoft Internet Explorer will only start to display - the page after they have received 256 bytes of output, so you may need to - send extra whitespace before flushing to get those browsers to display the - page. - </para> - </refsect1> - </refentry> +<refentry id="function.flush"> + <refnamediv> + <refname>flush</refname> + <refpurpose>Flush the output buffer</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>void</type><methodname>flush</methodname> + <void/> + </methodsynopsis> + <simpara> + Flushes the output buffers of PHP and whatever backend PHP is + using (CGI, a web server, etc). This effectively tries to push + all the output so far to the user's browser. + </simpara> + <para> + <function>flush</function> has no effect on the buffering + scheme of your web server or the browser on the client + side. + Thus you need to call both <function>ob_flush</function> and + <function>flush</function> to flush the output buffers. + </para> + <para> + Several servers, especially on Win32, will still buffer + the output from your script until it terminates before + transmitting the results to the browser. + </para> + <para> + Server modules for Apache like mod_gzip may do buffering of their own + that will cause <function>flush</function> to not result in data being + sent immediately to the client. + </para> + <para> + Even the browser may buffer its input before displaying it. + Netscape, for example, buffers text until it receives an + end-of-line or the beginning of a tag, and it won't render + tables until the </table> tag of the outermost table is + seen. + </para> + <para> + Some versions of Microsoft Internet Explorer will only start to display + the page after they have received 256 bytes of output, so you may need to + send extra whitespace before flushing to get those browsers to display the + page. + </para> + </refsect1> +</refentry>  +  - <refentry id="function.ob-clean"> - <refnamediv> - <refname>ob_clean</refname> - <refpurpose> - Clean (erase) the output buffer - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>void</type><methodname>ob_clean</methodname> - <void/> - </methodsynopsis> - <para> - This function discards the contents of the output buffer. - </para> - <para> - This function does not destroy the output buffer like - <function>ob_end_clean</function> does. - </para> - <para> - See also <function>ob_flush</function>, - <function>ob_end_flush</function> and - <function>ob_end_clean</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.ob-clean"> + <refnamediv> + <refname>ob_clean</refname> + <refpurpose>Clean (erase) the output buffer</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>void</type><methodname>ob_clean</methodname> + <void/> + </methodsynopsis> + <para> + This function discards the contents of the output buffer. + </para> + <para> + This function does not destroy the output buffer like + <function>ob_end_clean</function> does. + </para> + <para> + See also <function>ob_flush</function>, + <function>ob_end_flush</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> - <methodsynopsis> - <type>bool</type><methodname>ob_end_clean</methodname> - <void/> - </methodsynopsis> - <para> - This function discards the contents of the topmost output buffer and - turns off this output buffering. If you want to further - process the buffer's contents you have to call - <function>ob_get_contents</function> before - <function>ob_end_clean</function> as the buffer contents are - discarded when <function>ob_end_clean</function> is called. - The function returns &true; when it successfully - discarded one buffer and &false; otherwise. Reasons for failure are first - that you called the function without an active buffer or that for some - reason a buffer could not be deleted (possible for special buffer). - </para> - <para> - The following example shows an easy way to get rid of all output buffers: - </para> - <para> - <example> - <title><function>ob_end_clean</function> example</title> - <programlisting role="php"> +<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> + <methodsynopsis> + <type>bool</type><methodname>ob_end_clean</methodname> + <void/> + </methodsynopsis> + <para> + This function discards the contents of the topmost output buffer and + turns off this output buffering. If you want to further + process the buffer's contents you have to call + <function>ob_get_contents</function> before + <function>ob_end_clean</function> as the buffer contents are + discarded when <function>ob_end_clean</function> is called. + The function returns &true; when it successfully + discarded one buffer and &false; otherwise. Reasons for failure are first + that you called the function without an active buffer or that for some + reason a buffer could not be deleted (possible for special buffer). + </para> + <para> + The following example shows an easy way to get rid of all output buffers: + </para> + <para> + <example> + <title><function>ob_end_clean</function> example</title> + <programlisting role="php"> <![CDATA[ <?php ob_start(); @@ -40,24 +38,24 @@ ob_end_clean(); ?> ]]> - </programlisting> - </example> - </para> - <note> - <simpara> - If the function fails it generates an E_NOTICE. - </simpara> - <simpara> - The boolean return value was added in PHP 4.2.0. - </simpara> - </note> - <para> - See also <function>ob_start</function>, - <function>ob_get_contents</function>, and - <function>ob_flush</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <note> + <simpara> + If the function fails it generates an E_NOTICE. + </simpara> + <simpara> + The boolean return value was added in PHP 4.2.0. + </simpara> + </note> + <para> + See also <function>ob_start</function>, + <function>ob_get_contents</function>, and + <function>ob_flush</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> - <methodsynopsis> - <type>bool</type><methodname>ob_end_flush</methodname> - <void/> - </methodsynopsis> - <para> - This function will send the contents of the topmost output buffer (if - any) and turn this output buffer off. If you want to further - process the buffer's contents you have to call - <function>ob_get_contents</function> before - <function>ob_end_flush</function> as the buffer contents are - discarded after <function>ob_end_flush</function> is called. - The function returns &true; when it successfully - discarded one buffer and &false; otherwise. Reasons for failure are first - that you called the function without an active buffer or that for some - reason a buffer could not be deleted (possible for special buffer). - </para> - <note> - <simpara> - This function is similar to <function>ob_get_flush</function>, except - that <function>ob_get_flush</function> returns the buffer as a string. - </simpara> - </note> - <para> - The following example shows an easy way to flush and end all output - buffers: - </para> - <para> - <example> - <title><function>ob_end_flush</function> example</title> - <programlisting role="php"> +<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> + <methodsynopsis> + <type>bool</type><methodname>ob_end_flush</methodname> + <void/> + </methodsynopsis> + <para> + This function will send the contents of the topmost output buffer (if + any) and turn this output buffer off. If you want to further + process the buffer's contents you have to call + <function>ob_get_contents</function> before + <function>ob_end_flush</function> as the buffer contents are + discarded after <function>ob_end_flush</function> is called. + The function returns &true; when it successfully + discarded one buffer and &false; otherwise. Reasons for failure are first + that you called the function without an active buffer or that for some + reason a buffer could not be deleted (possible for special buffer). + </para> + <note> + <simpara> + This function is similar to <function>ob_get_flush</function>, except + that <function>ob_get_flush</function> returns the buffer as a string. + </simpara> + </note> + <para> + The following example shows an easy way to flush and end all output + buffers: + </para> + <para> + <example> + <title><function>ob_end_flush</function> example</title> + <programlisting role="php"> <![CDATA[ <?php while (@ob_end_flush()); ?> ]]> - </programlisting> - </example> - </para> - <note> - <simpara> - If the function fails it generates an E_NOTICE. - </simpara> - <simpara> - The boolean return value was added in PHP 4.2.0. - </simpara> - </note> - <para> - See also <function>ob_start</function>, - <function>ob_get_contents</function>, - <function>ob_get_flush</function>, - <function>ob_flush</function> and - <function>ob_end_clean</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <note> + <simpara> + If the function fails it generates an E_NOTICE. + </simpara> + <simpara> + The boolean return value was added in PHP 4.2.0. + </simpara> + </note> + <para> + See also <function>ob_start</function>, + <function>ob_get_contents</function>, + <function>ob_get_flush</function>, + <function>ob_flush</function> and + <function>ob_end_clean</function>. + </para> + </refsect1> +</refentry>  +  - <refentry id="function.ob-flush"> - <refnamediv> - <refname>ob_flush</refname> - <refpurpose> - Flush (send) the output buffer - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>void</type><methodname>ob_flush</methodname> - <void/> - </methodsynopsis> - <para> - This function will send the contents of the output buffer (if - any). If you want to further - process the buffer's contents you have to call - <function>ob_get_contents</function> before - <function>ob_flush</function> as the buffer contents are - discarded after <function>ob_flush</function> is called. - </para> - <para> - This function does not destroy the output buffer like - <function>ob_end_flush</function> does. - </para> - <para> - See also <function>ob_get_contents</function>, - <function>ob_clean</function>, - <function>ob_end_flush</function> and - <function>ob_end_clean</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.ob-flush"> + <refnamediv> + <refname>ob_flush</refname> + <refpurpose>Flush (send) the output buffer</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>void</type><methodname>ob_flush</methodname> + <void/> + </methodsynopsis> + <para> + This function will send the contents of the output buffer (if + any). If you want to further + process the buffer's contents you have to call + <function>ob_get_contents</function> before + <function>ob_flush</function> as the buffer contents are + discarded after <function>ob_flush</function> is called. + </para> + <para> + This function does not destroy the output buffer like + <function>ob_end_flush</function> does. + </para> + <para> + See also <function>ob_get_contents</function>, + <function>ob_clean</function>, + <function>ob_end_flush</function> and + <function>ob_end_clean</function>. + </para> + </refsect1> +</refentry>  - <refentry id="function.ob-get-clean"> - <refnamediv> - <refname>ob_get_clean</refname> - <refpurpose> - Get current buffer contents and delete current output buffer - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>ob_get_clean</methodname> - <void/> - </methodsynopsis> - <para> - This will return the contents of the output buffer and end output - buffering. If output buffering isn't active then &false; is returned. - <function>ob_get_clean</function> essentially executes both - <function>ob_get_contents</function> and - <function>ob_end_clean</function>. - </para> - <para> - <example> - <title>A simple <function>ob_get_clean</function> example</title> - <programlisting role="php"> + +<refentry id="function.ob-get-clean"> + <refnamediv> + <refname>ob_get_clean</refname> + <refpurpose>Get current buffer contents and delete current output buffer</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>ob_get_clean</methodname> + <void/> + </methodsynopsis> + <para> + This will return the contents of the output buffer and end output + buffering. If output buffering isn't active then &false; is returned. + <function>ob_get_clean</function> essentially executes both + <function>ob_get_contents</function> and + <function>ob_end_clean</function>. + </para> + <para> + <example> + <title>A simple <function>ob_get_clean</function> example</title> + <programlisting role="php"> <![CDATA[ <?php @@ -37,25 +35,25 @@ var_dump($out); ?> ]]> - </programlisting> - <para> - Our example will output: - </para> - <screen> + </programlisting> + <para> + Our example will output: + </para> + <screen> <![CDATA[ string(11) "hello world" ]]> - </screen> - </example> - </para> - <para> - See also <function>ob_start</function> and - <function>ob_get_contents</function>. - </para> - </refsect1> - </refentry> + </screen> + </example> + </para> + <para> + See also <function>ob_start</function> and + <function>ob_get_contents</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> - <methodsynopsis> - <type>string</type><methodname>ob_get_contents</methodname> - <void/> - </methodsynopsis> - <para> - This will return the contents of the output buffer without clearing it - or &false;, if output buffering isn't active. - </para> - <para> - <example> - <title>A simple <function>ob_get_contents</function> example</title> - <programlisting role="php"> +<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> + <methodsynopsis> + <type>string</type><methodname>ob_get_contents</methodname> + <void/> + </methodsynopsis> + <para> + This will return the contents of the output buffer without clearing it + or &false;, if output buffering isn't active. + </para> + <para> + <example> + <title>A simple <function>ob_get_contents</function> example</title> + <programlisting role="php"> <![CDATA[ <?php @@ -40,26 +38,26 @@ var_dump($out1, $out2); ?> ]]> - </programlisting> - <para> - Our example will output: - </para> - <screen> + </programlisting> + <para> + Our example will output: + </para> + <screen> <![CDATA[ string(6) "Hello " string(11) "Hello World" ]]> - </screen> - </example> - </para> - <para> - See also <function>ob_start</function> and - <function>ob_get_length</function>. - </para> - </refsect1> - </refentry> + </screen> + </example> + </para> + <para> + See also <function>ob_start</function> and + <function>ob_get_length</function>. + </para> + </refsect1> +</refentry>  - <refentry id="function.ob-get-flush"> - <refnamediv> - <refname>ob_get_flush</refname> - <refpurpose> - Flush the output buffer, return it as a string and turn off output buffering - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>ob_get_flush</methodname> - <void/> - </methodsynopsis> - <para><function>ob_get_flush</function> flushes the output buffer, return - it as a string and turns off output buffering. - <function>ob_get_flush</function> returns &false; if no buffering is - active. - </para> - <note> - <simpara> - This function is similar to <function>ob_end_flush</function>, except - that this function returns the buffer as a string. - </simpara> - </note> - <para> - <example> - <title><function>ob_get_flush</function> example</title> - <programlisting role="php"> + +<refentry id="function.ob-get-flush"> + <refnamediv> + <refname>ob_get_flush</refname> + <refpurpose>Flush the output buffer, return it as a string and turn off output buffering</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>ob_get_flush</methodname> + <void/> + </methodsynopsis> + <para> + <function>ob_get_flush</function> flushes the output buffer, return + it as a string and turns off output buffering. + <function>ob_get_flush</function> returns &false; if no buffering is + active. + </para> + <note> + <simpara> + This function is similar to <function>ob_end_flush</function>, except + that this function returns the buffer as a string. + </simpara> + </note> + <para> + <example> + <title><function>ob_get_flush</function> example</title> + <programlisting role="php"> <![CDATA[ <?php //using output_buffering=On @@ -40,9 +39,9 @@ print_r(ob_list_handlers()); ?> ]]> - </programlisting> - &example.outputs; - <screen> + </programlisting> + &example.outputs; + <screen> <![CDATA[ Array ( @@ -52,16 +51,16 @@ ( ) ]]> - </screen> - </example> - </para> - <para> - See also <function>ob_end_clean</function>, - <function>ob_end_flush</function> and - <function>ob_list_handlers</function>. - </para> - </refsect1> - </refentry> + </screen> + </example> + </para> + <para> + See also <function>ob_end_clean</function>, + <function>ob_end_flush</function> and + <function>ob_list_handlers</function>. + </para> + </refsect1> +</refentry>  +  - <refentry id="function.ob-get-length"> - <refnamediv> - <refname>ob_get_length</refname> - <refpurpose> - Return the length of the output buffer - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>ob_get_length</methodname> - <void/> - </methodsynopsis> - <para> - This will return the length of the contents in the output buffer - or &false;, if output buffering isn't active. - </para> - <para> - <example> - <title>A simple <function>ob_get_length</function> example</title> - <programlisting role="php"> +<refentry id="function.ob-get-length"> + <refnamediv> + <refname>ob_get_length</refname> + <refpurpose>Return the length of the output buffer</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>int</type><methodname>ob_get_length</methodname> + <void/> + </methodsynopsis> + <para> + This will return the length of the contents in the output buffer + or &false;, if output buffering isn't active. + </para> + <para> + <example> + <title>A simple <function>ob_get_length</function> example</title> + <programlisting role="php"> <![CDATA[ <?php @@ -40,25 +38,25 @@ echo $len1 . ", ." . $len2; ?> ]]> - </programlisting> - <para> - Our example will output: - </para> - <screen> + </programlisting> + <para> + Our example will output: + </para> + <screen> <![CDATA[ 6, 11 ]]> - </screen> - </example> - </para> - <para> - See also <function>ob_start</function> and - <function>ob_get_contents</function>. - </para> - </refsect1> - </refentry> + </screen> + </example> + </para> + <para> + See also <function>ob_start</function> and + <function>ob_get_contents</function>. + </para> + </refsect1> +</refentry>  +  - <refentry id="function.ob-get-level"> - <refnamediv> - <refname>ob_get_level</refname> - <refpurpose> - Return the nesting level of the output buffering mechanism - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>ob_get_level</methodname> - <void/> - </methodsynopsis> - <para> - This will return the level of nested output buffering handlers - or zero if output buffering is not activated. - </para> - <para> - See also <function>ob_start</function> and - <function>ob_get_contents</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.ob-get-level"> + <refnamediv> + <refname>ob_get_level</refname> + <refpurpose>Return the nesting level of the output buffering mechanism</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>int</type><methodname>ob_get_level</methodname> + <void/> + </methodsynopsis> + <para> + This will return the level of nested output buffering handlers + or zero if output buffering is not activated. + </para> + <para> + See also <function>ob_start</function> and + <function>ob_get_contents</function>. + </para> + </refsect1> +</refentry>  - <refentry id="function.ob-get-status"> - <refnamediv> - <refname>ob_get_status</refname> - <refpurpose> - Get status of output buffers - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>array</type><methodname>ob_get_status</methodname> - <methodparam choice="opt"> - <type>bool</type> - <parameter>full_status</parameter> - <initializer>FALSE</initializer> - </methodparam> - </methodsynopsis> - <para> - <function>ob_get_status</function> returns status information on - either the top level output buffer or all active output buffer levels - if <parameter>full_status</parameter> is set to &true;. - </para> - <para> - If called without the <parameter>full_status</parameter> parameter - or with <parameter>full_status</parameter> = &false; a simple array - with the following elements is returned: - </para> - <example> - <title>Simple <function>ob_get_status</function> output</title> - <screen> + +<refentry id="function.ob-get-status"> + <refnamediv> + <refname>ob_get_status</refname> + <refpurpose>Get status of output buffers</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>array</type><methodname>ob_get_status</methodname> + <methodparam choice="opt"><type>bool</type> <parameter>full_status</parameter> <initializer>FALSE</initializer></methodparam> + </methodsynopsis> + <para> + <function>ob_get_status</function> returns status information on + either the top level output buffer or all active output buffer levels + if <parameter>full_status</parameter> is set to &true;. + </para> + <para> + If called without the <parameter>full_status</parameter> parameter + or with <parameter>full_status</parameter> = &false; a simple array + with the following elements is returned: + </para> + <example> + <title>Simple <function>ob_get_status</function> output</title> + <screen> Array ( [level] => 2 @@ -38,29 +32,29 @@ [name] => URL-Rewriter [del] => 1 ) - </screen> - </example> - <para> - <segmentedlist> - <title>Simple <function>ob_get_status</function> results</title> - <segtitle>Key</segtitle><segtitle>Value</segtitle> - <seglistitem><seg>level</seg><seg>Output nesting level</seg></seglistitem> - <seglistitem><seg>type</seg><seg><literal>PHP_OUTPUT_HANDLER_INTERNAL (0)</literal> or <literal>PHP_OUTPUT_HANDLER_USER (1)</literal></seg></seglistitem> - <seglistitem><seg>status</seg><seg>One of <literal>PHP_OUTPUT_HANDLER_START</literal> (0), <literal>PHP_OUTPUT_HANDLER_CONT</literal> (1) or <literal>PHP_OUTPUT_HANDLER_END</literal> (2)</seg></seglistitem> - <seglistitem><seg>name</seg><seg>Name of active output handler or ' default output handler' if none is set</seg></seglistitem> - <seglistitem><seg>del</seg><seg>Erase-flag as set by <function>ob_start</function></seg></seglistitem> - </segmentedlist> - </para> - <para> - If called with <parameter>full_status</parameter> = &true; an array - with one element for each active output buffer level is returned. - The output level is used as key of the top level array and each array - element itself is another array holding status information - on one active output level. - </para> - <example> - <title>Full <function>ob_get_status</function> output</title> - <screen> + </screen> + </example> + <para> + <segmentedlist> + <title>Simple <function>ob_get_status</function> results</title> + <segtitle>Key</segtitle><segtitle>Value</segtitle> + <seglistitem><seg>level</seg><seg>Output nesting level</seg></seglistitem> + <seglistitem><seg>type</seg><seg><literal>PHP_OUTPUT_HANDLER_INTERNAL (0)</literal> or <literal>PHP_OUTPUT_HANDLER_USER (1)</literal></seg></seglistitem> + <seglistitem><seg>status</seg><seg>One of <literal>PHP_OUTPUT_HANDLER_START</literal> (0), <literal>PHP_OUTPUT_HANDLER_CONT</literal> (1) or <literal>PHP_OUTPUT_HANDLER_END</literal> (2)</seg></seglistitem> + <seglistitem><seg>name</seg><seg>Name of active output handler or ' default output handler' if none is set</seg></seglistitem> + <seglistitem><seg>del</seg><seg>Erase-flag as set by <function>ob_start</function></seg></seglistitem> + </segmentedlist> + </para> + <para> + If called with <parameter>full_status</parameter> = &true; an array + with one element for each active output buffer level is returned. + The output level is used as key of the top level array and each array + element itself is another array holding status information + on one active output level. + </para> + <example> + <title>Full <function>ob_get_status</function> output</title> + <screen> Array ( [0] => Array @@ -87,24 +81,24 @@ ) ) - </screen> - </example> - <para> - The full output contains these additional elements: - <segmentedlist> - <title>Full <function>ob_get_status</function> results</title> - <segtitle>Key</segtitle><segtitle>Value</segtitle> - <seglistitem><seg>chunk_size</seg><seg>Chunk size as set by <function>ob_start</function></seg></seglistitem> - <seglistitem><seg>size</seg><seg>...</seg></seglistitem> - <seglistitem><seg>blocksize</seg><seg>...</seg></seglistitem> - </segmentedlist> - </para> - <para> - See also <function>ob_get_level</function> and - <function>ob_list_handlers</function>. - </para> - </refsect1> - </refentry> + </screen> + </example> + <para> + The full output contains these additional elements: + <segmentedlist> + <title>Full <function>ob_get_status</function> results</title> + <segtitle>Key</segtitle><segtitle>Value</segtitle> + <seglistitem><seg>chunk_size</seg><seg>Chunk size as set by <function>ob_start</function></seg></seglistitem> + <seglistitem><seg>size</seg><seg>...</seg></seglistitem> + <seglistitem><seg>blocksize</seg><seg>...</seg></seglistitem> + </segmentedlist> + </para> + <para> + See also <function>ob_get_level</function> and + <function>ob_list_handlers</function>. + </para> + </refsect1> +</refentry>  +  - <refentry id="function.ob-gzhandler"> - <refnamediv> - <refname>ob_gzhandler</refname> - <refpurpose> - ob_start callback function to gzip output buffer - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>ob_gzhandler</methodname> - <methodparam><type>string</type><parameter>buffer</parameter></methodparam> - <methodparam><type>int</type><parameter>mode</parameter></methodparam> - </methodsynopsis> - <note> - <para> - <function>ob_gzhandler</function> requires the <link linkend="ref.zlib">zlib</link> - extension. - </para> - </note> - <para> - <function>ob_gzhandler</function> is intended to be used as a - callback function for <function>ob_start</function> to help - facilitate sending gz-encoded data to web browsers that support - compressed web pages. Before <function>ob_gzhandler</function> - actually sends compressed data, it determines what type of - content encoding the browser will accept ("gzip", "deflate" or - none at all) and will return its output accordingly. All - browsers are supported since it's up to the browser to send the - correct header saying that it accepts compressed web pages. - If a browser doesn't support compressed pages this function returns - &false;. - </para> - <note> - <para> - <parameter>mode</parameter> was added in PHP 4.0.5. - </para> - </note> - <para> - <example> - <title><function>ob_gzhandler</function> example</title> - <programlisting role="php"> +<refentry id="function.ob-gzhandler"> + <refnamediv> + <refname>ob_gzhandler</refname> + <refpurpose>ob_start callback function to gzip output buffer</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>ob_gzhandler</methodname> + <methodparam><type>string</type><parameter>buffer</parameter></methodparam> + <methodparam><type>int</type><parameter>mode</parameter></methodparam> + </methodsynopsis> + <note> + <para> + <function>ob_gzhandler</function> requires the <link linkend="ref.zlib">zlib</link> + extension. + </para> + </note> + <para> + <function>ob_gzhandler</function> is intended to be used as a + callback function for <function>ob_start</function> to help + facilitate sending gz-encoded data to web browsers that support + compressed web pages. Before <function>ob_gzhandler</function> + actually sends compressed data, it determines what type of + content encoding the browser will accept ("gzip", "deflate" or + none at all) and will return its output accordingly. All + browsers are supported since it's up to the browser to send the + correct header saying that it accepts compressed web pages. + If a browser doesn't support compressed pages this function returns + &false;. + </para> + <note> + <para> + <parameter>mode</parameter> was added in PHP 4.0.5. + </para> + </note> + <para> + <example> + <title><function>ob_gzhandler</function> example</title> + <programlisting role="php"> <![CDATA[ <?php @@ -55,26 +53,26 @@ </html> <body> ]]> - </programlisting> - </example> - </para> - <note> - <para> - You cannot use both <function>ob_gzhandler</function> and - <link linkend="ini.zlib.output-compression"> - zlib.output_compression</link>. Also note that - using <link linkend="ini.zlib.output-compression"> - zlib.output_compression</link> is preferred over - <function>ob_gzhandler</function>. - </para> - </note> - <para> - See also - <function>ob_start</function> and - <function>ob_end_flush</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <note> + <para> + You cannot use both <function>ob_gzhandler</function> and + <link linkend="ini.zlib.output-compression"> + zlib.output_compression</link>. Also note that + using <link linkend="ini.zlib.output-compression"> + zlib.output_compression</link> is preferred over + <function>ob_gzhandler</function>. + </para> + </note> + <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> - <methodsynopsis> - <type>void</type><methodname>ob_implicit_flush</methodname> - <methodparam choice="opt"><type>int</type><parameter>flag</parameter></methodparam> - </methodsynopsis> - <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> - See also <function>flush</function>, - <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> + <methodsynopsis> + <type>void</type><methodname>ob_implicit_flush</methodname> + <methodparam choice="opt"><type>int</type><parameter>flag</parameter></methodparam> + </methodsynopsis> + <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> + See also <function>flush</function>, + <function>ob_start</function>, and + <function>ob_end_flush</function>. + </para> + </refsect1> +</refentry>  - <refentry id="function.ob-list-handlers"> - <refnamediv> - <refname>ob_list_handlers</refname> - <refpurpose> - List all output handlers in use - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>array</type><methodname>ob_list_handlers</methodname> - <void/> - </methodsynopsis> - <para> - This will return an array with the output handlers in use (if any). If - <link - linkend="ini.output-buffering">output_buffering</link> is - enabled or an anonymous function was used with - <function>ob_start</function>, <function>ob_list_handlers</function> will - return "default output handler". - </para> - <para> - <example> - <title><function>ob_list_handlers</function> example</title> - <programlisting role="php"> + +<refentry id="function.ob-list-handlers"> + <refnamediv> + <refname>ob_list_handlers</refname> + <refpurpose>List all output handlers in use</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>array</type><methodname>ob_list_handlers</methodname> + <void/> + </methodsynopsis> + <para> + This will return an array with the output handlers in use (if any). If + <link + linkend="ini.output-buffering">output_buffering</link> is + enabled or an anonymous function was used with + <function>ob_start</function>, <function>ob_list_handlers</function> will + return "default output handler". + </para> + <para> + <example> + <title><function>ob_list_handlers</function> example</title> + <programlisting role="php"> <![CDATA[ <?php //using output_buffering=On @@ -41,9 +39,9 @@ ob_end_flush(); ?> ]]> - </programlisting> - &example.outputs; - <screen> + </programlisting> + &example.outputs; + <screen> <![CDATA[ Array ( @@ -58,20 +56,20 @@ Array ( [0] => default output handler -) +) ]]> - </screen> - </example> - </para> - <para> - See also - <function>ob_end_clean</function>, - <function>ob_end_flush</function>, - <function>ob_get_flush</function>, - <function>ob_start</function>. - </para> - </refsect1> - </refentry> + </screen> + </example> + </para> + <para> + See also + <function>ob_end_clean</function>, + <function>ob_end_flush</function>, + <function>ob_get_flush</function>, + <function>ob_start</function>. + </para> + </refsect1> +</refentry>  +  - <refentry id="function.ob-start"> - <refnamediv> - <refname>ob_start</refname> - <refpurpose>Turn on output buffering</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>ob_start</methodname> - <methodparam choice="opt"><type>callback</type><parameter>output_callback</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>chunk_size</parameter></methodparam> - <methodparam choice="opt"><type>bool</type><parameter>erase</parameter></methodparam> - </methodsynopsis> - <para> - This function will turn output buffering on. While output - buffering is active no output is sent from the script (other than - headers), instead the output is stored in an internal buffer. - </para> - <para> - The contents of this internal buffer may be copied into a string - variable using <function>ob_get_contents</function>. To output - what is stored in the internal buffer, use - <function>ob_end_flush</function>. Alternatively, - <function>ob_end_clean</function> will silently discard the - buffer contents. - </para> - <para> - An optional <parameter>output_callback</parameter> function may - be specified. This function takes a string as a parameter and - should return a string. The function will be called when - <function>ob_end_flush</function> is called, or when the output - buffer is flushed to the browser at the end of the request. When - <parameter>output_callback</parameter> is called, it will receive - the contents of the output buffer as its parameter and is - expected to return a new output buffer as a result, which will be - sent to the browser. If the <parameter>output_callback</parameter> is not - a callable function, this function will return &false;. - If the callback function has two parameters, the second parameter is filled - with a bit-field consisting of - <constant>PHP_OUTPUT_HANDLER_START</constant>, - <constant>PHP_OUTPUT_HANDLER_CONT</constant> and - <constant>PHP_OUTPUT_HANDLER_END</constant>. - If <parameter>output_callback</parameter> returns &false; original input - is sent to the browser. - </para> - <note> - <para> - In PHP 4.0.4, <function>ob_gzhandler</function> was introduced - to facilitate sending gz-encoded data to web browsers that - support compressed web pages. <function>ob_gzhandler</function> - determines what type of content encoding the browser will accept - and will return its output accordingly. - </para> - </note> - <note> - <para> - Before PHP 4.3.2 this function did not return &false; in case the passed - <parameter>output_callback</parameter> can not be executed. - </para> - </note> - <warning> - <para> - Some web servers (e.g. Apache) change the working directory of a script - when calling the callback function. You can change it back by e.g. - <literal>chdir(dirname($_SERVER['SCRIPT_FILENAME']))</literal> in the - callback function. - </para> - </warning> - <para> - If the optional parameter <parameter>chunk_size</parameter> is passed, the - callback function is called on every first newline after - <parameter>chunk_size</parameter> bytes of output. - The <parameter>output_callback</parameter> parameter may be bypassed by - passing a &null; value. - </para> - <para> - If the optional parameter <parameter>erase</parameter> is set to &false;, - the buffer will not be deleted until the script finishes (as of PHP 4.3.0). - </para> - <para> - Output buffers are stackable, that is, you may call - <function>ob_start</function> while another - <function>ob_start</function> is active. Just make - sure that you call <function>ob_end_flush</function> - the appropriate number of times. If multiple output callback - functions are active, output is being filtered sequentially - through each of them in nesting order. - </para> - <para> - <function>ob_end_clean</function>, - <function>ob_end_flush</function>, <function>ob_clean</function>, - <function>ob_flush</function> and <function>ob_start</function> - may not be called from a callback function. If you call them from - callback function, the behavior is undefined. If you would like to - delete the contents of a buffer, return "" (a null string) from callback - function. - You can't even call functions using the output buffering functions like - <literal>print_r($expression, true)</literal> or - <literal>highlight_file($filename, true)</literal> from a callback - function. - </para> - <para> - <example> - <title>User defined callback function example</title> - <programlisting role="php"> +<refentry id="function.ob-start"> + <refnamediv> + <refname>ob_start</refname> + <refpurpose>Turn on output buffering</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>ob_start</methodname> + <methodparam choice="opt"><type>callback</type><parameter>output_callback</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>chunk_size</parameter></methodparam> + <methodparam choice="opt"><type>bool</type><parameter>erase</parameter></methodparam> + </methodsynopsis> + <para> + This function will turn output buffering on. While output + buffering is active no output is sent from the script (other than + headers), instead the output is stored in an internal buffer. + </para> + <para> + The contents of this internal buffer may be copied into a string + variable using <function>ob_get_contents</function>. To output + what is stored in the internal buffer, use + <function>ob_end_flush</function>. Alternatively, + <function>ob_end_clean</function> will silently discard the + buffer contents. + </para> + <para> + An optional <parameter>output_callback</parameter> function may + be specified. This function takes a string as a parameter and + should return a string. The function will be called when + <function>ob_end_flush</function> is called, or when the output + buffer is flushed to the browser at the end of the request. When + <parameter>output_callback</parameter> is called, it will receive + the contents of the output buffer as its parameter and is + expected to return a new output buffer as a result, which will be + sent to the browser. If the <parameter>output_callback</parameter> is not + a callable function, this function will return &false;. + If the callback function has two parameters, the second parameter is filled + with a bit-field consisting of + <constant>PHP_OUTPUT_HANDLER_START</constant>, + <constant>PHP_OUTPUT_HANDLER_CONT</constant> and + <constant>PHP_OUTPUT_HANDLER_END</constant>. + If <parameter>output_callback</parameter> returns &false; original input + is sent to the browser. + </para> + <note> + <para> + In PHP 4.0.4, <function>ob_gzhandler</function> was introduced + to facilitate sending gz-encoded data to web browsers that + support compressed web pages. <function>ob_gzhandler</function> + determines what type of content encoding the browser will accept + and will return its output accordingly. + </para> + </note> + <note> + <para> + Before PHP 4.3.2 this function did not return &false; in case the passed + <parameter>output_callback</parameter> can not be executed. + </para> + </note> + <warning> + <para> + Some web servers (e.g. Apache) change the working directory of a script + when calling the callback function. You can change it back by e.g. + <literal>chdir(dirname($_SERVER['SCRIPT_FILENAME']))</literal> in the + callback function. + </para> + </warning> + <para> + If the optional parameter <parameter>chunk_size</parameter> is passed, the + callback function is called on every first newline after + <parameter>chunk_size</parameter> bytes of output. + The <parameter>output_callback</parameter> parameter may be bypassed by + passing a &null; value. + </para> + <para> + If the optional parameter <parameter>erase</parameter> is set to &false;, + the buffer will not be deleted until the script finishes (as of PHP 4.3.0). + </para> + <para> + Output buffers are stackable, that is, you may call + <function>ob_start</function> while another + <function>ob_start</function> is active. Just make + sure that you call <function>ob_end_flush</function> + the appropriate number of times. If multiple output callback + functions are active, output is being filtered sequentially + through each of them in nesting order. + </para> + <para> + <function>ob_end_clean</function>, + <function>ob_end_flush</function>, <function>ob_clean</function>, + <function>ob_flush</function> and <function>ob_start</function> + may not be called from a callback function. If you call them from + callback function, the behavior is undefined. If you would like to + delete the contents of a buffer, return "" (a null string) from callback + function. + You can't even call functions using the output buffering functions like + <literal>print_r($expression, true)</literal> or + <literal>highlight_file($filename, true)</literal> from a callback + function. + </para> + <para> + <example> + <title>User defined callback function example</title> + <programlisting role="php"> <![CDATA[ <?php -function callback($buffer) +function callback($buffer) { // replace all the apples with oranges return (str_replace("apples", "oranges", $buffer)); @@ -129,11 +129,11 @@ ?> ]]> - </programlisting> - <para> - Would produce: - </para> - <screen> + </programlisting> + <para> + Would produce: + </para> + <screen> <![CDATA[ <html> <body> @@ -141,20 +141,20 @@ </body> </html> ]]> - </screen> - </example> - </para> - <para> - See also <function>ob_get_contents</function>, - <function>ob_end_flush</function>, - <function>ob_end_clean</function>, - <function>ob_implicit_flush</function>, - <function>ob_gzhandler</function>, <function>ob_iconv_handler</function> - <function>mb_output_handler</function>, and - <function>ob_tidyhandler</function>. - </para> - </refsect1> - </refentry> + </screen> + </example> + </para> + <para> + See also <function>ob_get_contents</function>, + <function>ob_end_flush</function>, + <function>ob_end_clean</function>, + <function>ob_implicit_flush</function>, + <function>ob_gzhandler</function>, <function>ob_iconv_handler</function> + <function>mb_output_handler</function>, and + <function>ob_tidyhandler</function>. + </para> + </refsect1> +</refentry>  - <refentry id="function.output-add-rewrite-var"> - <refnamediv> - <refname>output_add_rewrite_var</refname> - <refpurpose> - Add URL rewriter values - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>output_add_rewrite_var</methodname> - <methodparam><type>string</type><parameter>name</parameter></methodparam> - <methodparam><type>string</type><parameter>value</parameter></methodparam> - </methodsynopsis> - <para> - This function adds another name/value pair to the URL rewrite mechanism. - The name and value will be added to URLs (as GET parameter) and forms - (as hidden input fields) the same way as the session ID when transparent - URL rewriting is enabled with <link - linkend="ini.session.use-trans-sid">session.use_trans_sid</link>. Please - note that absolute URLs (http://example.com/..) aren't rewritten. - </para> - <para> - This functions behavior is controlled by the <link - linkend="ini.url-rewriter.tags">url_rewriter.tags</link> &php.ini; - parameter. - </para> - <note> - <simpara> - Calling this function will implicitly start output buffering if it is - not active already. - </simpara> - </note> - <para> - <example> - <title><function>output_add_rewrite_var</function> example</title> - <programlisting role="php"> + +<refentry id="function.output-add-rewrite-var"> + <refnamediv> + <refname>output_add_rewrite_var</refname> + <refpurpose>Add URL rewriter values</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>output_add_rewrite_var</methodname> + <methodparam><type>string</type><parameter>name</parameter></methodparam> + <methodparam><type>string</type><parameter>value</parameter></methodparam> + </methodsynopsis> + <para> + This function adds another name/value pair to the URL rewrite mechanism. + The name and value will be added to URLs (as GET parameter) and forms + (as hidden input fields) the same way as the session ID when transparent + URL rewriting is enabled with <link + linkend="ini.session.use-trans-sid">session.use_trans_sid</link>. Please + note that absolute URLs (http://example.com/..) aren't rewritten. + </para> + <para> + This functions behavior is controlled by the <link + linkend="ini.url-rewriter.tags">url_rewriter.tags</link> &php.ini; + parameter. + </para> + <note> + <simpara> + Calling this function will implicitly start output buffering if it is + not active already. + </simpara> + </note> + <para> + <example> + <title><function>output_add_rewrite_var</function> example</title> + <programlisting role="php"> <![CDATA[ <?php output_add_rewrite_var('var', 'value'); @@ -53,9 +51,9 @@ print_r(ob_list_handlers()); ?> ]]> - </programlisting> - &example.outputs; - <screen> + </programlisting> + &example.outputs; + <screen> <![CDATA[ <a href="file.php?var=value">link</a> <a href="http://example.com">link2</a> @@ -70,17 +68,17 @@ [0] => URL-Rewriter ) ]]> - </screen> - </example> - </para> - <para> - See also - <function>output_reset_rewrite_vars</function>, - <function>ob_flush</function> and - <function>ob_list_handlers</function>. - </para> - </refsect1> - </refentry> + </screen> + </example> + </para> + <para> + See also + <function>output_reset_rewrite_vars</function>, + <function>ob_flush</function> and + <function>ob_list_handlers</function>. + </para> + </refsect1> +</refentry>  - <refentry id="function.output-reset-rewrite-vars"> - <refnamediv> - <refname>output_reset_rewrite_vars</refname> - <refpurpose> - Reset URL rewriter values - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>output_reset_rewrite_vars</methodname> - <void/> - </methodsynopsis> - <para> - This function resets the URL rewriter and removes all rewrite - variables previously set by the <function>output_add_rewrite_var</function> - function or the session mechanism (if <literal>session.use_trans_sid</literal> - was set on <function>session_start</function>). - </para> - <para> - <example> - <title><function>output_reset_rewrite_vars</function> example</title> - <programlisting role="php"> + +<refentry id="function.output-reset-rewrite-vars"> + <refnamediv> + <refname>output_reset_rewrite_vars</refname> + <refpurpose>Reset URL rewriter values</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>output_reset_rewrite_vars</methodname> + <void/> + </methodsynopsis> + <para> + This function resets the URL rewriter and removes all rewrite + variables previously set by the <function>output_add_rewrite_var</function> + function or the session mechanism (if <literal>session.use_trans_sid</literal> + was set on <function>session_start</function>). + </para> + <para> + <example> + <title><function>output_reset_rewrite_vars</function> example</title> + <programlisting role="php"> <![CDATA[ <?php session_start(); @@ -35,25 +33,25 @@ echo '<a href="file.php">link</a>'; ?> ]]> - </programlisting> - &example.outputs; - <screen> + </programlisting> + &example.outputs; + <screen> <![CDATA[ <a href="file.php?PHPSESSID=xxx&var=value">link</a> <a href="file.php">link</a> ]]> - </screen> - </example> - </para> - <para> - See also - <function>output_add_rewrite_var</function>, - <function>ob_flush</function>, - <function>ob_list_handlers</function> and - <function>session_start</function>. - </para> - </refsect1> - </refentry> + </screen> + </example> + </para> + <para> + See also + <function>output_add_rewrite_var</function>, + <function>ob_flush</function>, + <function>ob_list_handlers</function> and + <function>session_start</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: