Class Apache_Solr_Service
+ + +Starting point for the Solr API. Represents a Solr server resource and has methods for pinging, adding, deleting, committing, optimizing and searching.
+Example Usage:
- ...
+
- $solr = new Apache_Solr_Service(); //or explicitly new Apache_Solr_Service('localhost', 8180, '/solr')
+
- +
- {
+
- +
- +
- +
- $document->title = 'Some Title';
+
- $document->content = 'Some content for this wonderful document. Blah blah blah.';
+
- +
- //with an array of documents is faster
+
- +
- +
- //and the one we all care about, search!
+
- //any other common or custom parameters to the request handler can go in the
+
- //optional 4th array argument.
+
- +
- }
+
- ...
+
+ Located in /Service.php (line 62) +
+ + + + +
+ Whether Apache_Solr_Response objects should have multivalue fields with only a single value collapsed to appear as a single value would.
+ + + + + + +Whether Apache_Solr_Response objects should create Apache_Solr_Documents in the returned parsed data
+ + + + + + +Server identification strings
+ + + + + + +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.
+ + + + + + +Stream context for posting
+ + + + + + +Query delimiters. Someone might want to be able to change these (to use & instead of & for example), so I've provided them.
+ + + + + + +Constructed servlet full path URLs
+ + + + + + +Keep track of whether our URLs have been constructed
+ + + + + + +Escape a value for special query characters such as ':', '(', ')', '*', '?', etc.
+NOTE: inside a phrase fewer characters need escaped, use Apache_Solr_Service::escapePhrase() instead
+ + +-
+
- + string + $value +
Escape a value meant to be contained in a phrase for special query characters
+ + +-
+
- + string + $value +
Convenience function for creating phrase syntax from a value
+ + +-
+
- + string + $value +
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.
+ + + + +-
+
- + string + $rawPost +
Add a Solr Document to the index
+ + +-
+
- + Apache_Solr_Document + $document +
- + boolean + $allowDups +
- + boolean + $overwritePending +
- + boolean + $overwriteCommitted +
Add an array of Solr Documents to the index all at once
+ + +-
+
- + array + $documents: Should be an array of Apache_Solr_Document instances +
- + boolean + $allowDups +
- + boolean + $overwritePending +
- + boolean + $overwriteCommitted +
Send a commit command. Will be synchronous unless both wait parameters are set to false.
+ + +-
+
- + boolean + $optimize: Defaults to true +
- + boolean + $waitFlush: Defaults to true +
- + boolean + $waitSearcher: Defaults to true +
- + float + $timeout: Maximum expected duration (in seconds) of the commit operation on the server (otherwise, will throw a communication exception). Defaults to 1 hour +
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
+ + + + +-
+
- + string + $rawPost: Expected to be utf-8 encoded xml document +
Create a delete document based on document ID
+ + +-
+
- + string + $id: Expected to be utf-8 encoded +
- + boolean + $fromPending +
- + boolean + $fromCommitted +
Create a delete document based on a query and submit it
+ + +-
+
- + string + $rawQuery: Expected to be utf-8 encoded +
- + boolean + $fromPending +
- + boolean + $fromCommitted +
Get the current state of the collapse single value arrays flag.
+ + +Get the current state of teh create documents flag.
+ + +Get the current setting for named list treatment.
+ + +Constructor. All parameters are optional and will take on default values if not specified.
+ + +-
+
- + string + $host +
- + string + $port +
- + string + $path +
Send an optimize command. Will be synchronous unless both wait parameters are set to false.
+ + +-
+
- + boolean + $waitFlush +
- + boolean + $waitSearcher +
- + float + $timeout: Maximum expected duration of the commit operation on the server (otherwise, will throw a communication exception) +
Call the /admin/ping servlet, can be used to quickly tell if a connection to the server is able to be made.
+ + +-
+
- + float + $timeout: maximum time to wait for ping in seconds, -1 for unlimited (default is 2) +
Simple Search interface
+ + +-
+
- + string + $query: The raw query string +
- + int + $offset: The starting offset for result documents +
- + int + $limit: The maximum number of result documents to return +
- + array + $params: key / value pairs for other query parameters (see Solr documentation), use arrays for parameter keys used more than once (e.g. facet.field) +
Set the collapse single value arrays flag.
+ + +-
+
- + boolean + $collapseSingleValueArrays +
Set the create documents flag. This determines whether Apache_Solr_Response objects will parse the response and create Apache_Solr_Document instances in place.
+ + +-
+
- + unknown_type + $createDocuments +
Set the host used. If empty will fallback to constants
+ + +-
+
- + string + $host +
Set how NamedLists should be formatted in the response data. This mainly effects the facet counts format.
+ + +-
+
- + string + $namedListTreatment +
Set the path used. If empty will fallback to constants
+ + +-
+
- + string + $path +
Set the port used. If empty will fallback to constants
+ + +-
+
- + integer + $port +
Set the string used to separate the path form the query string.
+Defaulted to '?'
+ + +-
+
- + string + $queryDelimiter +
Set the string used to separate the parameters in thequery string Defaulted to '&'
+ + +-
+
- + string + $queryStringDelimiter +
Call the /admin/threads servlet and retrieve information about all threads in the Solr servlet's thread group. Useful for diagnostics.
+ + +Return a valid http URL given this server's host, port and path and a provided servlet name
+ + +-
+
- + string + $servlet +
- + + $params +
Create an XML fragment from a Apache_Solr_Document instance appropriate for use inside a Solr add call
+ + + + +-
+
- + Apache_Solr_Document + $document +
Construct the Full URLs for the three servlets we reference
+ + +Central method for making a get operation against this Solr Server
+ + + + +-
+
- + string + $url +
- + float + $timeout: Read timeout in seconds +
Central method for making a post operation against this Solr Server
+ + +-
+
- + string + $url +
- + string + $rawPost +
- + float + $timeout: Read timeout in seconds +
- + string + $contentType +
+
+ NAMED_LIST_FLAT
+ = 'flat'
+ (line 79)
+
+ NamedList Treatment constants
+ + +
+
+ NAMED_LIST_MAP
+ = 'map'
+ (line 80)
+
+
+
+ PING_SERVLET
+ = 'admin/ping'
+ (line 85)
+
+ Servlet mappings
+ + +
+
+ SEARCH_SERVLET
+ = 'select'
+ (line 87)
+
+
+
+ SOLR_VERSION
+ = '1.2'
+ (line 67)
+
+ Response version we support
+ + +
+
+ SOLR_WRITER
+ = 'json'
+ (line 74)
+
+ Response writer we support
+ + + +
+
+ THREADS_SERVLET
+ = 'admin/threads'
+ (line 88)
+
+
+
+ UPDATE_SERVLET
+ = 'update'
+ (line 86)
+
+ + Documentation generated on Tue, 02 Sep 2008 10:45:05 -0400 by phpDocumentor 1.4.0 +
+