## Full index

### Package indexes

- Apache

a
top

add
  Apache_Solr_Service_Balancer::add() in Balancer.php
  Raw Add Method. Takes a raw post body and sends it to the update service. Post body should be a complete and well formed "add" xml document.
add
  Apache_Solr_Service::add() in Service.php
  Raw Add Method. Takes a raw post body and sends it to the update service. Post body should be a complete and well formed "add" xml document.
addDocument
  Apache_Solr_Service_Balancer::addDocument() in Balancer.php
  Add a Solr Document to the index
addDocument
  Apache_Solr_Service::addDocument() in Service.php
  Add a Solr Document to the index
addDocuments
  Apache_Solr_Service::addDocuments() in Service.php
  Add an array of Solr Documents to the index all at once
addDocuments
  Apache_Solr_Service_Balancer::addDocuments() in Balancer.php
  Add an array of Solr Documents to the index all at once
addField
  Apache_Solr_Document::addField() in Document.php
  Add a value to a multi-valued field
addReadService
  Apache_Solr_Service_Balancer::addReadService() in Balancer.php
  Adds a service instance or service descriptor (if it is already not added)
addWriteService
  Apache_Solr_Service_Balancer::addWriteService() in Balancer.php
  Adds a service instance or service descriptor (if it is already not added)
Apache_Solr_Document
  Apache_Solr_Document in Document.php
  Holds Key / Value pairs that represent a Solr Document along with any associated boost values. Field values can be accessed by direct dereferencing such as:
Apache_Solr_Response
  Apache_Solr_Response in Response.php
  Represents a Solr response. Parses the raw response into a set of stdClass objects and associative arrays for easy access.
Apache_Solr_Service
  Apache_Solr_Service in Service.php
  Starting point for the Solr API. Represents a Solr server resource and has methods for pinging, adding, deleting, committing, optimizing and searching.
Apache_Solr_Service_Balancer
  Apache_Solr_Service_Balancer in Balancer.php
  Reference Implementation for using multiple Solr services in a distribution. Functionality

b
top

Balancer.php
  Balancer.php in Balancer.php

c
top

clear
  Apache_Solr_Document::clear() in Document.php
  Clear all boosts and fields from this document
commit
  Apache_Solr_Service::commit() in Service.php
  Send a commit command. Will be synchronous unless both wait parameters are set to false.
commit
  Apache_Solr_Service_Balancer::commit() in Balancer.php
  Send a commit command. Will be synchronous unless both wait parameters are set to false.

d
top

delete
  Apache_Solr_Service::delete() in Service.php
  Raw Delete Method. Takes a raw post body and sends it to the update service. Body should be a complete and well formed "delete" xml document
delete
  Apache_Solr_Service_Balancer::delete() in Balancer.php
  Raw Delete Method. Takes a raw post body and sends it to the update service. Body should be a complete and well formed "delete" xml document
deleteById
  Apache_Solr_Service::deleteById() in Service.php
  Create a delete document based on document ID
deleteById
  Apache_Solr_Service_Balancer::deleteById() in Balancer.php
  Create a delete document based on document ID
deleteByMultipleIds
  Apache_Solr_Service::deleteByMultipleIds() in Service.php
  Create and post a delete document based on multiple document IDs.
deleteByQuery
  Apache_Solr_Service::deleteByQuery() in Service.php
  Create a delete document based on a query and submit it
deleteByQuery
  Apache_Solr_Service_Balancer::deleteByQuery() in Balancer.php
  Create a delete document based on a query and submit it
Document.php
  Document.php in Document.php

e
top

escape
  Apache_Solr_Service::escape() in Service.php
  Escape a value for special query characters such as ':', '(', ')', '*', '?', etc.
escape
  Apache_Solr_Service_Balancer::escape() in Balancer.php
  Escape a value for special query characters such as ':', '(', ')', '*', '?', etc.
