首页 发现 帮助
登录
S.H.I.E.L.D.
/
wenda-php
2
0
派生 0
文件 工单管理 0 合并请求 0 Wiki
分支: master
分支列表 标签列表
wenda-php
/
protected
/
plugin
/
xsearch
/
doc
/
guide
/
class.document.html

class.document.html 13 KB
永久链接 文件历史 原始文件

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/html; charset=gbk" />
    5. 

  5. <meta name="language" content="zh-cn" />
    6. 

  6. <link rel="stylesheet" type="text/css" href="../api/css/style.css" />
    7. 

  7. <link rel="stylesheet" type="text/css" href="../api/css/guide.css" />
    8. 

  8. <link rel="stylesheet" type="text/css" href="../api/css/highlight.css" />
    9. 

  9. <title>XSDocument 文档</title>
    10. 

  10. </head>
    11. 

  11. 

  12. <body>
    13. 

  13. <div id="apiPage">
    14. 

  14. 

  15. <div id="apiHeader">
    16. 

  16. <a href="http://www.xunsearch.com" target="_blank">Xunsearch PHP-SDK</a> v1.3.2 权威指南
    17. 

  17. </div><!-- end of header -->
    18. 

  18. 

  19. <div id="content" class="markdown">
    20. 

  20. 	<div class="toc"><ol><li><a href="#ch0">搜索结果文档</a></li><li><a href="#ch1">索引文档</a></li></ol></div><h1 id="xsdocument-">XSDocument 文档</h1>
    21. 

  21. 

  22. <p><a href="../api/XSDocument.html">XSDocument</a> 是用于描述检索/索引的基础对象，包含一组字段及其值。相当于常规 <code>SQL</code> 数据表中的一行记录。
    23. 

  23. 通过魔术方法，每个字段名都是文档的虚拟属性，可直接赋值或取值，也支持数组下标方式访问文档字段。</p>
    24. 

  24. 

  25. <div class="hl-code"><div class="php-hl-main"><pre><span class="php-hl-var">$doc</span><span class="php-hl-code"> = </span><span class="php-hl-reserved">new</span> <span class="php-hl-identifier">XSDocument</span><span class="php-hl-code">;
    26. 

  26. </span><span class="php-hl-var">$doc</span><span class="php-hl-code">-&gt;</span><span class="php-hl-identifier">name</span><span class="php-hl-code"> = </span><span class="php-hl-quotes">'</span><span class="php-hl-string">value</span><span class="php-hl-quotes">'</span><span class="php-hl-code">; </span><span class="php-hl-comment">//</span><span class="php-hl-comment"> 用对象属性方式进行赋值、取值</span>
    27. 

  27. <span class="php-hl-var">$doc</span><span class="php-hl-brackets">[</span><span class="php-hl-quotes">'</span><span class="php-hl-string">name</span><span class="php-hl-quotes">'</span><span class="php-hl-brackets">]</span><span class="php-hl-code"> = </span><span class="php-hl-quotes">'</span><span class="php-hl-string">value</span><span class="php-hl-quotes">'</span><span class="php-hl-code">; </span><span class="php-hl-comment">//</span><span class="php-hl-comment"> 用数组下标方式进行赋值、取值</span>
    28. 

  28. <span class="php-hl-var">$value</span><span class="php-hl-code"> = </span><span class="php-hl-var">$doc</span><span class="php-hl-code">-&gt;</span><span class="php-hl-identifier">f</span><span class="php-hl-brackets">(</span><span class="php-hl-quotes">'</span><span class="php-hl-string">name</span><span class="php-hl-quotes">'</span><span class="php-hl-brackets">)</span><span class="php-hl-code">; </span><span class="php-hl-comment">//</span><span class="php-hl-comment"> 用函数方式进行取值</span>
    29. 

  29. <span class="php-hl-var">$doc</span><span class="php-hl-code">-&gt;</span><span class="php-hl-identifier">setField</span><span class="php-hl-brackets">(</span><span class="php-hl-quotes">'</span><span class="php-hl-string">name</span><span class="php-hl-quotes">'</span><span class="php-hl-code">, </span><span class="php-hl-quotes">'</span><span class="php-hl-string">value</span><span class="php-hl-quotes">'</span><span class="php-hl-brackets">)</span><span class="php-hl-code">; </span><span class="php-hl-comment">//</span><span class="php-hl-comment"> 用函数方式进行赋值</span>
    30. 

  30. <span class="php-hl-var">$doc</span><span class="php-hl-code">-&gt;</span><span class="php-hl-identifier">setFields</span><span class="php-hl-brackets">(</span><span class="php-hl-reserved">array</span><span class="php-hl-brackets">(</span><span class="php-hl-quotes">'</span><span class="php-hl-string">name</span><span class="php-hl-quotes">'</span><span class="php-hl-code"> =&gt; </span><span class="php-hl-quotes">'</span><span class="php-hl-string">value</span><span class="php-hl-quotes">'</span><span class="php-hl-code">, </span><span class="php-hl-quotes">'</span><span class="php-hl-string">name2</span><span class="php-hl-quotes">'</span><span class="php-hl-code"> =&gt; </span><span class="php-hl-quotes">'</span><span class="php-hl-string">value2</span><span class="php-hl-quotes">'</span><span class="php-hl-brackets">)</span><span class="php-hl-brackets">)</span><span class="php-hl-code">; </span><span class="php-hl-comment">//</span><span class="php-hl-comment"> 用数组进行批量赋值</span>
    31. 

  31.  
    32. 

  32. <span class="php-hl-comment">//</span><span class="php-hl-comment"> 迭代方式取所有字段值</span>
    33. 

  33. <span class="php-hl-reserved">foreach</span><span class="php-hl-brackets">(</span><span class="php-hl-var">$doc</span> <span class="php-hl-reserved">as</span> <span class="php-hl-var">$name</span><span class="php-hl-code"> =&gt; </span><span class="php-hl-var">$value</span><span class="php-hl-brackets">)</span> 
    34. 

  34. <span class="php-hl-brackets">{</span>
    35. 

  35.     <span class="php-hl-reserved">echo</span> <span class="php-hl-quotes">&quot;</span><span class="php-hl-var">$name</span><span class="php-hl-string">: </span><span class="php-hl-var">$value</span><span class="php-hl-special">\n</span><span class="php-hl-quotes">&quot;</span><span class="php-hl-code">;  
    36. 

  36. </span><span class="php-hl-brackets">}</span></pre></div></div>
    37. 

  37. 

  38. <p>用于索引更新的文档对象和搜索结果返回中略有不同，下面分开讲解。</p>
    39. 

  39. 

  40. <h2 id="ch0">1. 搜索结果文档<a name="ch0" class="anchor">?</a></h2>
    41. 

  41. 

  42. <p>搜索结果文档是指 <a href="../api/XSSearch.html#search">XSSearch::search</a> 返回值包含的文档，它由 <code>PHP-SDK</code> 内部代码创建。
    43. 

  43. 除了普通文档的功能外，还支持以下魔术方法来访问搜索结果的元数据：</p>
    44. 

  44. 

  45. <ul>
    46. 

  46. <li><code>docid()</code> 取得搜索结果文档的 docid 值 (实际数据库内的 id，一般用不到)</li>
    47. 

  47. <li><code>rank()</code> 取得搜索结果文档的序号值 (第X条结果)</li>
    48. 

  48. <li><code>percent()</code> 取得搜索结果文档的匹配百分比 (结果匹配度, 1~100)</li>
    49. 

  49. <li><code>weight()</code> 取得搜索结果文档的权重值 (浮点数)</li>
    50. 

  50. <li><code>ccount()</code> 取得搜索结果折叠的数量 (按字段折叠搜索时才有效)</li>
    51. 

  51. </ul>
    52. 

  52. 

  53. <p>访问结果文档的字符集默认是与 <a href="../api/XSSearch.html#setCharset">XSSearch::setCharset</a> 所指定的字符集一致的，如未指定过则为 <a href="../api/XS.html#defaultCharset">XS::defaultCharset</a>。
    54. 

  54. 虽然您可以通过 <a href="../api/XSDocument.html#setCharset">XSDocument::setCharset</a> 来强制修改文档的字符集，但不推荐这样做，也没必要这样做。</p>
    55. 

  55. 

  56. <h2 id="ch1">2. 索引文档<a name="ch1" class="anchor">?</a></h2>
    57. 

  57. 

  58. <p>索引文档是指由用户创建，并用于提交更新到索引库中的文档，创建文档时允许传入字符集作为构造函数的参数，
    59. 

  59. 如未传入，则自动视为项目的默认字符集 <a href="../api/XS.html#defaultCharset">XS::defaultCharset</a>，如果字符集不是 <code>UTF-8</code> 的系统内部会
    60. 

  60. 自动进行转换，但要求 <code>PHP</code> 带有中文转码扩展 (<a href="http://php.net/manual/en/book.iconv.php">iconv</a> 或 <a href="http://php.net/manual/en/book.mbstring.php">mbstring</a>)</p>
    61. 

  61. 

  62. <div class="hl-code"><div class="php-hl-main"><pre><span class="php-hl-var">$doc</span><span class="php-hl-code"> = </span><span class="php-hl-reserved">new</span> <span class="php-hl-identifier">XSDocument</span><span class="php-hl-code">;  </span><span class="php-hl-comment">//</span><span class="php-hl-comment"> 使用默认字符集</span>
    63. 

  63. <span class="php-hl-var">$doc</span><span class="php-hl-code"> = </span><span class="php-hl-reserved">new</span> <span class="php-hl-identifier">XSDocument</span><span class="php-hl-brackets">(</span><span class="php-hl-quotes">'</span><span class="php-hl-string">gbk</span><span class="php-hl-quotes">'</span><span class="php-hl-brackets">)</span><span class="php-hl-code">; </span><span class="php-hl-comment">//</span><span class="php-hl-comment"> 指定文档为 GBK 编码</span>
    64. 

  64. <span class="php-hl-var">$doc</span><span class="php-hl-code"> = </span><span class="php-hl-reserved">new</span> <span class="php-hl-identifier">XSDocument</span><span class="php-hl-brackets">(</span><span class="php-hl-var">$data</span><span class="php-hl-brackets">)</span><span class="php-hl-code">; </span><span class="php-hl-comment">//</span><span class="php-hl-comment"> 数组 $data 为初始字段数据, 编码则为默认编码</span>
    65. 

  65. <span class="php-hl-var">$doc</span><span class="php-hl-code"> = </span><span class="php-hl-reserved">new</span> <span class="php-hl-identifier">XSDocument</span><span class="php-hl-brackets">(</span><span class="php-hl-var">$data</span><span class="php-hl-code">, </span><span class="php-hl-quotes">'</span><span class="php-hl-string">gbk</span><span class="php-hl-quotes">'</span><span class="php-hl-brackets">)</span><span class="php-hl-code">; </span><span class="php-hl-comment">//</span><span class="php-hl-comment"> 数组 $data 为字段数据, 编码为 GBK</span>
    66. 

  66.  
    67. 

  67. <span class="php-hl-comment">//</span><span class="php-hl-comment"> 然后进行一系列赋值操作</span>
    68. 

  68.  
    69. 

  69. <span class="php-hl-comment">//</span><span class="php-hl-comment"> 提交到索引中</span>
    70. 

  70. <span class="php-hl-var">$xs</span><span class="php-hl-code">-&gt;</span><span class="php-hl-identifier">index</span><span class="php-hl-code">-&gt;</span><span class="php-hl-identifier">add</span><span class="php-hl-brackets">(</span><span class="php-hl-var">$doc</span><span class="php-hl-brackets">)</span><span class="php-hl-code">;</span></pre></div></div>
    71. 

  71. 

  72. <p>如果您希望在 <code>XSDocument</code> 提交到索引前、后进行一系列必要的操作，您可以对 <code>XSDocument</code> 进行扩展，
    73. 

  73. 重写 <a href="../api/XSDocument.html#beforeSubmit">XSDocument::beforeSubmit</a> 和 <a href="../api/XSDocument.html#afterSubmit">XSDocument::afterSubmit</a> 方法来实现，比如扩展代码为
    74. 

  74. <code>$prefix/sdk/php/lib/MyDocument.class.php</code>。</p>
    75. 

  75. 

  76. <div class="hl-code"><div class="php-hl-main"><pre><span class="php-hl-reserved">class</span> <span class="php-hl-identifier">MyDocument</span> <span class="php-hl-reserved">extends</span> <span class="php-hl-identifier">XSDocument</span>
    77. 

  77. <span class="php-hl-brackets">{</span>
    78. 

  78.     <span class="php-hl-reserved">public</span> <span class="php-hl-reserved">function</span> <span class="php-hl-identifier">beforeSubmit</span><span class="php-hl-brackets">(</span><span class="php-hl-identifier">XSIndex</span> <span class="php-hl-var">$index</span><span class="php-hl-brackets">)</span>
    79. 

  79.     <span class="php-hl-brackets">{</span>
    80. 

  80.         <span class="php-hl-comment">//</span><span class="php-hl-comment"> 在此编写您的代码，如需要中断添加请提前返回 false</span>
    81. 

  81.         <span class="php-hl-comment">//</span><span class="php-hl-comment"> ...</span>
    82. 

  82.         <span class="php-hl-reserved">return</span> <span class="php-hl-identifier">parent</span><span class="php-hl-code">::</span><span class="php-hl-identifier">beforeSubmit</span><span class="php-hl-brackets">(</span><span class="php-hl-var">$index</span><span class="php-hl-brackets">)</span><span class="php-hl-code">;
    83. 

  83.     </span><span class="php-hl-brackets">}</span>
    84. 

  84.  
    85. 

  85.     <span class="php-hl-reserved">public</span> <span class="php-hl-reserved">function</span> <span class="php-hl-identifier">afterSubmit</span><span class="php-hl-brackets">(</span><span class="php-hl-identifier">XSIndex</span> <span class="php-hl-var">$index</span><span class="php-hl-brackets">)</span>
    86. 

  86.     <span class="php-hl-brackets">{</span>
    87. 

  87.         <span class="php-hl-comment">//</span><span class="php-hl-comment"> 在此编写您的代码，只有加入索引成功后才会执行</span>
    88. 

  88.         <span class="php-hl-comment">//</span><span class="php-hl-comment"> ...</span>
    89. 

  89.     <span class="php-hl-brackets">}</span>    
    90. 

  90. <span class="php-hl-brackets">}</span>
    91. 

  91.  
    92. 

  92. <span class="php-hl-var">$doc</span><span class="php-hl-code"> = </span><span class="php-hl-reserved">new</span> <span class="php-hl-identifier">MyDocument</span><span class="php-hl-brackets">(</span><span class="php-hl-quotes">'</span><span class="php-hl-string">gbk</span><span class="php-hl-quotes">'</span><span class="php-hl-brackets">)</span><span class="php-hl-code">;
    93. 

  93. </span><span class="php-hl-var">$doc</span><span class="php-hl-code">-&gt;</span><span class="php-hl-identifier">pid</span><span class="php-hl-code"> = </span><span class="php-hl-number">123</span><span class="php-hl-code">;
    94. 

  94. </span><span class="php-hl-var">$doc</span><span class="php-hl-code">-&gt;</span><span class="php-hl-identifier">subject</span><span class="php-hl-code"> = </span><span class="php-hl-quotes">'</span><span class="php-hl-string">Hello, 测试</span><span class="php-hl-quotes">'</span><span class="php-hl-code">;
    95. 

  95. </span><span class="php-hl-var">$doc</span><span class="php-hl-code">-&gt;</span><span class="php-hl-identifier">message</span><span class="php-hl-code"> = </span><span class="php-hl-quotes">'</span><span class="php-hl-string">测试的内容在此</span><span class="php-hl-quotes">'</span><span class="php-hl-code">;
    96. 

  96. </span><span class="php-hl-var">$xs</span><span class="php-hl-code">-&gt;</span><span class="php-hl-identifier">index</span><span class="php-hl-code">-&gt;</span><span class="php-hl-identifier">add</span><span class="php-hl-brackets">(</span><span class="php-hl-var">$doc</span><span class="php-hl-brackets">)</span><span class="php-hl-code">;</span></pre></div></div>
    97. 

  97. 

  98. <div class="revision">$Id$</div>
    99. 

  99. 	<div class="clear"></div>
    100. 

  100. </div><!-- end of content -->
    101. 

  101. <div id="guideNav">
    102. 

  102. 		<div class="prev"><a href="class.exception.html">&laquo; XSException 异常</a></div>
    103. 

  103. 			<div class="next"><a href="class.index.html">XSIndex 索引管理 &raquo;</a></div>
    104. 

  104. 		<div class="clear"></div>
    105. 

  105. </div><!-- end of nav -->
    106. 

  106. 

  107. <div id="apiFooter">
    108. 

  108. Copyright &copy; 2008-2011 by <a href="http://www.xunsearch.com" target="_blank">杭州云圣网络科技有限公司</a><br/>
    109. 

  109. All Rights Reserved.<br/>
    110. 

  110. </div><!-- end of footer -->
    111. 

  111. 

  112. </div><!-- end of page -->
    113. 

  113. 

  114. <div style="display:none;">
    115. 

  115. 	<img src="../api/css/info.gif" />
    116. 

  116. 	<img src="../api/css/tip.gif" />
    117. 

  117. 	<img src="../api/css/note.gif" />
    118. 

  118. </div>
    119. 

  119. 

  120. </body>
    121. 

  121. </html>
    122.