📄 sphinxclient.buildexcerpts.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><html> <head> <title>Build text snippets</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> </head> <body><div style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="sphinxclient.addquery.html">SphinxClient::addQuery</a></div> <div class="next" style="text-align: right; float: right;"><a href="sphinxclient.buildkeywords.html">SphinxClient::buildKeywords</a></div> <div class="up"><a href="class.sphinxclient.html">SphinxClient</a></div> <div class="home"><a href="index.html">PHP Manual</a></div></div><hr /><div id="sphinxclient.buildexcerpts" class="refentry"> <div class="refnamediv"> <h1 class="refname">SphinxClient::buildExcerpts</h1> <p class="verinfo">(No version information available, might be only in CVS)</p><p class="refpurpose"><span class="refname">SphinxClient::buildExcerpts</span> — <span class="dc-title">Build text snippets</span></p> </div> <div class="refsect1 description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><b><b>SphinxClient::buildExcerpts</b></b></span> ( <span class="methodparam"><span class="type">array</span> <tt class="parameter">$docs</tt></span> , <span class="methodparam"><span class="type">string</span> <tt class="parameter">$index</tt></span> , <span class="methodparam"><span class="type">string</span> <tt class="parameter">$words</tt></span> [, <span class="methodparam"><span class="type">array</span> <tt class="parameter">$opts</tt></span> ] )</div> <p class="para rdfs-comment"> Connects to searchd, requests it to generate excerpts (snippets) from the given documents, and returns the results. </p> </div> <div class="refsect1 parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><i><tt class="parameter">docs</tt></i></span> <dd> <p class="para"> Array of strings with documents' contents. </p> </dd> </dt> <dt> <span class="term"><i><tt class="parameter">index</tt></i></span> <dd> <p class="para"> Index name. </p> </dd> </dt> <dt> <span class="term"><i><tt class="parameter">words</tt></i></span> <dd> <p class="para"> Keywords to highlight. </p> </dd> </dt> <dt> <span class="term"><i><tt class="parameter">opts</tt></i></span> <dd> <p class="para"> Associative array of additional highlighting options (see below). </p> </dd> </dt> </dl> <table border="5"> <caption><b>Highlighting options</b></caption> <colgroup> <thead valign="middle"> <tr valign="middle"> <th colspan="1">Option</th> <th colspan="1">Description</th> </tr> </thead> <tbody valign="middle" class="tbody"> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">"before_match"</td> <td colspan="1" rowspan="1" align="left">A string to insert before a keyword match. Default is "<b>".</td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">"after_match"</td> <td colspan="1" rowspan="1" align="left">A string to insert after a keyword match. Default is "</b>".</td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">"chunk_separator"</td> <td colspan="1" rowspan="1" align="left">A string to insert between snippet chunks (passages). Default is " ... ".</td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">"limit"</td> <td colspan="1" rowspan="1" align="left">Maximum snippet size, in symbols (codepoints). Integer, default is 256.</td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">"around"</td> <td colspan="1" rowspan="1" align="left">How much words to pick around each matching keywords block. Integer, default is 5.</td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">"exact_phrase"</td> <td colspan="1" rowspan="1" align="left">Whether to highlight exact query phrase matches only instead of individual keywords. Boolean, default is <b><tt>FALSE</tt></b>.</td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">"single_passage"</td> <td colspan="1" rowspan="1" align="left">Whether to extract single best passage only. Boolean, default is <b><tt>FALSE</tt></b>.</td> </tr> </tbody> </colgroup> </table> </p> </div> <div class="refsect1 returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns array of snippets on success, or <b><tt>FALSE</tt></b> on failure. </p> </div></div><hr /><div style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="sphinxclient.addquery.html">SphinxClient::addQuery</a></div> <div class="next" style="text-align: right; float: right;"><a href="sphinxclient.buildkeywords.html">SphinxClient::buildKeywords</a></div> <div class="up"><a href="class.sphinxclient.html">SphinxClient</a></div> <div class="home"><a href="index.html">PHP Manual</a></div></div></body></html>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -