XSErrorException.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/html; charset=gbk" />
  5. <meta name="language" content="zh-cn" />
  6. <link rel="stylesheet" type="text/css" href="css/style.css" />
  7. <link rel="stylesheet" type="text/css" href="css/api.css" />
  8. <script type="text/javascript" src="js/jquery.js"></script>
  9. <title>XSErrorException</title>
  10. </head>
  11. <body>
  12. <div id="apiPage">
  13. <div id="apiHeader">
  14. <a href="http://www.xunsearch.com" target="_blank">Xunsearch PHP-SDK</a> v1.3.2 API 参考文档
  15. </div><!-- end of header -->
  16. <div id="content" class="api-index">
  17. <h1>XSErrorException</h1>
  18. <div id="nav">
  19. <a href="index.html">All Packages</a>
  20. | <a href="#properties">属性</a>
  21. | <a href="#methods">方法(函数)</a>
  22. </div>
  23. <table class="summaryTable docClass">
  24. <colgroup>
  25. <col class="col-name" />
  26. <col class="col-value" />
  27. </colgroup>
  28. <tr>
  29. <th>包</th>
  30. <td><a href="index.html#XS">XS</a></td>
  31. </tr>
  32. <tr>
  33. <th>继承关系</th>
  34. <td>class XSErrorException &raquo;
  35. <a href="XSException.html">XSException</a> &raquo;
  36. Exception</td>
  37. </tr>
  38. <tr>
  39. <th>版本</th>
  40. <td>1.0.0</td>
  41. </tr>
  42. <tr>
  43. <th>源代码</th>
  44. <td><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XS.class.php">sdk/php/lib/XS.class.php</a></td>
  45. </tr>
  46. </table>
  47. <div id="classDescription">
  48. XS 错误异常类定义, XS 所有操作过程发生错误均抛出该实例</div>
  49. <a name="properties"></a>
  50. <div class="summary docProperty">
  51. <h2>Protected 属性</h2>
  52. <p><a href="#" class="toggle">隐去继承来的属性</a></p>
  53. <table class="summaryTable">
  54. <colgroup>
  55. <col class="col-property" />
  56. <col class="col-type" />
  57. <col class="col-description" />
  58. <col class="col-defined" />
  59. </colgroup>
  60. <tr>
  61. <th>名称</th><th>类型</th><th>描述</th><th>定义于</th>
  62. </tr>
  63. <tr class="inherited" id="code">
  64. <td>code</td>
  65. <td></td>
  66. <td></td>
  67. <td>Exception</td>
  68. </tr>
  69. <tr class="inherited" id="file">
  70. <td>file</td>
  71. <td></td>
  72. <td></td>
  73. <td>Exception</td>
  74. </tr>
  75. <tr class="inherited" id="line">
  76. <td>line</td>
  77. <td></td>
  78. <td></td>
  79. <td>Exception</td>
  80. </tr>
  81. <tr class="inherited" id="message">
  82. <td>message</td>
  83. <td></td>
  84. <td></td>
  85. <td>Exception</td>
  86. </tr>
  87. </table>
  88. </div>
  89. <a name="methods"></a>
  90. <div class="summary docMethod">
  91. <h2>Public 方法</h2>
  92. <p><a href="#" class="toggle">隐去继承来的方法</a></p>
  93. <table class="summaryTable">
  94. <colgroup>
  95. <col class="col-method" />
  96. <col class="col-description" />
  97. <col class="col-defined" />
  98. </colgroup>
  99. <tr>
  100. <th>名称</th><th>描述</th><th>定义于</th>
  101. </tr>
  102. <tr id="__construct">
  103. <td><a href="XSErrorException.html#__construct-detail">__construct()</a></td>
  104. <td>构造函数</td>
  105. <td>XSErrorException</td>
  106. </tr>
  107. <tr id="__toString">
  108. <td><a href="XSErrorException.html#__toString-detail">__toString()</a></td>
  109. <td>将类对象转换成字符串</td>
  110. <td>XSErrorException</td>
  111. </tr>
  112. <tr class="inherited" id="getCode">
  113. <td>getCode()</td>
  114. <td></td>
  115. <td>Exception</td>
  116. </tr>
  117. <tr class="inherited" id="getFile">
  118. <td>getFile()</td>
  119. <td></td>
  120. <td>Exception</td>
  121. </tr>
  122. <tr class="inherited" id="getLine">
  123. <td>getLine()</td>
  124. <td></td>
  125. <td>Exception</td>
  126. </tr>
  127. <tr class="inherited" id="getMessage">
  128. <td>getMessage()</td>
  129. <td></td>
  130. <td>Exception</td>
  131. </tr>
  132. <tr class="inherited" id="getPrevious">
  133. <td>getPrevious()</td>
  134. <td></td>
  135. <td>Exception</td>
  136. </tr>
  137. <tr class="inherited" id="getRelPath">
  138. <td><a href="XSException.html#getRelPath-detail">getRelPath()</a></td>
  139. <td>取得相对当前的文件路径</td>
  140. <td><a href="XSException.html">XSException</a></td>
  141. </tr>
  142. <tr class="inherited" id="getTrace">
  143. <td>getTrace()</td>
  144. <td></td>
  145. <td>Exception</td>
  146. </tr>
  147. <tr class="inherited" id="getTraceAsString">
  148. <td>getTraceAsString()</td>
  149. <td></td>
  150. <td>Exception</td>
  151. </tr>
  152. </table>
  153. </div>
  154. <a name="events"></a>
  155. <h2>方法明细</h2>
  156. <div class="detailHeader" id="__construct-detail">
  157. __construct()
  158. <span class="detailHeaderTag">
  159. 方法
  160. </span>
  161. </div>
  162. <table class="summaryTable">
  163. <tr><td colspan="3">
  164. <div class="signature2">
  165. public void <b>__construct</b>(int $code, string $message, string $file, int $line, Exception $previous=NULL)</div>
  166. </td></tr>
  167. <tr>
  168. <td class="paramNameCol">$code</td>
  169. <td class="paramTypeCol">int</td>
  170. <td class="paramDescCol">出错代码</td>
  171. </tr>
  172. <tr>
  173. <td class="paramNameCol">$message</td>
  174. <td class="paramTypeCol">string</td>
  175. <td class="paramDescCol">出错信息</td>
  176. </tr>
  177. <tr>
  178. <td class="paramNameCol">$file</td>
  179. <td class="paramTypeCol">string</td>
  180. <td class="paramDescCol">出错所在文件</td>
  181. </tr>
  182. <tr>
  183. <td class="paramNameCol">$line</td>
  184. <td class="paramTypeCol">int</td>
  185. <td class="paramDescCol">出错所在的行数</td>
  186. </tr>
  187. <tr>
  188. <td class="paramNameCol">$previous</td>
  189. <td class="paramTypeCol">Exception</td>
  190. <td class="paramDescCol"></td>
  191. </tr>
  192. </table>
  193. <div class="sourceCode">
  194. <b>源码:</b> <a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XS.class.php#L137">sdk/php/lib/XS.class.php#L137</a> (<b><a href="#" class="show">显示</a></b>)
  195. <div class="code"><code><span style="color: #000000">
  196. <span style="color: #0000BB"></span><span style="color: #007700">public&nbsp;function&nbsp;</span><span style="color: #0000BB">__construct</span><span style="color: #007700">(</span><span style="color: #0000BB">$code</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$message</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$file</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$line</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$previous&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">null</span><span style="color: #007700">)<br />{<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$this</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">_file&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">$file</span><span style="color: #007700">;<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$this</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">_line&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">$line</span><span style="color: #007700">;<br />&nbsp;&nbsp;&nbsp;&nbsp;if&nbsp;(</span><span style="color: #0000BB">version_compare</span><span style="color: #007700">(</span><span style="color: #0000BB">PHP_VERSION</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">'5.3.0'</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">'&gt;='</span><span style="color: #007700">))<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">parent</span><span style="color: #007700">::</span><span style="color: #0000BB">__construct</span><span style="color: #007700">(</span><span style="color: #0000BB">$message</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$code</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$previous</span><span style="color: #007700">);<br />&nbsp;&nbsp;&nbsp;&nbsp;else<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">parent</span><span style="color: #007700">::</span><span style="color: #0000BB">__construct</span><span style="color: #007700">(</span><span style="color: #0000BB">$message</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$code</span><span style="color: #007700">);<br />}</span>
  197. </span>
  198. </code></div>
  199. </div>
  200. <p>构造函数
  201. 将 $file, $line 记录到私有属性在 __toString 中使用</p>
  202. <div class="detailHeader" id="__toString-detail">
  203. __toString()
  204. <span class="detailHeaderTag">
  205. 方法
  206. </span>
  207. </div>
  208. <table class="summaryTable">
  209. <tr><td colspan="3">
  210. <div class="signature2">
  211. public string <b>__toString</b>()</div>
  212. </td></tr>
  213. <tr>
  214. <td class="paramNameCol">{return}</td>
  215. <td class="paramTypeCol">string</td>
  216. <td class="paramDescCol">异常的简要描述信息</td>
  217. </tr>
  218. </table>
  219. <div class="sourceCode">
  220. <b>源码:</b> <a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XS.class.php#L151">sdk/php/lib/XS.class.php#L151</a> (<b><a href="#" class="show">显示</a></b>)
  221. <div class="code"><code><span style="color: #000000">
  222. <span style="color: #0000BB"></span><span style="color: #007700">public&nbsp;function&nbsp;</span><span style="color: #0000BB">__toString</span><span style="color: #007700">()<br />{<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$string&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #DD0000">'['&nbsp;</span><span style="color: #007700">.&nbsp;</span><span style="color: #0000BB">__CLASS__&nbsp;</span><span style="color: #007700">.&nbsp;</span><span style="color: #DD0000">']&nbsp;'&nbsp;</span><span style="color: #007700">.&nbsp;</span><span style="color: #0000BB">$this</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getRelPath</span><span style="color: #007700">(</span><span style="color: #0000BB">$this</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">_file</span><span style="color: #007700">)&nbsp;.&nbsp;</span><span style="color: #DD0000">'('&nbsp;</span><span style="color: #007700">.&nbsp;</span><span style="color: #0000BB">$this</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">_line&nbsp;</span><span style="color: #007700">.&nbsp;</span><span style="color: #DD0000">'):&nbsp;'</span><span style="color: #007700">;<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$string&nbsp;</span><span style="color: #007700">.=&nbsp;</span><span style="color: #0000BB">$this</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getMessage</span><span style="color: #007700">()&nbsp;.&nbsp;</span><span style="color: #DD0000">'('&nbsp;</span><span style="color: #007700">.&nbsp;</span><span style="color: #0000BB">$this</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getCode</span><span style="color: #007700">()&nbsp;.&nbsp;</span><span style="color: #DD0000">')'</span><span style="color: #007700">;<br />&nbsp;&nbsp;&nbsp;&nbsp;return&nbsp;</span><span style="color: #0000BB">$string</span><span style="color: #007700">;<br />}</span>
  223. </span>
  224. </code></div>
  225. </div>
  226. <p>将类对象转换成字符串</p>
  227. </div><!-- end of content -->
  228. <div id="apiFooter">
  229. Copyright &copy; 2008-2011 by <a href="http://www.xunsearch.com" target="_blank">杭州云圣网络科技有限公司</a><br/>
  230. All Rights Reserved.<br/>
  231. </div><!-- end of footer -->
  232. <script type="text/javascript">
  233. /*<![CDATA[*/
  234. $("a.toggle").toggle(function(){
  235. $(this).text($(this).text().replace(/Hide/,'Show'));
  236. $(this).parents(".summary").find(".inherited").hide();
  237. },function(){
  238. $(this).text($(this).text().replace(/Show/,'Hide'));
  239. $(this).parents(".summary").find(".inherited").show();
  240. });
  241. $(".sourceCode a.show").toggle(function(){
  242. $(this).text($(this).text().replace(/show/,'hide'));
  243. $(this).parents(".sourceCode").find("div.code").show();
  244. },function(){
  245. $(this).text($(this).text().replace(/hide/,'show'));
  246. $(this).parents(".sourceCode").find("div.code").hide();
  247. });
  248. $("a.sourceLink").click(function(){
  249. $(this).attr('target','_blank');
  250. });
  251. /*]]>*/
  252. </script>
  253. </div><!-- end of page -->
  254. </body>
  255. </html>