XSException.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271
  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>XSException</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>XSException</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 XSException &raquo;
  35. Exception</td>
  36. </tr>
  37. <tr>
  38. <th>子类</th>
  39. <td><a href="XSErrorException.html">XSErrorException</a></td>
  40. </tr>
  41. <tr>
  42. <th>版本</th>
  43. <td>1.0.0</td>
  44. </tr>
  45. <tr>
  46. <th>源代码</th>
  47. <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>
  48. </tr>
  49. </table>
  50. <div id="classDescription">
  51. XS 异常类定义, XS 所有操作过程发生异常均抛出该实例</div>
  52. <a name="properties"></a>
  53. <div class="summary docProperty">
  54. <h2>Protected 属性</h2>
  55. <p><a href="#" class="toggle">隐去继承来的属性</a></p>
  56. <table class="summaryTable">
  57. <colgroup>
  58. <col class="col-property" />
  59. <col class="col-type" />
  60. <col class="col-description" />
  61. <col class="col-defined" />
  62. </colgroup>
  63. <tr>
  64. <th>名称</th><th>类型</th><th>描述</th><th>定义于</th>
  65. </tr>
  66. <tr class="inherited" id="code">
  67. <td>code</td>
  68. <td></td>
  69. <td></td>
  70. <td>Exception</td>
  71. </tr>
  72. <tr class="inherited" id="file">
  73. <td>file</td>
  74. <td></td>
  75. <td></td>
  76. <td>Exception</td>
  77. </tr>
  78. <tr class="inherited" id="line">
  79. <td>line</td>
  80. <td></td>
  81. <td></td>
  82. <td>Exception</td>
  83. </tr>
  84. <tr class="inherited" id="message">
  85. <td>message</td>
  86. <td></td>
  87. <td></td>
  88. <td>Exception</td>
  89. </tr>
  90. </table>
  91. </div>
  92. <a name="methods"></a>
  93. <div class="summary docMethod">
  94. <h2>Public 方法</h2>
  95. <p><a href="#" class="toggle">隐去继承来的方法</a></p>
  96. <table class="summaryTable">
  97. <colgroup>
  98. <col class="col-method" />
  99. <col class="col-description" />
  100. <col class="col-defined" />
  101. </colgroup>
  102. <tr>
  103. <th>名称</th><th>描述</th><th>定义于</th>
  104. </tr>
  105. <tr class="inherited" id="__construct">
  106. <td>__construct()</td>
  107. <td></td>
  108. <td>Exception</td>
  109. </tr>
  110. <tr id="__toString">
  111. <td><a href="XSException.html#__toString-detail">__toString()</a></td>
  112. <td>将类对象转换成字符串</td>
  113. <td>XSException</td>
  114. </tr>
  115. <tr class="inherited" id="getCode">
  116. <td>getCode()</td>
  117. <td></td>
  118. <td>Exception</td>
  119. </tr>
  120. <tr class="inherited" id="getFile">
  121. <td>getFile()</td>
  122. <td></td>
  123. <td>Exception</td>
  124. </tr>
  125. <tr class="inherited" id="getLine">
  126. <td>getLine()</td>
  127. <td></td>
  128. <td>Exception</td>
  129. </tr>
  130. <tr class="inherited" id="getMessage">
  131. <td>getMessage()</td>
  132. <td></td>
  133. <td>Exception</td>
  134. </tr>
  135. <tr class="inherited" id="getPrevious">
  136. <td>getPrevious()</td>
  137. <td></td>
  138. <td>Exception</td>
  139. </tr>
  140. <tr id="getRelPath">
  141. <td><a href="XSException.html#getRelPath-detail">getRelPath()</a></td>
  142. <td>取得相对当前的文件路径</td>
  143. <td>XSException</td>
  144. </tr>
  145. <tr class="inherited" id="getTrace">
  146. <td>getTrace()</td>
  147. <td></td>
  148. <td>Exception</td>
  149. </tr>
  150. <tr class="inherited" id="getTraceAsString">
  151. <td>getTraceAsString()</td>
  152. <td></td>
  153. <td>Exception</td>
  154. </tr>
  155. </table>
  156. </div>
  157. <a name="events"></a>
  158. <h2>方法明细</h2>
  159. <div class="detailHeader" id="__toString-detail">
  160. __toString()
  161. <span class="detailHeaderTag">
  162. 方法
  163. </span>
  164. </div>
  165. <table class="summaryTable">
  166. <tr><td colspan="3">
  167. <div class="signature2">
  168. public string <b>__toString</b>()</div>
  169. </td></tr>
  170. <tr>
  171. <td class="paramNameCol">{return}</td>
  172. <td class="paramTypeCol">string</td>
  173. <td class="paramDescCol">异常的简要描述信息</td>
  174. </tr>
  175. </table>
  176. <div class="sourceCode">
  177. <b>源码:</b> <a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XS.class.php#L67">sdk/php/lib/XS.class.php#L67</a> (<b><a href="#" class="show">显示</a></b>)
  178. <div class="code"><code><span style="color: #000000">
  179. <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">getFile</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">getLine</span><span style="color: #007700">()&nbsp;.&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: #0000BB">$this</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getCode</span><span style="color: #007700">()&nbsp;&gt;&nbsp;</span><span style="color: #0000BB">0&nbsp;</span><span style="color: #007700">?&nbsp;</span><span style="color: #DD0000">'(S#'&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">')'&nbsp;</span><span style="color: #007700">:&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>
  180. </span>
  181. </code></div>
  182. </div>
  183. <p>将类对象转换成字符串</p>
  184. <div class="detailHeader" id="getRelPath-detail">
  185. getRelPath()
  186. <span class="detailHeaderTag">
  187. 方法
  188. </span>
  189. </div>
  190. <table class="summaryTable">
  191. <tr><td colspan="3">
  192. <div class="signature2">
  193. public static string <b>getRelPath</b>(string $file)</div>
  194. </td></tr>
  195. <tr>
  196. <td class="paramNameCol">$file</td>
  197. <td class="paramTypeCol">string</td>
  198. <td class="paramDescCol">需要转换的绝对路径</td>
  199. </tr>
  200. <tr>
  201. <td class="paramNameCol">{return}</td>
  202. <td class="paramTypeCol">string</td>
  203. <td class="paramDescCol">转换后的相对路径</td>
  204. </tr>
  205. </table>
  206. <div class="sourceCode">
  207. <b>源码:</b> <a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XS.class.php#L79">sdk/php/lib/XS.class.php#L79</a> (<b><a href="#" class="show">显示</a></b>)
  208. <div class="code"><code><span style="color: #000000">
  209. <span style="color: #0000BB"></span><span style="color: #007700">public&nbsp;static&nbsp;function&nbsp;</span><span style="color: #0000BB">getRelPath</span><span style="color: #007700">(</span><span style="color: #0000BB">$file</span><span style="color: #007700">)<br />{<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$from&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">getcwd</span><span style="color: #007700">();<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$file&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">realpath</span><span style="color: #007700">(</span><span style="color: #0000BB">$file</span><span style="color: #007700">);<br />&nbsp;&nbsp;&nbsp;&nbsp;if&nbsp;(</span><span style="color: #0000BB">is_dir</span><span style="color: #007700">(</span><span style="color: #0000BB">$file</span><span style="color: #007700">))<br />&nbsp;&nbsp;&nbsp;&nbsp;{<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$pos&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">false</span><span style="color: #007700">;<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$to&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">$file</span><span style="color: #007700">;<br />&nbsp;&nbsp;&nbsp;&nbsp;}<br />&nbsp;&nbsp;&nbsp;&nbsp;else<br />&nbsp;&nbsp;&nbsp;&nbsp;{<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$pos&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">strrpos</span><span style="color: #007700">(</span><span style="color: #0000BB">$file</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">'/'</span><span style="color: #007700">);<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$to&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">substr</span><span style="color: #007700">(</span><span style="color: #0000BB">$file</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">0</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$pos</span><span style="color: #007700">);<br />&nbsp;&nbsp;&nbsp;&nbsp;}<br />&nbsp;&nbsp;&nbsp;&nbsp;for&nbsp;(</span><span style="color: #0000BB">$rel&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #DD0000">''</span><span style="color: #007700">;;&nbsp;</span><span style="color: #0000BB">$rel&nbsp;</span><span style="color: #007700">.=&nbsp;</span><span style="color: #DD0000">'../'</span><span style="color: #007700">)<br />&nbsp;&nbsp;&nbsp;&nbsp;{<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;if&nbsp;(</span><span style="color: #0000BB">$from&nbsp;</span><span style="color: #007700">===&nbsp;</span><span style="color: #0000BB">$to</span><span style="color: #007700">)<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;break;<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;if&nbsp;(</span><span style="color: #0000BB">$from&nbsp;</span><span style="color: #007700">===&nbsp;</span><span style="color: #0000BB">dirname</span><span style="color: #007700">(</span><span style="color: #0000BB">$from</span><span style="color: #007700">))<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$rel&nbsp;</span><span style="color: #007700">.=&nbsp;</span><span style="color: #0000BB">substr</span><span style="color: #007700">(</span><span style="color: #0000BB">$to</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">1</span><span style="color: #007700">);<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;break;<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;if&nbsp;(!</span><span style="color: #0000BB">strncmp</span><span style="color: #007700">(</span><span style="color: #0000BB">$from&nbsp;</span><span style="color: #007700">.&nbsp;</span><span style="color: #DD0000">'/'</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$to</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">strlen</span><span style="color: #007700">(</span><span style="color: #0000BB">$from</span><span style="color: #007700">)&nbsp;+&nbsp;</span><span style="color: #0000BB">1</span><span style="color: #007700">))<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$rel&nbsp;</span><span style="color: #007700">.=&nbsp;</span><span style="color: #0000BB">substr</span><span style="color: #007700">(</span><span style="color: #0000BB">$to</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">strlen</span><span style="color: #007700">(</span><span style="color: #0000BB">$from</span><span style="color: #007700">)&nbsp;+&nbsp;</span><span style="color: #0000BB">1</span><span style="color: #007700">);<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;break;<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$from&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">dirname</span><span style="color: #007700">(</span><span style="color: #0000BB">$from</span><span style="color: #007700">);<br />&nbsp;&nbsp;&nbsp;&nbsp;}<br />&nbsp;&nbsp;&nbsp;&nbsp;if&nbsp;(</span><span style="color: #0000BB">substr</span><span style="color: #007700">(</span><span style="color: #0000BB">$rel</span><span style="color: #007700">,&nbsp;-</span><span style="color: #0000BB">1</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">1</span><span style="color: #007700">)&nbsp;===&nbsp;</span><span style="color: #DD0000">'/'</span><span style="color: #007700">)<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$rel&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">substr</span><span style="color: #007700">(</span><span style="color: #0000BB">$rel</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">0</span><span style="color: #007700">,&nbsp;-</span><span style="color: #0000BB">1</span><span style="color: #007700">);<br />&nbsp;&nbsp;&nbsp;&nbsp;if&nbsp;(</span><span style="color: #0000BB">$pos&nbsp;</span><span style="color: #007700">!==&nbsp;</span><span style="color: #0000BB">false</span><span style="color: #007700">)<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$rel&nbsp;</span><span style="color: #007700">.=&nbsp;</span><span style="color: #0000BB">substr</span><span style="color: #007700">(</span><span style="color: #0000BB">$file</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$pos</span><span style="color: #007700">);<br />&nbsp;&nbsp;&nbsp;&nbsp;return&nbsp;</span><span style="color: #0000BB">$rel</span><span style="color: #007700">;<br />}</span>
  210. </span>
  211. </code></div>
  212. </div>
  213. <p>取得相对当前的文件路径</p>
  214. </div><!-- end of content -->
  215. <div id="apiFooter">
  216. Copyright &copy; 2008-2011 by <a href="http://www.xunsearch.com" target="_blank">杭州云圣网络科技有限公司</a><br/>
  217. All Rights Reserved.<br/>
  218. </div><!-- end of footer -->
  219. <script type="text/javascript">
  220. /*<![CDATA[*/
  221. $("a.toggle").toggle(function(){
  222. $(this).text($(this).text().replace(/Hide/,'Show'));
  223. $(this).parents(".summary").find(".inherited").hide();
  224. },function(){
  225. $(this).text($(this).text().replace(/Show/,'Hide'));
  226. $(this).parents(".summary").find(".inherited").show();
  227. });
  228. $(".sourceCode a.show").toggle(function(){
  229. $(this).text($(this).text().replace(/show/,'hide'));
  230. $(this).parents(".sourceCode").find("div.code").show();
  231. },function(){
  232. $(this).text($(this).text().replace(/hide/,'show'));
  233. $(this).parents(".sourceCode").find("div.code").hide();
  234. });
  235. $("a.sourceLink").click(function(){
  236. $(this).attr('target','_blank');
  237. });
  238. /*]]>*/
  239. </script>
  240. </div><!-- end of page -->
  241. </body>
  242. </html>