mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-29 23:38:56 +00:00
2909316d41
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@320357 c90b9560-bf6c-de11-be94-00142212c4b1
124 lines
3.4 KiB
XML
124 lines
3.4 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<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
|
|
-->
|