escapePhrase
  Apache_Solr_Service::escapePhrase() in Service.php
  Escape a value meant to be contained in a phrase for special query characters
escapePhrase
  Apache_Solr_Service_Balancer::escapePhrase() in Balancer.php
  Escape a value meant to be contained in a phrase for special query characters

g
top

getBoost
  Apache_Solr_Document::getBoost() in Document.php
  Get current document boost
getCollapseSingleValueArrays
  Apache_Solr_Service::getCollapseSingleValueArrays() in Service.php
  Get the current state of the collapse single value arrays flag.
getCreateDocuments
  Apache_Solr_Service_Balancer::getCreateDocuments() in Balancer.php
getCreateDocuments
  Apache_Solr_Service::getCreateDocuments() in Service.php
  Get the current state of teh create documents flag.
getEncoding
  Apache_Solr_Response::getEncoding() in Response.php
  Get character encoding of this response. Should usually be utf-8, but just in case
getField
  Apache_Solr_Document::getField() in Document.php
  Get field information
getFieldBoost
  Apache_Solr_Document::getFieldBoost() in Document.php
  Get the currently set field boost for a document field
getFieldBoosts
  Apache_Solr_Document::getFieldBoosts() in Document.php
  Return current field boosts, indexed by field name
getFieldNames
  Apache_Solr_Document::getFieldNames() in Document.php
  Get the names of all fields in this document
getFieldValues
  Apache_Solr_Document::getFieldValues() in Document.php
  Get the values of all fields in this document
getHost
  Apache_Solr_Service::getHost() in Service.php
  Returns the set host
getHttpStatus
  Apache_Solr_Response::getHttpStatus() in Response.php
  Get the HTTP status code
getHttpStatusMessage
  Apache_Solr_Response::getHttpStatusMessage() in Response.php
  Get the HTTP status message of the response
getIterator
  Apache_Solr_Document::getIterator() in Document.php
  IteratorAggregate implementation function. Allows usage:
getNamedListTreatment
  Apache_Solr_Service::getNamedListTreatment() in Service.php
  Get the current setting for named list treatment.
getPath
  Apache_Solr_Service::getPath() in Service.php
  Get the set path.
getPort
  Apache_Solr_Service::getPort() in Service.php
  Get the set port
getRawResponse
  Apache_Solr_Response::getRawResponse() in Response.php
  Get the raw response as it was given to this object
getType
  Apache_Solr_Response::getType() in Response.php
  Get content type of this Solr response

m
top

METHOD_GET
  Apache_Solr_Service::METHOD_GET in Service.php
  Search HTTP Methods
METHOD_POST
  Apache_Solr_Service::METHOD_POST in Service.php

n
top

NAMED_LIST_FLAT
  Apache_Solr_Service::NAMED_LIST_FLAT in Service.php
  NamedList Treatment constants
NAMED_LIST_MAP
  Apache_Solr_Service::NAMED_LIST_MAP in Service.php

o
top

optimize
  Apache_Solr_Service::optimize() in Service.php
  Send an optimize command. Will be synchronous unless both wait parameters are set to false.
optimize
  Apache_Solr_Service_Balancer::optimize() in Balancer.php
  Send an optimize command. Will be synchronous unless both wait parameters are set to false.

p
top

phrase
  Apache_Solr_Service_Balancer::phrase() in Balancer.php
  Convenience function for creating phrase syntax from a value
phrase
  Apache_Solr_Service::phrase() in Service.php
  Convenience function for creating phrase syntax from a value
ping
  Apache_Solr_Service::ping() in Service.php
  Call the /admin/ping servlet, can be used to quickly tell if a connection to the server is able to be made.
PING_SERVLET
  Apache_Solr_Service::PING_SERVLET in Service.php
  Servlet mappings

r
top

removeReadService
  Apache_Solr_Service_Balancer::removeReadService() in Balancer.php
  Removes a service instance or descriptor from the available services
