udm_set_agent_param
Introduction
Search Engine Extensions
PHP Manual

# Apache Solr

- Introduction
- Installing/Configuring
  - Requirements
  - Installation
  - Runtime Configuration
  - Resource Types
- Predefined Constants
- Solr Functions
  - solr_get_version — Returns the current version of the Apache Solr extension
- Examples
- SolrUtils — The SolrUtils class
  - SolrUtils::digestXmlResponse — Parses an response XML string into a SolrObject
  - SolrUtils::escapeQueryChars — Escapes a lucene query string
  - SolrUtils::getSolrVersion — Returns the current version of the Solr extension
  - SolrUtils::queryPhrase — Prepares a phrase from an unescaped lucene string
- SolrInputDocument — The SolrInputDocument class
  - SolrInputDocument::addField — Adds a field to the document
  - SolrInputDocument::clear — Resets the input document
  - SolrInputDocument::__clone — Creates a copy of a SolrDocument
  - SolrInputDocument::__construct — Constructor
  - SolrInputDocument::deleteField — Removes a field from the document
  - SolrInputDocument::__destruct — Destructor
  - SolrInputDocument::fieldExists — Checks if a field exists
  - SolrInputDocument::getBoost — Retrieves the current boost value for the document
  - SolrInputDocument::getField — Retrieves a field by name
  - SolrInputDocument::getFieldBoost — Retrieves the boost value for a particular field
  - SolrInputDocument::getFieldCount — Returns the number of fields in the document
  - SolrInputDocument::getFieldNames — Returns an array containing all the fields in the document
  - SolrInputDocument::merge — Merges one input document into another
  - SolrInputDocument::reset — This is an alias of SolrInputDocument::clear
  - SolrInputDocument::setBoost — Sets the boost value for this document
  - SolrInputDocument::setFieldBoost — Sets the index-time boost value for a field
  - SolrInputDocument::sort — Sorts the fields within the document
  - SolrInputDocument::toArray — Returns an array representation of the input document
- SolrDocument — The SolrDocument class
  - SolrDocument::addField — Adds a field to the document
  - SolrDocument::clear — Drops all the fields in the document
  - SolrDocument::__clone — Creates a copy of a SolrDocument object
  - SolrDocument::__construct — Constructor
  - SolrDocument::current — Retrieves the current field
  - SolrDocument::deleteField — Removes a field from the document
  - SolrDocument::__destruct — Destructor
  - SolrDocument::fieldExists — Checks if a field exists in the document
  - SolrDocument::__get — Access the field as a property
  - SolrDocument::getField — Retrieves a field by name
  - SolrDocument::getFieldCount — Returns the number of fields in this document
  - SolrDocument::getFieldNames — Returns an array of fields names in the document
  - SolrDocument::getInputDocument — Returns a SolrInputDocument equivalent of the object
  - SolrDocument::__isset — Checks if a field exists
  - SolrDocument::key — Retrieves the current key
  - SolrDocument::merge — Merges source to the current SolrDocument
  - SolrDocument::next — Moves the internal pointer to the next field
  - SolrDocument::offsetExists — Checks if a particular field exists
  - SolrDocument::offsetGet — Retrieves a field
  - SolrDocument::offsetSet — Adds a field to the document
  - SolrDocument::offsetUnset — Removes a field
  - SolrDocument::reset — This is an alias to SolrDocument::clear()
  - SolrDocument::rewind — Resets the internal pointer to the beginning
  - SolrDocument::serialize — Used for custom serialization
  - SolrDocument::__set — Adds another field to the document
  - SolrDocument::sort — Sorts the fields in the document
  - SolrDocument::toArray — Returns an array representation of the document
  - SolrDocument::unserialize — Custom serialization of SolrDocument objects
  - SolrDocument::__unset — Removes a field from the document
  - SolrDocument::valid — Checks if the current position internally is still valid
- SolrDocumentField — The SolrDocumentField class
  - SolrDocumentField::__construct — Constructor
  - SolrDocumentField::__destruct — Destructor
