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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 329534 $ -->
<phpdoc:classref xml:id="class.yaf-route-map" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The Yaf_Route_Map class</title>
<titleabbrev>Yaf_Route_Map</titleabbrev>
<partintro>
<!-- {{{ Yaf_Route_Map intro -->
<section xml:id="yaf-route-map.intro">
&reftitle.intro;
<para>
<classname>Yaf_Route_Map</classname> is a built-in route, it simply
convert a URI endpoint (that part of the URI which comes after the
base URI: see <methodname>Yaf_Request_Abstract::setBaseUri</methodname>)
to a controller name or action name(depends on the paramter passed to
<methodname>Yaf_Route_Map::__construct</methodname>) in following rule:
A => controller A.
A/B/C => controller A_B_C.
A/B/C/D/E => controller A_B_C_D_E.
</para>
<para>
If the second parameter of
<methodname>Yaf_Route_Map::__construct</methodname> is specificed, then
only the part before delimeter of URI will used to routing, the part after
it is used to routing request parameters (see the example section of
<methodname>Yaf_Route_Map::__construct</methodname>).
</para>
</section>
<!-- }}} -->
<section xml:id="yaf-route-map.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>Yaf_Route_Map</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>Yaf_Route_Map</classname>
</ooclass>
<oointerface>
<interfacename>Yaf_Route_Interface</interfacename>
</oointerface>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
<fieldsynopsis>
<modifier>protected</modifier>
<varname linkend="yaf-route-map.props.ctl-router">_ctl_router</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>protected</modifier>
<varname linkend="yaf-route-map.props.delimeter">_delimeter</varname>
</fieldsynopsis>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.yaf-route-map')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ Yaf_Route_Map properties -->
<section xml:id="yaf-route-map.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="yaf-route-map.props.ctl-router">
<term><varname>_ctl_router</varname></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="yaf-route-map.props.delimeter">
<term><varname>_delimeter</varname></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
</partintro>
&reference.yaf.entities.yaf-route-map;
</phpdoc:classref>
<!-- 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
-->
|