removeWriteService
  Apache_Solr_Service_Balancer::removeWriteService() in Balancer.php
  Removes a service instance or descriptor from the available services
Response.php
  Response.php in Response.php

s
top

search
  Apache_Solr_Service::search() in Service.php
  Simple Search interface
search
  Apache_Solr_Service_Balancer::search() in Balancer.php
  Simple Search interface
SEARCH_SERVLET
  Apache_Solr_Service::SEARCH_SERVLET in Service.php
Service.php
  Service.php in Service.php
setBoost
  Apache_Solr_Document::setBoost() in Document.php
  Set document boost factor
setCollapseSingleValueArrays
  Apache_Solr_Service::setCollapseSingleValueArrays() in Service.php
  Set the collapse single value arrays flag.
setCreateDocuments
  Apache_Solr_Service_Balancer::setCreateDocuments() in Balancer.php
setCreateDocuments
  Apache_Solr_Service::setCreateDocuments() in Service.php
  Set the create documents flag. This determines whether Apache_Solr_Response objects will parse the response and create Apache_Solr_Document instances in place.
setField
  Apache_Solr_Document::setField() in Document.php
  Set a field value. Multi-valued fields should be set as arrays or instead use the addField(...) function which will automatically make sure the field is an array.
setFieldBoost
  Apache_Solr_Document::setFieldBoost() in Document.php
  Set the field boost for a document field
setHost
  Apache_Solr_Service::setHost() in Service.php
  Set the host used. If empty will fallback to constants
setMultiValue
  Apache_Solr_Document::setMultiValue() in Document.php
  Handle the array manipulation for a multi-valued field
setNamedListTreatmet
  Apache_Solr_Service::setNamedListTreatmet() in Service.php
  Set how NamedLists should be formatted in the response data. This mainly effects the facet counts format.
setPath
  Apache_Solr_Service::setPath() in Service.php
  Set the path used. If empty will fallback to constants
setPort
  Apache_Solr_Service::setPort() in Service.php
  Set the port used. If empty will fallback to constants
setQueryDelimiter
  Apache_Solr_Service::setQueryDelimiter() in Service.php
  Set the string used to separate the path form the query string.
setQueryStringDelimiter
  Apache_Solr_Service::setQueryStringDelimiter() in Service.php
  Set the string used to separate the parameters in thequery string Defaulted to '&'
setReadPingTimeout
  Apache_Solr_Service_Balancer::setReadPingTimeout() in Balancer.php
setUseBackoff
  Apache_Solr_Service_Balancer::setUseBackoff() in Balancer.php
setWritePingTimeout
  Apache_Solr_Service_Balancer::setWritePingTimeout() in Balancer.php
SOLR_VERSION
  Apache_Solr_Service::SOLR_VERSION in Service.php
  Response version we support
SOLR_WRITER
  Apache_Solr_Service::SOLR_WRITER in Service.php
  Response writer we'll request - JSON. See http://code.google.com/p/solr-php-client/issues/detail?id=6#c1 for reasoning
SVN_ID
  Apache_Solr_Response::SVN_ID in Response.php
  SVN ID meta data for this class
SVN_ID
  Apache_Solr_Service_Balancer::SVN_ID in Balancer.php
  SVN ID meta data for this class
SVN_ID
  Apache_Solr_Document::SVN_ID in Document.php
  SVN ID meta data for this class
SVN_ID
  Apache_Solr_Service::SVN_ID in Service.php
  SVN ID meta data for this class
SVN_REVISION
  Apache_Solr_Service::SVN_REVISION in Service.php
  SVN Revision meta data for this class
SVN_REVISION
  Apache_Solr_Response::SVN_REVISION in Response.php
  SVN Revision meta data for this class
SVN_REVISION
  Apache_Solr_Service_Balancer::SVN_REVISION in Balancer.php
  SVN Revision meta data for this class