- SolrObject — The SolrObject class
  - SolrObject::__construct — Creates Solr object
  - SolrObject::__destruct — Destructor
  - SolrObject::getPropertyNames — Returns an array of all the names of the properties
  - SolrObject::offsetExists — Checks if the property exists
  - SolrObject::offsetGet — Used to retrieve a property
  - SolrObject::offsetSet — Sets the value for a property
  - SolrObject::offsetUnset — Unsets the value for the property
- SolrClient — The SolrClient class
  - SolrClient::addDocument — Adds a document to the index
  - SolrClient::addDocuments — Adds a collection of SolrInputDocument instances to the index
  - SolrClient::commit — Finalizes all add/deletes made to the index
  - SolrClient::__construct — Constructor for the SolrClient object
  - SolrClient::deleteById — Delete by Id
  - SolrClient::deleteByIds — Deletes by Ids
  - SolrClient::deleteByQueries — Removes all documents matching any of the queries
  - SolrClient::deleteByQuery — Deletes all documents matching the given query
  - SolrClient::__destruct — Destructor for SolrClient
  - SolrClient::getDebug — Returns the debug data for the last connection attempt
  - SolrClient::getOptions — Returns the client options set internally
  - SolrClient::optimize — Defragments the index
  - SolrClient::ping — Checks if Solr server is still up
  - SolrClient::query — Sends a query to the server
  - SolrClient::request — Sends a raw update request
  - SolrClient::rollback — Rollbacks all add/deletes made to the index since the last commit
  - SolrClient::setResponseWriter — Sets the response writer used to prepare the response from Solr
  - SolrClient::setServlet — Changes the specified servlet type to a new value
  - SolrClient::system — Retrieve Solr Server information
  - SolrClient::threads — Checks the threads status
- SolrResponse — The SolrResponse class
  - SolrResponse::getDigestedResponse — Returns the XML response as serialized PHP data
  - SolrResponse::getHttpStatus — Returns the HTTP status of the response
  - SolrResponse::getHttpStatusMessage — Returns more details on the HTTP status
  - SolrResponse::getRawRequest — Returns the raw request sent to the Solr server
  - SolrResponse::getRawRequestHeaders — Returns the raw request headers sent to the Solr server
  - SolrResponse::getRawResponse — Returns the raw response from the server
  - SolrResponse::getRawResponseHeaders — Returns the raw response headers from the server
  - SolrResponse::getRequestUrl — Returns the full URL the request was sent to
  - SolrResponse::getResponse — Returns a SolrObject representing the XML response from the server
  - SolrResponse::setParseMode — Sets the parse mode
  - SolrResponse::success — Was the request a success
- SolrQueryResponse — The SolrQueryResponse class
  - SolrQueryResponse::__construct — Constructor
  - SolrQueryResponse::__destruct — Destructor
- SolrUpdateResponse — The SolrUpdateResponse class
  - SolrUpdateResponse::__construct — Constructor
  - SolrUpdateResponse::__destruct — Destructor
- SolrPingResponse — The SolrPingResponse class
  - SolrPingResponse::__construct — Constructor
  - SolrPingResponse::__destruct — Destructor
  - SolrPingResponse::getResponse — Returns the response from the server
- SolrGenericResponse — The SolrGenericResponse class
  - SolrGenericResponse::__construct — Constructor
  - SolrGenericResponse::__destruct — Destructor
- SolrParams — The SolrParams class
  - SolrParams::add — This is an alias for SolrParams::addParam
  - SolrParams::addParam — Adds a parameter to the object
  - SolrParams::get — This is an alias for SolrParams::getParam
  - SolrParams::getParam — Returns a parameter value
  - SolrParams::getParams — Returns an array of non URL-encoded parameters
  - SolrParams::getPreparedParams — Returns an array of URL-encoded parameters
  - SolrParams::serialize — Used for custom serialization
  - SolrParams::set — An alias of SolrParams::setParam
  - SolrParams::setParam — Sets the parameter to the specified value
  - SolrParams::toString — Returns all the name-value pair parameters in the object
  - SolrParams::unserialize — Used for custom serialization
- SolrModifiableParams — The SolrModifiableParams class
  - SolrModifiableParams::__construct — Constructor
  - SolrModifiableParams::__destruct — Destructor
