PageRenderTime 55ms CodeModel.GetById 27ms RepoModel.GetById 0ms app.codeStats 0ms

/php/yaf-router.getcurrentroute.html

https://bitbucket.org/thncr/manuals
HTML | 111 lines | 93 code | 18 blank | 0 comment | 0 complexity | 97912bd1ffebb17ba153383c7bef3536 MD5 | raw file
    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
    2. 

  2. <html>
    3. 

  3.  <head>
    4. 

  4.   <meta http-equiv="content-type" content="text/html; charset=UTF-8">
    5. 

  5.   <title>Get the effective route name</title>
    6. 

  6. 

  7.  </head>
    8. 

  8.  <body><div class="manualnavbar" style="text-align: center;">
    9. 

  9.  <div class="prev" style="text-align: left; float: left;"><a href="yaf-router.construct.html">Yaf_Router::__construct</a></div>
    10. 

  10.  <div class="next" style="text-align: right; float: right;"><a href="yaf-router.getroute.html">Yaf_Router::getRoute</a></div>
    11. 

  11.  <div class="up"><a href="class.yaf-router.html">Yaf_Router</a></div>
    12. 

  12.  <div class="home"><a href="index.html">PHP Manual</a></div>
    13. 

  13. </div><hr /><div id="yaf-router.getcurrentroute" class="refentry">
    14. 

  14.  <div class="refnamediv">
    15. 

  15.   <h1 class="refname">Yaf_Router::getCurrentRoute</h1>
    16. 

  16.   <p class="verinfo">(Yaf &gt;=1.0.0)</p><p class="refpurpose"><span class="refname">Yaf_Router::getCurrentRoute</span> &mdash; <span class="dc-title">Get the effective route name</span></p>
    17. 

  17. 

  18.  </div>
    19. 

  19. 

  20.  <div class="refsect1 description" id="refsect1-yaf-router.getcurrentroute-description">
    21. 

  21.   <h3 class="title">说明</h3>
    22. 

  22.   <div class="methodsynopsis dc-description">
    23. 

  23.    <span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><strong>Yaf_Router::getCurrentRoute</strong></span>
    24. 

  24.     ( <span class="methodparam">void</span>
    25. 

  25.    )</div>
    26. 

  26. 

  27.   <p class="para rdfs-comment">
    28. 

  28.    Get the name of the route which is effective in the route process.
    29. 

  29.    <blockquote class="note"><p><strong class="note">Note</strong>: 
    30. 

  30.     <p class="para">
    31. 

  31.      You should call this method after the route process finished, since
    32. 

  32.      before that, this method will always return <strong><code>NULL</code></strong>.
    33. 

  33.     </p>
    34. 

  34.    </p></blockquote>
    35. 

  35.   </p>
    36. 

  36.  </div>
    37. 

  37. 

  38. 

  39.  <div class="refsect1 parameters" id="refsect1-yaf-router.getcurrentroute-parameters">
    40. 

  40.   <h3 class="title">参数</h3>
    41. 

  41.   <p class="para">此函数没有参数。</p>
    42. 

  42.  </div>
    43. 

  43. 

  44. 

  45.  <div class="refsect1 returnvalues" id="refsect1-yaf-router.getcurrentroute-returnvalues">
    46. 

  46.   <h3 class="title">返回值</h3>
    47. 

  47.   <p class="para">
    48. 

  48.    String, the name of the effective route.
    49. 

  49.   </p>
    50. 

  50.  </div>
    51. 

  51. 

  52. 

  53.  <div class="refsect1 examples" id="refsect1-yaf-router.getcurrentroute-examples">
    54. 

  54.   <h3 class="title">范例</h3>
    55. 

  55.   <div class="example" id="example-3965">
    56. 

  56.    <p><strong>Example #1 Register some routes in Bootstrap</strong></p>
    57. 

  57.    <div class="example-contents">
    58. 

  58. <div class="phpcode"><code><span style="color: #000000">
    59. 

  59. <span style="color: #0000BB">&lt;?php<br /></span><span style="color: #007700">class&nbsp;</span><span style="color: #0000BB">Bootstrap&nbsp;</span><span style="color: #007700">extends&nbsp;</span><span style="color: #0000BB">Yaf_Bootstrap_Abstract</span><span style="color: #007700">{<br />&nbsp;&nbsp;&nbsp;&nbsp;public&nbsp;function&nbsp;</span><span style="color: #0000BB">_initConfig</span><span style="color: #007700">()&nbsp;{<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$config&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">Yaf_Application</span><span style="color: #007700">::</span><span style="color: #0000BB">app</span><span style="color: #007700">()-&gt;</span><span style="color: #0000BB">getConfig</span><span style="color: #007700">();<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">Yaf_Registry</span><span style="color: #007700">::</span><span style="color: #0000BB">set</span><span style="color: #007700">(</span><span style="color: #DD0000">"config"</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$config</span><span style="color: #007700">);<br />&nbsp;&nbsp;&nbsp;&nbsp;}<br /><br />&nbsp;&nbsp;&nbsp;&nbsp;public&nbsp;function&nbsp;</span><span style="color: #0000BB">_initRoute</span><span style="color: #007700">(</span><span style="color: #0000BB">Yaf_Dispatcher&nbsp;$dispatcher</span><span style="color: #007700">)&nbsp;{<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$router&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">$dispatcher</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getRouter</span><span style="color: #007700">();<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$rewrite_route&nbsp;&nbsp;</span><span style="color: #007700">=&nbsp;new&nbsp;</span><span style="color: #0000BB">Yaf_Route_Rewrite</span><span style="color: #007700">(<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">"/product/list/:page"</span><span style="color: #007700">,<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;array(<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">"controller"&nbsp;</span><span style="color: #007700">=&gt;&nbsp;</span><span style="color: #DD0000">"product"</span><span style="color: #007700">,<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">"action"&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #007700">=&gt;&nbsp;</span><span style="color: #DD0000">"list"</span><span style="color: #007700">,<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;)<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;);&nbsp;<br /><br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$regex_route&nbsp;&nbsp;</span><span style="color: #007700">=&nbsp;new&nbsp;</span><span style="color: #0000BB">Yaf_Route_Rewrite</span><span style="color: #007700">(<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">"#^/product/info/(\d+)"</span><span style="color: #007700">,<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;array(<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">"controller"&nbsp;</span><span style="color: #007700">=&gt;&nbsp;</span><span style="color: #DD0000">"product"</span><span style="color: #007700">,<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">"action"&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #007700">=&gt;&nbsp;</span><span style="color: #DD0000">"info"</span><span style="color: #007700">,<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;)<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;);&nbsp;<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$router</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">addRoute</span><span style="color: #007700">(</span><span style="color: #DD0000">'rewrite'</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$rewrite_route</span><span style="color: #007700">)-&gt;</span><span style="color: #0000BB">addRoute</span><span style="color: #007700">(</span><span style="color: #DD0000">'regex'</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$regex_route</span><span style="color: #007700">);<br />&nbsp;&nbsp;&nbsp;&nbsp;}&nbsp;<br /><br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #FF8000">/**<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;*&nbsp;register&nbsp;plugin&nbsp;<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;*/<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #007700">public&nbsp;function&nbsp;</span><span style="color: #0000BB">__initPlugins</span><span style="color: #007700">(</span><span style="color: #0000BB">Yaf_Dispatcher&nbsp;$dispatcher</span><span style="color: #007700">)&nbsp;{<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$dispatcher</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">registerPlugin</span><span style="color: #007700">(new&nbsp;</span><span style="color: #0000BB">DummyPlugin</span><span style="color: #007700">());<br />&nbsp;&nbsp;&nbsp;&nbsp;}<br /></span><span style="color: #0000BB">?&gt;</span>
    60. 

  60. </span>
    61. 

  61. </code></div>
    62. 

  62.    </div>
    63. 

  63. 

  64.   </div>
    65. 

  65.   <div class="example" id="example-3966">
    66. 

  66.    <p><strong>Example #2 plugin Dummy.php (under <a href="yaf.appconfig.html#configuration.yaf.directory" class="link">application.directory</a>/plugins)</strong></p>
    67. 

  67.    <div class="example-contents">
    68. 

  68. <div class="phpcode"><code><span style="color: #000000">
    69. 

  69. <span style="color: #0000BB">&lt;?php<br /></span><span style="color: #007700">class&nbsp;</span><span style="color: #0000BB">DummyPlugin&nbsp;</span><span style="color: #007700">extends&nbsp;</span><span style="color: #0000BB">Yaf_Plugin_Abstract&nbsp;</span><span style="color: #007700">{<br /><br />&nbsp;&nbsp;&nbsp;&nbsp;public&nbsp;function&nbsp;</span><span style="color: #0000BB">routerShutdown</span><span style="color: #007700">(</span><span style="color: #0000BB">Yaf_Request_Abstract&nbsp;$request</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">Yaf_Response_Abstract&nbsp;$response</span><span style="color: #007700">)&nbsp;{<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">Yaf_Dispatcher</span><span style="color: #007700">::</span><span style="color: #0000BB">getInstance</span><span style="color: #007700">()-&gt;</span><span style="color: #0000BB">getRouter</span><span style="color: #007700">()-&gt;</span><span style="color: #0000BB">getCurrentRoute</span><span style="color: #007700">());<br />&nbsp;&nbsp;&nbsp;&nbsp;}<br /></span><span style="color: #0000BB">?&gt;<br /></span>?&gt;</span>
    70. 

  70. </code></div>
    71. 

  71.    </div>
    72. 

  72. 

  73.    <div class="example-contents"><p>以上例程的输出类似于：</p></div>
    74. 

  74.    <div class="example-contents screen">
    75. 

  75. <div class="cdata"><pre>
    76. 

  76. /* for http://yourdomain.com/product/list/1
    77. 

  77.  * DummyPlugin will output:
    78. 

  78.  */
    79. 

  79. string(7) &quot;rewrite&quot;
    80. 

  80. 

  81. /* for http://yourdomain.com/product/info/34
    82. 

  82.  * DummyPlugin will output:
    83. 

  83.  */
    84. 

  84. string(5) &quot;regex&quot;
    85. 

  85. 

  86. /* for other request URI
    87. 

  87.  * DummyPlugin will output:
    88. 

  88.  */
    89. 

  89. string(8) &quot;_default&quot;
    90. 

  90. </pre></div>
    91. 

  91.    </div>
    92. 

  92.   </div>
    93. 

  93.  </div>
    94. 

  94. 

  95. 

  96.  <div class="refsect1 seealso" id="refsect1-yaf-router.getcurrentroute-seealso">
    97. 

  97.   <h3 class="title">参见</h3>
    98. 

  98.   <ul class="simplelist">
    99. 

  99.    <li class="member"><a href="class.yaf-bootstrap-abstract.html" class="classname">Yaf_Bootstrap_Abstract</a></li>
    100. 

  100.    <li class="member"><a href="class.yaf-plugin-abstract.html" class="classname">Yaf_Plugin_Abstract</a></li>
    101. 

  101.    <li class="member"> <span class="methodname"><a href="yaf-router.addroute.html" class="methodname" rel="rdfs-seeAlso">Yaf_Router::addRoute()</a> - Add new Route into Router</span></li>
    102. 

  102.   </ul>                       
    103. 

  103.  </div>
    104. 

  104.   
    105. 

  105. 

  106. </div><hr /><div class="manualnavbar" style="text-align: center;">
    107. 

  107.  <div class="prev" style="text-align: left; float: left;"><a href="yaf-router.construct.html">Yaf_Router::__construct</a></div>
    108. 

  108.  <div class="next" style="text-align: right; float: right;"><a href="yaf-router.getroute.html">Yaf_Router::getRoute</a></div>
    109. 

  109.  <div class="up"><a href="class.yaf-router.html">Yaf_Router</a></div>
    110. 

  110.  <div class="home"><a href="index.html">PHP Manual</a></div>
    111. 

  111. </div></body></html>
    112. 

  112.