SVN_REVISION
  Apache_Solr_Document::SVN_REVISION in Document.php
  SVN Revision meta data for this class

t
top

threads
  Apache_Solr_Service::threads() in Service.php
  Call the /admin/threads servlet and retrieve information about all threads in the Solr servlet's thread group. Useful for diagnostics.
THREADS_SERVLET
  Apache_Solr_Service::THREADS_SERVLET in Service.php

u
top

UPDATE_SERVLET
  Apache_Solr_Service::UPDATE_SERVLET in Service.php

_
top

$_backoffEscalation
  Apache_Solr_Service_Balancer::$_backoffEscalation in Balancer.php
$_backoffLimit
  Apache_Solr_Service_Balancer::$_backoffLimit in Balancer.php
$_collapseSingleValueArrays
  Apache_Solr_Service::$_collapseSingleValueArrays in Service.php
  Whether Apache_Solr_Response objects should have multivalue fields with only a single value collapsed to appear as a single value would.
$_collapseSingleValueArrays
  Apache_Solr_Response::$_collapseSingleValueArrays in Response.php
$_createDocuments
  Apache_Solr_Response::$_createDocuments in Response.php
  Data parsing flags. Determines what extra processing should be done after the data is initially converted to a data structure.
$_createDocuments
  Apache_Solr_Service::$_createDocuments in Service.php
  Whether Apache_Solr_Response objects should create Apache_Solr_Documents in the returned parsed data
$_createDocuments
  Apache_Solr_Service_Balancer::$_createDocuments in Balancer.php
$_currentReadService
  Apache_Solr_Service_Balancer::$_currentReadService in Balancer.php
$_currentWriteService
  Apache_Solr_Service_Balancer::$_currentWriteService in Balancer.php
$_defaultBackoff
  Apache_Solr_Service_Balancer::$_defaultBackoff in Balancer.php
$_defaultTimeout
  Apache_Solr_Service::$_defaultTimeout in Service.php
  Default HTTP timeout when one is not specified (initialized to default_socket_timeout ini setting)
$_documentBoost
  Apache_Solr_Document::$_documentBoost in Document.php
  Document boost value
$_encoding
  Apache_Solr_Response::$_encoding in Response.php
$_fieldBoosts
  Apache_Solr_Document::$_fieldBoosts in Document.php
  Document field boost values, indexed by name
$_fields
  Apache_Solr_Document::$_fields in Document.php
  Document field values, indexed by name
$_getContext
  Apache_Solr_Service::$_getContext in Service.php
  Reusable stream context resources for GET and POST operations
$_host
  Apache_Solr_Service::$_host in Service.php
  Server identification strings
$_httpStatus
  Apache_Solr_Response::$_httpStatus in Response.php
  Parsed values from the passed in http headers
$_httpStatusMessage
  Apache_Solr_Response::$_httpStatusMessage in Response.php
$_isParsed
  Apache_Solr_Response::$_isParsed in Response.php
  Whether the raw response has been parsed
$_namedListTreatment
  Apache_Solr_Service::$_namedListTreatment in Service.php
  How NamedLists should be formatted in the output. This specifically effects facet counts. Valid values are Apache_Solr_Service::NAMED_LIST_MAP (default) or Apache_Solr_Service::NAMED_LIST_FLAT.
$_parsedData
  Apache_Solr_Response::$_parsedData in Response.php
  Parsed representation of the data
$_path
  Apache_Solr_Service::$_path in Service.php
$_pingUrl
  Apache_Solr_Service::$_pingUrl in Service.php
  Constructed servlet full path URLs
$_port
  Apache_Solr_Service::$_port in Service.php
$_postContext
  Apache_Solr_Service::$_postContext in Service.php
$_queryDelimiter
  Apache_Solr_Service::$_queryDelimiter in Service.php
  Query delimiters. Someone might want to be able to change these (to use &amp; instead of & for example), so I've provided them.
$_queryStringDelimiter
  Apache_Solr_Service::$_queryStringDelimiter in Service.php
