sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 08:58:56 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

update docs for Yaf_Router

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@327774 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Xinchen Hui 2012-09-25 08:28:49 +00:00
parent d38dc50d90
commit 30c2d6226d
6 changed files with 24 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
reference/yaf/yaf_router/addconfig.xml
View file

@ -10,16 +10,13 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Yaf_Router::addConfig</methodname>
<modifier>public</modifier> <type>bool</type><methodname>Yaf_Router::addConfig</methodname>
<methodparam><type>Yaf_Config_Abstract</type><parameter>config</parameter></methodparam>
</methodsynopsis>
<para>
Add Routes defined in application.ini into
Add routes defined by configs into
<classname>Yaf_Router</classname>'s route stack
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">
@ -30,7 +27,8 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
An <classname>Yaf_Config_Abstract</classname> instance, which should
contains one or more valid route configs
</para>
</refsect1>

9
reference/yaf/yaf_router/addroute.xml
View file

@ -10,22 +10,19 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>Yaf_Router</type><methodname>Yaf_Router::addRoute</methodname>
<modifier>public</modifier> <type>bool</type><methodname>Yaf_Router::addRoute</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>Yaf_Route_Abstract</type><parameter>route</parameter></methodparam>
</methodsynopsis>
<para>
defaultly, Yaf_Router using a <classname>Yaf_Route_Static</classname> as its defualt route. you
can add new routes into Router's route stack by calling this method.
can add new routes into router's route stack by calling this method.
</para>
<para>
the newer route will be called before the older(route stack), and if the newer router return
TRUE, the router process will be end. otherwise, the older one will be
called.
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">
@ -36,7 +33,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
</refsect1>

3
reference/yaf/yaf_router/construct.xml
View file

@ -16,9 +16,6 @@
<para>
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">

3
reference/yaf/yaf_router/getcurrentroute.xml
View file

@ -22,9 +22,6 @@
</para>
</note>
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">

20
reference/yaf/yaf_router/getroute.xml
View file

@ -4,21 +4,19 @@
<refentry xml:id="yaf-router.getroute" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Yaf_Router::getRoute</refname>
<refpurpose>The getRoute purpose</refpurpose>
<refpurpose>Retrieve a route by name</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Yaf_Router::getRoute</methodname>
<modifier>public</modifier> <type>Yaf_Route_Interface</type><methodname>Yaf_Router::getRoute</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>
<para>
Retrieve a route by name, see also
<methodname>Yaf_Router::getCurrentRoute</methodname>
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">
@ -34,6 +32,16 @@
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><classname>Yaf_Bootstrap_Abstract</classname></member>
<member><classname>Yaf_Plugin_Abstract</classname></member>
<member><methodname>Yaf_Router::addRoute</methodname></member>
<member><methodname>Yaf_Router::getCurrentRoute</methodname></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

9
reference/yaf/yaf_router/getroutes.xml
View file

@ -4,21 +4,18 @@
<refentry xml:id="yaf-router.getroutes" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Yaf_Router::getRoutes</refname>
<refpurpose>The getRoutes purpose</refpurpose>
<refpurpose>Retrieve registered routes</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Yaf_Router::getRoutes</methodname>
<modifier>public</modifier> <type>mixed</type><methodname>Yaf_Router::getRoutes</methodname>
<void />
</methodsynopsis>
<para>
Retrieve registered routes
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">