File: output-add-rewrite-var.xml

package info (click to toggle)
php-doc 20061001-1
  • links: PTS
  • area: non-free
  • in suites: etch, etch-m68k
  • size: 45,764 kB
  • ctags: 1,611
  • sloc: xml: 502,485; php: 7,645; cpp: 500; makefile: 297; perl: 161; sh: 141; awk: 28
file content (101 lines) | stat: -rwxr-xr-x 2,633 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.8 $ -->
  <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 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');

// 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
-->