php-doc-en/reference/outcontrol/functions/output-add-rewrite-var.xml
Nuno Lopes 611975374e nuke tab
link ini opts


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@203775 c90b9560-bf6c-de11-be94-00142212c4b1
2005-12-27 15:27:47 +00:00

101 lines
2.6 KiB
XML
Executable file

<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.7 $ -->
<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>.
</para>
<para>
This functions behavior is controled 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');
// 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>
&example.outputs;
<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>output_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
-->