[Apache] element index

All elements
a b c d e g n o p r s t u _
_
top
$_backoffEscalation
$_backoffLimit
$_collapseSingleValueArrays
$_collapseSingleValueArrays
Whether Apache_Solr_Response objects should have multivalue fields with only a single value collapsed to appear as a single value would.
$_createDocuments
Data parsing flags. Determines what extra processing should be done after the data is initially converted to a data structure.
$_createDocuments
Whether Apache_Solr_Response objects should create Apache_Solr_Documents in the returned parsed data
$_createDocuments
$_currentReadService
$_currentWriteService
$_defaultBackoff
$_documentBoost
Document boost value
$_encoding
$_fieldBoosts
Document field boost values, indexed by name
$_fields
Document field values, indexed by name
$_host
Server identification strings
$_httpStatus
Parsed values from the passed in http headers
$_httpStatusMessage
$_isParsed
Whether the raw response has been parsed
$_namedListTreatment
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
Parsed representation of the data
$_path
$_port
$_postContext
Stream context for posting
$_queryDelimiter
Query delimiters. Someone might want to be able to change these (to use & instead of & for example), so I've provided them.
$_queryStringDelimiter
$_rawResponse
Holds the raw response used in construction
$_readableServices
$_readPingTimeout
$_searchUrl
$_threadsUrl
$_type
$_updateUrl
Constructed servlet full path URLs
$_urlsInited
Keep track of whether our URLs have been constructed
$_useBackoff
$_writeableServices
$_writePingTimeout
_constructUrl
Return a valid http URL given this server's host, port and path and a provided servlet name
_documentToXmlFragment
Create an XML fragment from a Apache_Solr_Document instance appropriate for use inside a Solr add call
_getServiceId
Generates a service ID
_initUrls
Construct the Full URLs for the three servlets we reference
_parseData
Parse the raw response into the parsed_data array for access
_selectReadService
Iterate through available read services and select the first with a ping that satisfies configured timeout restrictions (or the default)
_selectWriteService
Iterate through available write services and select the first with a ping that satisfies configured timeout restrictions (or the default)
_selectWriteServiceSafe
Iterate through available write services and select the first with a ping
_sendRawGet
Central method for making a get operation against this Solr Server
_sendRawPost
Central method for making a post operation against this Solr Server
__construct
Constructor. All parameters are optional and will take on default values if not specified.
__construct
Constructor. Takes the raw HTTP response body and the exploded HTTP headers
__construct
Constructor. Takes arrays of read and write service instances or descriptions
__get
Magic get to expose the parsed data and to lazily load it
__get
Magic get for field values
__isset
Magic isset for fields values. Do not call directly. Allows usage:
__set
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
Magic unset for field values. Do not call directly. Allows usage:
a
top
add
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
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
Add a Solr Document to the index
addDocument
Add a Solr Document to the index
addDocuments
Add an array of Solr Documents to the index all at once
addDocuments
Add an array of Solr Documents to the index all at once
addField
Add a value to a multi-valued field
addReadService
Adds a service instance or service descriptor (if it is already not added)
addWriteService
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
Reference Implementation for using multiple Solr services in a distribution. Functionality
b
top
Balancer.php
Balancer.php in Balancer.php
c
top
clear
Clear all boosts and fields from this document
commit
Send a commit command. Will be synchronous unless both wait parameters are set to false.
commit
Send a commit command. Will be synchronous unless both wait parameters are set to false.
d
top
delete
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
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
Create a delete document based on document ID
deleteById
Create a delete document based on document ID
deleteByQuery
Create a delete document based on a query and submit it
deleteByQuery
Create a delete document based on a query and submit it
Document.php
Document.php in Document.php
e
top
escape
Escape a value for special query characters such as ':', '(', ')', '*', '?', etc.
escape
Escape a value for special query characters such as ':', '(', ')', '*', '?', etc.
escapePhrase
Escape a value meant to be contained in a phrase for special query characters
escapePhrase
Escape a value meant to be contained in a phrase for special query characters
g
top
getBoost
Get current document boost
getCollapseSingleValueArrays
Get the current state of the collapse single value arrays flag.
getCreateDocuments
getCreateDocuments
Get the current state of teh create documents flag.
getEncoding
Get character encoding of this response. Should usually be utf-8, but just in case
getField
Get field information
getFieldBoost
Get the currently set field boost for a document field
getFieldBoosts
Return current field boosts, indexed by field name
getFieldNames
Get the names of all fields in this document
getFieldValues
Get the values of all fields in this document
getHost
Returns the set host
getHttpStatus
Get the HTTP status code
getHttpStatusMessage
Get the HTTP status message of the response
getIterator
IteratorAggregate implementation function. Allows usage:
getNamedListTreatment
Get the current setting for named list treatment.
getPath
Get the set path.
getPort
Get the set port
getRawResponse
Get the raw response as it was given to this object
getType
Get content type of this Solr response
n
top
NAMED_LIST_FLAT
NamedList Treatment constants
NAMED_LIST_MAP
o
top
optimize
Send an optimize command. Will be synchronous unless both wait parameters are set to false.
optimize
Send an optimize command. Will be synchronous unless both wait parameters are set to false.
p
top
phrase
Convenience function for creating phrase syntax from a value
phrase
Convenience function for creating phrase syntax from a value
ping
Call the /admin/ping servlet, can be used to quickly tell if a connection to the server is able to be made.
PING_SERVLET
Servlet mappings
r
top
removeReadService
Removes a service instance or descriptor from the available services
removeWriteService
Removes a service instance or descriptor from the available services
Response.php
Response.php in Response.php
s
top
search
Simple Search interface
search
Simple Search interface
SEARCH_SERVLET
Service.php
Service.php in Service.php
setBoost
Set document boost factor
setCollapseSingleValueArrays
Set the collapse single value arrays flag.
setCreateDocuments
setCreateDocuments
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
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
Set the field boost for a document field
setHost
Set the host used. If empty will fallback to constants
setMultiValue
Handle the array manipulation for a multi-valued field
setNamedListTreatmet
Set how NamedLists should be formatted in the response data. This mainly effects the facet counts format.
setPath
Set the path used. If empty will fallback to constants
setPort
Set the port used. If empty will fallback to constants
setQueryDelimiter
Set the string used to separate the path form the query string.
setQueryStringDelimiter
Set the string used to separate the parameters in thequery string Defaulted to '&'
setReadPingTimeout
setUseBackoff
setWritePingTimeout
SOLR_VERSION
Response version we support
SOLR_WRITER
Response writer we support
t
top
threads
Call the /admin/threads servlet and retrieve information about all threads in the Solr servlet's thread group. Useful for diagnostics.
THREADS_SERVLET
u
top
UPDATE_SERVLET
a b c d e g n o p r s t u _