nlopess Sun Jan 4 07:25:48 2004 EDT
Added files:
/phpdoc/en/reference/outcontrol/functions
output-add-rewrite-var.xml
output-reset-rewrite-vars.xml
Log:
new function
Index: phpdoc/en/reference/outcontrol/functions/output-add-rewrite-var.xml
+++ phpdoc/en/reference/outcontrol/functions/output-add-rewrite-var.xml
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<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 rewrite the URLs and forms with the given variable.
</para>
<note>
<simpara>
This function buffers the output.
</simpara>
</note>
<para>
<example>
<title><function>output_add_rewrite_var</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
output_add_rewrite_var('var', 'value');
// a link
echo '<a href="file.php">link</a>';
// a form
echo '<form action="script.php" method="POST">
<input type="text" name="var2" />
</form>';
print_r(ob_list_handlers());
?>
]]>
</programlisting>
<para>
The above example will output:
</para>
<screen>
<![CDATA[
<a href="file.php?var=value">link</a>
<form action="script.php" method="POST">
<input type="hidden" name="var" value="value" />
<input type="text" name="var2" />
</form>
Array
(
[0] => URL-Rewriter
)
]]>
</screen>
</example>
</para>
<para>
See also <function>ob_reset_rewrite_vars</function>,
<function>ob_flush</function> and <function>ob_list_handlers</function>.
</para>
</refsect1>
</refentry>
<!-- 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:"../../../../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
-->
Index: phpdoc/en/reference/outcontrol/functions/output-reset-rewrite-vars.xml
+++ phpdoc/en/reference/outcontrol/functions/output-reset-rewrite-vars.xml
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<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 undo the changes made by
<function>output_add_rewrite_var</function> and/or by the
<function>session_start</function> that are still in the buffer.
</para>
<para>
<example>
<title><function>output_reset_rewrite_vars</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
session_start();
output_add_rewrite_var('var', 'value');
echo '<a href="file.php">link</a>';
ob_flush();
output_reset_rewrite_vars();
echo '<a href="file.php">link</a>';
?>
]]>
</programlisting>
<para>
The above example will output:
</para>
<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>ob_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:
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:"../../../../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
-->
