/php/class.yaf-request-abstract.html

https://bitbucket.org/thncr/manuals · HTML · 601 lines · 306 code · 295 blank · 0 comment · 0 complexity · 7934666e914957be4782e5f0ff6c3c71 MD5 · raw file

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <html>
  3. <head>
  4. <meta http-equiv="content-type" content="text/html; charset=UTF-8">
  5. <title>The Yaf_Request_Abstract class</title>
  6. </head>
  7. <body><div class="manualnavbar" style="text-align: center;">
  8. <div class="prev" style="text-align: left; float: left;"><a href="yaf-registry.set.html">Yaf_Registry::set</a></div>
  9. <div class="next" style="text-align: right; float: right;"><a href="yaf-request-abstract.getactionname.html">Yaf_Request_Abstract::getActionName</a></div>
  10. <div class="up"><a href="book.yaf.html">Yaf</a></div>
  11. <div class="home"><a href="index.html">PHP Manual</a></div>
  12. </div><hr /><div id="class.yaf-request-abstract" class="reference">
  13. <h1 class="title">The Yaf_Request_Abstract class</h1>
  14. <div class="partintro"><p class="verinfo">(No version information available, might only be in SVN)</p>
  15. <div class="section" id="yaf-request-abstract.intro">
  16. <h2 class="title">简介</h2>
  17. <p class="para">
  18. </p>
  19. </div>
  20. <div class="section" id="yaf-request-abstract.synopsis">
  21. <h2 class="title">类摘要</h2>
  22. <div class="classsynopsis">
  23. <div class="ooclass"></div>
  24. <div class="classsynopsisinfo">
  25. <span class="ooclass">
  26. <strong class="classname">Yaf_Request_Abstract</strong>
  27. </span>
  28. {</div>
  29. <div class="classsynopsisinfo classsynopsisinfo_comment">/* Constants */</div>
  30. <div class="fieldsynopsis">
  31. <span class="modifier">const</span>
  32. <span class="type">string</span>
  33. <var class="fieldsynopsis_varname"><a href="class.yaf-request-abstract.html#yaf-request-abstract.constants.scheme-http"><var class="varname">SCHEME_HTTP</var></a></var>
  34. <span class="initializer"> = http</span>
  35. ;</div>
  36. <div class="fieldsynopsis">
  37. <span class="modifier">const</span>
  38. <span class="type">string</span>
  39. <var class="fieldsynopsis_varname"><a href="class.yaf-request-abstract.html#yaf-request-abstract.constants.scheme-https"><var class="varname">SCHEME_HTTPS</var></a></var>
  40. <span class="initializer"> = https</span>
  41. ;</div>
  42. <div class="classsynopsisinfo classsynopsisinfo_comment">/* 属性 */</div>
  43. <div class="fieldsynopsis">
  44. <span class="modifier">public</span>
  45. <var class="varname"><a href="class.yaf-request-abstract.html#yaf-request-abstract.props.module">$<var class="varname">module</var></a></var>
  46. ;</div>
  47. <div class="fieldsynopsis">
  48. <span class="modifier">public</span>
  49. <var class="varname"><a href="class.yaf-request-abstract.html#yaf-request-abstract.props.controller">$<var class="varname">controller</var></a></var>
  50. ;</div>
  51. <div class="fieldsynopsis">
  52. <span class="modifier">public</span>
  53. <var class="varname"><a href="class.yaf-request-abstract.html#yaf-request-abstract.props.action">$<var class="varname">action</var></a></var>
  54. ;</div>
  55. <div class="fieldsynopsis">
  56. <span class="modifier">public</span>
  57. <var class="varname"><a href="class.yaf-request-abstract.html#yaf-request-abstract.props.method">$<var class="varname">method</var></a></var>
  58. ;</div>
  59. <div class="fieldsynopsis">
  60. <span class="modifier">protected</span>
  61. <var class="varname"><a href="class.yaf-request-abstract.html#yaf-request-abstract.props.params">$<var class="varname">params</var></a></var>
  62. ;</div>
  63. <div class="fieldsynopsis">
  64. <span class="modifier">protected</span>
  65. <var class="varname"><a href="class.yaf-request-abstract.html#yaf-request-abstract.props.language">$<var class="varname">language</var></a></var>
  66. ;</div>
  67. <div class="fieldsynopsis">
  68. <span class="modifier">protected</span>
  69. <var class="varname"><a href="class.yaf-request-abstract.html#yaf-request-abstract.props.exception">$<var class="varname">_exception</var></a></var>
  70. ;</div>
  71. <div class="fieldsynopsis">
  72. <span class="modifier">protected</span>
  73. <var class="varname"><a href="class.yaf-request-abstract.html#yaf-request-abstract.props.base-uri">$<var class="varname">_base_uri</var></a></var>
  74. ;</div>
  75. <div class="fieldsynopsis">
  76. <span class="modifier">protected</span>
  77. <var class="varname"><a href="class.yaf-request-abstract.html#yaf-request-abstract.props.uri">$<var class="varname">uri</var></a></var>
  78. ;</div>
  79. <div class="fieldsynopsis">
  80. <span class="modifier">protected</span>
  81. <var class="varname"><a href="class.yaf-request-abstract.html#yaf-request-abstract.props.dispatched">$<var class="varname">dispatched</var></a></var>
  82. ;</div>
  83. <div class="fieldsynopsis">
  84. <span class="modifier">protected</span>
  85. <var class="varname"><a href="class.yaf-request-abstract.html#yaf-request-abstract.props.routed">$<var class="varname">routed</var></a></var>
  86. ;</div>
  87. <div class="classsynopsisinfo classsynopsisinfo_comment">/* 方法 */</div>
  88. <div class="methodsynopsis dc-description">
  89. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.getactionname.html" class="methodname">getActionName</a></span>
  90. ( <span class="methodparam">void</span>
  91. )</div>
  92. <div class="methodsynopsis dc-description">
  93. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.getbaseuri.html" class="methodname">getBaseUri</a></span>
  94. ( <span class="methodparam">void</span>
  95. )</div>
  96. <div class="methodsynopsis dc-description">
  97. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.getcontrollername.html" class="methodname">getControllerName</a></span>
  98. ( <span class="methodparam">void</span>
  99. )</div>
  100. <div class="methodsynopsis dc-description">
  101. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.getenv.html" class="methodname">getEnv</a></span>
  102. ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span>
  103. [, <span class="methodparam"><span class="type">string</span> <code class="parameter">$default</code></span>
  104. ] )</div>
  105. <div class="methodsynopsis dc-description">
  106. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.getexception.html" class="methodname">getException</a></span>
  107. ( <span class="methodparam">void</span>
  108. )</div>
  109. <div class="methodsynopsis dc-description">
  110. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.getlanguage.html" class="methodname">getLanguage</a></span>
  111. ( <span class="methodparam">void</span>
  112. )</div>
  113. <div class="methodsynopsis dc-description">
  114. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.getmethod.html" class="methodname">getMethod</a></span>
  115. ( <span class="methodparam">void</span>
  116. )</div>
  117. <div class="methodsynopsis dc-description">
  118. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.getmodulename.html" class="methodname">getModuleName</a></span>
  119. ( <span class="methodparam">void</span>
  120. )</div>
  121. <div class="methodsynopsis dc-description">
  122. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.getparam.html" class="methodname">getParam</a></span>
  123. ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span>
  124. [, <span class="methodparam"><span class="type">string</span> <code class="parameter">$default</code></span>
  125. ] )</div>
  126. <div class="methodsynopsis dc-description">
  127. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.getparams.html" class="methodname">getParams</a></span>
  128. ( <span class="methodparam">void</span>
  129. )</div>
  130. <div class="methodsynopsis dc-description">
  131. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.getrequesturi.html" class="methodname">getRequestUri</a></span>
  132. ( <span class="methodparam">void</span>
  133. )</div>
  134. <div class="methodsynopsis dc-description">
  135. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.getserver.html" class="methodname">getServer</a></span>
  136. ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span>
  137. [, <span class="methodparam"><span class="type">string</span> <code class="parameter">$default</code></span>
  138. ] )</div>
  139. <div class="methodsynopsis dc-description">
  140. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.iscli.html" class="methodname">isCli</a></span>
  141. ( <span class="methodparam">void</span>
  142. )</div>
  143. <div class="methodsynopsis dc-description">
  144. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.isdispatched.html" class="methodname">isDispatched</a></span>
  145. ( <span class="methodparam">void</span>
  146. )</div>
  147. <div class="methodsynopsis dc-description">
  148. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.isget.html" class="methodname">isGet</a></span>
  149. ( <span class="methodparam">void</span>
  150. )</div>
  151. <div class="methodsynopsis dc-description">
  152. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.ishead.html" class="methodname">isHead</a></span>
  153. ( <span class="methodparam">void</span>
  154. )</div>
  155. <div class="methodsynopsis dc-description">
  156. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.isoptions.html" class="methodname">isOptions</a></span>
  157. ( <span class="methodparam">void</span>
  158. )</div>
  159. <div class="methodsynopsis dc-description">
  160. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.ispost.html" class="methodname">isPost</a></span>
  161. ( <span class="methodparam">void</span>
  162. )</div>
  163. <div class="methodsynopsis dc-description">
  164. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.isput.html" class="methodname">isPut</a></span>
  165. ( <span class="methodparam">void</span>
  166. )</div>
  167. <div class="methodsynopsis dc-description">
  168. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.isrouted.html" class="methodname">isRouted</a></span>
  169. ( <span class="methodparam">void</span>
  170. )</div>
  171. <div class="methodsynopsis dc-description">
  172. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.isxmlhttprequest.html" class="methodname">isXmlHttpRequest</a></span>
  173. ( <span class="methodparam">void</span>
  174. )</div>
  175. <div class="methodsynopsis dc-description">
  176. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.setactionname.html" class="methodname">setActionName</a></span>
  177. ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$action</code></span>
  178. )</div>
  179. <div class="methodsynopsis dc-description">
  180. <span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="yaf-request-abstract.setbaseuri.html" class="methodname">setBaseUri</a></span>
  181. ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$uir</code></span>
  182. )</div>
  183. <div class="methodsynopsis dc-description">
  184. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.setcontrollername.html" class="methodname">setControllerName</a></span>
  185. ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$controller</code></span>
  186. )</div>
  187. <div class="methodsynopsis dc-description">
  188. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.setdispatched.html" class="methodname">setDispatched</a></span>
  189. ( <span class="methodparam">void</span>
  190. )</div>
  191. <div class="methodsynopsis dc-description">
  192. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.setmodulename.html" class="methodname">setModuleName</a></span>
  193. ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$module</code></span>
  194. )</div>
  195. <div class="methodsynopsis dc-description">
  196. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.setparam.html" class="methodname">setParam</a></span>
  197. ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span>
  198. [, <span class="methodparam"><span class="type">string</span> <code class="parameter">$value</code></span>
  199. ] )</div>
  200. <div class="methodsynopsis dc-description">
  201. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.setrequesturi.html" class="methodname">setRequestUri</a></span>
  202. ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$uir</code></span>
  203. )</div>
  204. <div class="methodsynopsis dc-description">
  205. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.setrouted.html" class="methodname">setRouted</a></span>
  206. ([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$flag</code></span>
  207. ] )</div>
  208. }</div>
  209. </div>
  210. <div class="section" id="yaf-request-abstract.props">
  211. <h2 class="title">属性</h2>
  212. <dl>
  213. <dt id="yaf-request-abstract.props.module">
  214. <span class="term"><var class="varname"><var class="varname">module</var></var></span>
  215. <dd>
  216. <p class="para"/>
  217. </dd>
  218. </dt>
  219. <dt id="yaf-request-abstract.props.controller">
  220. <span class="term"><var class="varname"><var class="varname">controller</var></var></span>
  221. <dd>
  222. <p class="para"/>
  223. </dd>
  224. </dt>
  225. <dt id="yaf-request-abstract.props.action">
  226. <span class="term"><var class="varname"><var class="varname">action</var></var></span>
  227. <dd>
  228. <p class="para"/>
  229. </dd>
  230. </dt>
  231. <dt id="yaf-request-abstract.props.method">
  232. <span class="term"><var class="varname"><var class="varname">method</var></var></span>
  233. <dd>
  234. <p class="para"/>
  235. </dd>
  236. </dt>
  237. <dt id="yaf-request-abstract.props.params">
  238. <span class="term"><var class="varname"><var class="varname">params</var></var></span>
  239. <dd>
  240. <p class="para"/>
  241. </dd>
  242. </dt>
  243. <dt id="yaf-request-abstract.props.language">
  244. <span class="term"><var class="varname"><var class="varname">language</var></var></span>
  245. <dd>
  246. <p class="para"/>
  247. </dd>
  248. </dt>
  249. <dt id="yaf-request-abstract.props.exception">
  250. <span class="term"><var class="varname"><var class="varname">_exception</var></var></span>
  251. <dd>
  252. <p class="para"/>
  253. </dd>
  254. </dt>
  255. <dt id="yaf-request-abstract.props.base-uri">
  256. <span class="term"><var class="varname"><var class="varname">_base_uri</var></var></span>
  257. <dd>
  258. <p class="para"/>
  259. </dd>
  260. </dt>
  261. <dt id="yaf-request-abstract.props.uri">
  262. <span class="term"><var class="varname"><var class="varname">uri</var></var></span>
  263. <dd>
  264. <p class="para"/>
  265. </dd>
  266. </dt>
  267. <dt id="yaf-request-abstract.props.dispatched">
  268. <span class="term"><var class="varname"><var class="varname">dispatched</var></var></span>
  269. <dd>
  270. <p class="para"/>
  271. </dd>
  272. </dt>
  273. <dt id="yaf-request-abstract.props.routed">
  274. <span class="term"><var class="varname"><var class="varname">routed</var></var></span>
  275. <dd>
  276. <p class="para"/>
  277. </dd>
  278. </dt>
  279. </dl>
  280. </div>
  281. <div class="section" id="yaf-request-abstract.constants">
  282. <h2 class="title">预定义常量</h2>
  283. <dl>
  284. <dt id="yaf-request-abstract.constants.scheme-http">
  285. <span class="term"><strong><code>Yaf_Request_Abstract::SCHEME_HTTP</code></strong></span>
  286. <dd>
  287. <p class="para"/>
  288. </dd>
  289. </dt>
  290. <dt id="yaf-request-abstract.constants.scheme-https">
  291. <span class="term"><strong><code>Yaf_Request_Abstract::SCHEME_HTTPS</code></strong></span>
  292. <dd>
  293. <p class="para"/>
  294. </dd>
  295. </dt>
  296. </dl>
  297. </div>
  298. </div>
  299. <h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="yaf-request-abstract.getactionname.html">Yaf_Request_Abstract::getActionName</a> The getActionName purpose</li><li><a href="yaf-request-abstract.getbaseuri.html">Yaf_Request_Abstract::getBaseUri</a> The getBaseUri purpose</li><li><a href="yaf-request-abstract.getcontrollername.html">Yaf_Request_Abstract::getControllerName</a> The getControllerName purpose</li><li><a href="yaf-request-abstract.getenv.html">Yaf_Request_Abstract::getEnv</a> Retrieve ENV varialbe</li><li><a href="yaf-request-abstract.getexception.html">Yaf_Request_Abstract::getException</a> The getException purpose</li><li><a href="yaf-request-abstract.getlanguage.html">Yaf_Request_Abstract::getLanguage</a> The getLanguage purpose</li><li><a href="yaf-request-abstract.getmethod.html">Yaf_Request_Abstract::getMethod</a> The getMethod purpose</li><li><a href="yaf-request-abstract.getmodulename.html">Yaf_Request_Abstract::getModuleName</a> The getModuleName purpose</li><li><a href="yaf-request-abstract.getparam.html">Yaf_Request_Abstract::getParam</a> The getParam purpose</li><li><a href="yaf-request-abstract.getparams.html">Yaf_Request_Abstract::getParams</a> The getParams purpose</li><li><a href="yaf-request-abstract.getrequesturi.html">Yaf_Request_Abstract::getRequestUri</a> The getRequestUri purpose</li><li><a href="yaf-request-abstract.getserver.html">Yaf_Request_Abstract::getServer</a> Retrieve SERVER variable</li><li><a href="yaf-request-abstract.iscli.html">Yaf_Request_Abstract::isCli</a> The isCli purpose</li><li><a href="yaf-request-abstract.isdispatched.html">Yaf_Request_Abstract::isDispatched</a> The isDispatched purpose</li><li><a href="yaf-request-abstract.isget.html">Yaf_Request_Abstract::isGet</a> The isGet purpose</li><li><a href="yaf-request-abstract.ishead.html">Yaf_Request_Abstract::isHead</a> The isHead purpose</li><li><a href="yaf-request-abstract.isoptions.html">Yaf_Request_Abstract::isOptions</a> The isOptions purpose</li><li><a href="yaf-request-abstract.ispost.html">Yaf_Request_Abstract::isPost</a> The isPost purpose</li><li><a href="yaf-request-abstract.isput.html">Yaf_Request_Abstract::isPut</a> The isPut purpose</li><li><a href="yaf-request-abstract.isrouted.html">Yaf_Request_Abstract::isRouted</a> The isRouted purpose</li><li><a href="yaf-request-abstract.isxmlhttprequest.html">Yaf_Request_Abstract::isXmlHttpRequest</a> The isXmlHttpRequest purpose</li><li><a href="yaf-request-abstract.setactionname.html">Yaf_Request_Abstract::setActionName</a> The setActionName purpose</li><li><a href="yaf-request-abstract.setbaseuri.html">Yaf_Request_Abstract::setBaseUri</a> set base URI</li><li><a href="yaf-request-abstract.setcontrollername.html">Yaf_Request_Abstract::setControllerName</a> The setControllerName purpose</li><li><a href="yaf-request-abstract.setdispatched.html">Yaf_Request_Abstract::setDispatched</a> The setDispatched purpose</li><li><a href="yaf-request-abstract.setmodulename.html">Yaf_Request_Abstract::setModuleName</a> The setModuleName purpose</li><li><a href="yaf-request-abstract.setparam.html">Yaf_Request_Abstract::setParam</a> The setParam purpose</li><li><a href="yaf-request-abstract.setrequesturi.html">Yaf_Request_Abstract::setRequestUri</a> The setRequestUri purpose</li><li><a href="yaf-request-abstract.setrouted.html">Yaf_Request_Abstract::setRouted</a> The setRouted purpose</li></ul>
  300. </div>
  301. <hr /><div class="manualnavbar" style="text-align: center;">
  302. <div class="prev" style="text-align: left; float: left;"><a href="yaf-registry.set.html">Yaf_Registry::set</a></div>
  303. <div class="next" style="text-align: right; float: right;"><a href="yaf-request-abstract.getactionname.html">Yaf_Request_Abstract::getActionName</a></div>
  304. <div class="up"><a href="book.yaf.html">Yaf</a></div>
  305. <div class="home"><a href="index.html">PHP Manual</a></div>
  306. </div></body></html>