| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=gbk" />
- <meta name="language" content="zh-cn" />
- <link rel="stylesheet" type="text/css" href="css/style.css" />
- <link rel="stylesheet" type="text/css" href="css/api.css" />
- <script type="text/javascript" src="js/jquery.js"></script>
- <title>XSDatabase</title>
- </head>
- <body>
- <div id="apiPage">
- <div id="apiHeader">
- <a href="http://www.xunsearch.com" target="_blank">Xunsearch PHP-SDK</a> v1.3.2 API 参考文档
- </div><!-- end of header -->
- <div id="content" class="api-index">
- <h1>XSDatabase</h1>
- <div id="nav">
- <a href="index.html">All Packages</a>
- | <a href="#methods">方法(函数)</a>
- </div>
- <table class="summaryTable docClass">
- <colgroup>
- <col class="col-name" />
- <col class="col-value" />
- </colgroup>
- <tr>
- <th>包</th>
- <td><a href="index.html#XS.util.db">XS.util.db</a></td>
- </tr>
- <tr>
- <th>继承关系</th>
- <td>abstract class XSDatabase</td>
- </tr>
- <tr>
- <th>子类</th>
- <td><a href="XSDatabaseMySQL.html">XSDatabaseMySQL</a>, <a href="XSDatabaseMySQLI.html">XSDatabaseMySQLI</a>, <a href="XSDatabasePDO.html">XSDatabasePDO</a>, <a href="XSDatabaseSQLite.html">XSDatabaseSQLite</a>, <a href="XSDatabaseSQLite3.html">XSDatabaseSQLite3</a></td>
- </tr>
- <tr>
- <th>版本</th>
- <td>1.0.0</td>
- </tr>
- <tr>
- <th>源代码</th>
- <td><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/util/XSDataSource.class.php">sdk/php/util/XSDataSource.class.php</a></td>
- </tr>
- </table>
- <div id="classDescription">
- 数据库操作基类
- 定义了 SQL 数据库源的四个基本操作: connect/query/close/setUtf8</div>
- <a name="properties"></a>
- <a name="methods"></a>
- <div class="summary docMethod">
- <h2>Public 方法</h2>
- <p><a href="#" class="toggle">隐去继承来的方法</a></p>
- <table class="summaryTable">
- <colgroup>
- <col class="col-method" />
- <col class="col-description" />
- <col class="col-defined" />
- </colgroup>
- <tr>
- <th>名称</th><th>描述</th><th>定义于</th>
- </tr>
- <tr id="close">
- <td><a href="XSDatabase.html#close-detail">close()</a></td>
- <td>关闭数据库连接</td>
- <td>XSDatabase</td>
- </tr>
- <tr id="connect">
- <td><a href="XSDatabase.html#connect-detail">connect()</a></td>
- <td>连接数据库</td>
- <td>XSDatabase</td>
- </tr>
- <tr id="query">
- <td><a href="XSDatabase.html#query-detail">query()</a></td>
- <td>查询 SQL 语句</td>
- <td>XSDatabase</td>
- </tr>
- <tr id="query1">
- <td><a href="XSDatabase.html#query1-detail">query1()</a></td>
- <td>查询数据库首行</td>
- <td>XSDatabase</td>
- </tr>
- <tr id="setUtf8">
- <td><a href="XSDatabase.html#setUtf8-detail">setUtf8()</a></td>
- <td>设置数据库字符集为 UTF-8</td>
- <td>XSDatabase</td>
- </tr>
- </table>
- </div>
- <a name="events"></a>
- <h2>方法明细</h2>
- <div class="detailHeader" id="close-detail">
- close()
- <span class="detailHeaderTag">
- 方法
- </span>
- </div>
- <table class="summaryTable">
- <tr><td colspan="3">
- <div class="signature2">
- abstract public void <b>close</b>()</div>
- </td></tr>
- </table>
- <div class="sourceCode">
- <b>源码:</b> <a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/util/XSDataSource.class.php#L428">sdk/php/util/XSDataSource.class.php#L428</a> (<b><a href="#" class="show">显示</a></b>)
- <div class="code"><code><span style="color: #000000">
- <span style="color: #0000BB"></span><span style="color: #007700">abstract public function </span><span style="color: #0000BB">close</span><span style="color: #007700">();</span>
- </span>
- </code></div>
- </div>
- <p>关闭数据库连接</p>
- <div class="detailHeader" id="connect-detail">
- connect()
- <span class="detailHeaderTag">
- 方法
- </span>
- </div>
- <table class="summaryTable">
- <tr><td colspan="3">
- <div class="signature2">
- abstract public void <b>connect</b>(array $param)</div>
- </td></tr>
- <tr>
- <td class="paramNameCol">$param</td>
- <td class="paramTypeCol">array</td>
- <td class="paramDescCol">连接参数, 采用 parse_url 解析, 可能包含: scheme,user,pass,host,path,table,dbname ...</td>
- </tr>
- </table>
- <div class="sourceCode">
- <b>源码:</b> <a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/util/XSDataSource.class.php#L423">sdk/php/util/XSDataSource.class.php#L423</a> (<b><a href="#" class="show">显示</a></b>)
- <div class="code"><code><span style="color: #000000">
- <span style="color: #0000BB"></span><span style="color: #007700">abstract public function </span><span style="color: #0000BB">connect</span><span style="color: #007700">(</span><span style="color: #0000BB">$param</span><span style="color: #007700">);</span>
- </span>
- </code></div>
- </div>
- <p>连接数据库</p>
- <div class="detailHeader" id="query-detail">
- query()
- <span class="detailHeaderTag">
- 方法
- </span>
- </div>
- <table class="summaryTable">
- <tr><td colspan="3">
- <div class="signature2">
- abstract public mixed <b>query</b>($sql)</div>
- </td></tr>
- <tr>
- <td class="paramNameCol">$sql</td>
- <td class="paramTypeCol"></td>
- <td class="paramDescCol"></td>
- </tr>
- <tr>
- <td class="paramNameCol">{return}</td>
- <td class="paramTypeCol">mixed</td>
- <td class="paramDescCol">非 SELECT 语句返回执行结果(true/false), SELECT 语句返回所有结果行的数组</td>
- </tr>
- </table>
- <div class="sourceCode">
- <b>源码:</b> <a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/util/XSDataSource.class.php#L434">sdk/php/util/XSDataSource.class.php#L434</a> (<b><a href="#" class="show">显示</a></b>)
- <div class="code"><code><span style="color: #000000">
- <span style="color: #0000BB"></span><span style="color: #007700">abstract public function </span><span style="color: #0000BB">query</span><span style="color: #007700">(</span><span style="color: #0000BB">$sql</span><span style="color: #007700">);</span>
- </span>
- </code></div>
- </div>
- <p>查询 SQL 语句</p>
- <div class="detailHeader" id="query1-detail">
- query1()
- <span class="detailHeaderTag">
- 方法
- </span>
- </div>
- <table class="summaryTable">
- <tr><td colspan="3">
- <div class="signature2">
- public 查询结果首行, <b>query1</b>(string $sql)</div>
- </td></tr>
- <tr>
- <td class="paramNameCol">$sql</td>
- <td class="paramTypeCol">string</td>
- <td class="paramDescCol"></td>
- </tr>
- <tr>
- <td class="paramNameCol">{return}</td>
- <td class="paramTypeCol">查询结果首行,</td>
- <td class="paramDescCol">失败或无数据则返回 false</td>
- </tr>
- </table>
- <div class="sourceCode">
- <b>源码:</b> <a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/util/XSDataSource.class.php#L450">sdk/php/util/XSDataSource.class.php#L450</a> (<b><a href="#" class="show">显示</a></b>)
- <div class="code"><code><span style="color: #000000">
- <span style="color: #0000BB"></span><span style="color: #007700">public function </span><span style="color: #0000BB">query1</span><span style="color: #007700">(</span><span style="color: #0000BB">$sql</span><span style="color: #007700">)<br />{<br /> </span><span style="color: #0000BB">$sql </span><span style="color: #007700">= </span><span style="color: #0000BB">preg_replace</span><span style="color: #007700">(</span><span style="color: #DD0000">'/ limit\s+(\d+)(?:\s*,\s*(\d+)|\s+offset\s+(\d+))?\s*$/i'</span><span style="color: #007700">, </span><span style="color: #DD0000">''</span><span style="color: #007700">, </span><span style="color: #0000BB">$sql</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$sql </span><span style="color: #007700">.= </span><span style="color: #DD0000">' LIMIT 1'</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">$res </span><span style="color: #007700">= </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">query</span><span style="color: #007700">(</span><span style="color: #0000BB">$sql</span><span style="color: #007700">);<br /> return (</span><span style="color: #0000BB">is_array</span><span style="color: #007700">(</span><span style="color: #0000BB">$res</span><span style="color: #007700">) && isset(</span><span style="color: #0000BB">$res</span><span style="color: #007700">[</span><span style="color: #0000BB">0</span><span style="color: #007700">])) ? </span><span style="color: #0000BB">$res</span><span style="color: #007700">[</span><span style="color: #0000BB">0</span><span style="color: #007700">] : </span><span style="color: #0000BB">false</span><span style="color: #007700">;<br />}</span>
- </span>
- </code></div>
- </div>
- <p>查询数据库首行</p>
- <div class="detailHeader" id="setUtf8-detail">
- setUtf8()
- <span class="detailHeaderTag">
- 方法
- </span>
- </div>
- <table class="summaryTable">
- <tr><td colspan="3">
- <div class="signature2">
- public bool <b>setUtf8</b>()</div>
- </td></tr>
- <tr>
- <td class="paramNameCol">{return}</td>
- <td class="paramTypeCol">bool</td>
- <td class="paramDescCol">如果数据库能直接输出 UTF-8 编码则返回 true 否则返回 false</td>
- </tr>
- </table>
- <div class="sourceCode">
- <b>源码:</b> <a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/util/XSDataSource.class.php#L440">sdk/php/util/XSDataSource.class.php#L440</a> (<b><a href="#" class="show">显示</a></b>)
- <div class="code"><code><span style="color: #000000">
- <span style="color: #0000BB"></span><span style="color: #007700">public function </span><span style="color: #0000BB">setUtf8</span><span style="color: #007700">()<br />{<br /> return </span><span style="color: #0000BB">false</span><span style="color: #007700">;<br />}</span>
- </span>
- </code></div>
- </div>
- <p>设置数据库字符集为 UTF-8</p>
- </div><!-- end of content -->
- <div id="apiFooter">
- Copyright © 2008-2011 by <a href="http://www.xunsearch.com" target="_blank">杭州云圣网络科技有限公司</a><br/>
- All Rights Reserved.<br/>
- </div><!-- end of footer -->
- <script type="text/javascript">
- /*<![CDATA[*/
- $("a.toggle").toggle(function(){
- $(this).text($(this).text().replace(/Hide/,'Show'));
- $(this).parents(".summary").find(".inherited").hide();
- },function(){
- $(this).text($(this).text().replace(/Show/,'Hide'));
- $(this).parents(".summary").find(".inherited").show();
- });
- $(".sourceCode a.show").toggle(function(){
- $(this).text($(this).text().replace(/show/,'hide'));
- $(this).parents(".sourceCode").find("div.code").show();
- },function(){
- $(this).text($(this).text().replace(/hide/,'show'));
- $(this).parents(".sourceCode").find("div.code").hide();
- });
- $("a.sourceLink").click(function(){
- $(this).attr('target','_blank');
- });
- /*]]>*/
- </script>
- </div><!-- end of page -->
- </body>
- </html>
|