cvs: phpdoc /en/reference/outcontrol/functions output-add-rewrite-var.xml output-reset-rewrite-vars.xml

hholzgra Tue Dec 27 12:24:35 2005 EDT Modified files: /phpdoc/en/reference/outcontrol/functions output-add-rewrite-var.xml output-reset-rewrite-vars.xml Log: polished up output-*-rewrite-var http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/outcontrol/functions/output-add-rewrite-var.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/outcontrol/functions/output-add-rewrite-var.xml diff -u phpdoc/en/reference/outcontrol/functions/output-add-rewrite-var.xml:1.5 phpdoc/en/reference/outcontrol/functions/output-add-rewrite-var.xml:1.6 --- phpdoc/en/reference/outcontrol/functions/output-add-rewrite-var.xml:1.5 Fri Mar 11 16:11:51 2005 +++ phpdoc/en/reference/outcontrol/functions/output-add-rewrite-var.xml Tue Dec 27 12:24:34 2005 @@ -1,5 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.output-add-rewrite-var"> <refnamediv> <refname>output_add_rewrite_var</refname> @@ -15,11 +15,21 @@ <methodparam><type>string</type><parameter>value</parameter></methodparam> </methodsynopsis> <para> - This function rewrite the URLs and forms with the given variable. + 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 + <parameter>session.use_trans_sid</parameter>. + </para> + <para> + This functions behavior is controled by the <literal>url_rewriter.tags</literal> + &php.ini; parameter. See the <link linkend="ref.session">session</link> section + for further details on this setting. </para> <note> <simpara> - This function buffers the output. + Calling this function will implicitly start output buffering if it is + not active already. </simpara> </note> <para> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/outcontrol/functions/output-reset-rewrite-vars.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/outcontrol/functions/output-reset-rewrite-vars.xml diff -u phpdoc/en/reference/outcontrol/functions/output-reset-rewrite-vars.xml:1.5 phpdoc/en/reference/outcontrol/functions/output-reset-rewrite-vars.xml:1.6 --- phpdoc/en/reference/outcontrol/functions/output-reset-rewrite-vars.xml:1.5 Fri Mar 11 16:11:51 2005 +++ phpdoc/en/reference/outcontrol/functions/output-reset-rewrite-vars.xml Tue Dec 27 12:24:35 2005 @@ -1,5 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.output-reset-rewrite-vars"> <refnamediv> <refname>output_reset_rewrite_vars</refname> @@ -13,9 +13,11 @@ <type>bool</type><methodname>output_reset_rewrite_vars</methodname> <void/> </methodsynopsis> - <para>This function resets the URL rewriter and undo the changes made by - <function>output_add_rewrite_var</function> and/or by - <function>session_start</function> that are still in the buffer. + <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>