[prev in list] [next in list] [prev in thread] [next in thread]
List: php-doc-cvs
Subject: [DOC-CVS] =?utf-8?q?svn:_/phpdoc/en/trunk/reference/yaf/_yaf=5Froute=5Finterface/route.xml_yaf=5Frou
From: Xinchen_Hui <laruence () php ! net>
Date: 2011-11-28 5:13:46
Message-ID: svn-laruence-1322457226-320072-1633559191 () svn ! php ! net
[Download RAW message or body]
laruence Mon, 28 Nov 2011 05:13:46 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=320072
Log:
update docs
Changed paths:
U phpdoc/en/trunk/reference/yaf/yaf_route_interface/route.xml
U phpdoc/en/trunk/reference/yaf/yaf_route_map/construct.xml
U phpdoc/en/trunk/reference/yaf/yaf_route_map/route.xml
U phpdoc/en/trunk/reference/yaf/yaf_route_regex/route.xml
U phpdoc/en/trunk/reference/yaf/yaf_route_rewrite/route.xml
U phpdoc/en/trunk/reference/yaf/yaf_route_simple/route.xml
U phpdoc/en/trunk/reference/yaf/yaf_route_static/route.xml
U phpdoc/en/trunk/reference/yaf/yaf_route_supervar/route.xml
["svn-diffs-320072.txt" (text/x-diff)]
Modified: phpdoc/en/trunk/reference/yaf/yaf_route_interface/route.xml
===================================================================
--- phpdoc/en/trunk/reference/yaf/yaf_route_interface/route.xml 2011-11-28 05:03:52 \
UTC (rev 320071)
+++ phpdoc/en/trunk/reference/yaf/yaf_route_interface/route.xml 2011-11-28 05:13:46 \
UTC (rev 320072) @@ -10,8 +10,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <modifier>abstract</modifier> <modifier>public</modifier> \
<type>void</type><methodname>Yaf_Route_Interface::route</methodname>
- <methodparam><type>string</type><parameter>request</parameter></methodparam>
+ <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
Modified: phpdoc/en/trunk/reference/yaf/yaf_route_map/construct.xml
===================================================================
--- phpdoc/en/trunk/reference/yaf/yaf_route_map/construct.xml 2011-11-28 05:03:52 UTC \
(rev 320071)
+++ phpdoc/en/trunk/reference/yaf/yaf_route_map/construct.xml 2011-11-28 05:13:46 UTC \
(rev 320072) @@ -11,8 +11,8 @@
&reftitle.description;
<methodsynopsis>
<methodname>Yaf_Route_Map::__construct</methodname>
- <methodparam choice="opt"><type>string</type><parameter>controller_prefer</parameter></methodparam>
- <methodparam choice="opt"><type>string</type><parameter>delimiter</parameter></methodparam>
+ <methodparam choice="opt"><type>string</type><parameter>controller_prefer</parameter><initializer>false</initializer></methodparam>
+ <methodparam choice="opt"><type>string</type><parameter>delimiter</parameter><initializer>''</initializer></methodparam>
</methodsynopsis>
<para>
@@ -29,7 +29,7 @@
<term><parameter>controller_prefer</parameter></term>
<listitem>
<para>
-
+ Whether the result should considering as controller or action
</para>
</listitem>
</varlistentry>
@@ -51,7 +51,77 @@
</para>
</refsect1>
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <example>
+ <title><function>Yaf_Route_Map</function>example</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+ /**
+ * Add a map route to Yaf_Router route stack
+ */
+ Yaf_Dispatcher::getInstance()->getRouter()->addRoute("name",
+ new Yaf_Route_Map());
+]]>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
+<![CDATA[
+/* for http://yourdomain.com/product/foo/bar
+ * route will result in following values:
+ */
+array(
+ "controller" => "product_foo_bar",
+)
+]]>
+ </screen>
+ </example>
+ <example>
+ <title><function>Yaf_Route_Map</function>example</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+ /**
+ * Add a map route to Yaf_Router route stack
+ */
+ Yaf_Dispatcher::getInstance()->getRouter()->addRoute("name",
+ new Yaf_Route_Map(true, "_"));
+]]>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
+<![CDATA[
+/* for http://yourdomain.com/user/list/_/foo/22
+ * route will result in following values:
+ */
+array(
+ "action" => "user_list",
+)
+/**
+ * and request parameters:
+ */
+array(
+ "foo" => 22,
+)
+]]>
+ </screen>
+ </example>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <simplelist>
+ <member><methodname>Yaf_Router::addRoute</methodname></member>
+ <member><classname>Yaf_Route_Static</classname></member>
+ <member><classname>Yaf_Route_Supervar</classname></member>
+ <member><classname>Yaf_Route_Simple</classname></member>
+ <member><classname>Yaf_Route_Regex</classname></member>
+ <member><classname>Yaf_Route_Rewrite</classname></member>
+ </simplelist>
+ </refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
Modified: phpdoc/en/trunk/reference/yaf/yaf_route_map/route.xml
===================================================================
--- phpdoc/en/trunk/reference/yaf/yaf_route_map/route.xml 2011-11-28 05:03:52 UTC \
(rev 320071)
+++ phpdoc/en/trunk/reference/yaf/yaf_route_map/route.xml 2011-11-28 05:13:46 UTC \
(rev 320072) @@ -10,8 +10,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <modifier>public</modifier> \
<type>void</type><methodname>Yaf_Route_Map::route</methodname>
- <methodparam><type>string</type><parameter>request</parameter></methodparam>
+ <modifier>public</modifier> \
<type>bool</type><methodname>Yaf_Route_Map::route</methodname> + \
<methodparam><type>Yaf_Request_Abstract</type><parameter>request</parameter></methodparam>
</methodsynopsis>
<para>
Modified: phpdoc/en/trunk/reference/yaf/yaf_route_regex/route.xml
===================================================================
--- phpdoc/en/trunk/reference/yaf/yaf_route_regex/route.xml 2011-11-28 05:03:52 UTC \
(rev 320071)
+++ phpdoc/en/trunk/reference/yaf/yaf_route_regex/route.xml 2011-11-28 05:13:46 UTC \
(rev 320072) @@ -10,8 +10,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <modifier>public</modifier> \
<type>void</type><methodname>Yaf_Route_Regex::route</methodname>
- <methodparam><type>string</type><parameter>request</parameter></methodparam>
+ <modifier>public</modifier> \
<type>bool</type><methodname>Yaf_Route_Regex::route</methodname> + \
<methodparam><type>Yaf_Request_Abstract</type><parameter>request</parameter></methodparam>
</methodsynopsis>
<para>
Modified: phpdoc/en/trunk/reference/yaf/yaf_route_rewrite/route.xml
===================================================================
--- phpdoc/en/trunk/reference/yaf/yaf_route_rewrite/route.xml 2011-11-28 05:03:52 UTC \
(rev 320071)
+++ phpdoc/en/trunk/reference/yaf/yaf_route_rewrite/route.xml 2011-11-28 05:13:46 UTC \
(rev 320072) @@ -10,8 +10,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <modifier>public</modifier> \
<type>void</type><methodname>Yaf_Route_Rewrite::route</methodname>
- <methodparam><type>string</type><parameter>request</parameter></methodparam>
+ <modifier>public</modifier> \
<type>bool</type><methodname>Yaf_Route_Rewrite::route</methodname> + \
<methodparam><type>Yaf_Request_Abstract</type><parameter>request</parameter></methodparam>
</methodsynopsis>
<para>
Modified: phpdoc/en/trunk/reference/yaf/yaf_route_simple/route.xml
===================================================================
--- phpdoc/en/trunk/reference/yaf/yaf_route_simple/route.xml 2011-11-28 05:03:52 UTC \
(rev 320071)
+++ phpdoc/en/trunk/reference/yaf/yaf_route_simple/route.xml 2011-11-28 05:13:46 UTC \
(rev 320072) @@ -10,8 +10,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <modifier>public</modifier> \
<type>void</type><methodname>Yaf_Route_Simple::route</methodname>
- <methodparam><type>string</type><parameter>request</parameter></methodparam>
+ <modifier>public</modifier> \
<type>bool</type><methodname>Yaf_Route_Simple::route</methodname> + \
<methodparam><type>Yaf_Request_Abstract</type><parameter>request</parameter></methodparam>
</methodsynopsis>
<para>
see <methodname>Yaf_Route_Simple::__construct</methodname>
Modified: phpdoc/en/trunk/reference/yaf/yaf_route_static/route.xml
===================================================================
--- phpdoc/en/trunk/reference/yaf/yaf_route_static/route.xml 2011-11-28 05:03:52 UTC \
(rev 320071)
+++ phpdoc/en/trunk/reference/yaf/yaf_route_static/route.xml 2011-11-28 05:13:46 UTC \
(rev 320072) @@ -10,8 +10,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <modifier>public</modifier> \
<type>void</type><methodname>Yaf_Route_Static::route</methodname>
- <methodparam><type>string</type><parameter>request</parameter></methodparam>
+ <modifier>public</modifier> \
<type>bool</type><methodname>Yaf_Route_Static::route</methodname> + \
<methodparam><type>Yaf_Request_Abstract</type><parameter>request</parameter></methodparam>
</methodsynopsis>
<para>
Modified: phpdoc/en/trunk/reference/yaf/yaf_route_supervar/route.xml
===================================================================
--- phpdoc/en/trunk/reference/yaf/yaf_route_supervar/route.xml 2011-11-28 05:03:52 \
UTC (rev 320071)
+++ phpdoc/en/trunk/reference/yaf/yaf_route_supervar/route.xml 2011-11-28 05:13:46 \
UTC (rev 320072) @@ -10,8 +10,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <modifier>public</modifier> \
<type>void</type><methodname>Yaf_Route_Supervar::route</methodname>
- <methodparam><type>string</type><parameter>request</parameter></methodparam>
+ <modifier>public</modifier> \
<type>bool</type><methodname>Yaf_Route_Supervar::route</methodname> + \
<methodparam><type>Yaf_Request_Abstract</type><parameter>request</parameter></methodparam>
</methodsynopsis>
<para>
--
PHP Documentation Commits Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic