Skip to content

Commit 1d92acb

Browse files
omars44Girgias
omars44
and
Girgias
authored
Solr 2.7.0: SolrQuery::setHighlightQuery / getHighlightQuery (hl.q) (#3485)
* Solr 2.7.0: SolrQuery::setHighlightQuery * Apply suggestions from code review #1 formatting suggestions from CR Co-authored-by: Gina Peter Banyard <girgias@php.net> * SolrQuery::setHighlightQuery: clarification and rewording * SolrQuery: remove entities file * Whitespaces --------- Co-authored-by: Gina Peter Banyard <girgias@php.net>
1 parent d23581d commit 1d92acb

File tree

4 files changed

+116
-1
lines changed

4 files changed

+116
-1
lines changed

‎reference/solr/solrquery/gethighlight.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<void />
1515
</methodsynopsis>
1616
<para>
17-
Returns a boolean indicating whether or not to enable highlighted snippets to be generated in the query response.
17+
Returns a boolean indicating whether to enable highlighted snippets to be generated in the query response.
1818
</para>
1919

2020

‎reference/solr/solrquery/gethighlightquery.xml‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<refentry xml:id="solrquery.gethighlightquery" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
3+
<refnamediv>
4+
<refname>SolrQuery::getHighlightQuery</refname>
5+
<refpurpose>return the highlightquery (hl.q)</refpurpose>
6+
</refnamediv>
7+
8+
<refsect1 role="description">
9+
&reftitle.description;
10+
<methodsynopsis>
11+
<modifier>public</modifier> <type>string</type><methodname>SolrQuery::getHighlightQuery</methodname>
12+
<void/>
13+
</methodsynopsis>
14+
<para>
15+
Returns previously set highlight query.
16+
This parameter allows you to highlight different terms or fields than those being used to retrieve documents.
17+
</para>
18+
19+
</refsect1>
20+
21+
<refsect1 role="returnvalues">
22+
&reftitle.returnvalues;
23+
<para>
24+
Returns the current SolrHighlightQuery string, or null if not set.
25+
</para>
26+
</refsect1>
27+
</refentry>
28+
<!-- Keep this comment at the end of the file
29+
Local variables:
30+
mode: sgml
31+
sgml-omittag:t
32+
sgml-shorttag:t
33+
sgml-minimize-attributes:nil
34+
sgml-always-quote-attributes:t
35+
sgml-indent-step:1
36+
sgml-indent-data:t
37+
indent-tabs-mode:nil
38+
sgml-parent-document:nil
39+
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
40+
sgml-exposed-tags:nil
41+
sgml-local-catalogs:nil
42+
sgml-local-ecat-files:nil
43+
End:
44+
vim600: syn=xml fen fdm=syntax fdl=2 si
45+
vim: et tw=78 syn=sgml
46+
vi: ts=1 sw=1
47+
-->

‎reference/solr/solrquery/sethighlightquery.xml‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<refentry xml:id="solrquery.sethighlightquery" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
3+
<refnamediv>
4+
<refname>SolrQuery::setHighlightQuery</refname>
5+
<refpurpose>A query designated for highlighting (hl.q)</refpurpose>
6+
</refnamediv>
7+
8+
<refsect1 role="description">
9+
&reftitle.description;
10+
<methodsynopsis>
11+
<modifier>public</modifier> <type>SolrQuery</type><methodname>SolrQuery::setHighlightQuery</methodname>
12+
<methodparam><type>string</type><parameter>q</parameter></methodparam>
13+
</methodsynopsis>
14+
<para>
15+
A query to use for highlighting.
16+
This parameter allows one to highlight different terms or fields than those being used to retrieve documents.
17+
</para>
18+
19+
<para>Default value when not set: the value of the request's q parameter</para>
20+
<para>Solr Parameter reference: hl.q</para>
21+
</refsect1>
22+
23+
<refsect1 role="parameters">
24+
&reftitle.parameters;
25+
<para>
26+
<variablelist>
27+
<varlistentry>
28+
<term><parameter>q</parameter></term>
29+
<listitem>
30+
<para>
31+
Highlight Query
32+
</para>
33+
</listitem>
34+
</varlistentry>
35+
</variablelist>
36+
</para>
37+
</refsect1>
38+
39+
<refsect1 role="returnvalues">
40+
&reftitle.returnvalues;
41+
<para>
42+
Returns the current <classname>SolrQuery</classname> object, if the return value is used.
43+
</para>
44+
</refsect1>
45+
46+
</refentry>
47+
<!-- Keep this comment at the end of the file
48+
Local variables:
49+
mode: sgml
50+
sgml-omittag:t
51+
sgml-shorttag:t
52+
sgml-minimize-attributes:nil
53+
sgml-always-quote-attributes:t
54+
sgml-indent-step:1
55+
sgml-indent-data:t
56+
indent-tabs-mode:nil
57+
sgml-parent-document:nil
58+
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
59+
sgml-exposed-tags:nil
60+
sgml-local-catalogs:nil
61+
sgml-local-ecat-files:nil
62+
End:
63+
vim600: syn=xml fen fdm=syntax fdl=2 si
64+
vim: et tw=78 syn=sgml
65+
vi: ts=1 sw=1
66+
-->

‎reference/solr/versions.xml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -208,6 +208,8 @@
208208
<function name='solrquery::addfacetdateother' from='PECL solr &gt;= 0.9.2'/>
209209
<function name='solrquery::removefacetdateother' from='PECL solr &gt;= 0.9.2'/>
210210
<function name='solrquery::getfacetdateother' from='PECL solr &gt;= 0.9.2'/>
211+
<function name='solrquery::sethighlightquery' from='PECL solr &gt;= 2.7.0'/>
212+
<function name='solrquery::gethighlightquery' from='PECL solr &gt;= 2.7.0'/>
211213
<function name='solrquery::sethighlight' from='PECL solr &gt;= 0.9.2'/>
212214
<function name='solrquery::gethighlight' from='PECL solr &gt;= 0.9.2'/>
213215
<function name='solrquery::addhighlightfield' from='PECL solr &gt;= 0.9.2'/>

0 commit comments

Comments
 (0)