$_rawResponse
  Apache_Solr_Response::$_rawResponse in Response.php
  Holds the raw response used in construction
$_readableServices
  Apache_Solr_Service_Balancer::$_readableServices in Balancer.php
$_readPingTimeout
  Apache_Solr_Service_Balancer::$_readPingTimeout in Balancer.php
$_searchUrl
  Apache_Solr_Service::$_searchUrl in Service.php
$_threadsUrl
  Apache_Solr_Service::$_threadsUrl in Service.php
$_type
  Apache_Solr_Response::$_type in Response.php
$_updateUrl
  Apache_Solr_Service::$_updateUrl in Service.php
$_urlsInited
  Apache_Solr_Service::$_urlsInited in Service.php
  Keep track of whether our URLs have been constructed
$_useBackoff
  Apache_Solr_Service_Balancer::$_useBackoff in Balancer.php
$_writeableServices
  Apache_Solr_Service_Balancer::$_writeableServices in Balancer.php
$_writePingTimeout
  Apache_Solr_Service_Balancer::$_writePingTimeout in Balancer.php
_constructUrl
  Apache_Solr_Service::_constructUrl() in Service.php
  Return a valid http URL given this server's host, port and path and a provided servlet name
_documentToXmlFragment
  Apache_Solr_Service::_documentToXmlFragment() in Service.php
  Create an XML fragment from a Apache_Solr_Document instance appropriate for use inside a Solr add call
_getServiceId
  Apache_Solr_Service_Balancer::_getServiceId() in Balancer.php
  Generates a service ID
_initUrls
  Apache_Solr_Service::_initUrls() in Service.php
  Construct the Full URLs for the three servlets we reference
_parseData
  Apache_Solr_Response::_parseData() in Response.php
  Parse the raw response into the parsed_data array for access
_selectReadService
  Apache_Solr_Service_Balancer::_selectReadService() in Balancer.php
  Iterate through available read services and select the first with a ping that satisfies configured timeout restrictions (or the default)
_selectWriteService
  Apache_Solr_Service_Balancer::_selectWriteService() in Balancer.php
  Iterate through available write services and select the first with a ping that satisfies configured timeout restrictions (or the default)
_selectWriteServiceSafe
  Apache_Solr_Service_Balancer::_selectWriteServiceSafe() in Balancer.php
  Iterate through available write services and select the first with a ping
_sendRawGet
  Apache_Solr_Service::_sendRawGet() in Service.php
  Central method for making a get operation against this Solr Server
_sendRawPost
  Apache_Solr_Service::_sendRawPost() in Service.php
  Central method for making a post operation against this Solr Server
_stripCtrlChars
  Apache_Solr_Service::_stripCtrlChars() in Service.php
  Replace control (non-printable) characters from string that are invalid to Solr's XML parser with a space.
__construct
  Apache_Solr_Response::__construct() in Response.php
  Constructor. Takes the raw HTTP response body and the exploded HTTP headers
__construct
  Apache_Solr_Service_Balancer::__construct() in Balancer.php
  Constructor. Takes arrays of read and write service instances or descriptions
__construct
  Apache_Solr_Service::__construct() in Service.php
  Constructor. All parameters are optional and will take on default values if not specified.
__get
  Apache_Solr_Document::__get() in Document.php
  Magic get for field values
__get
  Apache_Solr_Response::__get() in Response.php
  Magic get to expose the parsed data and to lazily load it
__isset
  Apache_Solr_Document::__isset() in Document.php
  Magic isset for fields values. Do not call directly. Allows usage:
__set
  Apache_Solr_Document::__set() in Document.php
  Magic set for field values. Multi-valued fields should be set as arrays or instead use the addField(...) function which will automatically make sure the field is an array.
__unset
  Apache_Solr_Document::__unset() in Document.php
  Magic unset for field values. Do not call directly. Allows usage: