Book/solr-Phpdoc专题

Apache Solr

简介
安装／配置
- 需求
- 安装
- 运行时配置
- 资源类型
预定义常量
Solr 函数
- solr_get_version — 返回当前Solr扩展的版本
范例
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::addChildDocument — Adds a child document for block indexing
- SolrInputDocument::addChildDocuments — Adds an array of child documents
- 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::getChildDocuments — Returns an array of child documents (SolrInputDocument)
- SolrInputDocument::getChildDocumentsCount — Returns the number of child documents
- 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::hasChildDocuments — Returns true if the document has any child documents
- 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::getChildDocuments — Returns an array of child documents (SolrDocument)
- SolrDocument::getChildDocumentsCount — Returns the number of child documents
- 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::hasChildDocuments — Checks whether the document has any child documents
- 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::getById — Get Document By Id. Utilizes Solr Realtime Get (RTG)
- SolrClient::getByIds — Get Documents by their Ids. Utilizes Solr Realtime Get (RTG)
- 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::addExpandFilterQuery — Overrides main filter query, determines which documents to include in the main group
- SolrQuery::addExpandSortField — Orders the documents within the expanded groups (expand.sort parameter)
- 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::addGroupField — Add a field to be used to group results
- SolrQuery::addGroupFunction — Allows grouping results based on the unique values of a function query (group.func parameter)
- SolrQuery::addGroupQuery — Allows grouping of documents that match the given query
- SolrQuery::addGroupSortField — Add a group sort field (group.sort parameter)
- 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::collapse — Collapses the result set to a single document per group
- SolrQuery::__construct — Constructor
- SolrQuery::__destruct — Destructor
- SolrQuery::getExpand — Returns true if group expanding is enabled
- SolrQuery::getExpandFilterQueries — Returns the expand filter queries
- SolrQuery::getExpandQuery — Returns the expand query expand.q parameter
- SolrQuery::getExpandRows — Returns The number of rows to display in each group (expand.rows)
- SolrQuery::getExpandSortFields — Returns an array of fields
- 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::getGroup — Returns true if grouping is enabled
- SolrQuery::getGroupCachePercent — Returns group cache percent value
- SolrQuery::getGroupFacet — Returns the group.facet parameter value
- SolrQuery::getGroupFields — Returns group fields (group.field parameter values)
- SolrQuery::getGroupFormat — Returns the group.format value
- SolrQuery::getGroupFunctions — Returns group functions (group.func parameter values)
- SolrQuery::getGroupLimit — Returns the group.limit value
- SolrQuery::getGroupMain — Returns the group.main value
- SolrQuery::getGroupNGroups — Returns the group.ngroups value
- SolrQuery::getGroupOffset — Returns the group.offset value
- SolrQuery::getGroupQueries — Returns all the group.query parameter values
- SolrQuery::getGroupSortFields — Returns the group.sort value
- SolrQuery::getGroupTruncate — Returns the group.truncate value
- 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::removeExpandFilterQuery — Removes an expand filter query
- SolrQuery::removeExpandSortField — Removes an expand sort field from the expand.sort parameter
- 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::setExpand — Enables/Disables the Expand Component
- SolrQuery::setExpandQuery — Sets the expand.q parameter
- SolrQuery::setExpandRows — Sets the number of rows to display in each group (expand.rows). Server Default 5
- 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::setGroup — Enable/Disable result grouping (group parameter)
- SolrQuery::setGroupCachePercent — Enables caching for result grouping
- SolrQuery::setGroupFacet — Sets group.facet parameter
- SolrQuery::setGroupFormat — Sets the group format, result structure (group.format parameter)
- SolrQuery::setGroupLimit — Specifies the number of results to return for each group. The server default value is 1
- SolrQuery::setGroupMain — If true, the result of the first field grouping command is used as the main result list in the response, using group.format=simple
- SolrQuery::setGroupNGroups — If true, Solr includes the number of groups that have matched the query in the results
- SolrQuery::setGroupOffset — Sets the group.offset parameter
- SolrQuery::setGroupTruncate — If true, facet counts are based on the most relevant document of each group matching the query
- 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
SolrCollapseFunction — The SolrCollapseFunction class
- SolrCollapseFunction::__construct — Constructor
- SolrCollapseFunction::getField — Returns the field that is being collapsed on
- SolrCollapseFunction::getHint — Returns collapse hint
- SolrCollapseFunction::getMax — Returns max parameter
- SolrCollapseFunction::getMin — Returns min parameter
- SolrCollapseFunction::getNullPolicy — Returns null policy
- SolrCollapseFunction::getSize — Returns size parameter
- SolrCollapseFunction::setField — Sets the field to collapse on
- SolrCollapseFunction::setHint — Sets collapse hint
- SolrCollapseFunction::setMax — Selects the group heads by the max value of a numeric field or function query
- SolrCollapseFunction::setMin — Sets the initial size of the collapse data structures when collapsing on a numeric field only
- SolrCollapseFunction::setNullPolicy — Sets the NULL Policy
- SolrCollapseFunction::setSize — Sets the initial size of the collapse data structures when collapsing on a numeric field only
- SolrCollapseFunction::__toString — Returns a string representing the constructed collapse function
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
SolrMissingMandatoryParameterException — The SolrMissingMandatoryParameterException class

简介

Contains utility methods for retrieving the current extension version and preparing query phrases.

Also contains method for escaping query strings and parsing XML responses.

类摘要

SolrUtils

abstract class SolrUtils {

/* 方法 */

public static SolrObject digestXmlResponse ( string $xmlresponse [, int $parse_mode = 0 ] )

public static stringfalse escapeQueryChars ( string $str )

public static string getSolrVersion ( void )

public static string queryPhrase ( string $str )

}

SolrUtils::digestXmlResponse

Parses an response XML string into a SolrObject

说明

public static SolrObject SolrUtils::digestXmlResponse ( string $xmlresponse [, int $parse_mode = 0 ] )

This method parses an response XML string from the Apache Solr server into a SolrObject. It throws a SolrException if there was an error.

参数

xmlresponse
The XML response string from the Solr server.

parse_mode
Use SolrResponse::PARSE_SOLR_OBJ or SolrResponse::PARSE_SOLR_DOC

返回值

Returns the SolrObject representing the XML response.

If the parse_mode parameter is set to SolrResponse::PARSE_SOLR_OBJ Solr documents will be parses as SolrObject instances.

If it is set to SolrResponse::PARSE_SOLR_DOC, they will be parsed as SolrDocument instances.

SolrUtils::escapeQueryChars

Escapes a lucene query string

说明

public static stringfalse SolrUtils::escapeQueryChars ( string $str )

Lucene supports escaping special characters that are part of the query syntax.

The current list special characters are:

+ - && || ! ( ) { } [ ] ^ " ~ * ? : \ /

final class SolrInputDocument {

/* 常量 */

const int SolrInputDocument::SORT_DEFAULT = 1 ;

const int SolrInputDocument::SORT_ASC = 1 ;

const int SolrInputDocument::SORT_DESC = 2 ;

const int SolrInputDocument::SORT_FIELD_NAME = 1 ;

const int SolrInputDocument::SORT_FIELD_VALUE_COUNT = 2 ;

const int SolrInputDocument::SORT_FIELD_BOOST_VALUE = 4 ;

/* 方法 */

public void addChildDocument ( SolrInputDocument $child )

public void addChildDocuments ( array &$docs )

public bool addField ( string $fieldName , string $fieldValue [, float $fieldBoostValue = 0.0 ] )

public bool clear ( void )

public void __clone ( void )

public __construct ( void )

public bool deleteField ( string $fieldName )

public void __destruct ( void )

public bool fieldExists ( string $fieldName )

public float getBoost ( void )

public array getChildDocuments ( void )

public int getChildDocumentsCount ( void )

public SolrDocumentField getField ( string $fieldName )

public float getFieldBoost ( string $fieldName )

public intfalse getFieldCount ( void )

public array getFieldNames ( void )

public bool hasChildDocuments ( void )

public bool merge ( SolrInputDocument $sourceDoc [, bool $overwrite = true ] )

public bool reset ( void )

public bool setBoost ( float $documentBoostValue )

public bool setFieldBoost ( string $fieldName , float $fieldBoostValue )

public bool sort ( int $sortOrderBy [, int $sortDirection = SolrInputDocument::SORT_ASC ] )

public array toArray ( void )

}

预定义常量

SolrInputDocument Class Constants

SolrInputDocument::SORT_DEFAULT
Sorts the fields in ascending order.

SolrInputDocument::SORT_ASC
Sorts the fields in ascending order.

SolrInputDocument::SORT_DESC
Sorts the fields in descending order.

SolrInputDocument::SORT_FIELD_NAME
Sorts the fields by name

SolrInputDocument::SORT_FIELD_VALUE_COUNT
Sorts the fields by number of values.

SolrInputDocument::SORT_FIELD_BOOST_VALUE
Sorts the fields by boost value.

SolrInputDocument::addChildDocument

Adds a child document for block indexing

说明

public void SolrInputDocument::addChildDocument ( SolrInputDocument $child )

Adds a child document to construct a document block with nested documents.

参数

child
A SolrInputDocument object.

错误／异常

Throws SolrIllegalArgumentException on failure.

Throws SolrException on internal failure.

返回值

范例

示例 #1 SolrInputDocument::addChildDocument example

<?php

include "bootstrap.php";

$options = array
(
    'hostname' => SOLR_SERVER_HOSTNAME,
    'login'    => SOLR_SERVER_USERNAME,
    'password' => SOLR_SERVER_PASSWORD,
    'port'     => SOLR_SERVER_PORT,
    'path'     => SOLR_SERVER_STORE_PATH,
);

$client = new SolrClient($options);

$product = new SolrInputDocument();

$product->addField('id', 'P-BLACK');
$product->addField('cat', 'tshirt');
$product->addField('cat', 'polo');
$product->addField('content_type', 'product');

$small = new SolrInputDocument();
$small->addField('id', 'TS-BLK-S');
$small->addField('content_type', 'sku');
$small->addField('size', 'S');
$small->addField('inventory', 100);

$medium = new SolrInputDocument();
$medium->addField('id', 'TS-BLK-M');
$medium->addField('content_type', 'sku');
$medium->addField('size', 'M');
$medium->addField('inventory', 200);

$large = new SolrInputDocument();
$large->addField('id', 'TS-BLK-L');
$large->addField('content_type', 'sku');
$large->addField('size', 'L');
$large->addField('inventory', 300);

// add child documents 
$product->addChildDocument($small);
$product->addChildDocument($medium);
$product->addChildDocument($large);

// add product document block to the index
$updateResponse = $client->addDocument(
        $product,
        true, // overwrite if the document exists
        10000 // commit within 10 seconds
);

print_r($updateResponse->getResponse());

以上例程的输出类似于：

SolrObject Object
(
    [responseHeader] => SolrObject Object
        (
            [status] => 0
            [QTime] => 5
        )
)

参见

SolrInputDocument::addChildDocuments
SolrInputDocument::hasChildDocuments
SolrInputDocument::getChildDocuments
SolrInputDocument::getChildDocumentsCount

SolrInputDocument::addChildDocuments

Adds an array of child documents

说明

public void SolrInputDocument::addChildDocuments ( array &$docs )

Adds an array of child documents to the current input document.

参数

docs
An array of SolrInputDocument objects.

错误／异常

Throws SolrIllegalArgumentException on failure.

Throws SolrException on internal failure.

返回值

范例

示例 #1 SolrInputDocument::addChildDocuments example

<?php

include "bootstrap.php";

$options = array
(
    'hostname' => SOLR_SERVER_HOSTNAME,
    'login'    => SOLR_SERVER_USERNAME,
    'password' => SOLR_SERVER_PASSWORD,
    'port'     => SOLR_SERVER_PORT,
    'path'     => SOLR_SERVER_STORE_PATH,
);

$client = new SolrClient($options);

$product = new SolrInputDocument();

$product->addField('id', 'P-BLACK');
$product->addField('cat', 'tshirt');
$product->addField('cat', 'polo');
$product->addField('content_type', 'product');

$small = new SolrInputDocument();
$small->addField('id', 'TS-BLK-S');
$small->addField('content_type', 'sku');
$small->addField('size', 'S');
$small->addField('inventory', 100);

$medium = new SolrInputDocument();
$medium->addField('id', 'TS-BLK-M');
$medium->addField('content_type', 'sku');
$medium->addField('size', 'M');
$medium->addField('inventory', 200);

$large = new SolrInputDocument();
$large->addField('id', 'TS-BLK-L');
$large->addField('content_type', 'sku');
$large->addField('size', 'L');
$large->addField('inventory', 300);

// add child documents 
$skus = [$small, $medium, $large];
$product->addChildDocuments($skus);

// add the product document block to the index
$updateResponse = $client->addDocument(
        $product,
        true, // overwrite if the document exists
        10000 // commit within 10 seconds
);

print_r($updateResponse->getResponse());

以上例程的输出类似于：

SolrObject Object
(
    [responseHeader] => SolrObject Object
        (
            [status] => 0
            [QTime] => 5
        )
)

参见

SolrInputDocument::addChildDocument
SolrInputDocument::hasChildDocuments
SolrInputDocument::getChildDocuments
SolrInputDocument::getChildDocumentsCount

SolrInputDocument::addField

Adds a field to the document

说明

public bool SolrInputDocument::addField ( string $fieldName , string $fieldValue [, float $fieldBoostValue = 0.0 ] )

For multi-value fields, if a valid boost value is specified, the specified value will be multiplied by the current boost value for this field.

参数

Returns an array of child documents (SolrInputDocument)

参数

此函数没有参数。

返回值

参见

SolrInputDocument::addChildDocument
SolrInputDocument::addChildDocuments
SolrInputDocument::hasChildDocuments
SolrInputDocument::getChildDocumentsCount

SolrInputDocument::getChildDocumentsCount

Returns the number of child documents

说明

public int SolrInputDocument::getChildDocumentsCount ( void )

Returns the number of child documents

参数

此函数没有参数。

返回值

参见

SolrInputDocument::addChildDocument
SolrInputDocument::addChildDocuments
SolrInputDocument::hasChildDocuments
SolrInputDocument::getChildDocuments

SolrInputDocument::addChildDocument
SolrInputDocument::addChildDocuments
SolrInputDocument::getChildDocuments
SolrInputDocument::getChildDocumentsCount

SolrInputDocument::merge

Merges one input document into another

说明

public bool SolrInputDocument::merge ( SolrInputDocument $sourceDoc [, bool $overwrite = true ] )

Merges one input document into another.

参数

参数

fieldName
The name of the field.

fieldBoostValue
The index time boost value.

SolrInputDocument::sort

Sorts the fields within the document

说明

public bool SolrInputDocument::sort ( int $sortOrderBy [, int $sortDirection = SolrInputDocument::SORT_ASC ] )

The fields are rearranged according to the specified criteria and sort direction

   Fields can be sorted by boost values, field names and number of values.

   The $order_by parameter must be one of :

   * SolrInputDocument::SORT_FIELD_NAME
   * SolrInputDocument::SORT_FIELD_BOOST_VALUE
   * SolrInputDocument::SORT_FIELD_VALUE_COUNT

   The sort direction can be one of :

   * SolrInputDocument::SORT_DEFAULT
   * SolrInputDocument::SORT_ASC
   * SolrInputDocument::SORT_DESC

参数

sortOrderBy
The sort criteria

sortDirection
The sort direction

返回值

成功时返回 true，或者在失败时返回 false。

SolrInputDocument::toArray

Returns an array representation of the input document

说明

public array SolrInputDocument::toArray ( void )

Returns an array representation of the input document.

参数

此函数没有参数。

返回值

Returns an array containing the fields. It returns false on failure.

简介

Represents a Solr document retrieved from a query response.

类摘要

SolrDocument

final class SolrDocument implements ArrayAccess , Iterator , Serializable {

/* 常量 */

const int SolrDocument::SORT_DEFAULT = 1 ;

const int SolrDocument::SORT_ASC = 1 ;

const int SolrDocument::SORT_DESC = 2 ;

const int SolrDocument::SORT_FIELD_NAME = 1 ;

const int SolrDocument::SORT_FIELD_VALUE_COUNT = 2 ;

const int SolrDocument::SORT_FIELD_BOOST_VALUE = 4 ;

/* 方法 */

public bool addField ( string $fieldName , string $fieldValue )

public bool clear ( void )

public void __clone ( void )

public __construct ( void )

public SolrDocumentField current ( void )

public bool deleteField ( string $fieldName )

public void __destruct ( void )

public bool fieldExists ( string $fieldName )

public SolrDocumentField __get ( string $fieldName )

public array getChildDocuments ( void )

public int getChildDocumentsCount ( void )

public SolrDocumentField getField ( string $fieldName )

public int getFieldCount ( void )

public array getFieldNames ( void )

public SolrInputDocument getInputDocument ( void )

public bool hasChildDocuments ( void )

public bool __isset ( string $fieldName )

public string key ( void )

public bool merge ( SolrDocument $sourceDoc [, bool $overwrite = true ] )

public void next ( void )

public bool offsetExists ( string $fieldName )

public SolrDocumentField offsetGet ( string $fieldName )

public void offsetSet ( string $fieldName , string $fieldValue )

public void offsetUnset ( string $fieldName )

public bool reset ( void )

public void rewind ( void )

public string serialize ( void )

public bool __set ( string $fieldName , string $fieldValue )

public bool sort ( int $sortOrderBy [, int $sortDirection = SolrDocument::SORT_ASC ] )

public array toArray ( void )

public void unserialize ( string $serialized )

public bool __unset ( string $fieldName )

public bool valid ( void )

}

预定义常量

SolrDocument::SORT_DEFAULT
Default mode for sorting fields within the document.

SolrDocument::SORT_ASC
Sorts the fields in ascending order

SolrDocument::SORT_DESC
Sorts the fields in descending order

SolrDocument::SORT_FIELD_NAME
Sorts the fields by field name.

SolrDocument::SORT_FIELD_VALUE_COUNT
Sorts the fields by number of values in each field.

SolrDocument::SORT_FIELD_BOOST_VALUE
Sorts the fields by thier boost values.

SolrDocument::addField

Adds a field to the document

说明

public bool SolrDocument::addField ( string $fieldName , string $fieldValue )

This method adds a field to the SolrDocument instance.

参数

参数

此函数没有参数。

SolrDocument::hasChildDocuments
SolrDocument::getChildDocumentsCount

SolrDocument::getChildDocumentsCount

Returns the number of child documents

说明

public int SolrDocument::getChildDocumentsCount ( void )

Returns the number of child documents

参数

此函数没有参数。

返回值

参见

SolrDocument::hasChildDocuments
SolrDocument::getChildDocuments

SolrDocument::getChildDocuments
SolrDocument::getChildDocumentsCount

SolrDocument::__isset

Checks if a field exists

说明

public bool SolrDocument::__isset ( string $fieldName )

Checks if a field exists

参数

fieldName
Name of the field.

返回值

成功时返回 true，或者在失败时返回 false。

SolrDocument::key

Retrieves the current key

说明

public string SolrDocument::key ( void )

Retrieves the current key.

参数

此函数没有参数。

返回值

Returns the current key.

SolrDocument::merge

Merges source to the current SolrDocument

说明

public bool SolrDocument::merge ( SolrDocument $sourceDoc [, bool $overwrite = true ] )

Merges source to the current SolrDocument.

参数

参数

参数

fieldName
Name of the field.

fieldValue
Field value.

返回值

成功时返回 true，或者在失败时返回 false。

SolrDocument::sort

Sorts the fields in the document

说明

public bool SolrDocument::sort ( int $sortOrderBy [, int $sortDirection = SolrDocument::SORT_ASC ] )

The fields are rearranged according to the specified criteria and sort direction

   Fields can be sorted by boost values, field names and number of values.

   The sortOrderBy parameter must be one of :

   * SolrDocument::SORT_FIELD_NAME
   * SolrDocument::SORT_FIELD_BOOST_VALUE
   * SolrDocument::SORT_FIELD_VALUE_COUNT

   The sortDirection can be one of :

   * SolrDocument::SORT_DEFAULT
   * SolrDocument::SORT_ASC
   * SolrDocument::SORT_DESC

   The default way is to sort in ascending order.

参数

sortOrderBy
The sort criteria.

sortDirection
The sort direction.

返回值

成功时返回 true，或者在失败时返回 false。

SolrDocument::toArray

Returns an array representation of the document

说明

public array SolrDocument::toArray ( void )

Returns an array representation of the document.

参数

此函数没有参数。

返回值

Returns an array representation of the document.

范例

示例 #1 SolrDocument::toArray example

<?php

$doc = new SolrDocument();

$doc->addField('id', 1123);

$doc->features = "PHP Client Side";
$doc->features = "Fast development cycles";

$doc['cat'] = 'Software';
$doc['cat'] = 'Custom Search';
$doc->cat   = 'Information Technology';

print_r($doc->toArray());

?>

以上例程的输出类似于：

Array
(
    [document_boost] => 0
    [field_count] => 3
    [fields] => Array
        (
            [0] => SolrDocumentField Object
                (
                    [name] => id
                    [boost] => 0
                    [values] => Array
                        (
                            [0] => 1123
                        )

                )

            [1] => SolrDocumentField Object
                (
                    [name] => features
                    [boost] => 0
                    [values] => Array
                        (
                            [0] => PHP Client Side
                            [1] => Fast development cycles
                        )

                )

            [2] => SolrDocumentField Object
                (
                    [name] => cat
                    [boost] => 0
                    [values] => Array
                        (
                            [0] => Software
                            [1] => Custom Search
                            [2] => Information Technology
                        )

                )

        )

)

简介

This represents a field in a Solr document. All its properties are read-only.

类摘要

SolrDocumentField

final class SolrDocumentField {

/* 属性 */

public readonly string $name ;

public readonly float $boost ;

public readonly array $values ;

/* 方法 */

public __construct ( void )

public void __destruct ( void )

}

属性

name
The name of the field.

boost
The boost value for the field

values
An array of values for this field

SolrDocumentField::__construct

Constructor

说明

public SolrDocumentField::__construct ( void )

Constructor.

参数

此函数没有参数。

返回值

None.

SolrDocumentField::__destruct

Destructor

说明

public void SolrDocumentField::__destruct ( void )

Destructor.

参数

此函数没有参数。

返回值

None.

简介

This is an object whose properties can also by accessed using the array syntax. All its properties are read-only.

类摘要

SolrObject

final class SolrObject implements ArrayAccess {

/* 方法 */

public __construct ( void )

public void __destruct ( void )

public array getPropertyNames ( void )

public bool offsetExists ( string $property_name )

public mixed offsetGet ( string $property_name )

public void offsetSet ( string $property_name , string $property_value )

public void offsetUnset ( string $property_name )

}

SolrObject::__construct

Creates Solr object

说明

public SolrObject::__construct ( void )

Creates Solr object.

参数

此函数没有参数。

返回值

None

范例

示例 #1 SolrObject::__construct example

<?php
/* ... */
?>

以上例程的输出类似于：

...

参见

Classname::Method

SolrObject::offsetSet

Sets the value for a property

说明

public void SolrObject::offsetSet ( string $property_name , string $property_value )

Sets the value for a property. This is used when the object is treated as an array. This object is read-only. This should never be attempted.

参数

property_name
The name of the property.

property_value
The new value.

返回值

None.

SolrObject::offsetUnset

Unsets the value for the property

说明

public void SolrObject::offsetUnset ( string $property_name )

Unsets the value for the property. This is used when the object is treated as an array. This object is read-only. This should never be attempted.

参数

property_name
The name of the property.

返回值

成功时返回 true，或者在失败时返回 false。

范例

示例 #1 SolrObject::offsetUnset example

<?php
/* ... */
?>

以上例程的输出类似于：

...

参见

Classname::Method

简介

Used to send requests to a Solr server. Currently, cloning and serialization of SolrClient instances is not supported.

类摘要

SolrClient

final class SolrClient {

/* 常量 */

const int SolrClient::SEARCH_SERVLET_TYPE = 1 ;

const int SolrClient::UPDATE_SERVLET_TYPE = 2 ;

const int SolrClient::THREADS_SERVLET_TYPE = 4 ;

const int SolrClient::PING_SERVLET_TYPE = 8 ;

const int SolrClient::TERMS_SERVLET_TYPE = 16 ;

const int SolrClient::SYSTEM_SERVLET_TYPE = 32 ;

const string SolrClient::DEFAULT_SEARCH_SERVLET = select ;

const string SolrClient::DEFAULT_UPDATE_SERVLET = update ;

const string SolrClient::DEFAULT_THREADS_SERVLET = admin/threads ;

const string SolrClient::DEFAULT_PING_SERVLET = admin/ping ;

const string SolrClient::DEFAULT_TERMS_SERVLET = terms ;

const string SolrClient::DEFAULT_SYSTEM_SERVLET = admin/system ;

/* 方法 */

public SolrUpdateResponse addDocument ( SolrInputDocument $doc [, bool $overwrite = true [, int $commitWithin = 0 ]] )

public void addDocuments ( array $docs [, bool $overwrite = true [, int $commitWithin = 0 ]] )

public SolrUpdateResponse commit ([ bool $softCommit = false [, bool $waitSearcher = true [, bool $expungeDeletes = false ]]] )

public __construct ( array $clientOptions )

public SolrUpdateResponse deleteById ( string $id )

public SolrUpdateResponse deleteByIds ( array $ids )

public SolrUpdateResponse deleteByQueries ( array $queries )

public SolrUpdateResponse deleteByQuery ( string $query )

public void __destruct ( void )

public SolrQueryResponse getById ( string $id )

public SolrQueryResponse getByIds ( array $ids )

public string getDebug ( void )

public array getOptions ( void )

public SolrUpdateResponse optimize ([ int $maxSegments = 1 [, bool $softCommit = true [, bool $waitSearcher = true ]]] )

public SolrPingResponse ping ( void )

public SolrQueryResponse query ( SolrParams $query )

public SolrUpdateResponse request ( string $raw_request )

public SolrUpdateResponse rollback ( void )

public void setResponseWriter ( string $responseWriter )

public bool setServlet ( int $type , string $value )

public void system ( void )

public void threads ( void )

}

预定义常量

SolrClient::SEARCH_SERVLET_TYPE
Used when updating the search servlet.

SolrClient::UPDATE_SERVLET_TYPE
Used when updating the update servlet.

SolrClient::THREADS_SERVLET_TYPE
Used when updating the threads servlet.

SolrClient::PING_SERVLET_TYPE
Used when updating the ping servlet.

SolrClient::TERMS_SERVLET_TYPE
Used when updating the terms servlet.

SolrClient::SYSTEM_SERVLET_TYPE
Used when retrieving system information from the system servlet.

SolrClient::DEFAULT_SEARCH_SERVLET
This is the initial value for the search servlet.

SolrClient::DEFAULT_UPDATE_SERVLET
This is the initial value for the update servlet.

SolrClient::DEFAULT_THREADS_SERVLET
This is the initial value for the threads servlet.

SolrClient::DEFAULT_PING_SERVLET
This is the initial value for the ping servlet.

SolrClient::DEFAULT_TERMS_SERVLET
This is the initial value for the terms servlet used for the TermsComponent

SolrClient::DEFAULT_SYSTEM_SERVLET
This is the initial value for the system servlet used to obtain Solr Server information

SolrClient::addDocument

Adds a document to the index

说明

public SolrUpdateResponse SolrClient::addDocument ( SolrInputDocument $doc [, bool $overwrite = true [, int $commitWithin = 0 ]] )

This method adds a document to the index.

参数

doc
The SolrInputDocument instance.

overwrite
Whether to overwrite existing document or not. If false there will be duplicates (several documents with the same ID).

Warning PECL Solr \< 2.0 $allowDups was used instead of $overwrite, which does the same functionality with exact opposite bool flag.

$allowDups = false is the same as $overwrite = true

commitWithin
Number of milliseconds within which to auto commit this document. Available since Solr 1.4 . Default (0) means disabled.

When this value specified, it leaves the control of when to do the commit to Solr itself, optimizing number of commits to a minimum while still fulfilling the update latency requirements, and Solr will automatically do a commit when the oldest add in the buffer is due.

返回值

Returns a SolrUpdateResponse object or throws an Exception on failure.

错误／异常

Throws SolrClientException if the client had failed, or there was a connection issue.

Throws SolrServerException if the Solr Server had failed to process the request.

范例

示例 #1 SolrClient::addDocument example

<?php

$options = array
(
    'hostname' => SOLR_SERVER_HOSTNAME,
    'login'    => SOLR_SERVER_USERNAME,
    'password' => SOLR_SERVER_PASSWORD,
    'port'     => SOLR_SERVER_PORT,
);

$client = new SolrClient($options);

$doc = new SolrInputDocument();

$doc->addField('id', 334455);
$doc->addField('cat', 'Software');
$doc->addField('cat', 'Lucene');

$updateResponse = $client->addDocument($doc);

// you will have to commit changes to be written if you didn't use $commitWithin
$client->commit();

print_r($updateResponse->getResponse());

?>

以上例程的输出类似于：

SolrObject Object
(
    [responseHeader] => SolrObject Object
        (
            [status] => 0
            [QTime] => 1
        )

)

示例 #2 SolrClient::addDocument example 2

<?php

$options = array
(
    'hostname' => SOLR_SERVER_HOSTNAME,
    'login'    => SOLR_SERVER_USERNAME,
    'password' => SOLR_SERVER_PASSWORD,
    'port'     => SOLR_SERVER_PORT,
);

$client = new SolrClient($options);

$doc = new SolrInputDocument();

$doc->addField('id', 334455);
$doc->addField('cat', 'Software');
$doc->addField('cat', 'Lucene');

// No need to call commit() because $commitWithin is passed, so Solr Server will auto commit within 10 seconds
$updateResponse = $client->addDocument($doc, false, 10000);

print_r($updateResponse->getResponse());

?>

以上例程的输出类似于：

SolrObject Object
(
    [responseHeader] => SolrObject Object
        (
            [status] => 0
            [QTime] => 1
        )

)

参见

SolrClient::addDocuments
SolrClient::commit

SolrClient::addDocuments

Adds a collection of SolrInputDocument instances to the index

说明

public void SolrClient::addDocuments ( array $docs [, bool $overwrite = true [, int $commitWithin = 0 ]] )

Adds a collection of documents to the index.

参数

docs
An array containing the collection of SolrInputDocument instances. This array must be an actual variable.

overwrite
Whether to overwrite existing documents or not. If false there will be duplicates (several documents with the same ID).

Warning PECL Solr \< 2.0 $allowDups was used instead of $overwrite, which does the same functionality with exact opposite bool flag.

$allowDups = false is the same as $overwrite = true

commitWithin
Number of milliseconds within which to auto commit this document. Available since Solr 1.4 . Default (0) means disabled.

返回值

Returns a SolrUpdateResponse object or throws an exception on failure.

错误／异常

Throws SolrClientException if the client had failed, or there was a connection issue.

Throws SolrServerException if the Solr Server had failed to process the request.

范例

示例 #1 SolrClient::addDocuments example

<?php

$options = array
(
    'hostname' => SOLR_SERVER_HOSTNAME,
    'login'    => SOLR_SERVER_USERNAME,
    'password' => SOLR_SERVER_PASSWORD,
    'port'     => SOLR_SERVER_PORT,
);

$client = new SolrClient($options);

$doc = new SolrInputDocument();

$doc->addField('id', 334455);
$doc->addField('cat', 'Software');
$doc->addField('cat', 'Lucene');

$doc2 = clone $doc;

$doc2->deleteField('id');
$doc2->addField('id', 334456);

$docs = array($doc, $doc2);

$updateResponse = $client->addDocuments($docs);

// no changes will be written to disk unless $commitWithin is passed or SolrClient::commit is called

print_r($updateResponse->getResponse());

?>

以上例程的输出类似于：

SolrObject Object
(
    [responseHeader] => SolrObject Object
        (
            [status] => 0
            [QTime] => 2
        )

)

参见

SolrClient::addDocument
SolrClient::commit

SolrClient::commit

Finalizes all add/deletes made to the index

说明

public SolrUpdateResponse SolrClient::commit ([ bool $softCommit = false [, bool $waitSearcher = true [, bool $expungeDeletes = false ]]] )

This method finalizes all add/deletes made to the index.

参数

softCommit
This will refresh the 'view' of the index in a more performant manner, but without "on-disk" guarantees. (Solr4.0+)

A soft commit is much faster since it only makes index changes visible and does not fsync index files or write a new index descriptor. If the JVM crashes or there is a loss of power, changes that occurred after the last hard commit will be lost. Search collections that have near-real-time requirements (that want index changes to be quickly visible to searches) will want to soft commit often but hard commit less frequently.

waitSearcher
block until a new searcher is opened and registered as the main query searcher, making the changes visible.

expungeDeletes
Merge segments with deletes away. (Solr1.4+)

返回值

Returns a SolrUpdateResponse object on success or throws an exception on failure.

错误／异常

Throws SolrClientException if the client had failed, or there was a connection issue.

Throws SolrServerException if the Solr Server had failed to process the request.

更新日志

版本	说明
PECL solr 1.1.0, 2.0.0	$maxSegments removed
PECL solr 2.0.0b	API Changed: SolrClient::commit ([ int $maxSegments = 0 [, bool $softCommit = false [, bool $waitSearcher = true[, bool $expungeDeletes = false ]]] )
PECL solr 0.9.2	Signature: SolrClient::commit ([ int $maxSegments = 1 [, bool $waitFlush = true [, bool $waitSearcher = true ]]] ). $waitFlush: Block until index changes are flushed to disk.

注释

Warning

PECL Solr >= 2.0 only supports Solr Server >= 4.0

参见

SolrClient::optimize
SolrClient::rollback

SolrClient::__construct

Constructor for the SolrClient object

说明

public SolrClient::__construct ( array $clientOptions )

Constructor for the SolrClient object

参数

clientOptions
This is an array containing one of the following keys :

- secure          (Boolean value indicating whether or not to connect in secure mode)
 - hostname        (The hostname for the Solr server)
 - port            (The port number)
 - path            (The path to solr)
 - wt              (The name of the response writer e.g. xml, json)
 - login           (The username used for HTTP Authentication, if any)
 - password        (The HTTP Authentication password)
 - proxy_host      (The hostname for the proxy server, if any)
 - proxy_port      (The proxy port)
 - proxy_login     (The proxy username)
 - proxy_password  (The proxy password)
 - timeout         (This is maximum time in seconds allowed for the http data transfer operation. Default is 30 seconds)
 - ssl_cert        (File name to a PEM-formatted file containing the private key + private certificate (concatenated in that order) )
 - ssl_key         (File name to a PEM-formatted private key file only)
 - ssl_keypassword (Password for private key)
 - ssl_cainfo      (Name of file holding one or more CA certificates to verify peer with)
 - ssl_capath      (Name of directory holding multiple CA certificates to verify peer with )

 Please note the if the ssl_cert file only contains the private certificate, you have to specify a separate ssl_key file

 The ssl_keypassword option is required if the ssl_cert or ssl_key options are set.

错误／异常

Throws SolrIllegalArgumentException on failure.

范例

示例 #1 SolrClient::__construct example

<?php

$options = array
(
    'hostname' => SOLR_SERVER_HOSTNAME,
    'login'    => SOLR_SERVER_USERNAME,
    'password' => SOLR_SERVER_PASSWORD,
    'port'     => SOLR_SERVER_PORT,
    'path'     => SOLR_PATH_TO_SOLR,
    'wt'       => 'xml',
);

$client = new SolrClient($options);

$doc = new SolrInputDocument();

$doc->addField('id', 334455);
$doc->addField('cat', 'Software');
$doc->addField('cat', 'Lucene');

$updateResponse = $client->addDocument($doc);

?>

以上例程的输出类似于：

参见

SolrClient::getOptions

SolrClient::deleteById

Delete by Id

说明

public SolrUpdateResponse SolrClient::deleteById ( string $id )

Deletes the document with the specified ID. Where ID is the value of the uniqueKey field declared in the schema

参数

id
The value of the uniqueKey field declared in the schema

返回值

Returns a SolrUpdateResponse on success and throws an exception on failure.

错误／异常

Throws SolrClientException if the client had failed, or there was a connection issue.

Throws SolrServerException if the Solr Server had failed to process the request.

参见

SolrClient::deleteByIds
SolrClient::deleteByQuery
SolrClient::deleteByQueries

SolrClient::deleteByIds

Deletes by Ids

说明

public SolrUpdateResponse SolrClient::deleteByIds ( array $ids )

Deletes a collection of documents with the specified set of ids.

参数

ids
An array of IDs representing the uniqueKey field declared in the schema for each document to be deleted. This must be an actual php variable.

返回值

Returns a SolrUpdateResponse on success and throws an exception on failure.

错误／异常

Throws SolrClientException if the client had failed, or there was a connection issue.

Throws SolrServerException if the Solr Server had failed to process the request.

参见

SolrClient::deleteById
SolrClient::deleteByQuery
SolrClient::deleteByQueries

SolrClient::deleteByQueries

Removes all documents matching any of the queries

说明

public SolrUpdateResponse SolrClient::deleteByQueries ( array $queries )

Removes all documents matching any of the queries

参数

queries
The array of queries. This must be an actual php variable.

返回值

Returns a SolrUpdateResponse on success and throws a SolrClientException on failure.

错误／异常

Throws SolrClientException if the client had failed, or there was a connection issue.

Throws SolrServerException if the Solr Server had failed to process the request.

参见

SolrClient::deleteById
SolrClient::deleteByIds
SolrClient::deleteByQuery

SolrClient::deleteByQuery

Deletes all documents matching the given query

说明

public SolrUpdateResponse SolrClient::deleteByQuery ( string $query )

Deletes all documents matching the given query.

参数

query
The query

返回值

Returns a SolrUpdateResponse on success and throws an exception on failure.

错误／异常

Throws SolrClientException if the client had failed, or there was a connection issue.

Throws SolrServerException if the Solr Server had failed to process the request.

范例

示例 #1 SolrQuery::deleteByQuery example

<?php

$options = array
(
    'hostname' => SOLR_SERVER_HOSTNAME,
    'login'    => SOLR_SERVER_USERNAME,
    'password' => SOLR_SERVER_PASSWORD,
    'port'     => SOLR_SERVER_PORT,
);

$client = new SolrClient($options);

//This will erase the entire index
$client->deleteByQuery("*:*");
$client->commit();

?>

参见

SolrClient::deleteById
SolrClient::deleteByIds
SolrClient::deleteByQueries

SolrClient::__destruct

Destructor for SolrClient

说明

public void SolrClient::__destruct ( void )

Destructor

参数

此函数没有参数。

返回值

Destructor for SolrClient

参见

SolrClient::__construct

SolrClient::getById

Get Document By Id. Utilizes Solr Realtime Get (RTG)

说明

public SolrQueryResponse SolrClient::getById ( string $id )

Get Document By Id. Utilizes Solr Realtime Get (RTG).

参数

id
Document ID

返回值

SolrQueryResponse

范例

示例 #1 SolrClient::getById example

<?php

include "bootstrap.php";

$options = array
(
    'hostname' => SOLR_SERVER_HOSTNAME,
    'login'    => SOLR_SERVER_USERNAME,
    'password' => SOLR_SERVER_PASSWORD,
    'port'     => SOLR_SERVER_PORT,
    'path'     => SOLR_SERVER_PATH
);

$client = new SolrClient($options);
$response = $client->getById('GB18030TEST');
print_r($response->getResponse());

?>

以上例程的输出类似于：

SolrObject Object
(
    [doc] => SolrObject Object
        (
            [id] => GB18030TEST
            [name] => Array
                (
                    [0] => Test with some GB18030 encoded characters
                )

            [features] => Array
                (
                    [0] => No accents here
                    [1] => 这是一个功能
                    [2] => This is a feature (translated)
                    [3] => 这份文件是很有光泽
                    [4] => This document is very shiny (translated)
                )

            [price] => Array
                (
                    [0] => 0
                )

            [inStock] => Array
                (
                    [0] => 1
                )

            [_version_] => 1510294336239042560
        )

)

参见

SolrClient::getByIds

SolrClient::getByIds

Get Documents by their Ids. Utilizes Solr Realtime Get (RTG)

说明

public SolrQueryResponse SolrClient::getByIds ( array $ids )

Get Documents by their Ids. Utilizes Solr Realtime Get (RTG).

参数

ids
Document ids

返回值

SolrQueryResponse

范例

示例 #1 SolrClient::getByIds example

<?php

include "bootstrap.php";

$options = array
(
    'hostname' => SOLR_SERVER_HOSTNAME,
    'login'    => SOLR_SERVER_USERNAME,
    'password' => SOLR_SERVER_PASSWORD,
    'port'     => SOLR_SERVER_PORT,
    'path'     => SOLR_SERVER_PATH
);

$client = new SolrClient($options);
$response = $client->getByIds(['GB18030TEST', '6H500F0']);

print_r($response->getResponse());

?>

以上例程的输出类似于：

参见

SolrClient::getById

SolrClient::getDebug

Returns the debug data for the last connection attempt

说明

public string SolrClient::getDebug ( void )

Returns the debug data for the last connection attempt

参数

此函数没有参数。

返回值

Returns a string on success and null if there is nothing to return.

SolrClient::getOptions

Returns the client options set internally

说明

public array SolrClient::getOptions ( void )

Returns the client options set internally. Very useful for debugging. The values returned are readonly and can only be set when the object is instantiated.

参数

此函数没有参数。

返回值

Returns an array containing all the options for the SolrClient object set internally.

参见

SolrClient::__construct

SolrClient::optimize

Defragments the index

说明

public SolrUpdateResponse SolrClient::optimize ([ int $maxSegments = 1 [, bool $softCommit = true [, bool $waitSearcher = true ]]] )

Defragments the index for faster search performance.

参数

maxSegments
Optimizes down to at most this number of segments. Since Solr 1.3

softCommit
This will refresh the 'view' of the index in a more performant manner, but without "on-disk" guarantees. (Solr4.0+)

waitSearcher
Block until a new searcher is opened and registered as the main query searcher, making the changes visible.

返回值

Returns a SolrUpdateResponse on success or throws an exception on failure.

错误／异常

Throws SolrClientException if the client had failed, or there was a connection issue.

Throws SolrServerException if the Solr Server had failed to process the request.

注释

Warning

PECL Solr >= 2.0 only supports Solr Server >= 4.0

Prior to PECL Solr 2.0 this method used to accept these arguments "int $maxSegments, bool $waitFlush, bool $waitSearcher".

参见

SolrClient::commit
SolrClient::rollback

SolrClient::ping

Checks if Solr server is still up

说明

public SolrPingResponse SolrClient::ping ( void )

Checks if the Solr server is still alive. Sends a HEAD request to the Apache Solr server.

参数

此函数没有参数。

返回值

Returns a SolrPingResponse object on success and throws an exception on failure.

错误／异常

Throws SolrClientException if the client had failed, or there was a connection issue.

Throws SolrServerException if the Solr Server had failed to satisfy the request.

范例

示例 #1 SolrClient::ping example

<?php
$options = array
(
    'hostname' => SOLR_SERVER_HOSTNAME,
    'login'    => SOLR_SERVER_USERNAME,
    'password' => SOLR_SERVER_PASSWORD,
    'port'     => SOLR_SERVER_PORT,
);

$client = new SolrClient($options);

$pingresponse = $client->ping();

?>

以上例程的输出类似于：

SolrClient::query

Sends a query to the server

说明

public SolrQueryResponse SolrClient::query ( SolrParams $query )

Sends a query to the server.

参数

query
A SolrParams object. It is recommended to use SolrQuery for advanced queries.

返回值

Returns a SolrQueryResponse object on success and throws an exception on failure.

错误／异常

Throws SolrClientException if the client had failed, or there was a connection issue.

Throws SolrServerException if the Solr Server had failed to satisfy the query.

范例

示例 #1 SolrClient::query example

<?php

$options = array
(
    'hostname' => 'localhost',
    'login'    => 'username',
    'password' => 'password',
    'port'     => '8983',
);

$client = new SolrClient($options);

$query = new SolrQuery();

$query->setQuery('lucene');

$query->setStart(0);

$query->setRows(50);

$query->addField('cat')->addField('features')->addField('id')->addField('timestamp');

$query_response = $client->query($query);

$response = $query_response->getResponse();

print_r($response);

?>

以上例程的输出类似于：

SolrObject Object
(
    [responseHeader] => SolrObject Object
        (
            [status] => 0
            [QTime] => 3
            [params] => SolrObject Object
                (
                    [fl] => cat,features,id,timestamp
                    [indent] => on
                    [start] => 0
                    [q] => lucene
                    [wt] => xml
                    [version] => 2.2
                    [rows] => 50
                )

        )

    [response] => SolrObject Object
        (
            [numFound] => 1
            [start] => 0
            [docs] => Array
                (
                    [0] => SolrObject Object
                        (
                            [id] => SOLR1000
                            [cat] => Array
                                (
                                    [0] => software
                                    [1] => search
                                )

                            [features] => Array
                                (
                                    [0] => Advanced Full-Text Search Capabilities using Lucene
                                    [1] => Optimized for High Volume Web Traffic
                                    [2] => Standards Based Open Interfaces - XML and HTTP
                                    [3] => Comprehensive HTML Administration Interfaces
                                    [4] => Scalability - Efficient Replication to other Solr Search Servers
                                    [5] => Flexible and Adaptable with XML configuration and Schema
                                    [6] => Good unicode support: héllo (hello with an accent over the e)
                                )

                        )

                )

        )

)

SolrClient::request

Sends a raw update request

说明

public SolrUpdateResponse SolrClient::request ( string $raw_request )

Sends a raw XML update request to the server

参数

raw_request
An XML string with the raw request to the server.

返回值

Returns a SolrUpdateResponse on success. Throws an exception on failure.

错误／异常

Throws SolrIllegalArgumentException if raw_request was an empty string

Throws SolrClientException if the client had failed, or there was a connection issue.

Throws SolrServerException if the Solr Server had failed to satisfy the query.

范例

示例 #1 SolrClient::request example

<?php
$options = array
(
    'hostname' => SOLR_SERVER_HOSTNAME,
    'login'    => SOLR_SERVER_USERNAME,
    'password' => SOLR_SERVER_PASSWORD,
    'port'     => SOLR_SERVER_PORT,
);

$client = new SolrClient($options);

$update_response = $client->request("<commit/>");

$response = $update_response->getResponse();

print_r($response);
?>

以上例程的输出类似于：

...

SolrClient::rollback

Rollbacks all add/deletes made to the index since the last commit

说明

public SolrUpdateResponse SolrClient::rollback ( void )

Rollbacks all add/deletes made to the index since the last commit. It neither calls any event listeners nor creates a new searcher.

参数

此函数没有参数。

返回值

Returns a SolrUpdateResponse on success or throws a SolrClientException on failure.

参见

SolrClient::commit
SolrClient::optimize

SolrClient::setResponseWriter

Sets the response writer used to prepare the response from Solr

说明

public void SolrClient::setResponseWriter ( string $responseWriter )

Sets the response writer used to prepare the response from Solr

参数

responseWriter
One of the following:

json
phps
xml

返回值

没有返回值。

范例

示例 #1 SolrClient::setResponseWriter example

<?php

// This is my custom class for objects
class SolrClass
{
   public $_properties = array();

   public function __get($property_name) {

      if (property_exists($this, $property_name)) {

          return $this->$property_name;

      } else if (isset($_properties[$property_name])) {

          return $_properties[$property_name];
      }

      return null;
   }
}

$options = array
(
  'hostname' => 'localhost',
  'port' => 8983,
  'path' => '/solr/core1'
);

$client = new SolrClient($options);

$client->setResponseWriter("json");

//$response = $client->ping();

$query = new SolrQuery();

$query->setQuery("*:*");

$query->set("objectClassName", "SolrClass");

$query->set("objectPropertiesStorageMode", 1); // 0 for independent properties, 1 for combined

try
{

$response = $client->query($query);

$resp = $response->getResponse();

print_r($response);

print_r($resp);

} catch (Exception $e) {

print_r($e);

}

?>

SolrClient::setServlet

Changes the specified servlet type to a new value

说明

public bool SolrClient::setServlet ( int $type , string $value )

Changes the specified servlet type to a new value

参数

type
One of the following :

- SolrClient::SEARCH_SERVLET_TYPE
 - SolrClient::UPDATE_SERVLET_TYPE
 - SolrClient::THREADS_SERVLET_TYPE
 - SolrClient::PING_SERVLET_TYPE
 - SolrClient::TERMS_SERVLET_TYPE

value
The new value for the servlet

返回值

成功时返回 true，或者在失败时返回 false。

SolrClient::system

Retrieve Solr Server information

说明

public void SolrClient::system ( void )

Retrieve Solr Server information

参数

此函数没有参数。

返回值

Returns a SolrGenericResponse object on success.

错误／异常

Emits SolrClientException if the client failed, or there was a connection issue.

Emits SolrServerException if the Solr Server failed to satisfy the query.

SolrClient::threads

Checks the threads status

说明

public void SolrClient::threads ( void )

Checks the threads status

参数

此函数没有参数。

返回值

Returns a SolrGenericResponse object.

错误／异常

Throws SolrClientException if the client failed, or there was a connection issue.

throws SolrServerException if the Solr Server failed to process the request.

简介

Represents a response from the Solr server.

类摘要

SolrResponse

abstract class SolrResponse {

/* 常量 */

const int SolrResponse::PARSE_SOLR_OBJ = 0 ;

const int SolrResponse::PARSE_SOLR_DOC = 1 ;

/* 属性 */

protected int $http_status ;

protected int $parser_mode ;

protected bool $success ;

protected string $http_status_message ;

protected string $http_request_url ;

protected string $http_raw_request_headers ;

protected string $http_raw_request ;

protected string $http_raw_response_headers ;

protected string $http_raw_response ;

protected string $http_digested_response ;

/* 方法 */

public string getDigestedResponse ( void )

public int getHttpStatus ( void )

public string getHttpStatusMessage ( void )

public string getRawRequest ( void )

public string getRawRequestHeaders ( void )

public string getRawResponse ( void )

public string getRawResponseHeaders ( void )

public string getRequestUrl ( void )

public SolrObject getResponse ( void )

public bool setParseMode ([ int $parser_mode = 0 ] )

public bool success ( void )

}

属性

http_status
The http status of the response.

parser_mode
Whether to parse the solr documents as SolrObject or SolrDocument instances.

success
Was there an error during the request

http_status_message
Detailed message on http status

http_request_url
The request URL

http_raw_request_headers
A string of raw headers sent during the request.

http_raw_request
The raw request sent to the server

http_raw_response_headers
Response headers from the Solr server.

http_raw_response
The response message from the server.

http_digested_response
The response in PHP serialized format.

预定义常量

SolrResponse Class Constants

返回值

Returns true if it was successful and false if it was not.

简介

Represents a response to a query request.

类摘要

SolrQueryResponse

final class SolrQueryResponse extends SolrResponse {

/* 常量 */

const int SolrQueryResponse::PARSE_SOLR_OBJ = 0 ;

const int SolrQueryResponse::PARSE_SOLR_DOC = 1 ;

/* 继承的属性 */

const int SolrResponse::PARSE_SOLR_OBJ = 0 ;

const int SolrResponse::PARSE_SOLR_DOC = 1 ;

protected int $http_status ;

protected int $parser_mode ;

protected bool $success ;

protected string $http_status_message ;

protected string $http_request_url ;

protected string $http_raw_request_headers ;

protected string $http_raw_request ;

protected string $http_raw_response_headers ;

protected string $http_raw_response ;

protected string $http_digested_response ;

/* 方法 */

public __construct ( void )

public void __destruct ( void )

/* 继承的方法 */

public string SolrResponse::getDigestedResponse ( void )

public int SolrResponse::getHttpStatus ( void )

public string SolrResponse::getHttpStatusMessage ( void )

public string SolrResponse::getRawRequest ( void )

public string SolrResponse::getRawRequestHeaders ( void )

public string SolrResponse::getRawResponse ( void )

public string SolrResponse::getRawResponseHeaders ( void )

public string SolrResponse::getRequestUrl ( void )

public SolrObject SolrResponse::getResponse ( void )

public bool SolrResponse::setParseMode ([ int $parser_mode = 0 ] )

public bool SolrResponse::success ( void )

}

预定义常量

SolrQueryResponse Class constants

SolrQueryResponse::PARSE_SOLR_OBJ
Documents should be parsed as SolrObject instances

SolrQueryResponse::PARSE_SOLR_DOC
Documents should be parsed as SolrDocument instances.

SolrQueryResponse::__construct

Constructor

说明

public SolrQueryResponse::__construct ( void )

Constructor

参数

此函数没有参数。

返回值

None

SolrQueryResponse::__destruct

Destructor

说明

public void SolrQueryResponse::__destruct ( void )

Destructor.

参数

此函数没有参数。

返回值

None

简介

Represents a response to an update request.

类摘要

SolrUpdateResponse

final class SolrUpdateResponse extends SolrResponse {

/* 常量 */

const int SolrUpdateResponse::PARSE_SOLR_OBJ = 0 ;

const int SolrUpdateResponse::PARSE_SOLR_DOC = 1 ;

/* 继承的属性 */

const int SolrResponse::PARSE_SOLR_OBJ = 0 ;

const int SolrResponse::PARSE_SOLR_DOC = 1 ;

protected int $http_status ;

protected int $parser_mode ;

protected bool $success ;

protected string $http_status_message ;

protected string $http_request_url ;

protected string $http_raw_request_headers ;

protected string $http_raw_request ;

protected string $http_raw_response_headers ;

protected string $http_raw_response ;

protected string $http_digested_response ;

/* 方法 */

public __construct ( void )

public void __destruct ( void )

/* 继承的方法 */

public string SolrResponse::getDigestedResponse ( void )

public int SolrResponse::getHttpStatus ( void )

public string SolrResponse::getHttpStatusMessage ( void )

public string SolrResponse::getRawRequest ( void )

public string SolrResponse::getRawRequestHeaders ( void )

public string SolrResponse::getRawResponse ( void )

public string SolrResponse::getRawResponseHeaders ( void )

public string SolrResponse::getRequestUrl ( void )

public SolrObject SolrResponse::getResponse ( void )

public bool SolrResponse::setParseMode ([ int $parser_mode = 0 ] )

public bool SolrResponse::success ( void )

}

预定义常量

SolrUpdateResponse Class Constants

SolrUpdateResponse::PARSE_SOLR_OBJ
Documents should be parsed as SolrObject instances

SolrUpdateResponse::PARSE_SOLR_DOC
Documents should be parsed as SolrDocument instances.

SolrUpdateResponse::__construct

Constructor

说明

public SolrUpdateResponse::__construct ( void )

Constructor

参数

此函数没有参数。

返回值

None

SolrUpdateResponse::__destruct

Destructor

说明

public void SolrUpdateResponse::__destruct ( void )

Destructor

参数

此函数没有参数。

返回值

None

简介

Represents a response to a ping request to the server

类摘要

SolrPingResponse

final class SolrPingResponse extends SolrResponse {

/* 常量 */

const int SolrPingResponse::PARSE_SOLR_OBJ = 0 ;

const int SolrPingResponse::PARSE_SOLR_DOC = 1 ;

/* 属性 */

/* 方法 */

public __construct ( void )

public void __destruct ( void )

public string getResponse ( void )

/* 继承的方法 */

public string SolrResponse::getDigestedResponse ( void )

public int SolrResponse::getHttpStatus ( void )

public string SolrResponse::getHttpStatusMessage ( void )

public string SolrResponse::getRawRequest ( void )

public string SolrResponse::getRawRequestHeaders ( void )

public string SolrResponse::getRawResponse ( void )

public string SolrResponse::getRawResponseHeaders ( void )

public string SolrResponse::getRequestUrl ( void )

public SolrObject SolrResponse::getResponse ( void )

public bool SolrResponse::setParseMode ([ int $parser_mode = 0 ] )

public bool SolrResponse::success ( void )

}

属性

http_status
The http status of the response.

parser_mode
Whether to parse the solr documents as SolrObject or SolrDocument instances.

success
Was there an error during the request

http_status_message
Detailed message on http status

http_request_url
The request URL

http_raw_request_headers
A string of raw headers sent during the request

http_raw_request
The raw request sent to the server

http_raw_response_headers
Response headers from the Solr server

http_raw_response
The response message from the server

http_digested_response
The response in PHP serialized format.

预定义常量

SolrPingResponse Class Constants

返回值

Returns an empty string.

简介

Represents a response from the solr server.

类摘要

SolrGenericResponse

final class SolrGenericResponse extends SolrResponse {

/* 常量 */

const int SolrGenericResponse::PARSE_SOLR_OBJ = 0 ;

const int SolrGenericResponse::PARSE_SOLR_DOC = 1 ;

/* 继承的属性 */

const int SolrResponse::PARSE_SOLR_OBJ = 0 ;

const int SolrResponse::PARSE_SOLR_DOC = 1 ;

protected int $http_status ;

protected int $parser_mode ;

protected bool $success ;

protected string $http_status_message ;

protected string $http_request_url ;

protected string $http_raw_request_headers ;

protected string $http_raw_request ;

protected string $http_raw_response_headers ;

protected string $http_raw_response ;

protected string $http_digested_response ;

/* 方法 */

public __construct ( void )

public void __destruct ( void )

/* 继承的方法 */

public string SolrResponse::getDigestedResponse ( void )

public int SolrResponse::getHttpStatus ( void )

public string SolrResponse::getHttpStatusMessage ( void )

public string SolrResponse::getRawRequest ( void )

public string SolrResponse::getRawRequestHeaders ( void )

public string SolrResponse::getRawResponse ( void )

public string SolrResponse::getRawResponseHeaders ( void )

public string SolrResponse::getRequestUrl ( void )

public SolrObject SolrResponse::getResponse ( void )

public bool SolrResponse::setParseMode ([ int $parser_mode = 0 ] )

public bool SolrResponse::success ( void )

}

预定义常量

SolrGenericResponse Class constants

SolrGenericResponse::PARSE_SOLR_OBJ
Documents should be parsed as SolrObject instances

SolrGenericResponse::PARSE_SOLR_DOC
Documents should be parsed as SolrDocument instances.

SolrGenericResponse::__construct

Constructor

说明

public SolrGenericResponse::__construct ( void )

Constructor

参数

此函数没有参数。

返回值

None

SolrGenericResponse::__destruct

Destructor

说明

public void SolrGenericResponse::__destruct ( void )

Destructor.

参数

此函数没有参数。

返回值

None

简介

Represents a collection of name-value pairs sent to the Solr server during a request.

类摘要

SolrParams

abstract class SolrParams implements Serializable {

/* 方法 */

final public SolrParams add ( string $name , string $value )

public SolrParams addParam ( string $name , string $value )

final public mixed get ( string $param_name )

final public mixed getParam ([ string $param_name ] )

final public array getParams ( void )

final public array getPreparedParams ( void )

final public string serialize ( void )

final public void set ( string $name , string $value )

public SolrParams setParam ( string $name , string $value )

final public string toString ([ bool $url_encode = false ] )

final public void unserialize ( string $serialized )

}

SolrParams::add

This is an alias for SolrParams::addParam

说明

final public SolrParams SolrParams::add ( string $name , string $value )

This is an alias for SolrParams::addParam

参数

name
The name of the parameter

value
The value of the parameter

返回值

Returns a SolrParams instance on success

SolrParams::addParam

Adds a parameter to the object

说明

public SolrParams SolrParams::addParam ( string $name , string $value )

Adds a parameter to the object. This is used for parameters that can be specified multiple times.

参数

参数

name
Then name of the parameter

value
The parameter value

返回值

Returns an instance of the SolrParams object on success

SolrParams::setParam

Sets the parameter to the specified value

说明

public SolrParams SolrParams::setParam ( string $name , string $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

参数

name
Name of the parameter

value
Value of the parameter

返回值

Returns a SolrParam object on success and false on value.

范例

示例 #1 SolrParams::setParam example

<?php

$param = new SolrParams();

$param->setParam('q', 'solr')->setParam('rows', 2);

?>

以上例程的输出类似于：

SolrParams::toString

Returns all the name-value pair parameters in the object

说明

final public string SolrParams::toString ([ bool $url_encode = false ] )

Returns all the name-value pair parameters in the object

参数

url_encode
Whether to return URL-encoded values

返回值

Returns a string on success and false on failure.

SolrParams::unserialize

Used for custom serialization

说明

final public void SolrParams::unserialize ( string $serialized )

Used for custom serialization

参数

serialized
The serialized representation of the object

返回值

None

简介

Represents a collection of name-value pairs sent to the Solr server during a request.

类摘要

SolrModifiableParams

class SolrModifiableParams extends SolrParams implements Serializable {

/* 方法 */

public __construct ( void )

public void __destruct ( void )

/* 继承的方法 */

final public SolrParams SolrParams::add ( string $name , string $value )

public SolrParams SolrParams::addParam ( string $name , string $value )

final public mixed SolrParams::get ( string $param_name )

final public mixed SolrParams::getParam ([ string $param_name ] )

final public array SolrParams::getParams ( void )

final public array SolrParams::getPreparedParams ( void )

final public string SolrParams::serialize ( void )

final public void SolrParams::set ( string $name , string $value )

public SolrParams SolrParams::setParam ( string $name , string $value )

final public string SolrParams::toString ([ bool $url_encode = false ] )

final public void SolrParams::unserialize ( string $serialized )

}

SolrModifiableParams::__construct

Constructor

说明

public SolrModifiableParams::__construct ( void )

Constructor

参数

此函数没有参数。

返回值

None

SolrModifiableParams::__destruct

Destructor

说明

public void SolrModifiableParams::__destruct ( void )

Destructor

参数

此函数没有参数。

返回值

None

简介

Represents a collection of name-value pairs sent to the Solr server during a request.

类摘要

SolrQuery

class SolrQuery extends SolrModifiableParams implements Serializable {

/* 常量 */

const int SolrQuery::ORDER_ASC = 0 ;

const int SolrQuery::ORDER_DESC = 1 ;

const int SolrQuery::FACET_SORT_INDEX = 0 ;

const int SolrQuery::FACET_SORT_COUNT = 1 ;

const int SolrQuery::TERMS_SORT_INDEX = 0 ;

const int SolrQuery::TERMS_SORT_COUNT = 1 ;

/* 属性 */

/* 方法 */

public SolrQuery addExpandFilterQuery ( string $fq )

public SolrQuery addExpandSortField ( string $field [, string $order ] )

public SolrQuery addFacetDateField ( string $dateField )

public SolrQuery addFacetDateOther ( string $value [, string $field_override ] )

public SolrQuery addFacetField ( string $field )

public SolrQuery addFacetQuery ( string $facetQuery )

public SolrQuery addField ( string $field )

public SolrQuery addFilterQuery ( string $fq )

public SolrQuery addGroupField ( string $value )

public SolrQuery addGroupFunction ( string $value )

public SolrQuery addGroupQuery ( string $value )

public SolrQuery addGroupSortField ( string $field [, int $order ] )

public SolrQuery addHighlightField ( string $field )

public SolrQuery addMltField ( string $field )

public SolrQuery addMltQueryField ( string $field , float $boost )

public SolrQuery addSortField ( string $field [, int $order = SolrQuery::ORDER_DESC ] )

public SolrQuery addStatsFacet ( string $field )

public SolrQuery addStatsField ( string $field )

public SolrQuery collapse ( SolrCollapseFunction $collapseFunction )

public __construct ([ string $q ] )

public void __destruct ( void )

public bool getExpand ( void )

public array getExpandFilterQueries ( void )

public array getExpandQuery ( void )

public int getExpandRows ( void )

public array getExpandSortFields ( void )

public bool getFacet ( void )

public string getFacetDateEnd ([ string $field_override ] )

public array getFacetDateFields ( void )

public string getFacetDateGap ([ string $field_override ] )

public string getFacetDateHardEnd ([ string $field_override ] )

public array getFacetDateOther ([ string $field_override ] )

public string getFacetDateStart ([ string $field_override ] )

public array getFacetFields ( void )

public int getFacetLimit ([ string $field_override ] )

public string getFacetMethod ([ string $field_override ] )

public int getFacetMinCount ([ string $field_override ] )

public bool getFacetMissing ([ string $field_override ] )

public int getFacetOffset ([ string $field_override ] )

public string getFacetPrefix ([ string $field_override ] )

public array getFacetQueries ( void )

public int getFacetSort ([ string $field_override ] )

public array getFields ( void )

public array getFilterQueries ( void )

public bool getGroup ( void )

public int getGroupCachePercent ( void )

public bool getGroupFacet ( void )

public array getGroupFields ( void )

public string getGroupFormat ( void )

public array getGroupFunctions ( void )

public int getGroupLimit ( void )

public bool getGroupMain ( void )

public bool getGroupNGroups ( void )

public int getGroupOffset ( void )

public array getGroupQueries ( void )

public array getGroupSortFields ( void )

public bool getGroupTruncate ( void )

public bool getHighlight ( void )

public string getHighlightAlternateField ([ string $field_override ] )

public array getHighlightFields ( void )

public string getHighlightFormatter ([ string $field_override ] )

public string getHighlightFragmenter ([ string $field_override ] )

public int getHighlightFragsize ([ string $field_override ] )

public bool getHighlightHighlightMultiTerm ( void )

public int getHighlightMaxAlternateFieldLength ([ string $field_override ] )

public int getHighlightMaxAnalyzedChars ( void )

public bool getHighlightMergeContiguous ([ string $field_override ] )

public int getHighlightRegexMaxAnalyzedChars ( void )

public string getHighlightRegexPattern ( void )

public float getHighlightRegexSlop ( void )

public bool getHighlightRequireFieldMatch ( void )

public string getHighlightSimplePost ([ string $field_override ] )

public string getHighlightSimplePre ([ string $field_override ] )

public int getHighlightSnippets ([ string $field_override ] )

public bool getHighlightUsePhraseHighlighter ( void )

public bool getMlt ( void )

public bool getMltBoost ( void )

public int getMltCount ( void )

public array getMltFields ( void )

public int getMltMaxNumQueryTerms ( void )

public int getMltMaxNumTokens ( void )

public int getMltMaxWordLength ( void )

public int getMltMinDocFrequency ( void )

public int getMltMinTermFrequency ( void )

public int getMltMinWordLength ( void )

public array getMltQueryFields ( void )

public string getQuery ( void )

public int getRows ( void )

public array getSortFields ( void )

public int getStart ( void )

public bool getStats ( void )

public array getStatsFacets ( void )

public array getStatsFields ( void )

public bool getTerms ( void )

public string getTermsField ( void )

public bool getTermsIncludeLowerBound ( void )

public bool getTermsIncludeUpperBound ( void )

public int getTermsLimit ( void )

public string getTermsLowerBound ( void )

public int getTermsMaxCount ( void )

public int getTermsMinCount ( void )

public string getTermsPrefix ( void )

public bool getTermsReturnRaw ( void )

public int getTermsSort ( void )

public string getTermsUpperBound ( void )

public int getTimeAllowed ( void )

public SolrQuery removeExpandFilterQuery ( string $fq )

public SolrQuery removeExpandSortField ( string $field )

public SolrQuery removeFacetDateField ( string $field )

public SolrQuery removeFacetDateOther ( string $value [, string $field_override ] )

public SolrQuery removeFacetField ( string $field )

public SolrQuery removeFacetQuery ( string $value )

public SolrQuery removeField ( string $field )

public SolrQuery removeFilterQuery ( string $fq )

public SolrQuery removeHighlightField ( string $field )

public SolrQuery removeMltField ( string $field )

public SolrQuery removeMltQueryField ( string $queryField )

public SolrQuery removeSortField ( string $field )

public SolrQuery removeStatsFacet ( string $value )

public SolrQuery removeStatsField ( string $field )

public SolrQuery setEchoHandler ( bool $flag )

public SolrQuery setEchoParams ( string $type )

public SolrQuery setExpand ( bool $value )

public SolrQuery setExpandQuery ( string $q )

public SolrQuery setExpandRows ( int $value )

public SolrQuery setExplainOther ( string $query )

public SolrQuery setFacet ( bool $flag )

public SolrQuery setFacetDateEnd ( string $value [, string $field_override ] )

public SolrQuery setFacetDateGap ( string $value [, string $field_override ] )

public SolrQuery setFacetDateHardEnd ( bool $value [, string $field_override ] )

public SolrQuery setFacetDateStart ( string $value [, string $field_override ] )

public SolrQuery setFacetEnumCacheMinDefaultFrequency ( int $frequency [, string $field_override ] )

public SolrQuery setFacetLimit ( int $limit [, string $field_override ] )

public SolrQuery setFacetMethod ( string $method [, string $field_override ] )

public SolrQuery setFacetMinCount ( int $mincount [, string $field_override ] )

public SolrQuery setFacetMissing ( bool $flag [, string $field_override ] )

public SolrQuery setFacetOffset ( int $offset [, string $field_override ] )

public SolrQuery setFacetPrefix ( string $prefix [, string $field_override ] )

public SolrQuery setFacetSort ( int $facetSort [, string $field_override ] )

public SolrQuery setGroup ( bool $value )

public SolrQuery setGroupCachePercent ( int $percent )

public SolrQuery setGroupFacet ( bool $value )

public SolrQuery setGroupFormat ( string $value )

public SolrQuery setGroupLimit ( int $value )

public SolrQuery setGroupMain ( string $value )

public SolrQuery setGroupNGroups ( bool $value )

public SolrQuery setGroupOffset ( int $value )

public SolrQuery setGroupTruncate ( bool $value )

public SolrQuery setHighlight ( bool $flag )

public SolrQuery setHighlightAlternateField ( string $field [, string $field_override ] )

public SolrQuery setHighlightFormatter ( string $formatter [, string $field_override ] )

public SolrQuery setHighlightFragmenter ( string $fragmenter [, string $field_override ] )

public SolrQuery setHighlightFragsize ( int $size [, string $field_override ] )

public SolrQuery setHighlightHighlightMultiTerm ( bool $flag )

public SolrQuery setHighlightMaxAlternateFieldLength ( int $fieldLength [, string $field_override ] )

public SolrQuery setHighlightMaxAnalyzedChars ( int $value )

public SolrQuery setHighlightMergeContiguous ( bool $flag [, string $field_override ] )

public SolrQuery setHighlightRegexMaxAnalyzedChars ( int $maxAnalyzedChars )

public SolrQuery setHighlightRegexPattern ( string $value )

public SolrQuery setHighlightRegexSlop ( float $factor )

public SolrQuery setHighlightRequireFieldMatch ( bool $flag )

public SolrQuery setHighlightSimplePost ( string $simplePost [, string $field_override ] )

public SolrQuery setHighlightSimplePre ( string $simplePre [, string $field_override ] )

public SolrQuery setHighlightSnippets ( int $value [, string $field_override ] )

public SolrQuery setHighlightUsePhraseHighlighter ( bool $flag )

public SolrQuery setMlt ( bool $flag )

public SolrQuery setMltBoost ( bool $flag )

public SolrQuery setMltCount ( int $count )

public SolrQuery setMltMaxNumQueryTerms ( int $value )

public SolrQuery setMltMaxNumTokens ( int $value )

public SolrQuery setMltMaxWordLength ( int $maxWordLength )

public SolrQuery setMltMinDocFrequency ( int $minDocFrequency )

public SolrQuery setMltMinTermFrequency ( int $minTermFrequency )

public SolrQuery setMltMinWordLength ( int $minWordLength )

public SolrQuery setOmitHeader ( bool $flag )

public SolrQuery setQuery ( string $query )

public SolrQuery setRows ( int $rows )

public SolrQuery setShowDebugInfo ( bool $flag )

public SolrQuery setStart ( int $start )

public SolrQuery setStats ( bool $flag )

public SolrQuery setTerms ( bool $flag )

public SolrQuery setTermsField ( string $fieldname )

public SolrQuery setTermsIncludeLowerBound ( bool $flag )

public SolrQuery setTermsIncludeUpperBound ( bool $flag )

public SolrQuery setTermsLimit ( int $limit )

public SolrQuery setTermsLowerBound ( string $lowerBound )

public SolrQuery setTermsMaxCount ( int $frequency )

public SolrQuery setTermsMinCount ( int $frequency )

public SolrQuery setTermsPrefix ( string $prefix )

public SolrQuery setTermsReturnRaw ( bool $flag )

public SolrQuery setTermsSort ( int $sortType )

public SolrQuery setTermsUpperBound ( string $upperBound )

public SolrQuery setTimeAllowed ( int $timeAllowed )

/* 继承的方法 */

public SolrModifiableParams::__construct ( void )

public void SolrModifiableParams::__destruct ( void )

}

预定义常量

SolrQuery::ORDER_ASC
Used to specify that the sorting should be in acending order

SolrQuery::ORDER_DESC
Used to specify that the sorting should be in descending order

SolrQuery::FACET_SORT_INDEX
Used to specify that the facet should sort by index

SolrQuery::FACET_SORT_COUNT
Used to specify that the facet should sort by count

SolrQuery::TERMS_SORT_INDEX
Used in the TermsComponent

SolrQuery::TERMS_SORT_COUNT
Used in the TermsComponent

SolrQuery::addExpandFilterQuery

Overrides main filter query, determines which documents to include in the main group

说明

public SolrQuery SolrQuery::addExpandFilterQuery ( string $fq )

Overrides main filter query, determines which documents to include in the main group.

参数

fq

返回值

SolrQuery

参见

SolrQuery::setExpand
SolrQuery::addExpandSortField
SolrQuery::removeExpandSortField
SolrQuery::setExpandRows
SolrQuery::setExpandQuery
SolrQuery::removeExpandFilterQuery

SolrQuery::addExpandSortField

Orders the documents within the expanded groups (expand.sort parameter)

说明

public SolrQuery SolrQuery::addExpandSortField ( string $field [, string $order ] )

Orders the documents within the expanded groups (expand.sort parameter).

参数

field
field name

order
Order ASC/DESC, utilizes SolrQuery::ORDER_* constants.

Default: SolrQuery::ORDER_DESC

返回值

SolrQuery

参见

SolrQuery::setExpand
SolrQuery::removeExpandSortField
SolrQuery::setExpandRows
SolrQuery::setExpandQuery
SolrQuery::addExpandFilterQuery
SolrQuery::removeExpandFilterQuery

SolrQuery::addFacetDateField

Maps to facet.date

说明

public SolrQuery SolrQuery::addFacetDateField ( string $dateField )

This method allows you to specify a field which should be treated as a facet.

It can be used multiple times with different field names to indicate multiple facet fields

参数

dateField
The name of the date field.

返回值

Returns a SolrQuery object.

SolrQuery::addFacetDateOther

Adds another facet.date.other parameter

说明

public SolrQuery SolrQuery::addFacetDateOther ( string $value [, string $field_override ] )

Sets the facet.date.other parameter. Accepts an optional field override

参数

value
The value to use.

field_override
The field name for the override.

返回值

Returns the current SolrQuery object, if the return value is used.

SolrQuery::addFacetField

Adds another field to the facet

说明

public SolrQuery SolrQuery::addFacetField ( string $field )

Adds another field to the facet

参数

field
The name of the field

返回值

Returns the current SolrQuery object, if the return value is used.

范例

示例 #1 SolrQuery::addFacetField example

<?php

$options = array
(
    'hostname' => SOLR_SERVER_HOSTNAME,
    'login'    => SOLR_SERVER_USERNAME,
    'password' => SOLR_SERVER_PASSWORD,
    'port'     => SOLR_SERVER_PORT,
);

$client = new SolrClient($options);

$query = new SolrQuery();

$query->setQuery($query);

$query->addField('price')->addField('color');

$query->setFacet(true);

$query->addFacetField('price')->addFacetField('color');

$query_response = $client->query($query);

$response = $query_response->getResponse();

print_r($response['facet_counts']['facet_fields']);

?>

以上例程的输出类似于：

SolrObject Object
(
    [color] => SolrObject Object
        (
            [blue] => 20
            [green] => 100
        )

)

SolrQuery::addFacetQuery

Adds a facet query

说明

public SolrQuery SolrQuery::addFacetQuery ( string $facetQuery )

Adds a facet query

参数

facetQuery
The facet query

返回值

Returns the current SolrQuery object, if the return value is used.

范例

示例 #1 SolrQuery::addFacetField example

<?php

$options = array
(
        'hostname' => SOLR_SERVER_HOSTNAME,
        'login'    => SOLR_SERVER_USERNAME,
        'password' => SOLR_SERVER_PASSWORD,
        'port'     => SOLR_SERVER_PORT,
);

$client = new SolrClient($options);

$query = new SolrQuery('*:*');

$query->setFacet(true);

$query->addFacetQuery('price:[* TO 500]')->addFacetQuery('price:[500 TO *]');

$query_response = $client->query($query);

$response = $query_response->getResponse();

print_r($response->facet_counts->facet_queries);

?>

以上例程的输出类似于：

SolrObject Object
(
    [price:[* TO 500]] => 14
    [price:[500 TO *]] => 2
)

SolrQuery::addField

Specifies which fields to return in the result

说明

public SolrQuery SolrQuery::addField ( string $field )

This method is used to used to specify a set of fields to return, thereby restricting the amount of data returned in the response.

It should be called multiple time, once for each field name.

参数

field
The name of the field

返回值

Returns the current SolrQuery object

SolrQuery::addFilterQuery

Specifies a filter query

说明

public SolrQuery SolrQuery::addFilterQuery ( string $fq )

Specifies a filter query

参数

fq
The filter query

返回值

Returns the current SolrQuery object.

范例

示例 #1 SolrQuery::addFilterQuery example

<?php

$options = array
(
    'hostname' => SOLR_SERVER_HOSTNAME,
    'login'    => SOLR_SERVER_USERNAME,
    'password' => SOLR_SERVER_PASSWORD,
    'port'     => SOLR_SERVER_PORT,
);

$client = new SolrClient($options);

$query = new SolrQuery();

$query->setQuery('*:*');

$query->addFilterQuery('color:blue,green');

$query_response = $client->query($query);

$response = $query_response->getResponse();

print_r($response['facet_counts']['facet_fields']);

?>

以上例程的输出类似于：

 &fq=color:blue,green

SolrQuery::addGroupField

Add a field to be used to group results

说明

public SolrQuery SolrQuery::addGroupField ( string $value )

The name of the field by which to group results. The field must be single-valued, and either be indexed or a field type that has a value source and works in a function query, such as ExternalFileField. It must also be a string-based field, such as StrField or TextField Uses group.field parameter

参数

value

参见

SolrQuery::setGroup
SolrQuery::addGroupFunction
SolrQuery::addGroupQuery
SolrQuery::addGroupSortField
SolrQuery::setGroupFacet
SolrQuery::setGroupOffset
SolrQuery::setGroupLimit
SolrQuery::setGroupMain
SolrQuery::setGroupNGroups
SolrQuery::setGroupTruncate
SolrQuery::setGroupFormat
SolrQuery::setGroupCachePercent

SolrQuery::addGroupFunction

Allows grouping results based on the unique values of a function query (group.func parameter)

说明

public SolrQuery SolrQuery::addGroupFunction ( string $value )

Adds a group function (group.func parameter) Allows grouping results based on the unique values of a function query.

参数

value

返回值

SolrQuery

参见

SolrQuery::setGroup
SolrQuery::addGroupField
SolrQuery::addGroupQuery
SolrQuery::addGroupSortField
SolrQuery::setGroupFacet
SolrQuery::setGroupOffset
SolrQuery::setGroupLimit
SolrQuery::setGroupMain
SolrQuery::setGroupNGroups
SolrQuery::setGroupTruncate
SolrQuery::setGroupFormat
SolrQuery::setGroupCachePercent

SolrQuery::addGroupQuery

Allows grouping of documents that match the given query

说明

public SolrQuery SolrQuery::addGroupQuery ( string $value )

Allows grouping of documents that match the given query. Adds query to the group.query parameter

参数

value

返回值

SolrQuery

参见

SolrQuery::setGroup
SolrQuery::addGroupField
SolrQuery::addGroupFunction
SolrQuery::addGroupSortField
SolrQuery::setGroupFacet
SolrQuery::setGroupOffset
SolrQuery::setGroupLimit
SolrQuery::setGroupMain
SolrQuery::setGroupNGroups
SolrQuery::setGroupTruncate
SolrQuery::setGroupFormat
SolrQuery::setGroupCachePercent

SolrQuery::addGroupSortField

Add a group sort field (group.sort parameter)

说明

public SolrQuery SolrQuery::addGroupSortField ( string $field [, int $order ] )

Allow sorting group documents, using group sort field (group.sort parameter).

参数

field
Field name

order
Order ASC/DESC, utilizes SolrQuery::ORDER_* constants

返回值

范例

示例 #1 SolrQuery::addGroupSortField example

<?php

$solrQuery = new SolrQuery('*:*');
$solrQuery
    ->setGroup(true)
    ->addGroupSortField('price', SolrQuery::ORDER_ASC);

echo $solrQuery; 
?>

以上例程的输出类似于：

q=*:*&group=true&group.sort=price asc

参见

SolrQuery::setGroup
SolrQuery::addGroupField
SolrQuery::addGroupFunction
SolrQuery::addGroupQuery
SolrQuery::setGroupFacet
SolrQuery::setGroupOffset
SolrQuery::setGroupLimit
SolrQuery::setGroupMain
SolrQuery::setGroupNGroups
SolrQuery::setGroupTruncate
SolrQuery::setGroupFormat
SolrQuery::setGroupCachePercent

SolrQuery::addHighlightField

Maps to hl.fl

说明

public SolrQuery SolrQuery::addHighlightField ( string $field )

Maps to hl.fl. This is used to specify that highlighted snippets should be generated for a particular field

参数

field
Name of the field

返回值

Returns the current SolrQuery object, if the return value is used.

SolrQuery::addMltField

Sets a field to use for similarity

说明

public SolrQuery SolrQuery::addMltField ( string $field )

Maps to mlt.fl. It specifies that a field should be used for similarity.

参数

field
The name of the field

返回值

Returns the current SolrQuery object, if the return value is used.

SolrQuery::addMltQueryField

Maps to mlt.qf

说明

public SolrQuery SolrQuery::addMltQueryField ( string $field , float $boost )

Maps to mlt.qf. It is used to specify query fields and their boosts

参数

field
The name of the field

boost
Its boost value

返回值

Returns the current SolrQuery object, if the return value is used.

SolrQuery::addSortField

Used to control how the results should be sorted

说明

public SolrQuery SolrQuery::addSortField ( string $field [, int $order = SolrQuery::ORDER_DESC ] )

Used to control how the results should be sorted.

参数

So all downstream components (faceting, highlighting, etc...) will work with the collapsed result set.

参数

collapseFunction

返回值

Returns the current SolrQuery object

范例

示例 #1 SolrQuery::collapse example

<?php

include "bootstrap.php";

$options = array
(
        'hostname' => SOLR_SERVER_HOSTNAME,
        'login'    => SOLR_SERVER_USERNAME,
        'password' => SOLR_SERVER_PASSWORD,
        'port'     => SOLR_SERVER_PORT,
        'path'     => SOLR_SERVER_PATH
);

$client = new SolrClient($options);

$query = new SolrQuery('*:*');

$collapseFunction = new SolrCollapseFunction('manu_id_s');

$collapseFunction
->setSize(2)
->setNullPolicy(SolrCollapseFunction::NULLPOLICY_IGNORE);

$query
->collapse($collapseFunction)
->setRows(4);

$queryResponse = $client->query($query);

$response = $queryResponse->getResponse();

print_r($response);

?>

以上例程的输出类似于：

SolrQuery::__construct

Constructor

说明

public SolrQuery::__construct ([ string $q ] )

Constructor.

参数

q
Optional search query

返回值

None

错误／异常

Emits SolrIllegalArgumentException in case of an invalid parameter was passed.

更新日志

版本	说明
PECL solr 2.0.0	If `q` was invalid, then a SolrIllegalArgumentException is now thrown. Previously an error was emitted.

SolrQuery::__destruct

Destructor

说明

public void SolrQuery::__destruct ( void )

Destructor

参数

此函数没有参数。

array

参见

SolrQuery::addGroupQuery

SolrQuery::getGroupSortFields

Returns the group.sort value

说明

public array SolrQuery::getGroupSortFields ( void )

Returns the group.sort value

参数

此函数没有参数。

返回值

参见

SolrQuery::addGroupSortField

SolrQuery::getGroupTruncate

Returns the group.truncate value

说明

public bool SolrQuery::getGroupTruncate ( void )

Returns the group.truncate value

参数

此函数没有参数。

返回值

参见

SolrQuery::setGroupTruncate

参见

SolrQuery::setExpand
SolrQuery::addExpandSortField
SolrQuery::removeExpandSortField
SolrQuery::setExpandRows
SolrQuery::setExpandQuery
SolrQuery::addExpandFilterQuery

SolrQuery::removeExpandSortField

Removes an expand sort field from the expand.sort parameter

说明

public SolrQuery SolrQuery::removeExpandSortField ( string $field )

Removes an expand sort field from the expand.sort parameter.

参数

field
field name

返回值

SolrQuery

参见

SolrQuery::setExpand
SolrQuery::addExpandSortField
SolrQuery::setExpandRows
SolrQuery::setExpandQuery
SolrQuery::addExpandFilterQuery
SolrQuery::removeExpandFilterQuery

SolrQuery::removeFacetDateField

Removes one of the facet date fields

说明

public SolrQuery SolrQuery::removeFacetDateField ( string $field )

The name of the field

参数

field
The name of the date field to remove

返回值

Returns the current SolrQuery object, if the return value is used.

SolrQuery::removeFacetDateOther

Removes one of the facet.date.other parameters

说明

public SolrQuery SolrQuery::removeFacetDateOther ( string $value [, string $field_override ] )

Removes one of the facet.date.other parameters

参数

- none - don't include any request parameters for debugging
- explicit - include the parameters explicitly specified by the client in the request
- all - include all parameters involved in this request, either specified explicitly by the client, or implicit because of the request handler configuration.

参数

type
The type of parameters to include

返回值

Returns the current SolrQuery object, if the return value is used.

SolrQuery::setExpand

Enables/Disables the Expand Component

说明

public SolrQuery SolrQuery::setExpand ( bool $value )

Enables/Disables the Expand Component.

参数

value
Bool flag

返回值

SolrQuery

范例

示例 #1 SolrQuery::setExpand example

<?php

$query = new SolrQuery('lucene');

$query
    ->setExpand(true)
    ->setExpandRows(50)
    ->setExpandQuery('text:product')
    ->addExpandFilterQuery('manu:apple')
    ->addExpandFilterQuery('inStock:true')
    ->addExpandSortField('score', SolrQuery::ORDER_DESC)
    ->addExpandSortField('title', SolrQuery::ORDER_ASC);

echo $query.PHP_EOL;

?>

以上例程的输出类似于：

q=lucene&expand=true&expand.rows=50&expand.q=text:product&expand.fq=manu:apple&expand.fq=inStock:true&expand.sort=score desc,title asc

参见

SolrQuery::addExpandSortField
SolrQuery::removeExpandSortField
SolrQuery::setExpandRows
SolrQuery::setExpandQuery
SolrQuery::addExpandFilterQuery
SolrQuery::removeExpandFilterQuery

SolrQuery::setExpandQuery

Sets the expand.q parameter

说明

public SolrQuery SolrQuery::setExpandQuery ( string $q )

Sets the expand.q parameter.

Overrides the main q parameter, determines which documents to include in the main group.

参数

q

返回值

SolrQuery

参见

SolrQuery::setExpand
SolrQuery::addExpandSortField
SolrQuery::removeExpandSortField
SolrQuery::setExpandRows
SolrQuery::addExpandFilterQuery
SolrQuery::removeExpandFilterQuery

SolrQuery::setExpandRows

Sets the number of rows to display in each group (expand.rows). Server Default 5

说明

public SolrQuery SolrQuery::setExpandRows ( int $value )

Sets the number of rows to display in each group (expand.rows). Server Default 5

参数

value

返回值

SolrQuery

参见

SolrQuery::setExpand
SolrQuery::addExpandSortField
SolrQuery::removeExpandSortField
SolrQuery::setExpandQuery
SolrQuery::addExpandFilterQuery
SolrQuery::removeExpandFilterQuery

SolrQuery::setExplainOther

Sets the explainOther common query parameter

说明

public SolrQuery SolrQuery::setExplainOther ( string $query )

Sets the explainOther common query parameter

参数

query
The Lucene query to identify a set of documents

返回值

Returns the current SolrQuery object, if the return value is used.

SolrQuery::setFacet

Maps to the facet parameter. Enables or disables facetting

说明

public SolrQuery SolrQuery::setFacet ( bool $flag )

Enables or disables faceting.

value

返回值

参见

SolrQuery::getGroup
SolrQuery::addGroupField
SolrQuery::addGroupFunction
SolrQuery::addGroupQuery
SolrQuery::addGroupSortField
SolrQuery::setGroupFacet
SolrQuery::setGroupOffset
SolrQuery::setGroupLimit
SolrQuery::setGroupMain
SolrQuery::setGroupNGroups
SolrQuery::setGroupTruncate
SolrQuery::setGroupFormat
SolrQuery::setGroupCachePercent

SolrQuery::setGroupCachePercent

Enables caching for result grouping

说明

public SolrQuery SolrQuery::setGroupCachePercent ( int $percent )

Setting this parameter to a number greater than 0 enables caching for result grouping. Result Grouping executes two searches; this option caches the second search. The server default value is 0. Testing has shown that group caching only improves search time with Boolean, wildcard, and fuzzy queries. For simple queries like term or "match all" queries, group caching degrades performance. group.cache.percent parameter

参数

percent

返回值

错误／异常

Emits SolrIllegalArgumentException in case of an invalid parameter was passed.

参见

SolrQuery::setGroup
SolrQuery::addGroupField
SolrQuery::addGroupFunction
SolrQuery::addGroupQuery
SolrQuery::addGroupSortField
SolrQuery::setGroupFacet
SolrQuery::setGroupOffset
SolrQuery::setGroupLimit
SolrQuery::setGroupMain
SolrQuery::setGroupNGroups
SolrQuery::setGroupTruncate
SolrQuery::setGroupFormat

SolrQuery::setGroupFacet

Sets group.facet parameter

说明

public SolrQuery SolrQuery::setGroupFacet ( bool $value )

Determines whether to compute grouped facets for the field facets specified in facet.field parameters. Grouped facets are computed based on the first specified group.

参数

value

返回值

参见

SolrQuery::setGroup
SolrQuery::addGroupField
SolrQuery::addGroupFunction
SolrQuery::addGroupQuery
SolrQuery::addGroupSortField
SolrQuery::setGroupOffset
SolrQuery::setGroupLimit
SolrQuery::setGroupMain
SolrQuery::setGroupNGroups
SolrQuery::setGroupTruncate
SolrQuery::setGroupFormat
SolrQuery::setGroupCachePercent

SolrQuery::setGroupFormat

Sets the group format, result structure (group.format parameter)

说明

public SolrQuery SolrQuery::setGroupFormat ( string $value )

Sets the group.format parameter. If this parameter is set to simple, the grouped documents are presented in a single flat list, and the start and rows parameters affect the numbers of documents instead of groups. Accepts: grouped/simple

参数

value

返回值

参见

SolrQuery::setGroup
SolrQuery::addGroupField
SolrQuery::addGroupFunction
SolrQuery::addGroupQuery
SolrQuery::addGroupSortField
SolrQuery::setGroupFacet
SolrQuery::setGroupOffset
SolrQuery::setGroupLimit
SolrQuery::setGroupMain
SolrQuery::setGroupNGroups
SolrQuery::setGroupTruncate
SolrQuery::setGroupCachePercent

SolrQuery::setGroupLimit

Specifies the number of results to return for each group. The server default value is 1

说明

public SolrQuery SolrQuery::setGroupLimit ( int $value )

Specifies the number of results to return for each group. The server default value is 1.

参数

value

返回值

参见

SolrQuery::setGroup
SolrQuery::addGroupField
SolrQuery::addGroupFunction
SolrQuery::addGroupQuery
SolrQuery::addGroupSortField
SolrQuery::setGroupFacet
SolrQuery::setGroupOffset
SolrQuery::setGroupMain
SolrQuery::setGroupNGroups
SolrQuery::setGroupTruncate
SolrQuery::setGroupFormat
SolrQuery::setGroupCachePercent

SolrQuery::setGroupMain

If true, the result of the first field grouping command is used as the main result list in the response, using group.format=simple

说明

public SolrQuery SolrQuery::setGroupMain ( string $value )

If true, the result of the first field grouping command is used as the main result list in the response, using group.format=simple.

参数

value

返回值

参见

SolrQuery::setGroup
SolrQuery::addGroupField
SolrQuery::addGroupFunction
SolrQuery::addGroupQuery
SolrQuery::addGroupSortField
SolrQuery::setGroupFacet
SolrQuery::setGroupOffset
SolrQuery::setGroupMain
SolrQuery::setGroupNGroups
SolrQuery::setGroupTruncate
SolrQuery::setGroupFormat
SolrQuery::setGroupCachePercent

SolrQuery::setGroupNGroups

If true, Solr includes the number of groups that have matched the query in the results

说明

public SolrQuery SolrQuery::setGroupNGroups ( bool $value )

If true, Solr includes the number of groups that have matched the query in the results.

参数

value

返回值

参见

SolrQuery::setGroup
SolrQuery::addGroupField
SolrQuery::addGroupFunction
SolrQuery::addGroupQuery
SolrQuery::addGroupSortField
SolrQuery::setGroupFacet
SolrQuery::setGroupOffset
SolrQuery::setGroupLimit
SolrQuery::setGroupMain
SolrQuery::setGroupTruncate
SolrQuery::setGroupFormat
SolrQuery::setGroupCachePercent

SolrQuery::setGroupOffset

Sets the group.offset parameter

说明

public SolrQuery SolrQuery::setGroupOffset ( int $value )

Sets the group.offset parameter.

参数

value

返回值

参见

SolrQuery::setGroup
SolrQuery::addGroupField
SolrQuery::addGroupFunction
SolrQuery::addGroupQuery
SolrQuery::addGroupSortField
SolrQuery::setGroupFacet
SolrQuery::setGroupLimit
SolrQuery::setGroupMain
SolrQuery::setGroupNGroups
SolrQuery::setGroupTruncate
SolrQuery::setGroupFormat
SolrQuery::setGroupCachePercent

SolrQuery::setGroupTruncate

If true, facet counts are based on the most relevant document of each group matching the query

说明

public SolrQuery SolrQuery::setGroupTruncate ( bool $value )

If true, facet counts are based on the most relevant document of each group matching the query. The server default value is false. group.truncate parameter

参数

value

返回值

参见

SolrQuery::setGroup
SolrQuery::addGroupField
SolrQuery::addGroupFunction
SolrQuery::addGroupQuery
SolrQuery::addGroupSortField
SolrQuery::setGroupFacet
SolrQuery::setGroupOffset
SolrQuery::setGroupLimit
SolrQuery::setGroupMain
SolrQuery::setGroupNGroups
SolrQuery::setGroupFormat
SolrQuery::setGroupCachePercent

SolrQuery::setHighlight

Enables or disables highlighting

说明

public SolrQuery SolrQuery::setHighlight ( bool $flag )

Setting it to true enables highlighted snippets to be generated in the query response.

Setting it to false disables highlighting

参数

flag
Enable or disable highlighting

返回值

Returns the current SolrQuery object, if the return value is used.

SolrQuery::setHighlightAlternateField

Specifies the backup field to use

说明

public SolrQuery SolrQuery::setHighlightAlternateField ( string $field [, string $field_override ] )

If a snippet cannot be generated because there were no matching terms, one can specify a field to use as the backup or default summary

参数

field
The name of the backup field

field_override
The name of the field we are overriding this setting for.

返回值

Returns the current SolrQuery object, if the return value is used.

SolrQuery::setHighlightFormatter

Specify a formatter for the highlight output

说明

public SolrQuery SolrQuery::setHighlightFormatter ( string $formatter [, string $field_override ] )

Specify a formatter for the highlight output.

参数

formatter
Currently the only legal value is "simple"

field_override
The name of the field.

SolrQuery::setHighlightFragmenter

Sets a text snippet generator for highlighted text

说明

public SolrQuery SolrQuery::setHighlightFragmenter ( string $fragmenter [, string $field_override ] )

Specify a text snippet generator for highlighted text.

参数

fragmenter
The standard fragmenter is gap. Another option is regex, which tries to create fragments that resembles a certain regular expression

field_override
The name of the field.

返回值

Returns the current SolrQuery object, if the return value is used.

SolrQuery::setHighlightFragsize

The size of fragments to consider for highlighting

说明

public SolrQuery SolrQuery::setHighlightFragsize ( int $size [, string $field_override ] )

Sets the size, in characters, of fragments to consider for highlighting. "0" indicates that the whole field value should be used (no fragmenting).

参数

size
The size, in characters, of fragments to consider for highlighting

field_override
The name of the field.

返回值

Returns the current SolrQuery object, if the return value is used.

SolrQuery::setHighlightHighlightMultiTerm

Use SpanScorer to highlight phrase terms

说明

public SolrQuery SolrQuery::setHighlightHighlightMultiTerm ( bool $flag )

Use SpanScorer to highlight phrase terms only when they appear within the query phrase in the document.

参数

flag
Whether or not to use SpanScorer to highlight phrase terms only when they appear within the query phrase in the document.

返回值

Returns the current SolrQuery object, if the return value is used.

SolrQuery::setHighlightMaxAlternateFieldLength

Sets the maximum number of characters of the field to return

说明

public SolrQuery SolrQuery::setHighlightMaxAlternateFieldLength ( int $fieldLength [, string $field_override ] )

If SolrQuery::setHighlightAlternateField() was passed the value true, this parameter specifies the maximum number of characters of the field to return

Any value less than or equal to 0 means unlimited.

参数

fieldLength
The length of the field

field_override
The name of the field.

返回值

Returns the current SolrQuery object, if the return value is used.

SolrQuery::setHighlightMaxAnalyzedChars

Specifies the number of characters into a document to look for suitable snippets

说明

public SolrQuery SolrQuery::setHighlightMaxAnalyzedChars ( int $value )

Specifies the number of characters into a document to look for suitable snippets

参数

value
The number of characters into a document to look for suitable snippets

返回值

Returns the current SolrQuery object, if the return value is used.

SolrQuery::setHighlightMergeContiguous

Whether or not to collapse contiguous fragments into a single fragment

说明

public SolrQuery SolrQuery::setHighlightMergeContiguous ( bool $flag [, string $field_override ] )

Whether or not to collapse contiguous fragments into a single fragment

参数

This will only work if SolrQuery::setHighlightUsePhraseHighlighter() was set to true

参数

flag
true or false

返回值

Returns the current SolrQuery object, if the return value is used.

SolrQuery::setHighlightSimplePost

Sets the text which appears after a highlighted term

说明

public SolrQuery SolrQuery::setHighlightSimplePost ( string $simplePost [, string $field_override ] )

Sets the text which appears before a highlighted term

参数

simplePost
Sets the text which appears after a highlighted term

The default is </em>

field_override
The name of the field.

SolrQuery::setHighlightSimplePre

Sets the text which appears before a highlighted term

说明

public SolrQuery SolrQuery::setHighlightSimplePre ( string $simplePre [, string $field_override ] )

Sets the text which appears before a highlighted term

The default is <em>

参数

simplePre
The text which appears before a highlighted term

field_override
The name of the field.

返回值

Returns the current SolrQuery object, if the return value is used.

SolrQuery::setHighlightSnippets

Sets the maximum number of highlighted snippets to generate per field

说明

public SolrQuery SolrQuery::setHighlightSnippets ( int $value [, string $field_override ] )

Sets the maximum number of highlighted snippets to generate per field

参数

参数

timeAllowed
The time allowed for a search to finish.

返回值

Returns the current SolrQuery object, if the return value is used.

简介

类摘要

SolrDisMaxQuery

class SolrDisMaxQuery extends SolrQuery implements Serializable {

/* 继承的属性 */

const int SolrQuery::ORDER_ASC = 0 ;

const int SolrQuery::ORDER_DESC = 1 ;

const int SolrQuery::FACET_SORT_INDEX = 0 ;

const int SolrQuery::FACET_SORT_COUNT = 1 ;

const int SolrQuery::TERMS_SORT_INDEX = 0 ;

const int SolrQuery::TERMS_SORT_COUNT = 1 ;

/* 方法 */

public SolrDisMaxQuery addBigramPhraseField ( string $field , string $boost [, string $slop ] )

public SolrDisMaxQuery addBoostQuery ( string $field , string $value [, string $boost ] )

public SolrDisMaxQuery addPhraseField ( string $field , string $boost [, string $slop ] )

public SolrDisMaxQuery addQueryField ( string $field [, string $boost ] )

public SolrDisMaxQuery addTrigramPhraseField ( string $field , string $boost [, string $slop ] )

public SolrDisMaxQuery addUserField ( string $field )

public __construct ([ string $q ] )

public SolrDisMaxQuery removeBigramPhraseField ( string $field )

public SolrDisMaxQuery removeBoostQuery ( string $field )

public SolrDisMaxQuery removePhraseField ( string $field )

public SolrDisMaxQuery removeQueryField ( string $field )

public SolrDisMaxQuery removeTrigramPhraseField ( string $field )

public SolrDisMaxQuery removeUserField ( string $field )

public SolrDisMaxQuery setBigramPhraseFields ( string $fields )

public SolrDisMaxQuery setBigramPhraseSlop ( string $slop )

public SolrDisMaxQuery setBoostFunction ( string $function )

public SolrDisMaxQuery setBoostQuery ( string $q )

public SolrDisMaxQuery setMinimumMatch ( string $value )

public SolrDisMaxQuery setPhraseFields ( string $fields )

public SolrDisMaxQuery setPhraseSlop ( string $slop )

public SolrDisMaxQuery setQueryAlt ( string $q )

public SolrDisMaxQuery setQueryPhraseSlop ( string $slop )

public SolrDisMaxQuery setTieBreaker ( string $tieBreaker )

public SolrDisMaxQuery setTrigramPhraseFields ( string $fields )

public SolrDisMaxQuery setTrigramPhraseSlop ( string $slop )

public SolrDisMaxQuery setUserFields ( string $fields )

public SolrDisMaxQuery useDisMaxQueryParser ( void )

public SolrDisMaxQuery useEDisMaxQueryParser ( void )

/* 继承的方法 */

public SolrQuery SolrQuery::addExpandFilterQuery ( string $fq )

public SolrQuery SolrQuery::addExpandSortField ( string $field [, string $order ] )

public SolrQuery SolrQuery::addFacetDateField ( string $dateField )

public SolrQuery SolrQuery::addFacetDateOther ( string $value [, string $field_override ] )

public SolrQuery SolrQuery::addFacetField ( string $field )

public SolrQuery SolrQuery::addFacetQuery ( string $facetQuery )

public SolrQuery SolrQuery::addField ( string $field )

public SolrQuery SolrQuery::addFilterQuery ( string $fq )

public SolrQuery SolrQuery::addGroupField ( string $value )

public SolrQuery SolrQuery::addGroupFunction ( string $value )

public SolrQuery SolrQuery::addGroupQuery ( string $value )

public SolrQuery SolrQuery::addGroupSortField ( string $field [, int $order ] )

public SolrQuery SolrQuery::addHighlightField ( string $field )

public SolrQuery SolrQuery::addMltField ( string $field )

public SolrQuery SolrQuery::addMltQueryField ( string $field , float $boost )

public SolrQuery SolrQuery::addSortField ( string $field [, int $order = SolrQuery::ORDER_DESC ] )

public SolrQuery SolrQuery::addStatsFacet ( string $field )

public SolrQuery SolrQuery::addStatsField ( string $field )

public SolrQuery SolrQuery::collapse ( SolrCollapseFunction $collapseFunction )

public SolrQuery::__construct ([ string $q ] )

public void SolrQuery::__destruct ( void )

public bool SolrQuery::getExpand ( void )

public array SolrQuery::getExpandFilterQueries ( void )

public array SolrQuery::getExpandQuery ( void )

public int SolrQuery::getExpandRows ( void )

public array SolrQuery::getExpandSortFields ( void )

public bool SolrQuery::getFacet ( void )

public string SolrQuery::getFacetDateEnd ([ string $field_override ] )

public array SolrQuery::getFacetDateFields ( void )

public string SolrQuery::getFacetDateGap ([ string $field_override ] )

public string SolrQuery::getFacetDateHardEnd ([ string $field_override ] )

public array SolrQuery::getFacetDateOther ([ string $field_override ] )

public string SolrQuery::getFacetDateStart ([ string $field_override ] )

public array SolrQuery::getFacetFields ( void )

public int SolrQuery::getFacetLimit ([ string $field_override ] )

public string SolrQuery::getFacetMethod ([ string $field_override ] )

public int SolrQuery::getFacetMinCount ([ string $field_override ] )

public bool SolrQuery::getFacetMissing ([ string $field_override ] )

public int SolrQuery::getFacetOffset ([ string $field_override ] )

public string SolrQuery::getFacetPrefix ([ string $field_override ] )

public array SolrQuery::getFacetQueries ( void )

public int SolrQuery::getFacetSort ([ string $field_override ] )

public array SolrQuery::getFields ( void )

public array SolrQuery::getFilterQueries ( void )

public bool SolrQuery::getGroup ( void )

public int SolrQuery::getGroupCachePercent ( void )

public bool SolrQuery::getGroupFacet ( void )

public array SolrQuery::getGroupFields ( void )

public string SolrQuery::getGroupFormat ( void )

public array SolrQuery::getGroupFunctions ( void )

public int SolrQuery::getGroupLimit ( void )

public bool SolrQuery::getGroupMain ( void )

public bool SolrQuery::getGroupNGroups ( void )

public int SolrQuery::getGroupOffset ( void )

public array SolrQuery::getGroupQueries ( void )

public array SolrQuery::getGroupSortFields ( void )

public bool SolrQuery::getGroupTruncate ( void )

public bool SolrQuery::getHighlight ( void )

public string SolrQuery::getHighlightAlternateField ([ string $field_override ] )

public array SolrQuery::getHighlightFields ( void )

public string SolrQuery::getHighlightFormatter ([ string $field_override ] )

public string SolrQuery::getHighlightFragmenter ([ string $field_override ] )

public int SolrQuery::getHighlightFragsize ([ string $field_override ] )

public bool SolrQuery::getHighlightHighlightMultiTerm ( void )

public int SolrQuery::getHighlightMaxAlternateFieldLength ([ string $field_override ] )

public int SolrQuery::getHighlightMaxAnalyzedChars ( void )

public bool SolrQuery::getHighlightMergeContiguous ([ string $field_override ] )

public int SolrQuery::getHighlightRegexMaxAnalyzedChars ( void )

public string SolrQuery::getHighlightRegexPattern ( void )

public float SolrQuery::getHighlightRegexSlop ( void )

public bool SolrQuery::getHighlightRequireFieldMatch ( void )

public string SolrQuery::getHighlightSimplePost ([ string $field_override ] )

public string SolrQuery::getHighlightSimplePre ([ string $field_override ] )

public int SolrQuery::getHighlightSnippets ([ string $field_override ] )

public bool SolrQuery::getHighlightUsePhraseHighlighter ( void )

public bool SolrQuery::getMlt ( void )

public bool SolrQuery::getMltBoost ( void )

public int SolrQuery::getMltCount ( void )

public array SolrQuery::getMltFields ( void )

public int SolrQuery::getMltMaxNumQueryTerms ( void )

public int SolrQuery::getMltMaxNumTokens ( void )

public int SolrQuery::getMltMaxWordLength ( void )

public int SolrQuery::getMltMinDocFrequency ( void )

public int SolrQuery::getMltMinTermFrequency ( void )

public int SolrQuery::getMltMinWordLength ( void )

public array SolrQuery::getMltQueryFields ( void )

public string SolrQuery::getQuery ( void )

public int SolrQuery::getRows ( void )

public array SolrQuery::getSortFields ( void )

public int SolrQuery::getStart ( void )

public bool SolrQuery::getStats ( void )

public array SolrQuery::getStatsFacets ( void )

public array SolrQuery::getStatsFields ( void )

public bool SolrQuery::getTerms ( void )

public string SolrQuery::getTermsField ( void )

public bool SolrQuery::getTermsIncludeLowerBound ( void )

public bool SolrQuery::getTermsIncludeUpperBound ( void )

public int SolrQuery::getTermsLimit ( void )

public string SolrQuery::getTermsLowerBound ( void )

public int SolrQuery::getTermsMaxCount ( void )

public int SolrQuery::getTermsMinCount ( void )

public string SolrQuery::getTermsPrefix ( void )

public bool SolrQuery::getTermsReturnRaw ( void )

public int SolrQuery::getTermsSort ( void )

public string SolrQuery::getTermsUpperBound ( void )

public int SolrQuery::getTimeAllowed ( void )

public SolrQuery SolrQuery::removeExpandFilterQuery ( string $fq )

public SolrQuery SolrQuery::removeExpandSortField ( string $field )

public SolrQuery SolrQuery::removeFacetDateField ( string $field )

public SolrQuery SolrQuery::removeFacetDateOther ( string $value [, string $field_override ] )

public SolrQuery SolrQuery::removeFacetField ( string $field )

public SolrQuery SolrQuery::removeFacetQuery ( string $value )

public SolrQuery SolrQuery::removeField ( string $field )

public SolrQuery SolrQuery::removeFilterQuery ( string $fq )

public SolrQuery SolrQuery::removeHighlightField ( string $field )

public SolrQuery SolrQuery::removeMltField ( string $field )

public SolrQuery SolrQuery::removeMltQueryField ( string $queryField )

public SolrQuery SolrQuery::removeSortField ( string $field )

public SolrQuery SolrQuery::removeStatsFacet ( string $value )

public SolrQuery SolrQuery::removeStatsField ( string $field )

public SolrQuery SolrQuery::setEchoHandler ( bool $flag )

public SolrQuery SolrQuery::setEchoParams ( string $type )

public SolrQuery SolrQuery::setExpand ( bool $value )

public SolrQuery SolrQuery::setExpandQuery ( string $q )

public SolrQuery SolrQuery::setExpandRows ( int $value )

public SolrQuery SolrQuery::setExplainOther ( string $query )

public SolrQuery SolrQuery::setFacet ( bool $flag )

public SolrQuery SolrQuery::setFacetDateEnd ( string $value [, string $field_override ] )

public SolrQuery SolrQuery::setFacetDateGap ( string $value [, string $field_override ] )

public SolrQuery SolrQuery::setFacetDateHardEnd ( bool $value [, string $field_override ] )

public SolrQuery SolrQuery::setFacetDateStart ( string $value [, string $field_override ] )

public SolrQuery SolrQuery::setFacetEnumCacheMinDefaultFrequency ( int $frequency [, string $field_override ] )

public SolrQuery SolrQuery::setFacetLimit ( int $limit [, string $field_override ] )

public SolrQuery SolrQuery::setFacetMethod ( string $method [, string $field_override ] )

public SolrQuery SolrQuery::setFacetMinCount ( int $mincount [, string $field_override ] )

public SolrQuery SolrQuery::setFacetMissing ( bool $flag [, string $field_override ] )

public SolrQuery SolrQuery::setFacetOffset ( int $offset [, string $field_override ] )

public SolrQuery SolrQuery::setFacetPrefix ( string $prefix [, string $field_override ] )

public SolrQuery SolrQuery::setFacetSort ( int $facetSort [, string $field_override ] )

public SolrQuery SolrQuery::setGroup ( bool $value )