- SolrQuery — The SolrQuery class
  - SolrQuery::addFacetDateField — Maps to facet.date
  - SolrQuery::addFacetDateOther — Adds another facet.date.other parameter
  - SolrQuery::addFacetField — Adds another field to the facet
  - SolrQuery::addFacetQuery — Adds a facet query
  - SolrQuery::addField — Specifies which fields to return in the result
  - SolrQuery::addFilterQuery — Specifies a filter query
  - SolrQuery::addHighlightField — Maps to hl.fl
  - SolrQuery::addMltField — Sets a field to use for similarity
  - SolrQuery::addMltQueryField — Maps to mlt.qf
  - SolrQuery::addSortField — Used to control how the results should be sorted
  - SolrQuery::addStatsFacet — Requests a return of sub results for values within the given facet
  - SolrQuery::addStatsField — Maps to stats.field parameter
  - SolrQuery::__construct — Constructor
  - SolrQuery::__destruct — Destructor
  - SolrQuery::getFacet — Returns the value of the facet parameter
  - SolrQuery::getFacetDateEnd — Returns the value for the facet.date.end parameter
  - SolrQuery::getFacetDateFields — Returns all the facet.date fields
  - SolrQuery::getFacetDateGap — Returns the value of the facet.date.gap parameter
  - SolrQuery::getFacetDateHardEnd — Returns the value of the facet.date.hardend parameter
  - SolrQuery::getFacetDateOther — Returns the value for the facet.date.other parameter
  - SolrQuery::getFacetDateStart — Returns the lower bound for the first date range for all date faceting on this field
  - SolrQuery::getFacetFields — Returns all the facet fields
  - SolrQuery::getFacetLimit — Returns the maximum number of constraint counts that should be returned for the facet fields
  - SolrQuery::getFacetMethod — Returns the value of the facet.method parameter
  - SolrQuery::getFacetMinCount — Returns the minimum counts for facet fields should be included in the response
  - SolrQuery::getFacetMissing — Returns the current state of the facet.missing parameter
  - SolrQuery::getFacetOffset — Returns an offset into the list of constraints to be used for pagination
  - SolrQuery::getFacetPrefix — Returns the facet prefix
  - SolrQuery::getFacetQueries — Returns all the facet queries
  - SolrQuery::getFacetSort — Returns the facet sort type
  - SolrQuery::getFields — Returns the list of fields that will be returned in the response
  - SolrQuery::getFilterQueries — Returns an array of filter queries
  - SolrQuery::getHighlight — Returns the state of the hl parameter
  - SolrQuery::getHighlightAlternateField — Returns the highlight field to use as backup or default
  - SolrQuery::getHighlightFields — Returns all the fields that Solr should generate highlighted snippets for
  - SolrQuery::getHighlightFormatter — Returns the formatter for the highlighted output
  - SolrQuery::getHighlightFragmenter — Returns the text snippet generator for highlighted text
  - SolrQuery::getHighlightFragsize — Returns the number of characters of fragments to consider for highlighting
  - SolrQuery::getHighlightHighlightMultiTerm — Returns whether or not to enable highlighting for range/wildcard/fuzzy/prefix queries
  - SolrQuery::getHighlightMaxAlternateFieldLength — Returns the maximum number of characters of the field to return
  - SolrQuery::getHighlightMaxAnalyzedChars — Returns the maximum number of characters into a document to look for suitable snippets
  - SolrQuery::getHighlightMergeContiguous — Returns whether or not the collapse contiguous fragments into a single fragment
  - SolrQuery::getHighlightRegexMaxAnalyzedChars — Returns the maximum number of characters from a field when using the regex fragmenter
  - SolrQuery::getHighlightRegexPattern — Returns the regular expression for fragmenting
  - SolrQuery::getHighlightRegexSlop — Returns the deviation factor from the ideal fragment size
  - SolrQuery::getHighlightRequireFieldMatch — Returns if a field will only be highlighted if the query matched in this particular field
  - SolrQuery::getHighlightSimplePost — Returns the text which appears after a highlighted term
  - SolrQuery::getHighlightSimplePre — Returns the text which appears before a highlighted term
  - SolrQuery::getHighlightSnippets — Returns the maximum number of highlighted snippets to generate per field
  - SolrQuery::getHighlightUsePhraseHighlighter — Returns the state of the hl.usePhraseHighlighter parameter
  - SolrQuery::getMlt — Returns whether or not MoreLikeThis results should be enabled
  - SolrQuery::getMltBoost — Returns whether or not the query will be boosted by the interesting term relevance
  - SolrQuery::getMltCount — Returns the number of similar documents to return for each result
  - SolrQuery::getMltFields — Returns all the fields to use for similarity
  - SolrQuery::getMltMaxNumQueryTerms — Returns the maximum number of query terms that will be included in any generated query
  - SolrQuery::getMltMaxNumTokens — Returns the maximum number of tokens to parse in each document field that is not stored with TermVector support
  - SolrQuery::getMltMaxWordLength — Returns the maximum word length above which words will be ignored
  - SolrQuery::getMltMinDocFrequency — Returns the treshold frequency at which words will be ignored which do not occur in at least this many docs
  - SolrQuery::getMltMinTermFrequency — Returns the frequency below which terms will be ignored in the source document
  - SolrQuery::getMltMinWordLength — Returns the minimum word length below which words will be ignored
  - SolrQuery::getMltQueryFields — Returns the query fields and their boosts
  - SolrQuery::getQuery — Returns the main query
  - SolrQuery::getRows — Returns the maximum number of documents
  - SolrQuery::getSortFields — Returns all the sort fields
  - SolrQuery::getStart — Returns the offset in the complete result set
  - SolrQuery::getStats — Returns whether or not stats is enabled
  - SolrQuery::getStatsFacets — Returns all the stats facets that were set
  - SolrQuery::getStatsFields — Returns all the statistics fields
  - SolrQuery::getTerms — Returns whether or not the TermsComponent is enabled
  - SolrQuery::getTermsField — Returns the field from which the terms are retrieved
  - SolrQuery::getTermsIncludeLowerBound — Returns whether or not to include the lower bound in the result set
  - SolrQuery::getTermsIncludeUpperBound — Returns whether or not to include the upper bound term in the result set
  - SolrQuery::getTermsLimit — Returns the maximum number of terms Solr should return
  - SolrQuery::getTermsLowerBound — Returns the term to start at
  - SolrQuery::getTermsMaxCount — Returns the maximum document frequency
  - SolrQuery::getTermsMinCount — Returns the minimum document frequency to return in order to be included
  - SolrQuery::getTermsPrefix — Returns the term prefix
  - SolrQuery::getTermsReturnRaw — Whether or not to return raw characters
  - SolrQuery::getTermsSort — Returns an integer indicating how terms are sorted
  - SolrQuery::getTermsUpperBound — Returns the term to stop at
  - SolrQuery::getTimeAllowed — Returns the time in milliseconds allowed for the query to finish
  - SolrQuery::removeFacetDateField — Removes one of the facet date fields
  - SolrQuery::removeFacetDateOther — Removes one of the facet.date.other parameters
  - SolrQuery::removeFacetField — Removes one of the facet.date parameters
  - SolrQuery::removeFacetQuery — Removes one of the facet.query parameters
  - SolrQuery::removeField — Removes a field from the list of fields
  - SolrQuery::removeFilterQuery — Removes a filter query
  - SolrQuery::removeHighlightField — Removes one of the fields used for highlighting
  - SolrQuery::removeMltField — Removes one of the moreLikeThis fields
  - SolrQuery::removeMltQueryField — Removes one of the moreLikeThis query fields
  - SolrQuery::removeSortField — Removes one of the sort fields
  - SolrQuery::removeStatsFacet — Removes one of the stats.facet parameters
  - SolrQuery::removeStatsField — Removes one of the stats.field parameters
  - SolrQuery::setEchoHandler — Toggles the echoHandler parameter
  - SolrQuery::setEchoParams — Determines what kind of parameters to include in the response
  - SolrQuery::setExplainOther — Sets the explainOther common query parameter
  - SolrQuery::setFacet — Maps to the facet parameter. Enables or disables facetting
  - SolrQuery::setFacetDateEnd — Maps to facet.date.end
  - SolrQuery::setFacetDateGap — Maps to facet.date.gap
  - SolrQuery::setFacetDateHardEnd — Maps to facet.date.hardend
  - SolrQuery::setFacetDateStart — Maps to facet.date.start
  - SolrQuery::setFacetEnumCacheMinDefaultFrequency — Sets the minimum document frequency used for determining term count
  - SolrQuery::setFacetLimit — Maps to facet.limit
  - SolrQuery::setFacetMethod — Specifies the type of algorithm to use when faceting a field
  - SolrQuery::setFacetMinCount — Maps to facet.mincount
  - SolrQuery::setFacetMissing — Maps to facet.missing
  - SolrQuery::setFacetOffset — Sets the offset into the list of constraints to allow for pagination
  - SolrQuery::setFacetPrefix — Specifies a string prefix with which to limits the terms on which to facet
  - SolrQuery::setFacetSort — Determines the ordering of the facet field constraints
  - SolrQuery::setHighlight — Enables or disables highlighting
  - SolrQuery::setHighlightAlternateField — Specifies the backup field to use
  - SolrQuery::setHighlightFormatter — Specify a formatter for the highlight output
  - SolrQuery::setHighlightFragmenter — Sets a text snippet generator for highlighted text
  - SolrQuery::setHighlightFragsize — The size of fragments to consider for highlighting
  - SolrQuery::setHighlightHighlightMultiTerm — Use SpanScorer to highlight phrase terms
  - SolrQuery::setHighlightMaxAlternateFieldLength — Sets the maximum number of characters of the field to return
  - SolrQuery::setHighlightMaxAnalyzedChars — Specifies the number of characters into a document to look for suitable snippets
  - SolrQuery::setHighlightMergeContiguous — Whether or not to collapse contiguous fragments into a single fragment
  - SolrQuery::setHighlightRegexMaxAnalyzedChars — Specify the maximum number of characters to analyze
  - SolrQuery::setHighlightRegexPattern — Specify the regular expression for fragmenting
  - SolrQuery::setHighlightRegexSlop — Sets the factor by which the regex fragmenter can stray from the ideal fragment size
  - SolrQuery::setHighlightRequireFieldMatch — Require field matching during highlighting
  - SolrQuery::setHighlightSimplePost — Sets the text which appears after a highlighted term
  - SolrQuery::setHighlightSimplePre — Sets the text which appears before a highlighted term
  - SolrQuery::setHighlightSnippets — Sets the maximum number of highlighted snippets to generate per field
  - SolrQuery::setHighlightUsePhraseHighlighter — Whether to highlight phrase terms only when they appear within the query phrase
  - SolrQuery::setMlt — Enables or disables moreLikeThis
  - SolrQuery::setMltBoost — Set if the query will be boosted by the interesting term relevance
  - SolrQuery::setMltCount — Set the number of similar documents to return for each result
  - SolrQuery::setMltMaxNumQueryTerms — Sets the maximum number of query terms included
  - SolrQuery::setMltMaxNumTokens — Specifies the maximum number of tokens to parse
  - SolrQuery::setMltMaxWordLength — Sets the maximum word length
  - SolrQuery::setMltMinDocFrequency — Sets the mltMinDoc frequency
  - SolrQuery::setMltMinTermFrequency — Sets the frequency below which terms will be ignored in the source docs
  - SolrQuery::setMltMinWordLength — Sets the minimum word length
  - SolrQuery::setOmitHeader — Exclude the header from the returned results
  - SolrQuery::setQuery — Sets the search query
  - SolrQuery::setRows — Specifies the maximum number of rows to return in the result
  - SolrQuery::setShowDebugInfo — Flag to show debug information
  - SolrQuery::setStart — Specifies the number of rows to skip
  - SolrQuery::setStats — Enables or disables the Stats component
  - SolrQuery::setTerms — Enables or disables the TermsComponent
  - SolrQuery::setTermsField — Sets the name of the field to get the Terms from
  - SolrQuery::setTermsIncludeLowerBound — Include the lower bound term in the result set
  - SolrQuery::setTermsIncludeUpperBound — Include the upper bound term in the result set
  - SolrQuery::setTermsLimit — Sets the maximum number of terms to return
  - SolrQuery::setTermsLowerBound — Specifies the Term to start from
  - SolrQuery::setTermsMaxCount — Sets the maximum document frequency
  - SolrQuery::setTermsMinCount — Sets the minimum document frequency
  - SolrQuery::setTermsPrefix — Restrict matches to terms that start with the prefix
  - SolrQuery::setTermsReturnRaw — Return the raw characters of the indexed term
  - SolrQuery::setTermsSort — Specifies how to sort the returned terms
  - SolrQuery::setTermsUpperBound — Sets the term to stop at
  - SolrQuery::setTimeAllowed — The time allowed for search to finish
