File: Yaf_Route_Interface.xml

package info (click to toggle)
phpdox 0.12.0-6
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, sid
  • size: 7,672 kB
  • sloc: xml: 80,724; php: 9,167; makefile: 13
file content (18 lines) | stat: -rw-r--r-- 1,227 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
<?xml version="1.0" encoding="UTF-8" ?>
<interface xmlns="http://xml.phpdox.net/src" full="Yaf_Route_Interface" namespace="" name="Yaf_Route_Interface">
  <method name="assemble" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Assemble a request">this method returns a url according to the argument info, and append query strings to the url according to the argument query.</description>
      <return type="string"/>
    </docblock>
    <parameter name="info" optional="false" byreference="false" type="object" class="array"/>
    <parameter name="query" optional="true" byreference="false" type="object" class="array"/>
  </method>
  <method name="route" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Route a request">Yaf_Route_Interface::route is the only method that a custom route should implement. since of 2.3.0, there is another method should also be implemented, see Yaf_Route_Interface::assemble.</description>
      <return type="bool"/>
    </docblock>
    <parameter name="request" optional="false" byreference="false" type="object" class="Yaf_Request_Abstract"/>
  </method>
</interface>