mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-21 11:28:55 +00:00
37a12bad6c
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@328221 c90b9560-bf6c-de11-be94-00142212c4b1
124 lines
3.5 KiB
XML
124 lines
3.5 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<phpdoc:classref xml:id="class.yaf-route-simple" 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_Simple class</title>
|
|
<titleabbrev>Yaf_Route_Simple</titleabbrev>
|
|
|
|
<partintro>
|
|
|
|
<!-- {{{ Yaf_Route_Simple intro -->
|
|
<section xml:id="yaf-route-simple.intro">
|
|
&reftitle.intro;
|
|
<para>
|
|
<classname>Yaf_Route_Simple</classname> will match the query string, and
|
|
find the route info.
|
|
</para>
|
|
<para>
|
|
all you need to do is tell <classname>Yaf_Route_Simple</classname> what key in the $_GET is
|
|
module, what key is controller, and what key is action.
|
|
</para>
|
|
<para>
|
|
<methodname>Yaf_Route_Simple::route</methodname> will always return
|
|
&true;,
|
|
so it is important put <classname>Yaf_Route_Simple</classname> in the front of the Route stack,
|
|
otherwise all the other routes will not be called.
|
|
</para>
|
|
</section>
|
|
<!-- }}} -->
|
|
|
|
<section xml:id="yaf-route-simple.synopsis">
|
|
&reftitle.classsynopsis;
|
|
|
|
<!-- {{{ Synopsis -->
|
|
<classsynopsis>
|
|
<ooclass><classname>Yaf_Route_Simple</classname></ooclass>
|
|
|
|
<!-- {{{ Class synopsis -->
|
|
<classsynopsisinfo>
|
|
<ooclass>
|
|
<classname>Yaf_Route_Simple</classname>
|
|
</ooclass>
|
|
|
|
<oointerface>
|
|
<interfacename>Yaf_Route_Interface</interfacename>
|
|
</oointerface>
|
|
</classsynopsisinfo>
|
|
<!-- }}} -->
|
|
<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
|
|
<fieldsynopsis>
|
|
<modifier>protected</modifier>
|
|
<varname linkend="yaf-route-simple.props.controller">controller</varname>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>protected</modifier>
|
|
<varname linkend="yaf-route-simple.props.module">module</varname>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>protected</modifier>
|
|
<varname linkend="yaf-route-simple.props.action">action</varname>
|
|
</fieldsynopsis>
|
|
|
|
|
|
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
|
|
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.yaf-route-simple')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
|
|
</classsynopsis>
|
|
<!-- }}} -->
|
|
|
|
</section>
|
|
|
|
|
|
<!-- {{{ Yaf_Route_Simple properties -->
|
|
<section xml:id="yaf-route-simple.props">
|
|
&reftitle.properties;
|
|
<variablelist>
|
|
<varlistentry xml:id="yaf-route-simple.props.controller">
|
|
<term><varname>controller</varname></term>
|
|
<listitem>
|
|
<para></para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="yaf-route-simple.props.module">
|
|
<term><varname>module</varname></term>
|
|
<listitem>
|
|
<para></para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="yaf-route-simple.props.action">
|
|
<term><varname>action</varname></term>
|
|
<listitem>
|
|
<para></para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<!-- }}} -->
|
|
|
|
|
|
</partintro>
|
|
|
|
&reference.yaf.entities.yaf-route-simple;
|
|
|
|
</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
|
|
-->
|