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

https://bitbucket.org/thncr/manuals · HTML · 452 lines · 305 code · 147 blank · 0 comment · 0 complexity · 1b8d443e74ab3074eaa86c940bfb8c36 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_Simple 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-http.isxmlhttprequest.html">Yaf_Request_Http::isXmlHttpRequest</a></div>
  9. <div class="next" style="text-align: right; float: right;"><a href="yaf-request-simple.clone.html">Yaf_Request_Simple::__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-simple" class="reference">
  13. <h1 class="title">The Yaf_Request_Simple 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-simple.intro">
  16. <h2 class="title">简介</h2>
  17. <p class="para">
  18. <strong class="classname">Yaf_Request_Simple</strong> is particularlly used for test
  19. puporse. ie. simulate some espacial request under CLI mode.
  20. </p>
  21. </div>
  22. <div class="section" id="yaf-request-simple.synopsis">
  23. <h2 class="title">类摘要</h2>
  24. <div class="classsynopsis">
  25. <div class="ooclass"></div>
  26. <div class="classsynopsisinfo">
  27. <span class="ooclass">
  28. <strong class="classname">Yaf_Request_Simple</strong>
  29. </span>
  30. <span class="ooclass">
  31. <span class="modifier">extends</span>
  32. <a href="class.yaf-request-abstract.html" class="classname">Yaf_Request_Abstract</a>
  33. </span>
  34. {</div>
  35. <div class="classsynopsisinfo classsynopsisinfo_comment">/* Constants */</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-simple.html#yaf-request-simple.constants.scheme-http"><var class="varname">SCHEME_HTTP</var></a></var>
  40. <span class="initializer"> = http</span>
  41. ;</div>
  42. <div class="fieldsynopsis">
  43. <span class="modifier">const</span>
  44. <span class="type">string</span>
  45. <var class="fieldsynopsis_varname"><a href="class.yaf-request-simple.html#yaf-request-simple.constants.scheme-https"><var class="varname">SCHEME_HTTPS</var></a></var>
  46. <span class="initializer"> = https</span>
  47. ;</div>
  48. <div class="classsynopsisinfo classsynopsisinfo_comment">/* 属性 */</div>
  49. <div class="classsynopsisinfo classsynopsisinfo_comment">/* 方法 */</div>
  50. <div class="methodsynopsis dc-description">
  51. <span class="modifier">private</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-simple.clone.html" class="methodname">__clone</a></span>
  52. ( <span class="methodparam">void</span>
  53. )</div>
  54. <div class="methodsynopsis dc-description">
  55. <span class="methodname"><a href="yaf-request-simple.construct.html" class="methodname">__construct</a></span>
  56. ( <span class="methodparam">void</span>
  57. )</div>
  58. <div class="methodsynopsis dc-description">
  59. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-simple.get.html" class="methodname">get</a></span>
  60. ( <span class="methodparam">void</span>
  61. )</div>
  62. <div class="methodsynopsis dc-description">
  63. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-simple.getcookie.html" class="methodname">getCookie</a></span>
  64. ( <span class="methodparam">void</span>
  65. )</div>
  66. <div class="methodsynopsis dc-description">
  67. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-simple.getfiles.html" class="methodname">getFiles</a></span>
  68. ( <span class="methodparam">void</span>
  69. )</div>
  70. <div class="methodsynopsis dc-description">
  71. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-simple.getpost.html" class="methodname">getPost</a></span>
  72. ( <span class="methodparam">void</span>
  73. )</div>
  74. <div class="methodsynopsis dc-description">
  75. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-simple.getquery.html" class="methodname">getQuery</a></span>
  76. ( <span class="methodparam">void</span>
  77. )</div>
  78. <div class="methodsynopsis dc-description">
  79. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-simple.getrequest.html" class="methodname">getRequest</a></span>
  80. ( <span class="methodparam">void</span>
  81. )</div>
  82. <div class="methodsynopsis dc-description">
  83. <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-simple.isxmlhttprequest.html" class="methodname">isXmlHttpRequest</a></span>
  84. ( <span class="methodparam">void</span>
  85. )</div>
  86. <div class="classsynopsisinfo classsynopsisinfo_comment">/* 继承的方法 */</div>
  87. <div class="methodsynopsis dc-description">
  88. <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>
  89. ( <span class="methodparam">void</span>
  90. )</div>
  91. <div class="methodsynopsis dc-description">
  92. <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>
  93. ( <span class="methodparam">void</span>
  94. )</div>
  95. <div class="methodsynopsis dc-description">
  96. <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>
  97. ( <span class="methodparam">void</span>
  98. )</div>
  99. <div class="methodsynopsis dc-description">
  100. <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>
  101. ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span>
  102. [, <span class="methodparam"><span class="type">string</span> <code class="parameter">$default</code></span>
  103. ] )</div>
  104. <div class="methodsynopsis dc-description">
  105. <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>
  106. ( <span class="methodparam">void</span>
  107. )</div>
  108. <div class="methodsynopsis dc-description">
  109. <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>
  110. ( <span class="methodparam">void</span>
  111. )</div>
  112. <div class="methodsynopsis dc-description">
  113. <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>
  114. ( <span class="methodparam">void</span>
  115. )</div>
  116. <div class="methodsynopsis dc-description">
  117. <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>
  118. ( <span class="methodparam">void</span>
  119. )</div>
  120. <div class="methodsynopsis dc-description">
  121. <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>
  122. ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span>
  123. [, <span class="methodparam"><span class="type">string</span> <code class="parameter">$default</code></span>
  124. ] )</div>
  125. <div class="methodsynopsis dc-description">
  126. <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>
  127. ( <span class="methodparam">void</span>
  128. )</div>
  129. <div class="methodsynopsis dc-description">
  130. <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>
  131. ( <span class="methodparam">void</span>
  132. )</div>
  133. <div class="methodsynopsis dc-description">
  134. <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>
  135. ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span>
  136. [, <span class="methodparam"><span class="type">string</span> <code class="parameter">$default</code></span>
  137. ] )</div>
  138. <div class="methodsynopsis dc-description">
  139. <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>
  140. ( <span class="methodparam">void</span>
  141. )</div>
  142. <div class="methodsynopsis dc-description">
  143. <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>
  144. ( <span class="methodparam">void</span>
  145. )</div>
  146. <div class="methodsynopsis dc-description">
  147. <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>
  148. ( <span class="methodparam">void</span>
  149. )</div>
  150. <div class="methodsynopsis dc-description">
  151. <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>
  152. ( <span class="methodparam">void</span>
  153. )</div>
  154. <div class="methodsynopsis dc-description">
  155. <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>
  156. ( <span class="methodparam">void</span>
  157. )</div>
  158. <div class="methodsynopsis dc-description">
  159. <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>
  160. ( <span class="methodparam">void</span>
  161. )</div>
  162. <div class="methodsynopsis dc-description">
  163. <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>
  164. ( <span class="methodparam">void</span>
  165. )</div>
  166. <div class="methodsynopsis dc-description">
  167. <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>
  168. ( <span class="methodparam">void</span>
  169. )</div>
  170. <div class="methodsynopsis dc-description">
  171. <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>
  172. ( <span class="methodparam">void</span>
  173. )</div>
  174. <div class="methodsynopsis dc-description">
  175. <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>
  176. ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$action</code></span>
  177. )</div>
  178. <div class="methodsynopsis dc-description">
  179. <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>
  180. ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$uir</code></span>
  181. )</div>
  182. <div class="methodsynopsis dc-description">
  183. <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>
  184. ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$controller</code></span>
  185. )</div>
  186. <div class="methodsynopsis dc-description">
  187. <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>
  188. ( <span class="methodparam">void</span>
  189. )</div>
  190. <div class="methodsynopsis dc-description">
  191. <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>
  192. ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$module</code></span>
  193. )</div>
  194. <div class="methodsynopsis dc-description">
  195. <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>
  196. ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span>
  197. [, <span class="methodparam"><span class="type">string</span> <code class="parameter">$value</code></span>
  198. ] )</div>
  199. <div class="methodsynopsis dc-description">
  200. <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>
  201. ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$uir</code></span>
  202. )</div>
  203. <div class="methodsynopsis dc-description">
  204. <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>
  205. ([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$flag</code></span>
  206. ] )</div>
  207. }</div>
  208. </div>
  209. <div class="section" id="yaf-request-simple.props">
  210. <h2 class="title">属性</h2>
  211. <dl>
  212. <dt id="yaf-request-simple.props.module">
  213. <span class="term"><var class="varname"><var class="varname">module</var></var></span>
  214. <dd>
  215. <p class="para"/>
  216. </dd>
  217. </dt>
  218. <dt id="yaf-request-simple.props.controller">
  219. <span class="term"><var class="varname"><var class="varname">controller</var></var></span>
  220. <dd>
  221. <p class="para"/>
  222. </dd>
  223. </dt>
  224. <dt id="yaf-request-simple.props.action">
  225. <span class="term"><var class="varname"><var class="varname">action</var></var></span>
  226. <dd>
  227. <p class="para"/>
  228. </dd>
  229. </dt>
  230. <dt id="yaf-request-simple.props.method">
  231. <span class="term"><var class="varname"><var class="varname">method</var></var></span>
  232. <dd>
  233. <p class="para"/>
  234. </dd>
  235. </dt>
  236. <dt id="yaf-request-simple.props.params">
  237. <span class="term"><var class="varname"><var class="varname">params</var></var></span>
  238. <dd>
  239. <p class="para"/>
  240. </dd>
  241. </dt>
  242. <dt id="yaf-request-simple.props.language">
  243. <span class="term"><var class="varname"><var class="varname">language</var></var></span>
  244. <dd>
  245. <p class="para"/>
  246. </dd>
  247. </dt>
  248. <dt id="yaf-request-simple.props.exception">
  249. <span class="term"><var class="varname"><var class="varname">_exception</var></var></span>
  250. <dd>
  251. <p class="para"/>
  252. </dd>
  253. </dt>
  254. <dt id="yaf-request-simple.props.base-uri">
  255. <span class="term"><var class="varname"><var class="varname">_base_uri</var></var></span>
  256. <dd>
  257. <p class="para"/>
  258. </dd>
  259. </dt>
  260. <dt id="yaf-request-simple.props.uri">
  261. <span class="term"><var class="varname"><var class="varname">uri</var></var></span>
  262. <dd>
  263. <p class="para"/>
  264. </dd>
  265. </dt>
  266. <dt id="yaf-request-simple.props.dispatched">
  267. <span class="term"><var class="varname"><var class="varname">dispatched</var></var></span>
  268. <dd>
  269. <p class="para"/>
  270. </dd>
  271. </dt>
  272. <dt id="yaf-request-simple.props.routed">
  273. <span class="term"><var class="varname"><var class="varname">routed</var></var></span>
  274. <dd>
  275. <p class="para"/>
  276. </dd>
  277. </dt>
  278. </dl>
  279. </div>
  280. <div class="section" id="yaf-request-simple.constants">
  281. <h2 class="title">预定义常量</h2>
  282. <dl>
  283. <dt id="yaf-request-simple.constants.scheme-http">
  284. <span class="term"><strong><code>Yaf_Request_Simple::SCHEME_HTTP</code></strong></span>
  285. <dd>
  286. <p class="para"/>
  287. </dd>
  288. </dt>
  289. <dt id="yaf-request-simple.constants.scheme-https">
  290. <span class="term"><strong><code>Yaf_Request_Simple::SCHEME_HTTPS</code></strong></span>
  291. <dd>
  292. <p class="para"/>
  293. </dd>
  294. </dt>
  295. </dl>
  296. </div>
  297. </div>
  298. <h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="yaf-request-simple.clone.html">Yaf_Request_Simple::__clone</a> The __clone purpose</li><li><a href="yaf-request-simple.construct.html">Yaf_Request_Simple::__construct</a> The __construct purpose</li><li><a href="yaf-request-simple.get.html">Yaf_Request_Simple::get</a> The get purpose</li><li><a href="yaf-request-simple.getcookie.html">Yaf_Request_Simple::getCookie</a> The getCookie purpose</li><li><a href="yaf-request-simple.getfiles.html">Yaf_Request_Simple::getFiles</a> The getFiles purpose</li><li><a href="yaf-request-simple.getpost.html">Yaf_Request_Simple::getPost</a> The getPost purpose</li><li><a href="yaf-request-simple.getquery.html">Yaf_Request_Simple::getQuery</a> The getQuery purpose</li><li><a href="yaf-request-simple.getrequest.html">Yaf_Request_Simple::getRequest</a> The getRequest purpose</li><li><a href="yaf-request-simple.isxmlhttprequest.html">Yaf_Request_Simple::isXmlHttpRequest</a> The isXmlHttpRequest purpose</li></ul>
  299. </div>
  300. <hr /><div class="manualnavbar" style="text-align: center;">
  301. <div class="prev" style="text-align: left; float: left;"><a href="yaf-request-http.isxmlhttprequest.html">Yaf_Request_Http::isXmlHttpRequest</a></div>
  302. <div class="next" style="text-align: right; float: right;"><a href="yaf-request-simple.clone.html">Yaf_Request_Simple::__clone</a></div>
  303. <div class="up"><a href="book.yaf.html">Yaf</a></div>
  304. <div class="home"><a href="index.html">PHP Manual</a></div>
  305. </div></body></html>