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

https://bitbucket.org/thncr/manuals · HTML · 407 lines · 277 code · 130 blank · 0 comment · 0 complexity · bb2f3d1bf5bd9994caa8d4c9b05a9ebb 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_Http 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-request-abstract.setrouted.html">Yaf_Request_Abstract::setRouted</a></div>
  9. <div class="next" style="text-align: right; float: right;"><a href="yaf-request-http.clone.html">Yaf_Request_Http::__clone</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-http" class="reference">
  13. <h1 class="title">The Yaf_Request_Http 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-http.intro">
  16. <h2 class="title">简介</h2>
  17. <p class="para">
  18. </p>
  19. </div>
  20. <div class="section" id="yaf-request-http.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_Http</strong>
  27. </span>
  28. <span class="ooclass">
  29. <span class="modifier">extends</span>
  30. <a href="class.yaf-request-abstract.html" class="classname">Yaf_Request_Abstract</a>
  31. </span>
  32. {</div>
  33. <div class="classsynopsisinfo classsynopsisinfo_comment">/* 属性 */</div>
  34. <div class="classsynopsisinfo classsynopsisinfo_comment">/* 方法 */</div>
  35. <div class="methodsynopsis dc-description">
  36. <span class="modifier">private</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-http.clone.html" class="methodname">__clone</a></span>
  37. ( <span class="methodparam">void</span>
  38. )</div>
  39. <div class="methodsynopsis dc-description">
  40. <span class="methodname"><a href="yaf-request-http.construct.html" class="methodname">__construct</a></span>
  41. ( <span class="methodparam">void</span>
  42. )</div>
  43. <div class="methodsynopsis dc-description">
  44. <span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="yaf-request-http.get.html" class="methodname">get</a></span>
  45. ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span>
  46. [, <span class="methodparam"><span class="type">string</span> <code class="parameter">$default</code></span>
  47. ] )</div>
  48. <div class="methodsynopsis dc-description">
  49. <span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="yaf-request-http.getcookie.html" class="methodname">getCookie</a></span>
  50. ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span>
  51. [, <span class="methodparam"><span class="type">string</span> <code class="parameter">$default</code></span>
  52. ] )</div>
  53. <div class="methodsynopsis dc-description">
  54. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-http.getfiles.html" class="methodname">getFiles</a></span>
  55. ( <span class="methodparam">void</span>
  56. )</div>
  57. <div class="methodsynopsis dc-description">
  58. <span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="yaf-request-http.getpost.html" class="methodname">getPost</a></span>
  59. ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span>
  60. [, <span class="methodparam"><span class="type">string</span> <code class="parameter">$default</code></span>
  61. ] )</div>
  62. <div class="methodsynopsis dc-description">
  63. <span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="yaf-request-http.getquery.html" class="methodname">getQuery</a></span>
  64. ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span>
  65. [, <span class="methodparam"><span class="type">string</span> <code class="parameter">$default</code></span>
  66. ] )</div>
  67. <div class="methodsynopsis dc-description">
  68. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-http.getrequest.html" class="methodname">getRequest</a></span>
  69. ( <span class="methodparam">void</span>
  70. )</div>
  71. <div class="methodsynopsis dc-description">
  72. <span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="yaf-request-http.isxmlhttprequest.html" class="methodname">isXmlHttpRequest</a></span>
  73. ( <span class="methodparam">void</span>
  74. )</div>
  75. <div class="classsynopsisinfo classsynopsisinfo_comment">/* 继承的方法 */</div>
  76. <div class="methodsynopsis dc-description">
  77. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.getactionname.html" class="methodname">Yaf_Request_Abstract::getActionName</a></span>
  78. ( <span class="methodparam">void</span>
  79. )</div>
  80. <div class="methodsynopsis dc-description">
  81. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.getbaseuri.html" class="methodname">Yaf_Request_Abstract::getBaseUri</a></span>
  82. ( <span class="methodparam">void</span>
  83. )</div>
  84. <div class="methodsynopsis dc-description">
  85. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.getcontrollername.html" class="methodname">Yaf_Request_Abstract::getControllerName</a></span>
  86. ( <span class="methodparam">void</span>
  87. )</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.getenv.html" class="methodname">Yaf_Request_Abstract::getEnv</a></span>
  90. ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span>
  91. [, <span class="methodparam"><span class="type">string</span> <code class="parameter">$default</code></span>
  92. ] )</div>
  93. <div class="methodsynopsis dc-description">
  94. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.getexception.html" class="methodname">Yaf_Request_Abstract::getException</a></span>
  95. ( <span class="methodparam">void</span>
  96. )</div>
  97. <div class="methodsynopsis dc-description">
  98. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.getlanguage.html" class="methodname">Yaf_Request_Abstract::getLanguage</a></span>
  99. ( <span class="methodparam">void</span>
  100. )</div>
  101. <div class="methodsynopsis dc-description">
  102. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.getmethod.html" class="methodname">Yaf_Request_Abstract::getMethod</a></span>
  103. ( <span class="methodparam">void</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.getmodulename.html" class="methodname">Yaf_Request_Abstract::getModuleName</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.getparam.html" class="methodname">Yaf_Request_Abstract::getParam</a></span>
  111. ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span>
  112. [, <span class="methodparam"><span class="type">string</span> <code class="parameter">$default</code></span>
  113. ] )</div>
  114. <div class="methodsynopsis dc-description">
  115. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.getparams.html" class="methodname">Yaf_Request_Abstract::getParams</a></span>
  116. ( <span class="methodparam">void</span>
  117. )</div>
  118. <div class="methodsynopsis dc-description">
  119. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.getrequesturi.html" class="methodname">Yaf_Request_Abstract::getRequestUri</a></span>
  120. ( <span class="methodparam">void</span>
  121. )</div>
  122. <div class="methodsynopsis dc-description">
  123. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.getserver.html" class="methodname">Yaf_Request_Abstract::getServer</a></span>
  124. ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span>
  125. [, <span class="methodparam"><span class="type">string</span> <code class="parameter">$default</code></span>
  126. ] )</div>
  127. <div class="methodsynopsis dc-description">
  128. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.iscli.html" class="methodname">Yaf_Request_Abstract::isCli</a></span>
  129. ( <span class="methodparam">void</span>
  130. )</div>
  131. <div class="methodsynopsis dc-description">
  132. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.isdispatched.html" class="methodname">Yaf_Request_Abstract::isDispatched</a></span>
  133. ( <span class="methodparam">void</span>
  134. )</div>
  135. <div class="methodsynopsis dc-description">
  136. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.isget.html" class="methodname">Yaf_Request_Abstract::isGet</a></span>
  137. ( <span class="methodparam">void</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.ishead.html" class="methodname">Yaf_Request_Abstract::isHead</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.isoptions.html" class="methodname">Yaf_Request_Abstract::isOptions</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.ispost.html" class="methodname">Yaf_Request_Abstract::isPost</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.isput.html" class="methodname">Yaf_Request_Abstract::isPut</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.isrouted.html" class="methodname">Yaf_Request_Abstract::isRouted</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.isxmlhttprequest.html" class="methodname">Yaf_Request_Abstract::isXmlHttpRequest</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.setactionname.html" class="methodname">Yaf_Request_Abstract::setActionName</a></span>
  165. ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$action</code></span>
  166. )</div>
  167. <div class="methodsynopsis dc-description">
  168. <span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="yaf-request-abstract.setbaseuri.html" class="methodname">Yaf_Request_Abstract::setBaseUri</a></span>
  169. ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$uir</code></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.setcontrollername.html" class="methodname">Yaf_Request_Abstract::setControllerName</a></span>
  173. ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$controller</code></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.setdispatched.html" class="methodname">Yaf_Request_Abstract::setDispatched</a></span>
  177. ( <span class="methodparam">void</span>
  178. )</div>
  179. <div class="methodsynopsis dc-description">
  180. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.setmodulename.html" class="methodname">Yaf_Request_Abstract::setModuleName</a></span>
  181. ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$module</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.setparam.html" class="methodname">Yaf_Request_Abstract::setParam</a></span>
  185. ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span>
  186. [, <span class="methodparam"><span class="type">string</span> <code class="parameter">$value</code></span>
  187. ] )</div>
  188. <div class="methodsynopsis dc-description">
  189. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.setrequesturi.html" class="methodname">Yaf_Request_Abstract::setRequestUri</a></span>
  190. ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$uir</code></span>
  191. )</div>
  192. <div class="methodsynopsis dc-description">
  193. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.setrouted.html" class="methodname">Yaf_Request_Abstract::setRouted</a></span>
  194. ([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$flag</code></span>
  195. ] )</div>
  196. }</div>
  197. </div>
  198. <div class="section" id="yaf-request-http.props">
  199. <h2 class="title">属性</h2>
  200. <dl>
  201. <dt id="yaf-request-http.props.module">
  202. <span class="term"><var class="varname"><var class="varname">module</var></var></span>
  203. <dd>
  204. <p class="para"/>
  205. </dd>
  206. </dt>
  207. <dt id="yaf-request-http.props.controller">
  208. <span class="term"><var class="varname"><var class="varname">controller</var></var></span>
  209. <dd>
  210. <p class="para"/>
  211. </dd>
  212. </dt>
  213. <dt id="yaf-request-http.props.action">
  214. <span class="term"><var class="varname"><var class="varname">action</var></var></span>
  215. <dd>
  216. <p class="para"/>
  217. </dd>
  218. </dt>
  219. <dt id="yaf-request-http.props.method">
  220. <span class="term"><var class="varname"><var class="varname">method</var></var></span>
  221. <dd>
  222. <p class="para"/>
  223. </dd>
  224. </dt>
  225. <dt id="yaf-request-http.props.params">
  226. <span class="term"><var class="varname"><var class="varname">params</var></var></span>
  227. <dd>
  228. <p class="para"/>
  229. </dd>
  230. </dt>
  231. <dt id="yaf-request-http.props.language">
  232. <span class="term"><var class="varname"><var class="varname">language</var></var></span>
  233. <dd>
  234. <p class="para"/>
  235. </dd>
  236. </dt>
  237. <dt id="yaf-request-http.props.exception">
  238. <span class="term"><var class="varname"><var class="varname">_exception</var></var></span>
  239. <dd>
  240. <p class="para"/>
  241. </dd>
  242. </dt>
  243. <dt id="yaf-request-http.props.base-uri">
  244. <span class="term"><var class="varname"><var class="varname">_base_uri</var></var></span>
  245. <dd>
  246. <p class="para"/>
  247. </dd>
  248. </dt>
  249. <dt id="yaf-request-http.props.uri">
  250. <span class="term"><var class="varname"><var class="varname">uri</var></var></span>
  251. <dd>
  252. <p class="para"/>
  253. </dd>
  254. </dt>
  255. <dt id="yaf-request-http.props.dispatched">
  256. <span class="term"><var class="varname"><var class="varname">dispatched</var></var></span>
  257. <dd>
  258. <p class="para"/>
  259. </dd>
  260. </dt>
  261. <dt id="yaf-request-http.props.routed">
  262. <span class="term"><var class="varname"><var class="varname">routed</var></var></span>
  263. <dd>
  264. <p class="para"/>
  265. </dd>
  266. </dt>
  267. </dl>
  268. </div>
  269. </div>
  270. <h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="yaf-request-http.clone.html">Yaf_Request_Http::__clone</a> The __clone purpose</li><li><a href="yaf-request-http.construct.html">Yaf_Request_Http::__construct</a> The __construct purpose</li><li><a href="yaf-request-http.get.html">Yaf_Request_Http::get</a> Retrieve variable from client</li><li><a href="yaf-request-http.getcookie.html">Yaf_Request_Http::getCookie</a> Retrieve Cookie varialbe</li><li><a href="yaf-request-http.getfiles.html">Yaf_Request_Http::getFiles</a> The getFiles purpose</li><li><a href="yaf-request-http.getpost.html">Yaf_Request_Http::getPost</a> Retrieve POST variable</li><li><a href="yaf-request-http.getquery.html">Yaf_Request_Http::getQuery</a> Fetch a query parameter</li><li><a href="yaf-request-http.getrequest.html">Yaf_Request_Http::getRequest</a> The getRequest purpose</li><li><a href="yaf-request-http.isxmlhttprequest.html">Yaf_Request_Http::isXmlHttpRequest</a> Whether a Ajax Request</li></ul>
  271. </div>
  272. <hr /><div class="manualnavbar" style="text-align: center;">
  273. <div class="prev" style="text-align: left; float: left;"><a href="yaf-request-abstract.setrouted.html">Yaf_Request_Abstract::setRouted</a></div>
  274. <div class="next" style="text-align: right; float: right;"><a href="yaf-request-http.clone.html">Yaf_Request_Http::__clone</a></div>
  275. <div class="up"><a href="book.yaf.html">Yaf</a></div>
  276. <div class="home"><a href="index.html">PHP Manual</a></div>
  277. </div></body></html>