mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-26 22:08:55 +00:00
fc9e379fd8
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@315005 c90b9560-bf6c-de11-be94-00142212c4b1
144 lines
3.4 KiB
XML
144 lines
3.4 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.output-add-rewrite-var">
|
|
<refnamediv>
|
|
<refname>output_add_rewrite_var</refname>
|
|
<refpurpose>Add URL rewriter values</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<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 function's 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>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>name</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The variable name.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>value</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The variable value.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.success;
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>output_add_rewrite_var</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
output_add_rewrite_var('var', 'value');
|
|
|
|
// some links
|
|
echo '<a href="file.php">link</a>
|
|
<a href="http://example.com">link2</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>
|
|
<a href="http://example.com">link2</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>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>output_reset_rewrite_vars</function></member>
|
|
<member><function>ob_flush</function></member>
|
|
<member><function>ob_list_handlers</function></member>
|
|
</simplelist>
|
|
</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:"~/.phpdoc/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
|
|
-->
|