Feature (#28): Add SolrQuery::setHighlightQuery(string )

php · Jan 9, 2024 · d648e04 · d648e04
1 parent 8bb73f7
commit d648e04
Show file tree

Hide file tree

Showing 7 changed files with 67 additions and 6 deletions.
diff --git a/NEWS b/NEWS
@@ -1,3 +1,4 @@
+- Add SolrQuery SolrQuery::setHighlightQuery(string $q) (#28)
 - Fix compile error: libcurl on linux multiarch support (#46)
 - Fix SegFault in SolrClient::optimize() (debug mode)
 - Fix parsed parameter types (#37)

diff --git a/docs/documentation.php b/docs/documentation.php
@@ -2182,6 +2182,15 @@ public function setFacetSort($facetSort, $field_override = null) {}
      * @link http://docs.php.net/manual/en/solrquery.sethighlight.php
      */
     public function setHighlight($flag) {}
+
+    /**
+     * A query to use for highlighting. This parameter allows you to highlight different terms than those being used to retrieve documents.
+     *
+     * @param string $q
+     * @return SolrQuery
+     * @link http://docs.php.net/manual/en/solrquery.sethighlightquery.php
+     */
+    public function setHighlightQuery($q) {}
 
     /**
      * Specifies the highlithing backup field to use
@@ -2431,11 +2440,11 @@ public function setOmitHeader($flag) {}
     /**
      * Sets the search query
      *
-     * @param string $query
+     * @param string $q
      * @return SolrQuery Returns the current SolrQuery object
      * @link http://docs.php.net/manual/en/solrquery.setquery.php
      */
-    public function setQuery($query) {}
+    public function setQuery($q) {}
 
     /**
      * Specifies the maximum number of rows to return in the result

diff --git a/examples/solrquery_004_highlight.php b/examples/solrquery_004_highlight.php
@@ -2,7 +2,9 @@
 
 $query = new SolrQuery();
 
-$query->setHighlight(0);
+$query->setHighlight(true);
+
+$query->setHighlightQuery('title:PHP OR description:Solr');
 
 $query->addHighlightField('a')->addHighlightField('a')->addHighlightField('a');
 

diff --git a/src/php7/php_solr.c b/src/php7/php_solr.c
@@ -959,6 +959,8 @@ static zend_function_entry solr_query_methods[] = {
 	/* HighlightingParameters */
 	PHP_ME(SolrQuery, setHighlight,  SolrQuery_hl_1_1_args, ZEND_ACC_PUBLIC)
 	PHP_ME(SolrQuery, getHighlight,  Solr_no_args, ZEND_ACC_PUBLIC)
+	PHP_ME(SolrQuery, setHighlightQuery,  SolrQuery_setQuery_args, ZEND_ACC_PUBLIC)
+	PHP_ME(SolrQuery, getHighlightQuery,  Solr_no_args, ZEND_ACC_PUBLIC)
 	PHP_ME(SolrQuery, addHighlightField,  SolrQuery_hl_1_1_args, ZEND_ACC_PUBLIC)
 	PHP_ME(SolrQuery, removeHighlightField,  SolrQuery_hl_1_1_args, ZEND_ACC_PUBLIC)
 	PHP_ME(SolrQuery, getHighlightFields,  Solr_no_args, ZEND_ACC_PUBLIC)

diff --git a/src/php7/php_solr.h b/src/php7/php_solr.h
@@ -431,6 +431,8 @@ PHP_METHOD(SolrQuery, getExpandFilterQueries);
 /* HighlightingParameters */
 PHP_METHOD(SolrQuery, setHighlight);
 PHP_METHOD(SolrQuery, getHighlight);
+PHP_METHOD(SolrQuery, setHighlightQuery);
+PHP_METHOD(SolrQuery, getHighlightQuery);
 PHP_METHOD(SolrQuery, addHighlightField);
 PHP_METHOD(SolrQuery, removeHighlightField);
 PHP_METHOD(SolrQuery, getHighlightFields);

diff --git a/src/php7/php_solr_query.c b/src/php7/php_solr_query.c
@@ -2169,6 +2169,31 @@ PHP_METHOD(SolrQuery, setHighlight)
 }
 /* }}} */
 
+/* {{{ proto SolrQuery SolrQuery::setHighlightQuery(string q)
+   Sets the hl.q parameter */
+PHP_METHOD(SolrQuery, setHighlightQuery)
+{
+	solr_char_t *param_name = (solr_char_t *) "hl.q";
+	COMPAT_ARG_SIZE_T param_name_len = sizeof("hl.q")-1;
+	solr_char_t *param_value = NULL;
+	COMPAT_ARG_SIZE_T param_value_len = 0;
+
+	if (zend_parse_parameters(ZEND_NUM_ARGS(), "s", &param_value, &param_value_len) == FAILURE) {
+
+		php_error_docref(NULL, E_WARNING, "Invalid parameters");
+
+		RETURN_NULL();
+	}
+
+	if (solr_set_normal_param(getThis(), param_name, param_name_len, param_value, param_value_len) == FAILURE) {
+
+		RETURN_NULL();
+	}
+	solr_return_solr_params_object();
+}
+/* }}} */
+
+
 /* {{{ proto SolrQuery SolrQuery::addHighlightField(string value)
    Adds another hl.fl parameter. */
 PHP_METHOD(SolrQuery, addHighlightField)
@@ -4563,6 +4588,23 @@ PHP_METHOD(SolrQuery, getHighlight)
 }
 /* }}} */
 
+/* {{{ proto string SolrQuery::getHighlightQuery()
+	 Returns the query */
+PHP_METHOD(SolrQuery, getHighlightQuery)
+{
+	solr_char_t *param_name = (solr_char_t *) "hl.q";
+	COMPAT_ARG_SIZE_T param_name_len = sizeof("hl.q")-1;
+	solr_param_t *solr_param = NULL;
+
+	if (solr_param_find(getThis(), param_name, param_name_len, (solr_param_t **) &solr_param) == FAILURE) {
+
+		RETURN_NULL();
+	}
+
+	solr_normal_param_value_display_string(solr_param, return_value);
+}
+/* }}} */
+
 /* {{{ proto array SolrQuery::getHighlightFields()
 	 Returns the parameter */
 PHP_METHOD(SolrQuery, getHighlightFields)

diff --git a/tests/063.solrquery_HighlightingParameters.phpt b/tests/063.solrquery_HighlightingParameters.phpt
@@ -8,6 +8,7 @@ $query = new SolrQuery();
 ob_start();
 var_dump(
 	$query->getHighlight(),
+	$query->getHighlightQuery(),
 	$query->getHighlightFields(),
 	$query->getHighlightSnippets(),
 	$query->getHighlightSnippets('june'),
@@ -38,7 +39,8 @@ var_dump(
 $nullOutput = ob_get_clean();
 
 
-$query->setHighlight(0);
+$query->setHighlight(true);
+$query->setHighlightQuery('title:PHP OR description:Solr');
 
 $query->addHighlightField('a')->addHighlightField('a')->addHighlightField('a')
 	->addHighlightField('b');
@@ -115,9 +117,9 @@ var_dump(
 echo PHP_EOL.$nullOutput;
 ?>
 --EXPECT--
-hl=false&hl.fl=b&hl.snippets=4&f.june.hl.snippets=5&hl.fragsize=41&f.june.hl.fragsize=52&hl.mergeContiguous=true&f.june.hl.mergeContiguous=false&hl.requireFieldMatch=true&hl.maxAnalyzedChars=53&hl.alternateField=a&f.june.hl.alternateField=b&hl.maxAlternateFieldLength=300&f.june.hl.maxAlternateFieldLength=335&hl.formatter=F&f.june.hl.formatter=G&hl.simple.pre=OO&f.june.hl.simple.pre=PP&hl.simple.post=ZZ&f.june.hl.simple.post=YY&hl.fragmenter=gap&f.june.hl.fragmenter=space&hl.usePhraseHighlighter=false&hl.highlightMultiTerm=true&hl.regex.slop=0.0025&hl.regex.pattern=ekpo&hl.regex.maxAnalyzedChars=5
+hl=true&hl.q=title:PHP OR description:Solr&hl.fl=b&hl.snippets=4&f.june.hl.snippets=5&hl.fragsize=41&f.june.hl.fragsize=52&hl.mergeContiguous=true&f.june.hl.mergeContiguous=false&hl.requireFieldMatch=true&hl.maxAnalyzedChars=53&hl.alternateField=a&f.june.hl.alternateField=b&hl.maxAlternateFieldLength=300&f.june.hl.maxAlternateFieldLength=335&hl.formatter=F&f.june.hl.formatter=G&hl.simple.pre=OO&f.june.hl.simple.pre=PP&hl.simple.post=ZZ&f.june.hl.simple.post=YY&hl.fragmenter=gap&f.june.hl.fragmenter=space&hl.usePhraseHighlighter=false&hl.highlightMultiTerm=true&hl.regex.slop=0.0025&hl.regex.pattern=ekpo&hl.regex.maxAnalyzedChars=5
 
-bool(false)
+bool(true)
 array(1) {
   [0]=>
   string(1) "b"
@@ -175,3 +177,4 @@ NULL
 NULL
 NULL
 NULL
+NULL