- SolrDisMaxQuery — The SolrDisMaxQuery class
  - SolrDisMaxQuery::addBigramPhraseField — Adds a Phrase Bigram Field (pf2 parameter)
  - SolrDisMaxQuery::addBoostQuery — Adds a boost query field with value and optional boost (bq parameter)
  - SolrDisMaxQuery::addPhraseField — Adds a Phrase Field (pf parameter)
  - SolrDisMaxQuery::addQueryField — Add a query field with optional boost (qf parameter)
  - SolrDisMaxQuery::addTrigramPhraseField — Adds a Trigram Phrase Field (pf3 parameter)
  - SolrDisMaxQuery::addUserField — Adds a field to User Fields Parameter (uf)
  - SolrDisMaxQuery::__construct — Class Constructor
  - SolrDisMaxQuery::removeBigramPhraseField — Removes phrase bigram field (pf2 parameter)
  - SolrDisMaxQuery::removeBoostQuery — Removes a boost query partial by field name (bq)
  - SolrDisMaxQuery::removePhraseField — Removes a Phrase Field (pf parameter)
  - SolrDisMaxQuery::removeQueryField — Removes a Query Field (qf parameter)
  - SolrDisMaxQuery::removeTrigramPhraseField — Removes a Trigram Phrase Field (pf3 parameter)
  - SolrDisMaxQuery::removeUserField — Removes a field from The User Fields Parameter (uf)
  - SolrDisMaxQuery::setBigramPhraseFields — Sets Bigram Phrase Fields and their boosts (and slops) using pf2 parameter
  - SolrDisMaxQuery::setBigramPhraseSlop — Sets Bigram Phrase Slop (ps2 parameter)
  - SolrDisMaxQuery::setBoostFunction — Sets a Boost Function (bf parameter).
  - SolrDisMaxQuery::setBoostQuery — Directly Sets Boost Query Parameter (bq)
  - SolrDisMaxQuery::setMinimumMatch — Set Minimum "Should" Match (mm)
  - SolrDisMaxQuery::setPhraseFields — Sets Phrase Fields and their boosts (and slops) using pf2 parameter
  - SolrDisMaxQuery::setPhraseSlop — Sets the default slop on phrase queries (ps parameter)
  - SolrDisMaxQuery::setQueryAlt — Set Query Alternate (q.alt parameter)
  - SolrDisMaxQuery::setQueryPhraseSlop — specifies the amount of slop permitted on phrase queries explicitly included in the user's query string (qf parameter)
  - SolrDisMaxQuery::setTieBreaker — Sets Tie Breaker parameter (tie parameter)
  - SolrDisMaxQuery::setTrigramPhraseFields — Directly Sets Trigram Phrase Fields (pf3 parameter)
  - SolrDisMaxQuery::setTrigramPhraseSlop — Sets Trigram Phrase Slop (ps3 parameter)
  - SolrDisMaxQuery::setUserFields — Sets User Fields parameter (uf)
  - SolrDisMaxQuery::useDisMaxQueryParser — Switch QueryParser to be DisMax Query Parser
  - SolrDisMaxQuery::useEDisMaxQueryParser — Switch QueryParser to be EDisMax
- SolrException — The SolrException class
  - SolrException::getInternalInfo — Returns internal information where the Exception was thrown
- SolrClientException — The SolrClientException class
  - SolrClientException::getInternalInfo — Returns internal information where the Exception was thrown
- SolrServerException — The SolrServerException class
  - SolrServerException::getInternalInfo — Returns internal information where the Exception was thrown
- SolrIllegalArgumentException — The SolrIllegalArgumentException class
  - SolrIllegalArgumentException::getInternalInfo — Returns internal information where the Exception was thrown
- SolrIllegalOperationException — The SolrIllegalOperationException class
  - SolrIllegalOperationException::getInternalInfo — Returns internal information where the Exception was thrown

udm_set_agent_param
Introduction
Search Engine Extensions
PHP Manual