diff --git a/reference/solr/functions/solr-get-version.xml b/reference/solr/functions/solr-get-version.xml index db633848f6..377797ecb7 100755 --- a/reference/solr/functions/solr-get-version.xml +++ b/reference/solr/functions/solr-get-version.xml @@ -1,5 +1,5 @@ - + diff --git a/reference/solr/setup.xml b/reference/solr/setup.xml index 8f3b473b2a..8b249934ab 100755 --- a/reference/solr/setup.xml +++ b/reference/solr/setup.xml @@ -9,28 +9,93 @@ PHP version 5.2.11 or later is required. The libxml and curl extensions must also be enabled for the Apache Solr extension to be available. + libxml2 2.6.31 or later is required. + libcurl 7.18.0 or later is also required. + The above library versions are required and attempting to hack the code to make it compile is strongly discouraged. It will fail, possibly with errors that could be hard to debug
&reftitle.install; + The source code can be downloaded here : http://pecl.php.net/package/solr In order to build or compile the extension from source, the following libraries are needed : libxml2 2.6.31 or later is required. libcurl 7.18.0 or later is also required. As mention before, the libxml and curl extensions must be enabled for the Apache Solr extension to be functional. + Do not attempt to hack the code to make it compile. It will fail, possibly with errors that could be hard to debug + + To install the Apache Solr extension directly from PECL, please follow the following steps: + + Installation of Apache Solr via PECL + + + + + To compile from source on UNIX, you will need to follow the steps below : Installation of Apache Solr on UNIX - +]]> @@ -59,8 +125,7 @@ For CLI only use, you do not have to restart your webserver. Installation of Apache Solr on WINDOWS - - + diff --git a/reference/solr/solrillegalargumentexception/getinternalinfo.xml b/reference/solr/solrillegalargumentexception/getinternalinfo.xml index 4c3028fbf7..a915038670 100755 --- a/reference/solr/solrillegalargumentexception/getinternalinfo.xml +++ b/reference/solr/solrillegalargumentexception/getinternalinfo.xml @@ -1,5 +1,5 @@ - + diff --git a/reference/solr/solrillegaloperationexception/getinternalinfo.xml b/reference/solr/solrillegaloperationexception/getinternalinfo.xml index 933ac8d6ef..de8e2a25ac 100755 --- a/reference/solr/solrillegaloperationexception/getinternalinfo.xml +++ b/reference/solr/solrillegaloperationexception/getinternalinfo.xml @@ -1,5 +1,5 @@ - + diff --git a/reference/solr/solrparams/add.xml b/reference/solr/solrparams/add.xml new file mode 100644 index 0000000000..6b3c6de627 --- /dev/null +++ b/reference/solr/solrparams/add.xml @@ -0,0 +1,76 @@ + + + + + + SolrParams::add + This is an alias for SolrParams::addParam + + + + &reftitle.description; + + final public SolrParamsSolrParams::add + stringname + stringvalue + + + This is an alias for SolrParams::addParam + + + + + + &reftitle.parameters; + + + + name + + + The name of the parameter + + + + + value + + + The value of the parameter + + + + + + + + + &reftitle.returnvalues; + +Returns a SolrParams instance on success + + + + + + + diff --git a/reference/solr/solrparams/addparam.xml b/reference/solr/solrparams/addparam.xml index 8767da6a1b..72a11e22a5 100755 --- a/reference/solr/solrparams/addparam.xml +++ b/reference/solr/solrparams/addparam.xml @@ -15,7 +15,7 @@ stringvalue - Adds a parameter to the object. + Adds a parameter to the object. This is used for parameters that can be specified multiple times. diff --git a/reference/solr/solrparams/get.xml b/reference/solr/solrparams/get.xml new file mode 100644 index 0000000000..921d14b203 --- /dev/null +++ b/reference/solr/solrparams/get.xml @@ -0,0 +1,67 @@ + + + + + + SolrParams::get + This is an alias for SolrParams::getParam + + + + &reftitle.description; + + final public mixedSolrParams::get + stringparam_name + + + This is an alias for SolrParams::getParam + + + + + + &reftitle.parameters; + + + + param_name + + + Then name of the parameter + + + + + + + + + &reftitle.returnvalues; + +Returns an array or string depending on the type of parameter + + + + + + + diff --git a/reference/solr/solrparams/getparam.xml b/reference/solr/solrparams/getparam.xml new file mode 100644 index 0000000000..6c1b733dcd --- /dev/null +++ b/reference/solr/solrparams/getparam.xml @@ -0,0 +1,67 @@ + + + + + + SolrParams::getParam + Returns a parameter value + + + + &reftitle.description; + + final public mixedSolrParams::getParam + stringparam_name + + + Returns a parameter with name param_name + + + + + + &reftitle.parameters; + + + + param_name + + + The name of the parameter + + + + + + + + + &reftitle.returnvalues; + +Returns a string or an array depending on the type of the parameter + + + + + + + diff --git a/reference/solr/solrparams/set.xml b/reference/solr/solrparams/set.xml new file mode 100644 index 0000000000..6e39dde1de --- /dev/null +++ b/reference/solr/solrparams/set.xml @@ -0,0 +1,75 @@ + + + + + + SolrParams::set + An alias of SolrParams::setParam + + + + &reftitle.description; + + final public voidSolrParams::set + stringname + stringvalue + + + An alias of SolrParams::setParam + + + + + &reftitle.parameters; + + + + name + + + Then name of the parameter + + + + + value + + + The parameter value + + + + + + + + + &reftitle.returnvalues; + +Returns an instance of the SolrParams object on success + + + + + + + diff --git a/reference/solr/solrparams/setparam.xml b/reference/solr/solrparams/setparam.xml index cca94a2b01..798cd254bc 100755 --- a/reference/solr/solrparams/setparam.xml +++ b/reference/solr/solrparams/setparam.xml @@ -15,7 +15,7 @@ stringvalue - Sets the query parameter to the specified value + Sets the query parameter to the specified value. This is used for parameters that can only be specified once. Subsequent calls with the same parameter name will override the existing value diff --git a/reference/solr/solrparams/tostring.xml b/reference/solr/solrparams/tostring.xml index 52a58307ea..17e930656c 100755 --- a/reference/solr/solrparams/tostring.xml +++ b/reference/solr/solrparams/tostring.xml @@ -3,34 +3,46 @@ - SolrParams::__toString - Returns a string representation of the object + SolrParams::toString + Returns all the name-value pair parameters in the object &reftitle.description; - public stringSolrParams::__toString - + final public stringSolrParams::toString + boolurl_encode - Returns a string representation of the object + Returns all the name-value pair parameters in the object - + &reftitle.parameters; - &no.function.parameters; + + + + url_encode + + + Whether to return URL-encoded values + + + + + &reftitle.returnvalues; - Returns a string + Returns a string on success and &false; on failure. + + + + + SolrQuery::getFacet + Returns the value of the facet parameter + + + + &reftitle.description; + + public boolSolrQuery::getFacet + + + + Returns the value of the facet parameter. + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + +Returns a boolean on success and &null; if not set + + + + + + + diff --git a/reference/solr/solrquery/getfacetdateend.xml b/reference/solr/solrquery/getfacetdateend.xml new file mode 100755 index 0000000000..cdcf916547 --- /dev/null +++ b/reference/solr/solrquery/getfacetdateend.xml @@ -0,0 +1,67 @@ + + + + + + SolrQuery::getFacetDateEnd + Returns the value for the facet.date.end parameter + + + + &reftitle.description; + + public stringSolrQuery::getFacetDateEnd + stringfield_override + + + Returns the value for the facet.date.end parameter. This method accepts an optional field override + + + + + + &reftitle.parameters; + + + + field_override + + + The name of the field + + + + + + + + + &reftitle.returnvalues; + +Returns a string on success and &null; if not set + + + + + + + diff --git a/reference/solr/solrquery/getfacetdatefields.xml b/reference/solr/solrquery/getfacetdatefields.xml new file mode 100755 index 0000000000..051876251f --- /dev/null +++ b/reference/solr/solrquery/getfacetdatefields.xml @@ -0,0 +1,55 @@ + + + + + + SolrQuery::getFacetDateFields + Returns all the facet.date fields + + + + &reftitle.description; + + public arraySolrQuery::getFacetDateFields + + + Returns all the facet.date fields + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns all the facet.date fields as an array or &null; if none was set + + + + + + + diff --git a/reference/solr/solrquery/getfacetdategap.xml b/reference/solr/solrquery/getfacetdategap.xml new file mode 100755 index 0000000000..628da2db81 --- /dev/null +++ b/reference/solr/solrquery/getfacetdategap.xml @@ -0,0 +1,67 @@ + + + + + + SolrQuery::getFacetDateGap + Returns the value of the facet.date.gap parameter + + + + &reftitle.description; + + public stringSolrQuery::getFacetDateGap + stringfield_override + + + Returns the value of the facet.date.gap parameter. It accepts an optional field override + + + + + + &reftitle.parameters; + + + + field_override + + + The name of the field + + + + + + + + + &reftitle.returnvalues; + +Returns a string on success and &null; if not set + + + + + + + diff --git a/reference/solr/solrquery/getfacetdatehardend.xml b/reference/solr/solrquery/getfacetdatehardend.xml new file mode 100755 index 0000000000..8cacec56ac --- /dev/null +++ b/reference/solr/solrquery/getfacetdatehardend.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::getFacetDateHardEnd + Returns the value of the facet.date.hardend parameter + + + + &reftitle.description; + + public stringSolrQuery::getFacetDateHardEnd + stringfield_override + + + Returns the value of the facet.date.hardend parameter. Accepts an optional field override + + + + + + &reftitle.parameters; + + + + field_override + + + The name of the field + + + + + + + + + &reftitle.returnvalues; + +Returns a string on success and &null; if not set + + + + + + diff --git a/reference/solr/solrquery/getfacetdateother.xml b/reference/solr/solrquery/getfacetdateother.xml new file mode 100755 index 0000000000..daa60dc3e8 --- /dev/null +++ b/reference/solr/solrquery/getfacetdateother.xml @@ -0,0 +1,67 @@ + + + + + + SolrQuery::getFacetDateOther + Returns the value for the facet.date.other parameter + + + + &reftitle.description; + + public stringSolrQuery::getFacetDateOther + stringfield_override + + + Returns the value for the facet.date.other parameter. This method accepts an optional field override. + + + + + + &reftitle.parameters; + + + + field_override + + + The name of the field + + + + + + + + + &reftitle.returnvalues; + +Returns a string on success and &null; if not set. + + + + + + + diff --git a/reference/solr/solrquery/getfacetdatestart.xml b/reference/solr/solrquery/getfacetdatestart.xml new file mode 100755 index 0000000000..6832b61975 --- /dev/null +++ b/reference/solr/solrquery/getfacetdatestart.xml @@ -0,0 +1,65 @@ + + + + + + SolrQuery::getFacetDateStart + Returns the lower bound for the first date range for all date faceting on this field + + + + &reftitle.description; + + public stringSolrQuery::getFacetDateStart + stringfield_override + + + Returns the lower bound for the first date range for all date faceting on this field. Accepts an optional field override + + + + + &reftitle.parameters; + + + + field_override + + + The name of the field + + + + + + + + + &reftitle.returnvalues; + +Returns a string on success and &null; if not set + + + + + + diff --git a/reference/solr/solrquery/getfacetfields.xml b/reference/solr/solrquery/getfacetfields.xml new file mode 100755 index 0000000000..b6fff67713 --- /dev/null +++ b/reference/solr/solrquery/getfacetfields.xml @@ -0,0 +1,54 @@ + + + + + + SolrQuery::getFacetFields + Returns all the facet fields + + + + &reftitle.description; + + public arraySolrQuery::getFacetFields + + + + Returns all the facet fields + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + +Returns an array of all the fields and &null; if none was set + + + + + diff --git a/reference/solr/solrquery/getfacetlimit.xml b/reference/solr/solrquery/getfacetlimit.xml new file mode 100755 index 0000000000..3d7a98902c --- /dev/null +++ b/reference/solr/solrquery/getfacetlimit.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::getFacetLimit + Returns the maximum number of constraint counts that should be returned for the facet fields + + + + &reftitle.description; + + public intSolrQuery::getFacetLimit + stringfield_override + + + Returns the maximum number of constraint counts that should be returned for the facet fields. This method accepts an optional field override + + + + + + &reftitle.parameters; + + + + field_override + + + The name of the field to override for + + + + + + + + + &reftitle.returnvalues; + +Returns an integer on success and &null; if not set + + + + + + diff --git a/reference/solr/solrquery/getfacetmethod.xml b/reference/solr/solrquery/getfacetmethod.xml new file mode 100755 index 0000000000..ced4a61e36 --- /dev/null +++ b/reference/solr/solrquery/getfacetmethod.xml @@ -0,0 +1,67 @@ + + + + + + SolrQuery::getFacetMethod + Returns the value of the facet.method parameter + + + + &reftitle.description; + + public stringSolrQuery::getFacetMethod + stringfield_override + + + Returns the value of the facet.method parameter. This accepts an optional field override. + + + + + + &reftitle.parameters; + + + + field_override + + + The name of the field + + + + + + + + + &reftitle.returnvalues; + +Returns an string on success and &null; if not set + + + + + + + diff --git a/reference/solr/solrquery/getfacetmincount.xml b/reference/solr/solrquery/getfacetmincount.xml new file mode 100755 index 0000000000..2d443d79ce --- /dev/null +++ b/reference/solr/solrquery/getfacetmincount.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::getFacetMinCount + Returns the minimum counts for facet fields should be included in the response + + + + &reftitle.description; + + public intSolrQuery::getFacetMinCount + stringfield_override + + + Returns the minimum counts for facet fields should be included in the response. It accepts an optional field override + + + + + + &reftitle.parameters; + + + + field_override + + + The name of the field + + + + + + + + + &reftitle.returnvalues; + +Returns an integer on success and &null; if not set + + + + + + diff --git a/reference/solr/solrquery/getfacetmissing.xml b/reference/solr/solrquery/getfacetmissing.xml new file mode 100755 index 0000000000..66723220a3 --- /dev/null +++ b/reference/solr/solrquery/getfacetmissing.xml @@ -0,0 +1,67 @@ + + + + + + SolrQuery::getFacetMissing + Returns the current state of the facet.missing parameter + + + + &reftitle.description; + + public boolSolrQuery::getFacetMissing + stringfield_override + + + Returns the current state of the facet.missing parameter. This accepts an optional field override + + + + + + &reftitle.parameters; + + + + field_override + + + The name of the field + + + + + + + + + &reftitle.returnvalues; + +Returns a boolean on success and &null; if not set + + + + + + + diff --git a/reference/solr/solrquery/getfacetoffset.xml b/reference/solr/solrquery/getfacetoffset.xml new file mode 100755 index 0000000000..3e07f12ea0 --- /dev/null +++ b/reference/solr/solrquery/getfacetoffset.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::getFacetOffset + Returns an offset into the list of constraints to be used for pagination + + + + &reftitle.description; + + public intSolrQuery::getFacetOffset + stringfield_override + + + Returns an offset into the list of constraints to be used for pagination. Accepts an optional field override + + + + + + &reftitle.parameters; + + + + field_override + + + The name of the field to override for. + + + + + + + + + &reftitle.returnvalues; + +Returns an integer on success and &null; if not set + + + + + + diff --git a/reference/solr/solrquery/getfacetprefix.xml b/reference/solr/solrquery/getfacetprefix.xml new file mode 100755 index 0000000000..1468b64509 --- /dev/null +++ b/reference/solr/solrquery/getfacetprefix.xml @@ -0,0 +1,67 @@ + + + + + + SolrQuery::getFacetPrefix + Returns the facet prefix + + + + &reftitle.description; + + public stringSolrQuery::getFacetPrefix + stringfield_override + + + Returns the facet prefix + + + + + + &reftitle.parameters; + + + + field_override + + + The name of the field + + + + + + + + + &reftitle.returnvalues; + +Returns a string on success and &null; if not set. + + + + + + + diff --git a/reference/solr/solrquery/getfacetqueries.xml b/reference/solr/solrquery/getfacetqueries.xml new file mode 100755 index 0000000000..73b16c8145 --- /dev/null +++ b/reference/solr/solrquery/getfacetqueries.xml @@ -0,0 +1,55 @@ + + + + + + SolrQuery::getFacetQueries + Returns all the facet queries + + + + &reftitle.description; + + public arraySolrQuery::getFacetQueries + + + +Returns all the facet queries + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + +Returns an array on success and &null; if not set. + + + + + + + diff --git a/reference/solr/solrquery/getfacetsort.xml b/reference/solr/solrquery/getfacetsort.xml new file mode 100755 index 0000000000..95fe11f7d7 --- /dev/null +++ b/reference/solr/solrquery/getfacetsort.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::getFacetSort + Returns the facet sort type + + + + &reftitle.description; + + public intSolrQuery::getFacetSort + stringfield_override + + + Returns an integer (SolrQuery::FACET_SORT_INDEX or SolrQuery::FACET_SORT_COUNT) + + + + + + &reftitle.parameters; + + + + field_override + + + The name of the field + + + + + + + + + &reftitle.returnvalues; + + Returns an integer (SolrQuery::FACET_SORT_INDEX or SolrQuery::FACET_SORT_COUNT) on success or &null; if not set. + + + + + + diff --git a/reference/solr/solrquery/getfields.xml b/reference/solr/solrquery/getfields.xml new file mode 100755 index 0000000000..2ca9614423 --- /dev/null +++ b/reference/solr/solrquery/getfields.xml @@ -0,0 +1,54 @@ + + + + + + SolrQuery::getFields + Returns the list of fields that will be returned in the response + + + + &reftitle.description; + + public arraySolrQuery::getFields + + + + Returns the list of fields that will be returned in the response + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + +Returns an array on success and &null; if not set. + + + + + diff --git a/reference/solr/solrquery/getfilterqueries.xml b/reference/solr/solrquery/getfilterqueries.xml new file mode 100755 index 0000000000..1795e41995 --- /dev/null +++ b/reference/solr/solrquery/getfilterqueries.xml @@ -0,0 +1,55 @@ + + + + + + SolrQuery::getFilterQueries + Returns an array of filter queries + + + + &reftitle.description; + + public arraySolrQuery::getFilterQueries + + + + Returns an array of filter queries. These are queries that can be used to restrict the super set of documents that can be returned, without influencing score + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + +Returns an array on success and &null; if not set. + + + + + + + diff --git a/reference/solr/solrquery/gethighlight.xml b/reference/solr/solrquery/gethighlight.xml new file mode 100755 index 0000000000..07431b57e9 --- /dev/null +++ b/reference/solr/solrquery/gethighlight.xml @@ -0,0 +1,58 @@ + + + + + + SolrQuery::getHighlight + Returns the state of the hl parameter + + + + &reftitle.description; + + public boolSolrQuery::getHighlight + + + + Returns a boolean indicating whether or not to enable highlighted snippets to be generated in the query response. + + + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + +Returns a boolean on success and &null; if not set. + + + + + + + diff --git a/reference/solr/solrquery/gethighlightalternatefield.xml b/reference/solr/solrquery/gethighlightalternatefield.xml new file mode 100755 index 0000000000..3992ee6481 --- /dev/null +++ b/reference/solr/solrquery/gethighlightalternatefield.xml @@ -0,0 +1,67 @@ + + + + + + SolrQuery::getHighlightAlternateField + Returns the highlight field to use as backup or default + + + + &reftitle.description; + + public stringSolrQuery::getHighlightAlternateField + stringfield_override + + + Returns the highlight field to use as backup or default. It accepts an optional override. + + + + + + &reftitle.parameters; + + + + field_override + + + The name of the field + + + + + + + + + &reftitle.returnvalues; + +Returns a string on success and &null; if not set. + + + + + + + diff --git a/reference/solr/solrquery/gethighlightfields.xml b/reference/solr/solrquery/gethighlightfields.xml new file mode 100755 index 0000000000..0ead847922 --- /dev/null +++ b/reference/solr/solrquery/gethighlightfields.xml @@ -0,0 +1,55 @@ + + + + + + SolrQuery::getHighlightFields + Returns all the fields that Solr should generate highlighted snippets for + + + + &reftitle.description; + + public arraySolrQuery::getHighlightFields + + + + Returns all the fields that Solr should generate highlighted snippets for + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + +Returns an array on success and &null; if not set. + + + + + + + diff --git a/reference/solr/solrquery/gethighlightformatter.xml b/reference/solr/solrquery/gethighlightformatter.xml new file mode 100755 index 0000000000..1a3657f81f --- /dev/null +++ b/reference/solr/solrquery/gethighlightformatter.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::getHighlightFormatter + Returns the formatter for the highlighted output + + + + &reftitle.description; + + public stringSolrQuery::getHighlightFormatter + stringfield_override + + + Returns the formatter for the highlighted output + + + + + + &reftitle.parameters; + + + + field_override + + + The name of the field + + + + + + + + + &reftitle.returnvalues; + +Returns a string on success and &null; if not set. + + + + + + diff --git a/reference/solr/solrquery/gethighlightfragmenter.xml b/reference/solr/solrquery/gethighlightfragmenter.xml new file mode 100755 index 0000000000..660463922b --- /dev/null +++ b/reference/solr/solrquery/gethighlightfragmenter.xml @@ -0,0 +1,69 @@ + + + + + + SolrQuery::getHighlightFragmenter + Returns the text snippet generator for highlighted text + + + + &reftitle.description; + + public stringSolrQuery::getHighlightFragmenter + stringfield_override + + + Returns the text snippet generator for highlighted text. Accepts an optional field override. + + + + + + + + &reftitle.parameters; + + + + field_override + + + The name of the field + + + + + + + + + &reftitle.returnvalues; + +Returns a string on success and &null; if not set. + + + + + + + diff --git a/reference/solr/solrquery/gethighlightfragsize.xml b/reference/solr/solrquery/gethighlightfragsize.xml new file mode 100755 index 0000000000..98fe3b0ab3 --- /dev/null +++ b/reference/solr/solrquery/gethighlightfragsize.xml @@ -0,0 +1,65 @@ + + + + + + SolrQuery::getHighlightFragsize + Returns the number of characters of fragments to consider for highlighting + + + + &reftitle.description; + + public intSolrQuery::getHighlightFragsize + stringfield_override + + + Returns the number of characters of fragments to consider for highlighting. Zero implies no fragmenting. The entire field should be used. + + + + + + &reftitle.parameters; + + + + field_override + + + The name of the field + + + + + + + + + &reftitle.returnvalues; + +Returns an integer on success or &null; if not set. + + + + + diff --git a/reference/solr/solrquery/gethighlighthighlightmultiterm.xml b/reference/solr/solrquery/gethighlighthighlightmultiterm.xml new file mode 100755 index 0000000000..9812eb83b6 --- /dev/null +++ b/reference/solr/solrquery/gethighlighthighlightmultiterm.xml @@ -0,0 +1,55 @@ + + + + + + SolrQuery::getHighlightHighlightMultiTerm + Returns whether or not to enable highlighting for range/wildcard/fuzzy/prefix queries + + + + &reftitle.description; + + public boolSolrQuery::getHighlightHighlightMultiTerm + + + + Returns whether or not to enable highlighting for range/wildcard/fuzzy/prefix queries + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + +Returns a boolean on success and &null; if not set. + + + + + + + diff --git a/reference/solr/solrquery/gethighlightmaxalternatefieldlength.xml b/reference/solr/solrquery/gethighlightmaxalternatefieldlength.xml new file mode 100755 index 0000000000..d5c10cff9f --- /dev/null +++ b/reference/solr/solrquery/gethighlightmaxalternatefieldlength.xml @@ -0,0 +1,67 @@ + + + + + + SolrQuery::getHighlightMaxAlternateFieldLength + Returns the maximum number of characters of the field to return + + + + &reftitle.description; + + public intSolrQuery::getHighlightMaxAlternateFieldLength + stringfield_override + + + Returns the maximum number of characters of the field to return + + + + + + &reftitle.parameters; + + + + field_override + + + The name of the field + + + + + + + + + &reftitle.returnvalues; + +Returns an integer on success and &null; if not set. + + + + + + + diff --git a/reference/solr/solrquery/gethighlightmaxanalyzedchars.xml b/reference/solr/solrquery/gethighlightmaxanalyzedchars.xml new file mode 100755 index 0000000000..614f5351cf --- /dev/null +++ b/reference/solr/solrquery/gethighlightmaxanalyzedchars.xml @@ -0,0 +1,55 @@ + + + + + + SolrQuery::getHighlightMaxAnalyzedChars + Returns the maximum number of characters into a document to look for suitable snippets + + + + &reftitle.description; + + public intSolrQuery::getHighlightMaxAnalyzedChars + + + + Returns the maximum number of characters into a document to look for suitable snippets + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + +Returns an integer on success and &null; if not set. + + + + + + diff --git a/reference/solr/solrquery/gethighlightmergecontiguous.xml b/reference/solr/solrquery/gethighlightmergecontiguous.xml new file mode 100755 index 0000000000..7c89341d78 --- /dev/null +++ b/reference/solr/solrquery/gethighlightmergecontiguous.xml @@ -0,0 +1,67 @@ + + + + + + SolrQuery::getHighlightMergeContiguous + Returns whether or not the collapse contiguous fragments into a single fragment + + + + &reftitle.description; + + public boolSolrQuery::getHighlightMergeContiguous + stringfield_override + + + Returns whether or not the collapse contiguous fragments into a single fragment. Accepts an optional field override. + + + + + + &reftitle.parameters; + + + + field_override + + + The name of the field + + + + + + + + + &reftitle.returnvalues; + +Returns a boolean on success and &null; if not set. + + + + + + + diff --git a/reference/solr/solrquery/gethighlightregexmaxanalyzedchars.xml b/reference/solr/solrquery/gethighlightregexmaxanalyzedchars.xml new file mode 100755 index 0000000000..f78e4e3abb --- /dev/null +++ b/reference/solr/solrquery/gethighlightregexmaxanalyzedchars.xml @@ -0,0 +1,56 @@ + + + + + + SolrQuery::getHighlightRegexMaxAnalyzedChars + Returns the maximum number of characters from a field when using the regex fragmenter + + + + &reftitle.description; + + public intSolrQuery::getHighlightRegexMaxAnalyzedChars + + + + Returns the maximum number of characters from a field when using the regex fragmenter + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + +Returns an integer on success and &null; if not set. + + + + + + + diff --git a/reference/solr/solrquery/gethighlightregexpattern.xml b/reference/solr/solrquery/gethighlightregexpattern.xml new file mode 100755 index 0000000000..65c8730128 --- /dev/null +++ b/reference/solr/solrquery/gethighlightregexpattern.xml @@ -0,0 +1,55 @@ + + + + + + SolrQuery::getHighlightRegexPattern + Returns the regular expression for fragmenting + + + + &reftitle.description; + + public stringSolrQuery::getHighlightRegexPattern + + + + Returns the regular expression used for fragmenting + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + +Returns a string on success and &null; if not set. + + + + + + + diff --git a/reference/solr/solrquery/gethighlightregexslop.xml b/reference/solr/solrquery/gethighlightregexslop.xml new file mode 100755 index 0000000000..28e4a77a45 --- /dev/null +++ b/reference/solr/solrquery/gethighlightregexslop.xml @@ -0,0 +1,56 @@ + + + + + + SolrQuery::getHighlightRegexSlop + Returns the deviation factor from the ideal fragment size + + + + &reftitle.description; + + public floatSolrQuery::getHighlightRegexSlop + + + + Returns the factor by which the regex fragmenter can deviate from the ideal fragment size to accomodate the regular expression + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + +Returns a double on success and &null; if not set. + + + + + + + diff --git a/reference/solr/solrquery/gethighlightrequirefieldmatch.xml b/reference/solr/solrquery/gethighlightrequirefieldmatch.xml new file mode 100755 index 0000000000..facabe0e71 --- /dev/null +++ b/reference/solr/solrquery/gethighlightrequirefieldmatch.xml @@ -0,0 +1,56 @@ + + + + + + SolrQuery::getHighlightRequireFieldMatch + Returns if a field will only be highlighted if the query matched in this particular field + + + + &reftitle.description; + + public boolSolrQuery::getHighlightRequireFieldMatch + + + + Returns if a field will only be highlighted if the query matched in this particular field. + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + +Returns a boolean on success and &null; if not set. + + + + + + + diff --git a/reference/solr/solrquery/gethighlightsimplepost.xml b/reference/solr/solrquery/gethighlightsimplepost.xml new file mode 100755 index 0000000000..3ea31b84a4 --- /dev/null +++ b/reference/solr/solrquery/gethighlightsimplepost.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::getHighlightSimplePost + Returns the text which appears after a highlighted term + + + + &reftitle.description; + + public stringSolrQuery::getHighlightSimplePost + stringfield_override + + + Returns the text which appears after a highlighted term. Accepts an optional field override + + + + + &reftitle.parameters; + + + + field_override + + + The name of the field + + + + + + + + + &reftitle.returnvalues; + +Returns a string on success and &null; if not set. + + + + + + + diff --git a/reference/solr/solrquery/gethighlightsimplepre.xml b/reference/solr/solrquery/gethighlightsimplepre.xml new file mode 100755 index 0000000000..de9af9fde2 --- /dev/null +++ b/reference/solr/solrquery/gethighlightsimplepre.xml @@ -0,0 +1,69 @@ + + + + + + SolrQuery::getHighlightSimplePre + Returns the text which appears before a highlighted term + + + + &reftitle.description; + + public stringSolrQuery::getHighlightSimplePre + stringfield_override + + + Returns the text which appears before a highlighted term. Accepts an optional field override + + + + + + + + &reftitle.parameters; + + + + field_override + + + The name of the field + + + + + + + + + &reftitle.returnvalues; + +Returns a string on success and &null; if not set. + + + + + + + diff --git a/reference/solr/solrquery/gethighlightsnippets.xml b/reference/solr/solrquery/gethighlightsnippets.xml new file mode 100755 index 0000000000..b72488b0fa --- /dev/null +++ b/reference/solr/solrquery/gethighlightsnippets.xml @@ -0,0 +1,69 @@ + + + + + + SolrQuery::getHighlightSnippets + Returns the maximum number of highlighted snippets to generate per field + + + + &reftitle.description; + + public intSolrQuery::getHighlightSnippets + stringfield_override + + + Returns the maximum number of highlighted snippets to generate per field. Accepts an optional field override + + + + + + + + &reftitle.parameters; + + + + field_override + + + The name of the field + + + + + + + + + &reftitle.returnvalues; + +Returns an integer on success and &null; if not set. + + + + + + + diff --git a/reference/solr/solrquery/gethighlightusephrasehighlighter.xml b/reference/solr/solrquery/gethighlightusephrasehighlighter.xml new file mode 100755 index 0000000000..c18e59bb6e --- /dev/null +++ b/reference/solr/solrquery/gethighlightusephrasehighlighter.xml @@ -0,0 +1,56 @@ + + + + + + SolrQuery::getHighlightUsePhraseHighlighter + Returns the state of the hl.usePhraseHighlighter parameter + + + + &reftitle.description; + + public boolSolrQuery::getHighlightUsePhraseHighlighter + + + + Returns whether or not to use SpanScorer to highlight phrase terms only when they appear within the query phrase in the document. + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + +Returns a boolean on success and &null; if not set. + + + + + + + diff --git a/reference/solr/solrquery/getmlt.xml b/reference/solr/solrquery/getmlt.xml new file mode 100755 index 0000000000..12a35b4a16 --- /dev/null +++ b/reference/solr/solrquery/getmlt.xml @@ -0,0 +1,58 @@ + + + + + + SolrQuery::getMlt + Returns whether or not MoreLikeThis results should be enabled + + + + &reftitle.description; + + public boolSolrQuery::getMlt + + + + Returns whether or not MoreLikeThis results should be enabled + + + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + +Returns a boolean on success and &null; if not set. + + + + + + + diff --git a/reference/solr/solrquery/getmltboost.xml b/reference/solr/solrquery/getmltboost.xml new file mode 100755 index 0000000000..88882f0d6e --- /dev/null +++ b/reference/solr/solrquery/getmltboost.xml @@ -0,0 +1,56 @@ + + + + + + SolrQuery::getMltBoost + Returns whether or not the query will be boosted by the interesting term relevance + + + + &reftitle.description; + + public boolSolrQuery::getMltBoost + + + + Returns whether or not the query will be boosted by the interesting term relevance + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + +Returns a boolean on success and &null; if not set. + + + + + + + diff --git a/reference/solr/solrquery/getmltcount.xml b/reference/solr/solrquery/getmltcount.xml new file mode 100755 index 0000000000..c4f098c343 --- /dev/null +++ b/reference/solr/solrquery/getmltcount.xml @@ -0,0 +1,56 @@ + + + + + + SolrQuery::getMltCount + Returns the number of similar documents to return for each result + + + + &reftitle.description; + + public intSolrQuery::getMltCount + + + + Returns the number of similar documents to return for each result + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + +Returns an integer on success and &null; if not set. + + + + + + + diff --git a/reference/solr/solrquery/getmltfields.xml b/reference/solr/solrquery/getmltfields.xml new file mode 100755 index 0000000000..53734390c8 --- /dev/null +++ b/reference/solr/solrquery/getmltfields.xml @@ -0,0 +1,56 @@ + + + + + + SolrQuery::getMltFields + Returns all the fields to use for similarity + + + + &reftitle.description; + + public arraySolrQuery::getMltFields + + + +Returns all the fields to use for similarity + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + +Returns an array on success and &null; if not set. + + + + + + + diff --git a/reference/solr/solrquery/getmltmaxnumqueryterms.xml b/reference/solr/solrquery/getmltmaxnumqueryterms.xml new file mode 100755 index 0000000000..ee16a67a5a --- /dev/null +++ b/reference/solr/solrquery/getmltmaxnumqueryterms.xml @@ -0,0 +1,55 @@ + + + + + + SolrQuery::getMltMaxNumQueryTerms + Returns the maximum number of query terms that will be included in any generated query + + + + &reftitle.description; + + public intSolrQuery::getMltMaxNumQueryTerms + + + + Returns the maximum number of query terms that will be included in any generated query + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + +Returns an integer on success and &null; if not set. + + + + + + diff --git a/reference/solr/solrquery/getmltmaxnumtokens.xml b/reference/solr/solrquery/getmltmaxnumtokens.xml new file mode 100755 index 0000000000..2da72aae95 --- /dev/null +++ b/reference/solr/solrquery/getmltmaxnumtokens.xml @@ -0,0 +1,56 @@ + + + + + + SolrQuery::getMltMaxNumTokens + Returns the maximum number of tokens to parse in each document field that is not stored with TermVector support + + + + &reftitle.description; + + public intSolrQuery::getMltMaxNumTokens + + + + Returns the maximum number of tokens to parse in each document field that is not stored with TermVector support + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + +Returns an integer on success and &null; if not set. + + + + + + + diff --git a/reference/solr/solrquery/getmltmaxwordlength.xml b/reference/solr/solrquery/getmltmaxwordlength.xml new file mode 100755 index 0000000000..5ab89beb6f --- /dev/null +++ b/reference/solr/solrquery/getmltmaxwordlength.xml @@ -0,0 +1,55 @@ + + + + + + SolrQuery::getMltMaxWordLength + Returns the maximum word length above which words will be ignored + + + + &reftitle.description; + + public intSolrQuery::getMltMaxWordLength + + + + Returns the maximum word length above which words will be ignored + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + +Returns an integer on success and &null; if not set. + + + + + + diff --git a/reference/solr/solrquery/getmltmindocfrequency.xml b/reference/solr/solrquery/getmltmindocfrequency.xml new file mode 100755 index 0000000000..e1ead6f212 --- /dev/null +++ b/reference/solr/solrquery/getmltmindocfrequency.xml @@ -0,0 +1,56 @@ + + + + + + SolrQuery::getMltMinDocFrequency + Returns the treshold frequency at which words will be ignored which do not occur in at least this many docs + + + + &reftitle.description; + + public intSolrQuery::getMltMinDocFrequency + + + + Returns the treshold frequency at which words will be ignored which do not occur in at least this many docs + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + +Returns an integer on success and &null; if not set. + + + + + + + diff --git a/reference/solr/solrquery/getmltmintermfrequency.xml b/reference/solr/solrquery/getmltmintermfrequency.xml new file mode 100755 index 0000000000..c6ff8d082e --- /dev/null +++ b/reference/solr/solrquery/getmltmintermfrequency.xml @@ -0,0 +1,56 @@ + + + + + + SolrQuery::getMltMinTermFrequency + Returns the frequency below which terms will be ignored in the source document + + + + &reftitle.description; + + public intSolrQuery::getMltMinTermFrequency + + + + Returns the frequency below which terms will be ignored in the source document + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + +Returns an integer on success and &null; if not set. + + + + + + + diff --git a/reference/solr/solrquery/getmltminwordlength.xml b/reference/solr/solrquery/getmltminwordlength.xml new file mode 100755 index 0000000000..81571999c6 --- /dev/null +++ b/reference/solr/solrquery/getmltminwordlength.xml @@ -0,0 +1,56 @@ + + + + + + SolrQuery::getMltMinWordLength + Returns the minimum word length below which words will be ignored + + + + &reftitle.description; + + public intSolrQuery::getMltMinWordLength + + + + Returns the minimum word length below which words will be ignored + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + +Returns an integer on success and &null; if not set. + + + + + + + diff --git a/reference/solr/solrquery/getmltqueryfields.xml b/reference/solr/solrquery/getmltqueryfields.xml new file mode 100755 index 0000000000..ad57cae90a --- /dev/null +++ b/reference/solr/solrquery/getmltqueryfields.xml @@ -0,0 +1,58 @@ + + + + + + SolrQuery::getMltQueryFields + Returns the query fields and their boosts + + + + &reftitle.description; + + public arraySolrQuery::getMltQueryFields + + + + Returns the query fields and their boosts + + + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + +Returns an array on success and &null; if not set. + + + + + + + diff --git a/reference/solr/solrquery/getquery.xml b/reference/solr/solrquery/getquery.xml new file mode 100755 index 0000000000..004c24b8b6 --- /dev/null +++ b/reference/solr/solrquery/getquery.xml @@ -0,0 +1,58 @@ + + + + + + SolrQuery::getQuery + Returns the main query + + + + &reftitle.description; + + public stringSolrQuery::getQuery + + + +Returns the main search query + + + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + +Returns a string on success and &null; if not set. + + + + + + + diff --git a/reference/solr/solrquery/getrows.xml b/reference/solr/solrquery/getrows.xml new file mode 100755 index 0000000000..4eb8cdb150 --- /dev/null +++ b/reference/solr/solrquery/getrows.xml @@ -0,0 +1,58 @@ + + + + + + SolrQuery::getRows + Returns the maximum number of documents + + + + &reftitle.description; + + public intSolrQuery::getRows + + + + Returns the maximum number of documents from the complete result set to return to the client for every request + + + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + +Returns an integer on success and &null; if not set. + + + + + + + diff --git a/reference/solr/solrquery/getsortfields.xml b/reference/solr/solrquery/getsortfields.xml new file mode 100755 index 0000000000..576835906c --- /dev/null +++ b/reference/solr/solrquery/getsortfields.xml @@ -0,0 +1,56 @@ + + + + + + SolrQuery::getSortFields + Returns all the sort fields + + + + &reftitle.description; + + public arraySolrQuery::getSortFields + + + +Returns all the sort fields + + + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + +Returns an array on success and &null; if none of the parameters was set. + + + + + diff --git a/reference/solr/solrquery/getstart.xml b/reference/solr/solrquery/getstart.xml new file mode 100755 index 0000000000..3d84ee17f0 --- /dev/null +++ b/reference/solr/solrquery/getstart.xml @@ -0,0 +1,58 @@ + + + + + + SolrQuery::getStart + Returns the offset in the complete result set + + + + &reftitle.description; + + public intSolrQuery::getStart + + + + Returns the offset in the complete result set for the queries where the set of returned documents should begin. + + + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + +Returns an integer on success and &null; if not set. + + + + + + + diff --git a/reference/solr/solrquery/getstats.xml b/reference/solr/solrquery/getstats.xml new file mode 100755 index 0000000000..c59ff59531 --- /dev/null +++ b/reference/solr/solrquery/getstats.xml @@ -0,0 +1,58 @@ + + + + + + SolrQuery::getStats + Returns whether or not stats is enabled + + + + &reftitle.description; + + public boolSolrQuery::getStats + + + + Returns whether or not stats is enabled + + + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + +Returns a boolean on success and &null; if not set. + + + + + + + diff --git a/reference/solr/solrquery/getstatsfacets.xml b/reference/solr/solrquery/getstatsfacets.xml new file mode 100755 index 0000000000..08ae72c694 --- /dev/null +++ b/reference/solr/solrquery/getstatsfacets.xml @@ -0,0 +1,55 @@ + + + + + + SolrQuery::getStatsFacets + Returns all the stats facets that were set + + + + &reftitle.description; + + public arraySolrQuery::getStatsFacets + + + + Returns all the stats facets that were set + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + +Returns an array on success and &null; if not set. + + + + + + + diff --git a/reference/solr/solrquery/getstatsfields.xml b/reference/solr/solrquery/getstatsfields.xml new file mode 100755 index 0000000000..08c6f8fe05 --- /dev/null +++ b/reference/solr/solrquery/getstatsfields.xml @@ -0,0 +1,56 @@ + + + + + + SolrQuery::getStatsFields + Returns all the statistics fields + + + + &reftitle.description; + + public arraySolrQuery::getStatsFields + + + + Returns all the statistics fields + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + +Returns an array on success and &null; if not set. + + + + + + + diff --git a/reference/solr/solrquery/getterms.xml b/reference/solr/solrquery/getterms.xml new file mode 100755 index 0000000000..06a114e436 --- /dev/null +++ b/reference/solr/solrquery/getterms.xml @@ -0,0 +1,57 @@ + + + + + + SolrQuery::getTerms + Returns whether or not the TermsComponent is enabled + + + + &reftitle.description; + + public boolSolrQuery::getTerms + + + + Returns whether or not the TermsComponent is enabled + + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + +Returns a boolean on success and &null; if not set. + + + + + + + diff --git a/reference/solr/solrquery/gettermsfield.xml b/reference/solr/solrquery/gettermsfield.xml new file mode 100755 index 0000000000..f7854bfbe6 --- /dev/null +++ b/reference/solr/solrquery/gettermsfield.xml @@ -0,0 +1,58 @@ + + + + + + SolrQuery::getTermsField + Returns the field from which the terms are retrieved + + + + &reftitle.description; + + public stringSolrQuery::getTermsField + + + + Returns the field from which the terms are retrieved + + + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + +Returns a string on success and &null; if not set. + + + + + + + diff --git a/reference/solr/solrquery/gettermsincludelowerbound.xml b/reference/solr/solrquery/gettermsincludelowerbound.xml new file mode 100755 index 0000000000..388e46bbdd --- /dev/null +++ b/reference/solr/solrquery/gettermsincludelowerbound.xml @@ -0,0 +1,55 @@ + + + + + + SolrQuery::getTermsIncludeLowerBound + Returns whether or not to include the lower bound in the result set + + + + &reftitle.description; + + public boolSolrQuery::getTermsIncludeLowerBound + + + + Returns whether or not to include the lower bound in the result set + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + +Returns a boolean on success and &null; if not set. + + + + + + diff --git a/reference/solr/solrquery/gettermsincludeupperbound.xml b/reference/solr/solrquery/gettermsincludeupperbound.xml new file mode 100755 index 0000000000..b2ffc64a66 --- /dev/null +++ b/reference/solr/solrquery/gettermsincludeupperbound.xml @@ -0,0 +1,56 @@ + + + + + + SolrQuery::getTermsIncludeUpperBound + Returns whether or not to include the upper bound term in the result set + + + + &reftitle.description; + + public boolSolrQuery::getTermsIncludeUpperBound + + + + Returns whether or not to include the upper bound term in the result set + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + +Returns a boolean on success and &null; if not set. + + + + + + + diff --git a/reference/solr/solrquery/gettermslimit.xml b/reference/solr/solrquery/gettermslimit.xml new file mode 100755 index 0000000000..d2f45c0595 --- /dev/null +++ b/reference/solr/solrquery/gettermslimit.xml @@ -0,0 +1,56 @@ + + + + + + SolrQuery::getTermsLimit + Returns the maximum number of terms Solr should return + + + + &reftitle.description; + + public intSolrQuery::getTermsLimit + + + + Returns the maximum number of terms Solr should return + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + +Returns an integer on success and &null; if not set. + + + + + + + diff --git a/reference/solr/solrquery/gettermslowerbound.xml b/reference/solr/solrquery/gettermslowerbound.xml new file mode 100755 index 0000000000..cb593be780 --- /dev/null +++ b/reference/solr/solrquery/gettermslowerbound.xml @@ -0,0 +1,56 @@ + + + + + + SolrQuery::getTermsLowerBound + Returns the term to start at + + + + &reftitle.description; + + public stringSolrQuery::getTermsLowerBound + + + + Returns the term to start at + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + +Returns a string on success and &null; if not set. + + + + + + + diff --git a/reference/solr/solrquery/gettermsmaxcount.xml b/reference/solr/solrquery/gettermsmaxcount.xml new file mode 100755 index 0000000000..d4c440a2ed --- /dev/null +++ b/reference/solr/solrquery/gettermsmaxcount.xml @@ -0,0 +1,58 @@ + + + + + + SolrQuery::getTermsMaxCount + Returns the maximum document frequency + + + + &reftitle.description; + + public intSolrQuery::getTermsMaxCount + + + + Returns the maximum document frequency + + + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + +Returns an integer on success and &null; if not set. + + + + + + + diff --git a/reference/solr/solrquery/gettermsmincount.xml b/reference/solr/solrquery/gettermsmincount.xml new file mode 100755 index 0000000000..4eb0f0ff9a --- /dev/null +++ b/reference/solr/solrquery/gettermsmincount.xml @@ -0,0 +1,56 @@ + + + + + + SolrQuery::getTermsMinCount + Returns the minimum document frequency to return in order to be included + + + + &reftitle.description; + + public intSolrQuery::getTermsMinCount + + + + Returns the minimum document frequency to return in order to be included + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + +Returns an integer on success and &null; if not set. + + + + + + + diff --git a/reference/solr/solrquery/gettermsprefix.xml b/reference/solr/solrquery/gettermsprefix.xml new file mode 100755 index 0000000000..65eeb0c1e3 --- /dev/null +++ b/reference/solr/solrquery/gettermsprefix.xml @@ -0,0 +1,56 @@ + + + + + + SolrQuery::getTermsPrefix + Returns the term prefix + + + + &reftitle.description; + + public stringSolrQuery::getTermsPrefix + + + + Returns the prefix to which matching terms must be restricted. This will restrict matches to only terms that start with the prefix + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + +Returns a string on success and &null; if not set. + + + + + + + diff --git a/reference/solr/solrquery/gettermsreturnraw.xml b/reference/solr/solrquery/gettermsreturnraw.xml new file mode 100755 index 0000000000..b8906f4c29 --- /dev/null +++ b/reference/solr/solrquery/gettermsreturnraw.xml @@ -0,0 +1,57 @@ + + + + + + SolrQuery::getTermsReturnRaw + Whether or not to return raw characters + + + + &reftitle.description; + + public boolSolrQuery::getTermsReturnRaw + + + + Returns a boolean indicating whether or not to return the raw characters of the indexed term, regardless of if it is human readable + + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + +Returns a boolean on success and &null; if not set. + + + + + + + diff --git a/reference/solr/solrquery/gettermssort.xml b/reference/solr/solrquery/gettermssort.xml new file mode 100755 index 0000000000..e7e83cba3f --- /dev/null +++ b/reference/solr/solrquery/gettermssort.xml @@ -0,0 +1,55 @@ + + + + + + SolrQuery::getTermsSort + Returns an integer indicating how terms are sorted + + + + &reftitle.description; + + public intSolrQuery::getTermsSort + + + + SolrQuery::TERMS_SORT_INDEX indicates that the terms are returned by index order. SolrQuery::TERMS_SORT_COUNT implies that the terms are sorted by term frequency (highest count first) + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + +Returns an integer on success and &null; if not set. + + + + + + + diff --git a/reference/solr/solrquery/gettermsupperbound.xml b/reference/solr/solrquery/gettermsupperbound.xml new file mode 100755 index 0000000000..d8bfd3d6fe --- /dev/null +++ b/reference/solr/solrquery/gettermsupperbound.xml @@ -0,0 +1,55 @@ + + + + + + SolrQuery::getTermsUpperBound + Returns the term to stop at + + + + &reftitle.description; + + public stringSolrQuery::getTermsUpperBound + + + + Returns the term to stop at + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + +Returns a string on success and &null; if not set. + + + + + + + diff --git a/reference/solr/solrquery/gettimeallowed.xml b/reference/solr/solrquery/gettimeallowed.xml new file mode 100755 index 0000000000..8c8090c858 --- /dev/null +++ b/reference/solr/solrquery/gettimeallowed.xml @@ -0,0 +1,56 @@ + + + + + + SolrQuery::getTimeAllowed + Returns the time in milliseconds allowed for the query to finish + + + + &reftitle.description; + + public intSolrQuery::getTimeAllowed + + + +Returns the time in milliseconds allowed for the query to finish. + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + +Returns and integer on success and &null; if it is not set. + + + + + + + diff --git a/reference/solr/solrquery/removefacetdatefield.xml b/reference/solr/solrquery/removefacetdatefield.xml index d8c1926aeb..2b6e694c03 100755 --- a/reference/solr/solrquery/removefacetdatefield.xml +++ b/reference/solr/solrquery/removefacetdatefield.xml @@ -4,17 +4,17 @@ SolrQuery::removeFacetDateField - The removeFacetDateField purpose + Removes one of the facet date fields &reftitle.description; publicSolrQuerySolrQuery::removeFacetDateField - stringvalue + stringfield - The method description goes here. + The name of the field @@ -24,10 +24,10 @@ - value + field - Description... + The name of the date field to remove @@ -42,37 +42,6 @@ - - &reftitle.examples; - - - <methodname>SolrQuery::removeFacetDateField</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - + - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +