Apache Solr

Table of Contents

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

The SolrUtils class

Introduction

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

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

Class synopsis

SolrUtils

abstract class SolrUtils {

/* Methods */

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

public static string escapeQueryChars ( string $str )

public static string getSolrVersion ( void )

public static string queryPhrase ( string $str )

}

The SolrInputDocument class

Introduction

This class represents a Solr document that is about to be submitted to the Solr index.

Class synopsis

SolrInputDocument

final class SolrInputDocument {

/* Constants */

const integer SolrInputDocument::SORT_DEFAULT = 1 ;

const integer SolrInputDocument::SORT_ASC = 1 ;

const integer SolrInputDocument::SORT_DESC = 2 ;

const integer SolrInputDocument::SORT_FIELD_NAME = 1 ;

const integer SolrInputDocument::SORT_FIELD_VALUE_COUNT = 2 ;

const integer SolrInputDocument::SORT_FIELD_BOOST_VALUE = 4 ;

/* Methods */

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 SolrDocumentField getField ( string $fieldName )

public float getFieldBoost ( string $fieldName )

public int getFieldCount ( void )

public array getFieldNames ( 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 )

}

Predefined Constants

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.

The SolrDocument class

Introduction

Represents a Solr document retrieved from a query response.

Class synopsis

SolrDocument

final class SolrDocument implements ArrayAccess , Iterator , Serializable {

/* Constants */

const integer SolrDocument::SORT_DEFAULT = 1 ;

const integer SolrDocument::SORT_ASC = 1 ;

const integer SolrDocument::SORT_DESC = 2 ;

const integer SolrDocument::SORT_FIELD_NAME = 1 ;

const integer SolrDocument::SORT_FIELD_VALUE_COUNT = 2 ;

const integer SolrDocument::SORT_FIELD_BOOST_VALUE = 4 ;

/* Methods */

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 SolrDocumentField getField ( string $fieldName )

public int getFieldCount ( void )

public array getFieldNames ( void )

public SolrInputDocument getInputDocument ( 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 )

}

Predefined Constants

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.

The SolrDocumentField class

Introduction

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

Class synopsis

SolrDocumentField

final class SolrDocumentField {

/* Properties */

readonly public string $name ;

readonly public float $boost ;

readonly public array $values ;

/* Methods */

public __construct ( void )

public void __destruct ( void )

}

Properties

name: The name of the field.
boost: The boost value for the field
values: An array of values for this field

The SolrObject class

Introduction

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

Class synopsis

SolrObject

final class SolrObject implements ArrayAccess {

/* Methods */

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 )

}

The SolrClient class

Introduction

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

Class synopsis

SolrClient

final class SolrClient {

/* Constants */

const integer SolrClient::SEARCH_SERVLET_TYPE = 1 ;

const integer SolrClient::UPDATE_SERVLET_TYPE = 2 ;

const integer SolrClient::THREADS_SERVLET_TYPE = 4 ;

const integer SolrClient::PING_SERVLET_TYPE = 8 ;

const integer SolrClient::TERMS_SERVLET_TYPE = 16 ;

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 ;

/* Methods */

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

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

public SolrUpdateResponse commit ([ int $maxSegments = "1" [, bool $waitFlush = true [, bool $waitSearcher = true ]]] )

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 string getDebug ( void )

public array getOptions ( void )

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

public SolrPingResponse ping ( void )

public SolrQueryResponse query ( SolrParams $query )

public void request ( string $raw_request )

public SolrUpdateResponse rollback ( void )

public void setResponseWriter ( string $responseWriter )

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

public void threads ( void )

}

Predefined Constants

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::DEFAULT_SEARCH_SERVLET: This is the intial value for the search servlet.
SolrClient::DEFAULT_UPDATE_SERVLET: This is the intial value for the update servlet.
SolrClient::DEFAULT_THREADS_SERVLET: This is the intial value for the threads servlet.
SolrClient::DEFAULT_PING_SERVLET: This is the intial value for the ping servlet.
SolrClient::DEFAULT_TERMS_SERVLET: This is the intial value for the terms servlet used for the TermsComponent

The SolrResponse class

Introduction

Represents a response from the Solr server.

Class synopsis

SolrResponse

abstract class SolrResponse {

/* Constants */

const integer SolrResponse::PARSE_SOLR_OBJ = 0 ;

const integer SolrResponse::PARSE_SOLR_DOC = 1 ;

/* Properties */

protected integer $http_status ;

protected integer $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 ;

/* Methods */

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 )

}

Properties

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.

Predefined Constants

SolrResponse Class Constants

SolrResponse::PARSE_SOLR_OBJ: Documents should be parsed as SolrObject instances
SolrResponse::PARSE_SOLR_DOC: Documents should be parsed as SolrDocument instances.

The SolrQueryResponse class

Introduction

Represents a response to a query request.

Class synopsis

SolrQueryResponse

final class SolrQueryResponse extends SolrResponse {

/* Constants */

const integer SolrQueryResponse::PARSE_SOLR_OBJ = 0 ;

const integer SolrQueryResponse::PARSE_SOLR_DOC = 1 ;

/* Inherited properties */

const integer SolrResponse::PARSE_SOLR_OBJ = 0 ;

const integer SolrResponse::PARSE_SOLR_DOC = 1 ;

protected integer $http_status ;

protected integer $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 ;

/* Methods */

public __construct ( void )

public void __destruct ( void )

/* Inherited methods */

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 )

}

Predefined Constants

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.

The SolrUpdateResponse class

Introduction

Represents a response to an update request.

Class synopsis

SolrUpdateResponse

final class SolrUpdateResponse extends SolrResponse {

/* Constants */

const integer SolrUpdateResponse::PARSE_SOLR_OBJ = 0 ;

const integer SolrUpdateResponse::PARSE_SOLR_DOC = 1 ;

/* Inherited properties */

const integer SolrResponse::PARSE_SOLR_OBJ = 0 ;

const integer SolrResponse::PARSE_SOLR_DOC = 1 ;

protected integer $http_status ;

protected integer $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 ;

/* Methods */

public __construct ( void )

public void __destruct ( void )

/* Inherited methods */

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 )

}

Predefined Constants

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.

The SolrPingResponse class

Introduction

Represents a response to a ping request to the server

Class synopsis

SolrPingResponse

final class SolrPingResponse extends SolrResponse {

/* Constants */

const integer SolrPingResponse::PARSE_SOLR_OBJ = 0 ;

const integer SolrPingResponse::PARSE_SOLR_DOC = 1 ;

/* Properties */

/* Methods */

public __construct ( void )

public void __destruct ( void )

public string getResponse ( void )

/* Inherited methods */

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 )

}

Properties

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.

Predefined Constants

SolrPingResponse Class Constants

SolrPingResponse::PARSE_SOLR_OBJ: Documents should be parsed as SolrObject instances
SolrPingResponse::PARSE_SOLR_DOC: Documents should be parsed as SolrDocument instances.

The SolrGenericResponse class

Introduction

Represents a response from the solr server.

Class synopsis

SolrGenericResponse

final class SolrGenericResponse extends SolrResponse {

/* Constants */

const integer SolrGenericResponse::PARSE_SOLR_OBJ = 0 ;

const integer SolrGenericResponse::PARSE_SOLR_DOC = 1 ;

/* Inherited properties */

const integer SolrResponse::PARSE_SOLR_OBJ = 0 ;

const integer SolrResponse::PARSE_SOLR_DOC = 1 ;

protected integer $http_status ;

protected integer $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 ;

/* Methods */

public __construct ( void )

public void __destruct ( void )

/* Inherited methods */

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 )

}

Predefined Constants

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.

The SolrParams class

Introduction

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

Class synopsis

SolrParams

abstract class SolrParams implements Serializable {

/* Methods */

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 )

}

The SolrModifiableParams class

Introduction

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

Class synopsis

SolrModifiableParams

class SolrModifiableParams extends SolrParams implements Serializable {

/* Methods */

public __construct ( void )

public void __destruct ( void )

/* Inherited methods */

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 )

}

The SolrQuery class

Introduction

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

Class synopsis

SolrQuery

class SolrQuery extends SolrModifiableParams implements Serializable {

/* Constants */

const integer SolrQuery::ORDER_ASC = 0 ;

const integer SolrQuery::ORDER_DESC = 1 ;

const integer SolrQuery::FACET_SORT_INDEX = 0 ;

const integer SolrQuery::FACET_SORT_COUNT = 1 ;

const integer SolrQuery::TERMS_SORT_INDEX = 0 ;

const integer SolrQuery::TERMS_SORT_COUNT = 1 ;

/* Properties */

/* Methods */

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 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 __construct ([ string $q ] )

public void __destruct ( 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 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 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 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 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 )

/* Inherited methods */

public SolrModifiableParams::__construct ( void )

public void SolrModifiableParams::__destruct ( void )

}

Predefined Constants

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

The SolrException class

Introduction

This is the base class for all exception thrown by the Solr extension classes.

Class synopsis

SolrException

class SolrException extends Exception {

/* Properties */

protected integer $sourceline ;

protected string $sourcefile ;

protected string $zif_name ;

/* Inherited properties */

protected string $message ;

protected int $code ;

protected string $file ;

protected int $line ;

/* Methods */

public array getInternalInfo ( void )

/* Inherited methods */

final public string Exception::getMessage ( void )

final public Exception Exception::getPrevious ( void )

final public mixed Exception::getCode ( void )

final public string Exception::getFile ( void )

final public int Exception::getLine ( void )

final public array Exception::getTrace ( void )

final public string Exception::getTraceAsString ( void )

public string Exception::__toString ( void )

final private void Exception::__clone ( void )

}

Properties

sourceline: The line in c-space source file where exception was generated
sourcefile: The c-space source file where exception was generated
zif_name: The c-space function where exception was generated

The SolrClientException class

Introduction

An exception thrown when there is an error while making a request to the server from the client.

Class synopsis

SolrClientException

class SolrClientException extends SolrException {

/* Inherited properties */

protected string $message ;

protected int $code ;

protected string $file ;

protected int $line ;

protected integer $sourceline ;

protected string $sourcefile ;

protected string $zif_name ;

/* Methods */

public array getInternalInfo ( void )

/* Inherited methods */

final public string Exception::getMessage ( void )

final public Exception Exception::getPrevious ( void )

final public mixed Exception::getCode ( void )

final public string Exception::getFile ( void )

final public int Exception::getLine ( void )

final public array Exception::getTrace ( void )

final public string Exception::getTraceAsString ( void )

public string Exception::__toString ( void )

final private void Exception::__clone ( void )

public array SolrException::getInternalInfo ( void )

}

The SolrIllegalArgumentException class

Introduction

This object is thrown when an illeglal or invalid argument is passed to a method.

Class synopsis

SolrIllegalArgumentException

class SolrIllegalArgumentException extends SolrException {

/* Inherited properties */

protected string $message ;

protected int $code ;

protected string $file ;

protected int $line ;

protected integer $sourceline ;

protected string $sourcefile ;

protected string $zif_name ;

/* Methods */

public array getInternalInfo ( void )

/* Inherited methods */

final public string Exception::getMessage ( void )

final public Exception Exception::getPrevious ( void )

final public mixed Exception::getCode ( void )

final public string Exception::getFile ( void )

final public int Exception::getLine ( void )

final public array Exception::getTrace ( void )

final public string Exception::getTraceAsString ( void )

public string Exception::__toString ( void )

final private void Exception::__clone ( void )

public array SolrException::getInternalInfo ( void )

}

The SolrIllegalOperationException class

Introduction

This object is thrown when an illegal or unsupported operation is performed on an object.

Class synopsis

SolrIllegalOperationException

class SolrIllegalOperationException extends SolrException {

/* Inherited properties */

protected string $message ;

protected int $code ;

protected string $file ;

protected int $line ;

protected integer $sourceline ;

protected string $sourcefile ;

protected string $zif_name ;

/* Methods */

public array getInternalInfo ( void )

/* Inherited methods */

final public string Exception::getMessage ( void )

final public Exception Exception::getPrevious ( void )

final public mixed Exception::getCode ( void )

final public string Exception::getFile ( void )

final public int Exception::getLine ( void )

final public array Exception::getTrace ( void )

final public string Exception::getTraceAsString ( void )

public string Exception::__toString ( void )

final private void Exception::__clone ( void )

public array SolrException::getInternalInfo ( void )

}