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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 332586 $ -->
<refentry xml:id="yaf-route-interface.route" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Yaf_Route_Interface::route</refname>
<refpurpose>route a request</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>abstract</modifier> <modifier>public</modifier> <type>bool</type><methodname>Yaf_Route_Interface::route</methodname>
<methodparam><type>Yaf_Request_Abstract</type><parameter>request</parameter></methodparam>
</methodsynopsis>
<para>
<methodname>Yaf_Route_Interface::route</methodname> is the only method
that a custom route should implement.
<note>
<para>
since of 2.3.0, there is another method should also be implemented,
see <methodname>Yaf_Route_Interface::assemble</methodname>.
</para>
</note>
</para>
<para>
if this method return &true;, then the route process will be end. otherwise,
<classname>Yaf_Router</classname> will call next route in the route stack
to route request.
</para>
<para>
This method would set the route result to the parameter request, by
calling <methodname>Yaf_Request_Abstract::setControllerName</methodname>,
<methodname>Yaf_Request_Abstract::setActionName</methodname> and
<methodname>Yaf_Request_Abstract::setModuleName</methodname>.
</para>
<para>
This method should also call
<methodname>Yaf_Request_Abstract::setRouted</methodname> to make the
request routed at last.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>request</parameter></term>
<listitem>
<para>
A <classname>Yaf_Request_Abstract</classname> instance.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</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
-->
|
