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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 328221 $ -->
<refentry xml:id="yaf-route-simple.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Yaf_Route_Simple::__construct</refname>
<refpurpose>Yaf_Route_Simple constructor</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier><methodname>Yaf_Route_Simple::__construct</methodname>
<methodparam><type>string</type><parameter>module_name</parameter></methodparam>
<methodparam><type>string</type><parameter>controller_name</parameter></methodparam>
<methodparam><type>string</type><parameter>action_name</parameter></methodparam>
</methodsynopsis>
<para>
<classname>Yaf_Route_Simple</classname> will get route info from query
string. and the parameters of this constructor will used as keys while searching for the
route info in $_GET.
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>module_name</parameter></term>
<listitem>
<para>
The key name of the module info.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>controller_name</parameter></term>
<listitem>
<para>
the key name of the controller info.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>action_name</parameter></term>
<listitem>
<para>
the key name of the action info.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Always return &true;.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>Yaf_Route_Simple::route</function>example</title>
<programlisting role="php">
<![CDATA[
<?php
$route = new Yaf_Route_Simple("m", "controller", "act");
Yaf_Router::getInstance()->addRoute("simple", $route);
?>
]]>
</programlisting>
</example>
<example>
<title><function>Yaf_Route_Simple::route</function>example</title>
<programlisting role="bash">
<![CDATA[
Request: http://yourdomain.com/path/?controller=a&act=b
=> module = default(index), controller = a, action = b
Request: http://yourdomain.com/path
=> module = default(index), controller = default(index), action = default(index)
]]>
</programlisting>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><methodname>Yaf_Route_Supervar::route</methodname></member>
<member><methodname>Yaf_Route_Static::route</methodname></member>
<member><methodname>Yaf_Route_Regex::route</methodname></member>
<member><methodname>Yaf_Route_Rewrite::route</methodname></member>
<member><methodname>Yaf_Route_Map::route</methodname></member>
</simplelist>
</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
-->
|
