diff --git a/reference/solr/.cvsignore b/reference/solr/.cvsignore new file mode 100755 index 0000000000..c436382dcf --- /dev/null +++ b/reference/solr/.cvsignore @@ -0,0 +1 @@ +entities.*.xml \ No newline at end of file diff --git a/reference/solr/book.xml b/reference/solr/book.xml new file mode 100755 index 0000000000..d556654c1a --- /dev/null +++ b/reference/solr/book.xml @@ -0,0 +1,73 @@ + + + + + Apache Solr + Solr + + + &reftitle.intro; + + The Solr extension allows your to communicate effectively with the Apache Solr server in PHP 5. + + + The Solr extension is an extremely fast, light-weight, feature-rich library that allows PHP developers to communicate effectively with Solr server instances. + It is compatible with both versions 1.3 and 1.4 of Apache Solr. + There are built-in tools to add documents and make updates to the solr server. + It also contains tools that allows you to build advanced queries to the server when searching for documents. + + + &reference.solr.setup; + &reference.solr.constants; + &reference.solr.reference; + + &reference.solr.examples; + + &reference.solr.solrutils; + + &reference.solr.solrinputdocument; + &reference.solr.solrdocument; + &reference.solr.solrdocumentfield; + + &reference.solr.solrobject; + + &reference.solr.solrclient; + + &reference.solr.solrresponse; + &reference.solr.solrqueryresponse; + &reference.solr.solrupdateresponse; + &reference.solr.solrpingresponse; + &reference.solr.solrgenericresponse; + + &reference.solr.solrparams; + &reference.solr.solrmodifiableparams; + &reference.solr.solrquery; + + &reference.solr.solrexception; + &reference.solr.solrclientexception; + &reference.solr.solrillegalargumentexception; + &reference.solr.solrillegaloperationexception; + + + + + diff --git a/reference/solr/constants.xml b/reference/solr/constants.xml new file mode 100755 index 0000000000..22440ddda9 --- /dev/null +++ b/reference/solr/constants.xml @@ -0,0 +1,73 @@ + + + + + &reftitle.constants; + &extension.constants; + + + + + SOLR_MAJOR_VERSION + (integer) + + + + + + + + + SOLR_MINOR_VERSION + (integer) + + + + + + + + + SOLR_PATCH_VERSION + (integer) + + + + + + + + + SOLR_EXTENSION_VERSION + (string) + + + + + + + + + + + + diff --git a/reference/solr/examples.xml b/reference/solr/examples.xml new file mode 100755 index 0000000000..c6c8d1725f --- /dev/null +++ b/reference/solr/examples.xml @@ -0,0 +1,379 @@ + + + + + &reftitle.examples; + + Examples of how to use the Apache Solr extension in PHP + + + Adding a document to the index + + 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); + +print_r($updateResponse->getResponse()); + +?> + +]]> + + &example.outputs.similar; + + SolrObject Object + ( + [status] => 0 + [QTime] => 446 + ) + +) +]]> + + + + + Merging one document into another document + + addField('id', 1123); + +$doc->features = "PHP Client Side"; +$doc->features = "Fast development cycles"; + +$doc['cat'] = 'Software'; +$doc['cat'] = 'Custom Search'; +$doc->cat = 'Information Technology'; + +$second_doc->addField('cat', 'Lucene Search'); + +$second_doc->merge($doc, true); + +print_r($second_doc->toArray()); + + +?> + +]]> + + &example.outputs.similar; + + 0 + [field_count] => 3 + [fields] => Array + ( + [0] => SolrDocumentField Object + ( + [name] => cat + [boost] => 0 + [values] => Array + ( + [0] => Software + [1] => Custom Search + [2] => Information Technology + ) + + ) + + [1] => SolrDocumentField Object + ( + [name] => id + [boost] => 0 + [values] => Array + ( + [0] => 1123 + ) + + ) + + [2] => SolrDocumentField Object + ( + [name] => features + [boost] => 0 + [values] => Array + ( + [0] => PHP Client Side + [1] => Fast development cycles + ) + + ) + + ) + +) +]]> + + + + + + Searching for documents - SolrObject responses + + SOLR_SERVER_HOSTNAME, + 'login' => SOLR_SERVER_USERNAME, + 'password' => SOLR_SERVER_PASSWORD, + 'port' => SOLR_SERVER_PORT, +); + +$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); + +?> + +]]> + + &example.outputs.similar; + + SolrObject Object + ( + [status] => 0 + [QTime] => 1 + [params] => SolrObject Object + ( + [wt] => xml + [rows] => 50 + [start] => 0 + [indent] => on + [q] => lucene + [fl] => cat,features,id,timestamp + [version] => 2.2 + ) + + ) + + [response] => SolrObject Object + ( + [numFound] => 3 + [start] => 0 + [docs] => Array + ( + [0] => SolrObject Object + ( + [cat] => Array + ( + [0] => Software + [1] => Lucene + ) + + [id] => 334456 + ) + + [1] => SolrObject Object + ( + [cat] => Array + ( + [0] => Software + [1] => Lucene + ) + + [id] => 334455 + ) + + [2] => SolrObject Object + ( + [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) + ) + + [id] => SOLR1000 + [timestamp] => 2009-09-04T20:38:55.906 + ) + + ) + + ) + +) +]]> + + + + + Searching for documents - SolrDocument responses + + SOLR_SERVER_HOSTNAME, + 'login' => SOLR_SERVER_USERNAME, + 'password' => SOLR_SERVER_PASSWORD, + 'port' => SOLR_SERVER_PORT, +); + +$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); + +$query_response->setParseMode(SolrQueryResponse::PARSE_SOLR_DOC); + +$response = $query_response->getResponse(); + +print_r($response); + +?> + +]]> + + &example.outputs.similar; + + SolrObject Object + ( + [status] => 0 + [QTime] => 1 + [params] => SolrObject Object + ( + [wt] => xml + [rows] => 50 + [start] => 0 + [indent] => on + [q] => lucene + [fl] => cat,features,id,timestamp + [version] => 2.2 + ) + + ) + + [response] => SolrObject Object + ( + [numFound] => 3 + [start] => 0 + [docs] => Array + ( + [0] => SolrDocument Object + ( + [_hashtable_index:SolrDocument:private] => 19740 + ) + + [1] => SolrDocument Object + ( + [_hashtable_index:SolrDocument:private] => 25485 + ) + + [2] => SolrDocument Object + ( + [_hashtable_index:SolrDocument:private] => 25052 + ) + + ) + + ) + +) +]]> + + + + + + diff --git a/reference/solr/functions/solr-get-version.xml b/reference/solr/functions/solr-get-version.xml new file mode 100755 index 0000000000..377797ecb7 --- /dev/null +++ b/reference/solr/functions/solr-get-version.xml @@ -0,0 +1,104 @@ + + + + + + solr_get_version + Returns the current version of the Apache Solr extension + + + + &reftitle.description; + + stringsolr_get_version + + + + This function returns the current version of the extension as a string. + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + It returns a string on success and &false; on failure. + + + + + &reftitle.errors; + + This function throws no errors or exceptions. + + + + + &reftitle.examples; + + + <function>solr_get_version</function> example + + Any text that describes the purpose of the example, or what + goes on in the example should be here. + + + +]]> + + &example.outputs.similar; + + + + + + + + + &reftitle.seealso; + + + SolrUtils::getSolrVersion() + + + + + + + diff --git a/reference/solr/reference.xml b/reference/solr/reference.xml new file mode 100755 index 0000000000..b6de6e1f51 --- /dev/null +++ b/reference/solr/reference.xml @@ -0,0 +1,31 @@ + + + + + Solr &Functions; + + &reference.solr.entities.functions; + + + + + diff --git a/reference/solr/setup.xml b/reference/solr/setup.xml new file mode 100755 index 0000000000..8f3b473b2a --- /dev/null +++ b/reference/solr/setup.xml @@ -0,0 +1,188 @@ + + + + + &reftitle.setup; + +
+ &reftitle.required; + + PHP version 5.2.11 or later is required. + The libxml and curl extensions must also be enabled for the Apache Solr extension to be available. +
+ + +
+ &reftitle.install; + In order to build or compile the extension from source, the following libraries are needed : + libxml2 2.6.31 or later is required. + libcurl 7.18.0 or later is also required. + As mention before, the libxml and curl extensions must be enabled for the Apache Solr extension to be functional. + To compile from source on UNIX, you will need to follow the steps below : + + Installation of Apache Solr on UNIX + + + + + + To install the Apache Solr extension on WINDOWS, you will need to follow the steps below : + + Installation of Apache Solr on WINDOWS + + + + + +
+ + + + +
+ &reftitle.runtime; + &no.config; +
+ + + +
+ &reftitle.resources; + &no.resource; + +
+ + + + + diff --git a/reference/solr/solrclient.xml b/reference/solr/solrclient.xml new file mode 100755 index 0000000000..829a6bd51b --- /dev/null +++ b/reference/solr/solrclient.xml @@ -0,0 +1,235 @@ + + + + + + The SolrClient class + SolrClient + + + + +
+ &reftitle.intro; + + Used to send requests to a Solr server. + +
+ + +
+ &reftitle.classsynopsis; + + + + SolrClient + + + + + final + 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 + + + Properties + + private + integer + _hashtable_index + + + Methods + + + + +
+ + + +
+ &reftitle.properties; + + + _hashtable_index + + Used to track each SolrClient instance internally. + + + +
+ + + + +
+ &reftitle.constants; +
+ SolrClient Node Types + + + + 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 + + + + +
+
+ + + + + + &reference.solr.entities.solrclient; + + + + diff --git a/reference/solr/solrclient/adddocument.xml b/reference/solr/solrclient/adddocument.xml new file mode 100755 index 0000000000..1a169ffbb3 --- /dev/null +++ b/reference/solr/solrclient/adddocument.xml @@ -0,0 +1,147 @@ + + + + + + SolrClient::addDocument + Adds a document to the index. + + + + &reftitle.description; + + public SolrUpdateResponseSolrClient::addDocument + SolrInputDocumentdoc + boolallowDups + intcommitWithin + + + This method adds a document to the index. + + + + + + &reftitle.parameters; + + + + doc + + + The SolrInputDocument instance. + + + + + allowDups + + + If &false; duplicates will be overwritten. Default value is &false; + + + + + commitWithin + + + Number of milliseconds within which to commit this document. Available since Solr 1.4 + + + + + + + + + &reftitle.returnvalues; + + Returns a SolrUpdateResponse object or throws a SolrClientException on failure. + + + + + &reftitle.examples; + + + <methodname>SolrClient::addDocument</methodname> example + + 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); + +print_r($updateResponse->getResponse()); + +?> + +]]> + + &example.outputs.similar; + + SolrObject Object + ( + [status] => 0 + [QTime] => 1 + ) + +) + +]]> + + + + + + + &reftitle.seealso; + + + SolrClient::addDocuments + + + + + + + diff --git a/reference/solr/solrclient/adddocuments.xml b/reference/solr/solrclient/adddocuments.xml new file mode 100755 index 0000000000..3d6a392889 --- /dev/null +++ b/reference/solr/solrclient/adddocuments.xml @@ -0,0 +1,151 @@ + + + + + + SolrClient::addDocuments + Adds a collection of SolrInputDocument instances to the index. + + + + &reftitle.description; + + public voidSolrClient::addDocuments + arraydocs + boolallowDups + intcommitWithin + + + Adds a collection of documents to the index. + + + + + + &reftitle.parameters; + + + + docs + + + An array containing the collection of SolrInputDocument instances. This array must be an actual variable. + + + + + allowDups + + + If &false; duplicates will be overwritten. Default value is &false; + + + + + commitWithin + + + Number of milliseconds within which to commit the documents to the index. This was only available since Solr 1.4 + + + + + + + + + &reftitle.returnvalues; + + Returns a SolrUpdateResponse object on success and throws a SolrClientException on failure. + + + + + &reftitle.examples; + + + <methodname>SolrClient::addDocuments</methodname> example + + 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); + +print_r($updateResponse->getResponse()); + +?> +]]> + + &example.outputs.similar; + + SolrObject Object + ( + [status] => 0 + [QTime] => 2 + ) + +) + +]]> + + + + + + + &reftitle.seealso; + + + SolrClient::addDocument + + + + + + + diff --git a/reference/solr/solrclient/commit.xml b/reference/solr/solrclient/commit.xml new file mode 100755 index 0000000000..095056a2f3 --- /dev/null +++ b/reference/solr/solrclient/commit.xml @@ -0,0 +1,94 @@ + + + + + + SolrClient::commit + Finalizes all add/deletes made to the index. + + + + &reftitle.description; + + public SolrUpdateResponseSolrClient::commit + intmaxSegments + boolwaitFlush + boolwaitSearcher + + + This method finalizes all add/deletes made to the index. + + + + + + &reftitle.parameters; + + + + maxSegments + + + Optimizes down to at most this number of segments. Since Solr 1.3 + + + + + waitFlush + + + Block until index changes are flushed to disk. + + + + + waitSearcher + + + Block until a new searcher is opened and registered as the main query searcher, making the changes visible. + + + + + + + + + &reftitle.returnvalues; + + Returns a SolrUpdateResponse object on success or throws a SolrClientException on failure. + + + + + &reftitle.seealso; + + + SolrClient::optimize + SolrClient::rollback + + + + + + + diff --git a/reference/solr/solrclient/construct.xml b/reference/solr/solrclient/construct.xml new file mode 100755 index 0000000000..74e7233284 --- /dev/null +++ b/reference/solr/solrclient/construct.xml @@ -0,0 +1,116 @@ + + + + + + SolrClient::__construct + Constructor for the SolrClient object + + + + &reftitle.description; + + publicSolrClient::__construct + arrayclientOptions + + + Constructor for the SolrClient object + + + + + + &reftitle.parameters; + + + + clientOptions + + + This is an array containing one of the following keys + + + + + + + + + + + + + &reftitle.examples; + + + <methodname>SolrClient::__construct</methodname> example + + 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); + +?> + +]]> + + &example.outputs.similar; + + + + + + + + + + + diff --git a/reference/solr/solrclient/deletebyid.xml b/reference/solr/solrclient/deletebyid.xml new file mode 100755 index 0000000000..3da4a7c6aa --- /dev/null +++ b/reference/solr/solrclient/deletebyid.xml @@ -0,0 +1,77 @@ + + + + + + SolrClient::deleteById + Delete by Id + + + + &reftitle.description; + + public SolrUpdateResponseSolrClient::deleteById + stringid + + + Deletes the document with the specified ID. Where ID is the value of the uniqueKey field declared in the schema + + + + + + &reftitle.parameters; + + + + id + + + The value of the uniqueKey field declared in the schema + + + + + + + + + &reftitle.returnvalues; + + Returns a SolrUpdateResponse on success and throws a SolrClientException on failure. + + + + + &reftitle.seealso; + + + SolrClient::deleteByIds + SolrClient::deleteByQuery + SolrClient::deleteByQueries + + + + + + + diff --git a/reference/solr/solrclient/deletebyids.xml b/reference/solr/solrclient/deletebyids.xml new file mode 100755 index 0000000000..266a5c220a --- /dev/null +++ b/reference/solr/solrclient/deletebyids.xml @@ -0,0 +1,77 @@ + + + + + + SolrClient::deleteByIds + Deletes by Ids + + + + &reftitle.description; + + public SolrUpdateResponseSolrClient::deleteByIds + arrayids + + + Deletes a collection of documents with the specified set of ids. + + + + + + &reftitle.parameters; + + + + 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. + + + + + + + + + &reftitle.returnvalues; + + Returns a SolrUpdateResponse on success and throws a SolrClientException on failure. + + + + + &reftitle.seealso; + + + SolrClient::deleteById + SolrClient::deleteByQuery + SolrClient::deleteByQueries + + + + + + + diff --git a/reference/solr/solrclient/deletebyqueries.xml b/reference/solr/solrclient/deletebyqueries.xml new file mode 100755 index 0000000000..d22d0ff879 --- /dev/null +++ b/reference/solr/solrclient/deletebyqueries.xml @@ -0,0 +1,77 @@ + + + + + + SolrClient::deleteByQueries + Removes all documents matching any of the queries + + + + &reftitle.description; + + public SolrUpdateResponseSolrClient::deleteByQueries + arrayqueries + + + Removes all documents matching any of the queries + + + + + + &reftitle.parameters; + + + + queries + + + The array of queries. This must be an actual php variable. + + + + + + + + + &reftitle.returnvalues; + + Returns a SolrUpdateResponse on success and throws a SolrClientException on failure. + + + + + &reftitle.seealso; + + + SolrClient::deleteById + SolrClient::deleteByIds + SolrClient::deleteByQuery + + + + + + + diff --git a/reference/solr/solrclient/deletebyquery.xml b/reference/solr/solrclient/deletebyquery.xml new file mode 100755 index 0000000000..b5f34fdd7b --- /dev/null +++ b/reference/solr/solrclient/deletebyquery.xml @@ -0,0 +1,77 @@ + + + + + + SolrClient::deleteByQuery + Deletes all documents matching the given query + + + + &reftitle.description; + + public SolrUpdateResponseSolrClient::deleteByQuery + stringquery + + + Deletes all documents matching the given query. + + + + + + &reftitle.parameters; + + + + query + + + The query + + + + + + + + + &reftitle.returnvalues; + + Returns a SolrUpdateResponse on success and throws a SolrClientException on failure. + + + + + &reftitle.seealso; + + + SolrClient::deleteById + SolrClient::deleteByIds + SolrClient::deleteByQueries + + + + + + + diff --git a/reference/solr/solrclient/destruct.xml b/reference/solr/solrclient/destruct.xml new file mode 100755 index 0000000000..cfca9677cd --- /dev/null +++ b/reference/solr/solrclient/destruct.xml @@ -0,0 +1,63 @@ + + + + + + SolrClient::__destruct + Destructor for SolrClient + + + + &reftitle.description; + + public voidSolrClient::__destruct + + + + Destructor + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Destructor for SolrClient + + + + + &reftitle.seealso; + + + SolrClient::__construct + + + + + + + diff --git a/reference/solr/solrclient/optimize.xml b/reference/solr/solrclient/optimize.xml new file mode 100755 index 0000000000..051d302e41 --- /dev/null +++ b/reference/solr/solrclient/optimize.xml @@ -0,0 +1,94 @@ + + + + + + SolrClient::optimize + Defragments the index + + + + &reftitle.description; + + public SolrUpdateResponseSolrClient::optimize + intmaxSegments + boolwaitFlush + boolwaitSearcher + + + Defragments the index for faster search performance. + + + + + + &reftitle.parameters; + + + + maxSegments + + + Optimizes down to at most this number of segments. Since Solr 1.3 + + + + + waitFlush + + + Block until index changes are flushed to disk. + + + + + waitSearcher + + + Block until a new searcher is opened and registered as the main query searcher, making the changes visible. + + + + + + + + + &reftitle.returnvalues; + + Returns a SolrUpdateResponse on success or throws a SolrClientException on failure. + + + + + &reftitle.seealso; + + + SolrClient::commit + SolrClient::rollback + + + + + + + diff --git a/reference/solr/solrclient/ping.xml b/reference/solr/solrclient/ping.xml new file mode 100755 index 0000000000..9739a71122 --- /dev/null +++ b/reference/solr/solrclient/ping.xml @@ -0,0 +1,88 @@ + + + + + + SolrClient::ping + Checks if Solr server is still up + + + + &reftitle.description; + + public SolrPingResponseSolrClient::ping + + + + Checks if the Solr server is still alive. Sends a HEAD request to the Apache Solr server. + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns a SolrPingResponse object on success and throws a SolrClientException on failure. + + + + + &reftitle.examples; + + + <methodname>SolrClient::ping</methodname> example + + SOLR_SERVER_HOSTNAME, + 'login' => SOLR_SERVER_USERNAME, + 'password' => SOLR_SERVER_PASSWORD, + 'port' => SOLR_SERVER_PORT, +); + +$client = new SolrClient($options); + +$pingresponse = $client->ping(); + +?> +]]> + + &example.outputs.similar; + + + + + + + + + + diff --git a/reference/solr/solrclient/query.xml b/reference/solr/solrclient/query.xml new file mode 100755 index 0000000000..14fd75f5cd --- /dev/null +++ b/reference/solr/solrclient/query.xml @@ -0,0 +1,116 @@ + + + + + + SolrClient::query + Sends a query to the server. + + + + &reftitle.description; + + public SolrQueryResponseSolrClient::query + SolrParamsquery + + + Sends a query to the server. + + + + + + &reftitle.parameters; + + + + query + + + A SolrParam object. It is recommended to use SolrQuery for advanced queries. + + + + + + + + + &reftitle.returnvalues; + + Returns a SolrQueryResponse object on success and throws a SolrClientException object on failure. + + + + + &reftitle.examples; + + + <methodname>SolrClient::query</methodname> example + + SOLR_SERVER_HOSTNAME, + 'login' => SOLR_SERVER_USERNAME, + 'password' => SOLR_SERVER_PASSWORD, + 'port' => SOLR_SERVER_PORT, +); + +$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); + +?> +]]> + + &example.outputs.similar; + + + + + + + + + + diff --git a/reference/solr/solrclient/request.xml b/reference/solr/solrclient/request.xml new file mode 100755 index 0000000000..0b0915944e --- /dev/null +++ b/reference/solr/solrclient/request.xml @@ -0,0 +1,102 @@ + + + + + + SolrClient::request + Sends a raw update request + + + + &reftitle.description; + + public voidSolrClient::request + stringraw_request + + + Sends a raw XML update request to the server + + + + + + &reftitle.parameters; + + + + raw_request + + + An XML string with the raw request to the server. + + + + + + + + + &reftitle.returnvalues; + + Returns a SolrUpdateResponse on success. Throws a SolrClientException on failure. + + + + + &reftitle.examples; + + + <methodname>SolrClient::request</methodname> example + + SOLR_SERVER_HOSTNAME, + 'login' => SOLR_SERVER_USERNAME, + 'password' => SOLR_SERVER_PASSWORD, + 'port' => SOLR_SERVER_PORT, +); + +$client = new SolrClient($options); + +$update_response = $client->request(""); + +$response = $update_response->getResponse(); + +print_r($response); +?> +]]> + + &example.outputs.similar; + + + + + + + + + + diff --git a/reference/solr/solrclient/rollback.xml b/reference/solr/solrclient/rollback.xml new file mode 100755 index 0000000000..588768067d --- /dev/null +++ b/reference/solr/solrclient/rollback.xml @@ -0,0 +1,65 @@ + + + + + + SolrClient::rollback + Rollbacks all add/deletes made to the index since the last commit. + + + + &reftitle.description; + + public SolrUpdateResponseSolrClient::rollback + + + + Rollbacks all add/deletes made to the index since the last commit. It neither calls any event listeners nor creates a new searcher. + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns a SolrUpdateResponse on success or throws a SolrClientException on failure. + + + + + &reftitle.seealso; + + + SolrClient::commit + SolrClient::optimize + + + + + + + diff --git a/reference/solr/solrclient/setservlet.xml b/reference/solr/solrclient/setservlet.xml new file mode 100755 index 0000000000..38d9638ba8 --- /dev/null +++ b/reference/solr/solrclient/setservlet.xml @@ -0,0 +1,82 @@ + + + + + + SolrClient::setServlet + Changes the specified servlet type to a new value + + + + &reftitle.description; + + public boolSolrClient::setServlet + inttype + stringvalue + + + Changes the specified servlet type to a new value + + + + + + &reftitle.parameters; + + + + type + + One of the following : + + + + + + + value + + + The new value for the servlet + + + + + + + + + &reftitle.returnvalues; + + Returns &true; on success and &false; on failure. + + + + + + diff --git a/reference/solr/solrclient/threads.xml b/reference/solr/solrclient/threads.xml new file mode 100755 index 0000000000..9ab6a34061 --- /dev/null +++ b/reference/solr/solrclient/threads.xml @@ -0,0 +1,55 @@ + + + + + + SolrClient::threads + Checks the threads status + + + + &reftitle.description; + + public voidSolrClient::threads + + + + Checks the threads status + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns a SolrGenericResponse object. + + + + + + diff --git a/reference/solr/solrclientexception.xml b/reference/solr/solrclientexception.xml new file mode 100755 index 0000000000..5411e132e7 --- /dev/null +++ b/reference/solr/solrclientexception.xml @@ -0,0 +1,130 @@ + + + + + + The SolrClientException class + SolrClientException + + + + +
+ &reftitle.intro; + + An exception thrown when there is an error while making a request to the server from the client. + +
+ + +
+ &reftitle.classsynopsis; + + + + SolrClientException + + + + + SolrClientException + + + + extends + SolrException + + + + Properties + + + Methods + + + Inherited methods + + + + + +
+ + + +
+ &reftitle.properties; + + + message + + The error message + + + + code + + The error code + + + + file + + The userspace php source file where exception was generated + + + + line + + The line in userspace php source file where exception was generated + + + + 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 + + + +
+ + + + + + &reference.solr.entities.solrclientexception; + + + + diff --git a/reference/solr/solrclientexception/getinternalinfo.xml b/reference/solr/solrclientexception/getinternalinfo.xml new file mode 100755 index 0000000000..064a99c724 --- /dev/null +++ b/reference/solr/solrclientexception/getinternalinfo.xml @@ -0,0 +1,55 @@ + + + + + + SolrClientException::getInternalInfo + Returns internal information where the Exception was thrown + + + + &reftitle.description; + + public arraySolrClientException::getInternalInfo + + + + Returns internal information where the Exception was thrown. + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns an array containing internal information where the error was thrown. Used only for debugging by extension developers. + + + + + + diff --git a/reference/solr/solrdocument.xml b/reference/solr/solrdocument.xml new file mode 100755 index 0000000000..abeb904939 --- /dev/null +++ b/reference/solr/solrdocument.xml @@ -0,0 +1,199 @@ + + + + + + The SolrDocument class + SolrDocument + + + + +
+ &reftitle.intro; + + Represents a Solr document retrieved from a query response. + +
+ + +
+ &reftitle.classsynopsis; + + + + SolrDocument + + + + + final + SolrDocument + + + + ArrayAccess + + + + Iterator + + + + Traversable + + + + 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 + + + Properties + + private + _hashtable_index + + + + Methods + + + + +
+ + + +
+ &reftitle.properties; + + + privateinteger_hashtable_index + + Used internally for mapping object instances in the hash table. + + + +
+ + + + +
+ &reftitle.constants; +
+ SolrDocument Node Types + + + + 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. + + + + +
+
+ + + + + + &reference.solr.entities.solrdocument; + + + + diff --git a/reference/solr/solrdocument/addfield.xml b/reference/solr/solrdocument/addfield.xml new file mode 100755 index 0000000000..13ce7511fc --- /dev/null +++ b/reference/solr/solrdocument/addfield.xml @@ -0,0 +1,75 @@ + + + + + + SolrDocument::addField + Adds a field to the document. + + + + &reftitle.description; + + public boolSolrDocument::addField + stringfieldName + stringfieldValue + + + This method adds a field to the SolrDocument instance. + + + + + + &reftitle.parameters; + + + + fieldName + + + The name of the field + + + + + fieldValue + + + The value of the field. + + + + + + + + + &reftitle.returnvalues; + + Returns &true; on success and &false; on failure. + + + + + + diff --git a/reference/solr/solrdocument/clear.xml b/reference/solr/solrdocument/clear.xml new file mode 100755 index 0000000000..ed306481b9 --- /dev/null +++ b/reference/solr/solrdocument/clear.xml @@ -0,0 +1,55 @@ + + + + + + SolrDocument::clear + Drops all the fields in the document. + + + + &reftitle.description; + + public boolSolrDocument::clear + + + + Resets the current object. Discards all the fields and resets the document boost to zero. + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns &true; on success and &false; on failure. + + + + + + diff --git a/reference/solr/solrdocument/clone.xml b/reference/solr/solrdocument/clone.xml new file mode 100755 index 0000000000..1da8639931 --- /dev/null +++ b/reference/solr/solrdocument/clone.xml @@ -0,0 +1,55 @@ + + + + + + SolrDocument::__clone + Creates a copy of a SolrDocument object. + + + + &reftitle.description; + + public voidSolrDocument::__clone + + + + Creates a copy of a SolrDocument object. Not to be called directly. + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + None. + + + + + + diff --git a/reference/solr/solrdocument/construct.xml b/reference/solr/solrdocument/construct.xml new file mode 100755 index 0000000000..0d7648244d --- /dev/null +++ b/reference/solr/solrdocument/construct.xml @@ -0,0 +1,55 @@ + + + + + + SolrDocument::__construct + Constructor + + + + &reftitle.description; + + SolrDocument::__construct + + + + Constructor for SolrDocument + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + + diff --git a/reference/solr/solrdocument/current.xml b/reference/solr/solrdocument/current.xml new file mode 100755 index 0000000000..2e7fb77039 --- /dev/null +++ b/reference/solr/solrdocument/current.xml @@ -0,0 +1,56 @@ + + + + + + SolrDocument::current + Retrieves the current field + + + + &reftitle.description; + + public SolrDocumentFieldSolrDocument::current + + + + Retrieves the current field + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns the field + + + + + + + diff --git a/reference/solr/solrdocument/deletefield.xml b/reference/solr/solrdocument/deletefield.xml new file mode 100755 index 0000000000..e308cf1bb4 --- /dev/null +++ b/reference/solr/solrdocument/deletefield.xml @@ -0,0 +1,68 @@ + + + + + + SolrDocument::deleteField + Removes a field from the document. + + + + &reftitle.description; + + public boolSolrDocument::deleteField + stringfieldName + + + Removes a field from the document. + + + + + + + + &reftitle.parameters; + + + + fieldName + + + Name of the field + + + + + + + + + &reftitle.returnvalues; + + Returns &true; on success and &false; on failure. + + + + + + diff --git a/reference/solr/solrdocument/destruct.xml b/reference/solr/solrdocument/destruct.xml new file mode 100755 index 0000000000..081e674f79 --- /dev/null +++ b/reference/solr/solrdocument/destruct.xml @@ -0,0 +1,55 @@ + + + + + + SolrDocument::__destruct + Destructor + + + + &reftitle.description; + + public voidSolrDocument::__destruct + + + + Destructor for SolrDocument. + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + + diff --git a/reference/solr/solrdocument/fieldexists.xml b/reference/solr/solrdocument/fieldexists.xml new file mode 100755 index 0000000000..e5cfb6e9d6 --- /dev/null +++ b/reference/solr/solrdocument/fieldexists.xml @@ -0,0 +1,66 @@ + + + + + + SolrDocument::fieldExists + Checks if a field exists in the document. + + + + &reftitle.description; + + public boolSolrDocument::fieldExists + stringfieldName + + + Checks if the requested field as a valid fieldname in the document. + + + + + + &reftitle.parameters; + + + + fieldName + + + The name of the field. + + + + + + + + + &reftitle.returnvalues; + + Returns &true; if the field is present and &false; if it does not. + + + + + + diff --git a/reference/solr/solrdocument/get.xml b/reference/solr/solrdocument/get.xml new file mode 100755 index 0000000000..556b63a354 --- /dev/null +++ b/reference/solr/solrdocument/get.xml @@ -0,0 +1,68 @@ + + + + + + SolrDocument::__get + Acess the field as a property. + + + + &reftitle.description; + + public SolrDocumentFieldSolrDocument::__get + stringfieldName + + + Magic method for accessing the field as a property. + + + + + + + + &reftitle.parameters; + + + + fieldName + + + The name of the field. + + + + + + + + + &reftitle.returnvalues; + + Returns a SolrDocumentField instance. + + + + + + diff --git a/reference/solr/solrdocument/getfield.xml b/reference/solr/solrdocument/getfield.xml new file mode 100755 index 0000000000..b12a63e85d --- /dev/null +++ b/reference/solr/solrdocument/getfield.xml @@ -0,0 +1,66 @@ + + + + + + SolrDocument::getField + Retrieves a field by name. + + + + &reftitle.description; + + public SolrDocumentFieldSolrDocument::getField + stringfieldName + + + Retrieves a field by name. + + + + + + &reftitle.parameters; + + + + fieldName + + + Name of the field. + + + + + + + + + &reftitle.returnvalues; + + Returns a SolrDocumentField on success and &false; on failure. + + + + + + diff --git a/reference/solr/solrdocument/getfieldcount.xml b/reference/solr/solrdocument/getfieldcount.xml new file mode 100755 index 0000000000..bc25e87e4b --- /dev/null +++ b/reference/solr/solrdocument/getfieldcount.xml @@ -0,0 +1,57 @@ + + + + + + SolrDocument::getFieldCount + Returns the number of fields in this document. + + + + &reftitle.description; + + public intSolrDocument::getFieldCount + + + + Returns the number of fields in this document. Multi-value fields are only counted once. + + + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns an integer on success and &false; on failure. + + + + + + diff --git a/reference/solr/solrdocument/getfieldnames.xml b/reference/solr/solrdocument/getfieldnames.xml new file mode 100755 index 0000000000..0fe80f5638 --- /dev/null +++ b/reference/solr/solrdocument/getfieldnames.xml @@ -0,0 +1,55 @@ + + + + + + SolrDocument::getFieldNames + Returns an array of fields names in the document. + + + + &reftitle.description; + + public arraySolrDocument::getFieldNames + + + + Returns an array of fields names in the document. + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns an array containing the names of the fields in this document. + + + + + + diff --git a/reference/solr/solrdocument/getinputdocument.xml b/reference/solr/solrdocument/getinputdocument.xml new file mode 100755 index 0000000000..18c518cd33 --- /dev/null +++ b/reference/solr/solrdocument/getinputdocument.xml @@ -0,0 +1,55 @@ + + + + + + SolrDocument::getInputDocument + Returns a SolrInputDocument equivalent of the object. + + + + &reftitle.description; + + public SolrInputDocumentSolrDocument::getInputDocument + + + + Returns a SolrInputDocument equivalent of the object. This is useful if one wishes to resubmit/update a document retrieved from a query. + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns a SolrInputDocument on success and &null; on failure. + + + + + + diff --git a/reference/solr/solrdocument/isset.xml b/reference/solr/solrdocument/isset.xml new file mode 100755 index 0000000000..fc47b09c88 --- /dev/null +++ b/reference/solr/solrdocument/isset.xml @@ -0,0 +1,68 @@ + + + + + + SolrDocument::__isset + Checks if a field exists + + + + &reftitle.description; + + public boolSolrDocument::__isset + stringfieldName + + + Checks if a field exists + + + + + + + + &reftitle.parameters; + + + + fieldName + + + Name of the field. + + + + + + + + + &reftitle.returnvalues; + + Returns &true; on success and &false; on failure. + + + + + + diff --git a/reference/solr/solrdocument/key.xml b/reference/solr/solrdocument/key.xml new file mode 100755 index 0000000000..7641097a4c --- /dev/null +++ b/reference/solr/solrdocument/key.xml @@ -0,0 +1,55 @@ + + + + + + SolrDocument::key + Retrieves the current key. + + + + &reftitle.description; + + public stringSolrDocument::key + + + + Retrieves the current key. + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns the current key. + + + + + + diff --git a/reference/solr/solrdocument/merge.xml b/reference/solr/solrdocument/merge.xml new file mode 100755 index 0000000000..75e08b428d --- /dev/null +++ b/reference/solr/solrdocument/merge.xml @@ -0,0 +1,75 @@ + + + + + + SolrDocument::merge + Merges source to the current SolrDocument. + + + + &reftitle.description; + + public voidSolrDocument::merge + SolrDocumentsourceDoc + booloverwrite + + + Merges source to the current SolrDocument. + + + + + + &reftitle.parameters; + + + + sourceDoc + + + The source document. + + + + + overwrite + + + If this is &true; then fields with the same name in the destination document will be overwritten. + + + + + + + + + &reftitle.returnvalues; + + Returns &true; on success and &false; on failure. + + + + + + diff --git a/reference/solr/solrdocument/next.xml b/reference/solr/solrdocument/next.xml new file mode 100755 index 0000000000..431be30bc3 --- /dev/null +++ b/reference/solr/solrdocument/next.xml @@ -0,0 +1,57 @@ + + + + + + SolrDocument::next + Moves the internal pointer to the next field + + + + &reftitle.description; + + public voidSolrDocument::next + + + + Moves the internal pointer to the next field. + + + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + This method has no return value. + + + + + + diff --git a/reference/solr/solrdocument/offsetexists.xml b/reference/solr/solrdocument/offsetexists.xml new file mode 100755 index 0000000000..89d4d3a86d --- /dev/null +++ b/reference/solr/solrdocument/offsetexists.xml @@ -0,0 +1,66 @@ + + + + + + SolrDocument::offsetExists + Checks if a particular field exists. + + + + &reftitle.description; + + public boolSolrDocument::offsetExists + stringfieldName + + + Checks if a particular field exists. This is used when the object is treated as an array. + + + + + + &reftitle.parameters; + + + + fieldName + + + The name of the field. + + + + + + + + + &reftitle.returnvalues; + + Returns &true; on success and &false; on failure. + + + + + + diff --git a/reference/solr/solrdocument/offsetget.xml b/reference/solr/solrdocument/offsetget.xml new file mode 100755 index 0000000000..77a21e352c --- /dev/null +++ b/reference/solr/solrdocument/offsetget.xml @@ -0,0 +1,68 @@ + + + + + + SolrDocument::offsetGet + Retrieves a field. + + + + &reftitle.description; + + public SolrDocumentFieldSolrDocument::offsetGet + stringfieldName + + + This is used to retrieve the field when the object is treated as an array. + + + + + + + + &reftitle.parameters; + + + + fieldName + + + The name of the field. + + + + + + + + + &reftitle.returnvalues; + + Returns a SolrDocumentField object. + + + + + + diff --git a/reference/solr/solrdocument/offsetset.xml b/reference/solr/solrdocument/offsetset.xml new file mode 100755 index 0000000000..79d88fada9 --- /dev/null +++ b/reference/solr/solrdocument/offsetset.xml @@ -0,0 +1,75 @@ + + + + + + SolrDocument::offsetSet + Adds a field to the document. + + + + &reftitle.description; + + public voidSolrDocument::offsetSet + stringfieldName + stringfieldValue + + + Used when the object is treated as an array to add a field to the document. + + + + + + &reftitle.parameters; + + + + fieldName + + + The name of the field. + + + + + fieldValue + + + The value for this field. + + + + + + + + + &reftitle.returnvalues; + + Returns &true; on success and &false; on failure. + + + + + + diff --git a/reference/solr/solrdocument/offsetunset.xml b/reference/solr/solrdocument/offsetunset.xml new file mode 100755 index 0000000000..b475eea186 --- /dev/null +++ b/reference/solr/solrdocument/offsetunset.xml @@ -0,0 +1,68 @@ + + + + + + SolrDocument::offsetUnset + Removes a field. + + + + &reftitle.description; + + public voidSolrDocument::offsetUnset + stringfieldName + + + Removes a field from the document. + + + + + + + + &reftitle.parameters; + + + + fieldName + + + The name of the field. + + + + + + + + + &reftitle.returnvalues; + + No return value. + + + + + + diff --git a/reference/solr/solrdocument/reset.xml b/reference/solr/solrdocument/reset.xml new file mode 100755 index 0000000000..7f85d87d1a --- /dev/null +++ b/reference/solr/solrdocument/reset.xml @@ -0,0 +1,57 @@ + + + + + + SolrDocument::reset + This is an alias to SolrDocument::clear() + + + + &reftitle.description; + + public boolSolrDocument::reset + + + + This is an alias to SolrDocument::clear() + + + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns &true; on success and &false; on failure. + + + + + + diff --git a/reference/solr/solrdocument/rewind.xml b/reference/solr/solrdocument/rewind.xml new file mode 100755 index 0000000000..b765a3540d --- /dev/null +++ b/reference/solr/solrdocument/rewind.xml @@ -0,0 +1,57 @@ + + + + + + SolrDocument::rewind + Resets the internal pointer to the beginning + + + + &reftitle.description; + + public voidSolrDocument::rewind + + + + Resets the internal pointer to the beginning. + + + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + This method has no return value. + + + + + + diff --git a/reference/solr/solrdocument/serialize.xml b/reference/solr/solrdocument/serialize.xml new file mode 100755 index 0000000000..415bcf67c8 --- /dev/null +++ b/reference/solr/solrdocument/serialize.xml @@ -0,0 +1,57 @@ + + + + + + SolrDocument::serialize + Used for custom serialization + + + + &reftitle.description; + + public stringSolrDocument::serialize + + + + Used for custom serialization. + + + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns a string representing the serialized Solr document. + + + + + + diff --git a/reference/solr/solrdocument/set.xml b/reference/solr/solrdocument/set.xml new file mode 100755 index 0000000000..d1da93b3ae --- /dev/null +++ b/reference/solr/solrdocument/set.xml @@ -0,0 +1,75 @@ + + + + + + SolrDocument::__set + Adds another field to the document. + + + + &reftitle.description; + + public voidSolrDocument::__set + stringfieldName + stringfieldValue + + + Adds another field to the document. Used to set the fields as new properties. + + + + + + &reftitle.parameters; + + + + fieldName + + + Name of the field. + + + + + fieldValue + + + Field value. + + + + + + + + + &reftitle.returnvalues; + + No return values. + + + + + + diff --git a/reference/solr/solrdocument/sort.xml b/reference/solr/solrdocument/sort.xml new file mode 100755 index 0000000000..dfc0adaa1c --- /dev/null +++ b/reference/solr/solrdocument/sort.xml @@ -0,0 +1,92 @@ + + + + + + SolrDocument::sort + Sorts the fields in the document. + + + + &reftitle.description; + + public voidSolrDocument::sort + intsortOrderBy + intsortDirection + + + + + + + + &reftitle.parameters; + + + + sortOrderBy + + + The sort criteria. + + + + + sortDirection + + + The sort direction. + + + + + + + + + &reftitle.returnvalues; + + Returns &true; on success and &false; on failure. + + + + + + diff --git a/reference/solr/solrdocument/toarray.xml b/reference/solr/solrdocument/toarray.xml new file mode 100755 index 0000000000..72e690a5d3 --- /dev/null +++ b/reference/solr/solrdocument/toarray.xml @@ -0,0 +1,134 @@ + + + + + + SolrDocument::toArray + Returns an array representation of the document. + + + + &reftitle.description; + + public arraySolrDocument::toArray + + + + Returns an array representation of the document. + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns an array representation of the document. + + + + + &reftitle.examples; + + + <methodname>SolrDocument::toArray</methodname> example + +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()); + +?> +]]> + + &example.outputs.similar; + + 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 + ) + + ) + + ) + +) +]]> + + + + + + + + diff --git a/reference/solr/solrdocument/unserialize.xml b/reference/solr/solrdocument/unserialize.xml new file mode 100755 index 0000000000..e267212621 --- /dev/null +++ b/reference/solr/solrdocument/unserialize.xml @@ -0,0 +1,68 @@ + + + + + + SolrDocument::unserialize + Custom serialization of SolrDocument objects + + + + &reftitle.description; + + public voidSolrDocument::unserialize + stringserialized + + + Custom serialization of SolrDocument objects + + + + + + + + &reftitle.parameters; + + + + serialized + + + An XML representation of the document. + + + + + + + + + &reftitle.returnvalues; + + None. + + + + + + diff --git a/reference/solr/solrdocument/unset.xml b/reference/solr/solrdocument/unset.xml new file mode 100755 index 0000000000..1daa443920 --- /dev/null +++ b/reference/solr/solrdocument/unset.xml @@ -0,0 +1,68 @@ + + + + + + SolrDocument::__unset + Removes a field from the document. + + + + &reftitle.description; + + public voidSolrDocument::__unset + stringfieldName + + + Removes a field from the document when the field is access as an object property. + + + + + + + + &reftitle.parameters; + + + + fieldName + + + The name of the field. + + + + + + + + + &reftitle.returnvalues; + + None. + + + + + + diff --git a/reference/solr/solrdocument/valid.xml b/reference/solr/solrdocument/valid.xml new file mode 100755 index 0000000000..3f1ae3dbc0 --- /dev/null +++ b/reference/solr/solrdocument/valid.xml @@ -0,0 +1,55 @@ + + + + + + SolrDocument::valid + Checks if the current position internally is still valid + + + + &reftitle.description; + + public boolSolrDocument::valid + + + + Checks if the current position internally is still valid. It is used during foreach operations. + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns &true; on success and &false; if the current position is no longer valid. + + + + + + diff --git a/reference/solr/solrdocumentfield.xml b/reference/solr/solrdocumentfield.xml new file mode 100755 index 0000000000..15e019ea6f --- /dev/null +++ b/reference/solr/solrdocumentfield.xml @@ -0,0 +1,116 @@ + + + + + + The SolrDocumentField class + SolrDocumentField + + + + +
+ &reftitle.intro; + + This represents a field in a Solr document. All its properties are read-only. + +
+ + +
+ &reftitle.classsynopsis; + + + + SolrDocumentField + + + + + final + SolrDocumentField + + + + Properties + + readonly + public + string + name + + + readonly + public + float + boost + + + readonly + public + array + values + + + + Methods + + + + +
+ + + +
+ &reftitle.properties; + + + name + + The name of the field. + + + + boost + + The boost value for the field + + + + values + + An array of values for this field + + + +
+ + + + + + &reference.solr.entities.solrdocumentfield; + + + + diff --git a/reference/solr/solrdocumentfield/construct.xml b/reference/solr/solrdocumentfield/construct.xml new file mode 100755 index 0000000000..c2da31987a --- /dev/null +++ b/reference/solr/solrdocumentfield/construct.xml @@ -0,0 +1,55 @@ + + + + + + SolrDocumentField::__construct + Constructor + + + + &reftitle.description; + + SolrDocumentField::__construct + + + + Constructor. + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + None. + + + + + + diff --git a/reference/solr/solrdocumentfield/destruct.xml b/reference/solr/solrdocumentfield/destruct.xml new file mode 100755 index 0000000000..8cb9e69438 --- /dev/null +++ b/reference/solr/solrdocumentfield/destruct.xml @@ -0,0 +1,55 @@ + + + + + + SolrDocumentField::__destruct + Destructor + + + + &reftitle.description; + + public voidSolrDocumentField::__destruct + + + + Destructor. + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + None. + + + + + + diff --git a/reference/solr/solrexception.xml b/reference/solr/solrexception.xml new file mode 100755 index 0000000000..5e65a4b7fd --- /dev/null +++ b/reference/solr/solrexception.xml @@ -0,0 +1,145 @@ + + + + + + The SolrException class + SolrException + + + + +
+ &reftitle.intro; + + This is the base class for all exception thrown by the Solr extension classes. + +
+ + +
+ &reftitle.classsynopsis; + + + + SolrException + + + + + SolrException + + + + extends + Exception + + + + Properties + + protected + integer + sourceline + + + protected + string + sourcefile + + + protected + string + zif_name + + + + Methods + + + Inherited methods + + + + + +
+ + + +
+ &reftitle.properties; + + + message + + The error message + + + + code + + The error code + + + + file + + The userspace php source file where exception was generated + + + + line + + The line in userspace php source file where exception was generated + + + + 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 + + + +
+ + + + + + &reference.solr.entities.solrexception; + + + + diff --git a/reference/solr/solrexception/getinternalinfo.xml b/reference/solr/solrexception/getinternalinfo.xml new file mode 100755 index 0000000000..fea723637f --- /dev/null +++ b/reference/solr/solrexception/getinternalinfo.xml @@ -0,0 +1,55 @@ + + + + + + SolrException::getInternalInfo + Returns internal information where the Exception was thrown + + + + &reftitle.description; + + public arraySolrException::getInternalInfo + + + + Returns internal information where the Exception was thrown. + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns an array containing internal information where the error was thrown. Used only for debugging by extension developers. + + + + + + diff --git a/reference/solr/solrgenericresponse.xml b/reference/solr/solrgenericresponse.xml new file mode 100755 index 0000000000..edc77f18bf --- /dev/null +++ b/reference/solr/solrgenericresponse.xml @@ -0,0 +1,190 @@ + + + + + + The SolrGenericResponse class + SolrGenericResponse + + + + +
+ &reftitle.intro; + + Represents a response from the solr server. + +
+ + +
+ &reftitle.classsynopsis; + + + + SolrGenericResponse + + + + + final + SolrGenericResponse + + + + extends + SolrResponse + + + + Constants + + const + integer + SolrGenericResponse::PARSE_SOLR_OBJ + 0 + + + const + integer + SolrGenericResponse::PARSE_SOLR_DOC + 1 + + + Properties + + + Methods + + + Inherited methods + + + + + +
+ + + +
+ &reftitle.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. + + + +
+ + + + +
+ &reftitle.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. + + + + +
+
+ + + + + + &reference.solr.entities.solrgenericresponse; + + + + diff --git a/reference/solr/solrgenericresponse/construct.xml b/reference/solr/solrgenericresponse/construct.xml new file mode 100755 index 0000000000..92b8dae479 --- /dev/null +++ b/reference/solr/solrgenericresponse/construct.xml @@ -0,0 +1,55 @@ + + + + + + SolrGenericResponse::__construct + Constructor + + + + &reftitle.description; + + SolrGenericResponse::__construct + + + + Constructor + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + None + + + + + + diff --git a/reference/solr/solrgenericresponse/destruct.xml b/reference/solr/solrgenericresponse/destruct.xml new file mode 100755 index 0000000000..77848d1925 --- /dev/null +++ b/reference/solr/solrgenericresponse/destruct.xml @@ -0,0 +1,54 @@ + + + + + + SolrGenericResponse::__destruct + Destructor + + + + &reftitle.description; + + public voidSolrGenericResponse::__destruct + + + + Destructor. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + None + + + + + + diff --git a/reference/solr/solrillegalargumentexception.xml b/reference/solr/solrillegalargumentexception.xml new file mode 100755 index 0000000000..57d7dfe486 --- /dev/null +++ b/reference/solr/solrillegalargumentexception.xml @@ -0,0 +1,130 @@ + + + + + + The SolrIllegalArgumentException class + SolrIllegalArgumentException + + + + +
+ &reftitle.intro; + + This object is thrown when an illeglal or invalid argument is passed to a method. + +
+ + +
+ &reftitle.classsynopsis; + + + + SolrIllegalArgumentException + + + + + SolrIllegalArgumentException + + + + extends + SolrException + + + + Properties + + + Methods + + + Inherited methods + + + + + +
+ + + +
+ &reftitle.properties; + + + message + + The error message + + + + code + + The error code + + + + file + + The userspace php source file where exception was generated + + + + line + + The line in userspace php source file where exception was generated + + + + 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 + + + +
+ + + + + + &reference.solr.entities.solrillegalargumentexception; + + + + diff --git a/reference/solr/solrillegalargumentexception/getinternalinfo.xml b/reference/solr/solrillegalargumentexception/getinternalinfo.xml new file mode 100755 index 0000000000..4c3028fbf7 --- /dev/null +++ b/reference/solr/solrillegalargumentexception/getinternalinfo.xml @@ -0,0 +1,57 @@ + + + + + + SolrIllegalArgumentException::getInternalInfo + Returns internal information where the Exception was thrown + + + + &reftitle.description; + + public arraySolrIllegalArgumentException::getInternalInfo + + + + Returns internal information where the Exception was thrown. + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns an array containing internal information where the error was thrown. Used only for debugging by extension developers. + + + + + + diff --git a/reference/solr/solrillegaloperationexception.xml b/reference/solr/solrillegaloperationexception.xml new file mode 100755 index 0000000000..01b468709c --- /dev/null +++ b/reference/solr/solrillegaloperationexception.xml @@ -0,0 +1,130 @@ + + + + + + The SolrIllegalOperationException class + SolrIllegalOperationException + + + + +
+ &reftitle.intro; + + This object is thrown when an illegal or unsupported operation is performed on an object. + +
+ + +
+ &reftitle.classsynopsis; + + + + SolrIllegalOperationException + + + + + SolrIllegalOperationException + + + + extends + SolrException + + + + Properties + + + Methods + + + Inherited methods + + + + + +
+ + + +
+ &reftitle.properties; + + + message + + The error message + + + + code + + The error code + + + + file + + The userspace php source file where exception was generated + + + + line + + The line in userspace php source file where exception was generated + + + + 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 + + + +
+ + + + + + &reference.solr.entities.solrillegaloperationexception; + + + + diff --git a/reference/solr/solrillegaloperationexception/getinternalinfo.xml b/reference/solr/solrillegaloperationexception/getinternalinfo.xml new file mode 100755 index 0000000000..933ac8d6ef --- /dev/null +++ b/reference/solr/solrillegaloperationexception/getinternalinfo.xml @@ -0,0 +1,57 @@ + + + + + + SolrIllegalOperationException::getInternalInfo + Returns internal information where the Exception was thrown + + + + &reftitle.description; + + public arraySolrIllegalOperationException::getInternalInfo + + + + Returns internal information where the Exception was thrown. + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns an array containing internal information where the error was thrown. Used only for debugging by extension developers. + + + + + + diff --git a/reference/solr/solrinputdocument.xml b/reference/solr/solrinputdocument.xml new file mode 100755 index 0000000000..4af7d28174 --- /dev/null +++ b/reference/solr/solrinputdocument.xml @@ -0,0 +1,183 @@ + + + + + + The SolrInputDocument class + SolrInputDocument + + + + +
+ &reftitle.intro; + + This class represents a Solr document that is about to be submitted to the Solr index. + +
+ + +
+ &reftitle.classsynopsis; + + + + SolrInputDocument + + + + + final + 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 + + + Properties + + private + _hashtable_index + + + + Methods + + + + +
+ + + +
+ &reftitle.properties; + + + privateinteger_hashtable_index + + Used internally to track the document instance. + + + +
+ + + + +
+ &reftitle.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. + + + + +
+
+ + + + + + &reference.solr.entities.solrinputdocument; + + + + diff --git a/reference/solr/solrinputdocument/addfield.xml b/reference/solr/solrinputdocument/addfield.xml new file mode 100755 index 0000000000..eeaf333f08 --- /dev/null +++ b/reference/solr/solrinputdocument/addfield.xml @@ -0,0 +1,84 @@ + + + + + + SolrInputDocument::addField + Adds a field to the document + + + + &reftitle.description; + + public boolSolrInputDocument::addField + stringfieldName + stringfieldValue + floatfieldBoostValue + + + 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. + + + + + + &reftitle.parameters; + + + + fieldName + + + The name of the field + + + + + fieldValue + + + The value for the field. + + + + + fieldBoostValue + + + The index time boost for the field. Though this cannot be negative, you can still pass values less than 1.0 but they must be greater than zero. + + + + + + + + + &reftitle.returnvalues; + + Returns &true; on success and &false; on failure. + + + + + + diff --git a/reference/solr/solrinputdocument/clear.xml b/reference/solr/solrinputdocument/clear.xml new file mode 100755 index 0000000000..52f62c91c5 --- /dev/null +++ b/reference/solr/solrinputdocument/clear.xml @@ -0,0 +1,55 @@ + + + + + + SolrInputDocument::clear + Resets the input document. + + + + &reftitle.description; + + public boolSolrInputDocument::clear + + + + Resets the document by dropping all the fields and resets the document boost to zero. + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns &true; on success and &false; on failure. + + + + + + diff --git a/reference/solr/solrinputdocument/clone.xml b/reference/solr/solrinputdocument/clone.xml new file mode 100755 index 0000000000..992723f500 --- /dev/null +++ b/reference/solr/solrinputdocument/clone.xml @@ -0,0 +1,55 @@ + + + + + + SolrInputDocument::__clone + Creates a copy of a SolrDocument + + + + &reftitle.description; + + public voidSolrInputDocument::__clone + + + + Should not be called directly. It is used to create a deep copy of a SolrInputDocument. + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Creates a new SolrInputDocument instance. + + + + + + diff --git a/reference/solr/solrinputdocument/construct.xml b/reference/solr/solrinputdocument/construct.xml new file mode 100755 index 0000000000..7e50c4f6ab --- /dev/null +++ b/reference/solr/solrinputdocument/construct.xml @@ -0,0 +1,55 @@ + + + + + + SolrInputDocument::__construct + Constructor. + + + + &reftitle.description; + + SolrInputDocument::__construct + + + + Constructor. + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + None. + + + + + + diff --git a/reference/solr/solrinputdocument/deletefield.xml b/reference/solr/solrinputdocument/deletefield.xml new file mode 100755 index 0000000000..a3c4f91e34 --- /dev/null +++ b/reference/solr/solrinputdocument/deletefield.xml @@ -0,0 +1,66 @@ + + + + + + SolrInputDocument::deleteField + Removes a field from the document. + + + + &reftitle.description; + + public boolSolrInputDocument::deleteField + stringfieldName + + + Removes a field from the document. + + + + + + &reftitle.parameters; + + + + fieldName + + + The name of the field. + + + + + + + + + &reftitle.returnvalues; + + Returns &true; on success and &false; on failure. + + + + + + diff --git a/reference/solr/solrinputdocument/destruct.xml b/reference/solr/solrinputdocument/destruct.xml new file mode 100755 index 0000000000..bf521b928e --- /dev/null +++ b/reference/solr/solrinputdocument/destruct.xml @@ -0,0 +1,57 @@ + + + + + + SolrInputDocument::__destruct + Destructor + + + + &reftitle.description; + + public voidSolrInputDocument::__destruct + + + + Destructor + + + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + None. + + + + + + diff --git a/reference/solr/solrinputdocument/fieldexists.xml b/reference/solr/solrinputdocument/fieldexists.xml new file mode 100755 index 0000000000..93a55d0342 --- /dev/null +++ b/reference/solr/solrinputdocument/fieldexists.xml @@ -0,0 +1,66 @@ + + + + + + SolrInputDocument::fieldExists + Checks if a field exists + + + + &reftitle.description; + + public boolSolrInputDocument::fieldExists + stringfieldName + + + Checks if a field exists + + + + + + &reftitle.parameters; + + + + fieldName + + + Name of the field. + + + + + + + + + &reftitle.returnvalues; + + Returns &true; if the field was found and &false; if it was not found. + + + + + + diff --git a/reference/solr/solrinputdocument/getboost.xml b/reference/solr/solrinputdocument/getboost.xml new file mode 100755 index 0000000000..34f2f546e3 --- /dev/null +++ b/reference/solr/solrinputdocument/getboost.xml @@ -0,0 +1,57 @@ + + + + + + SolrInputDocument::getBoost + Retrieves the current boost value for the document + + + + &reftitle.description; + + public floatSolrInputDocument::getBoost + + + + Retrieves the current boost value for the document. + + + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns the boost value on success and &false; on failure. + + + + + + diff --git a/reference/solr/solrinputdocument/getfield.xml b/reference/solr/solrinputdocument/getfield.xml new file mode 100755 index 0000000000..e6a29f7419 --- /dev/null +++ b/reference/solr/solrinputdocument/getfield.xml @@ -0,0 +1,66 @@ + + + + + + SolrInputDocument::getField + Retrieves a field by name + + + + &reftitle.description; + + public SolrDocumentFieldSolrInputDocument::getField + stringfieldName + + + Retrieves a field in the document. + + + + + + &reftitle.parameters; + + + + fieldName + + + The name of the field. + + + + + + + + + &reftitle.returnvalues; + + Returns a SolrDocumentField object on success and &false; on failure. + + + + + + diff --git a/reference/solr/solrinputdocument/getfieldboost.xml b/reference/solr/solrinputdocument/getfieldboost.xml new file mode 100755 index 0000000000..e66b25c44d --- /dev/null +++ b/reference/solr/solrinputdocument/getfieldboost.xml @@ -0,0 +1,66 @@ + + + + + + SolrInputDocument::getFieldBoost + Retrieves the boost value for a particular field + + + + &reftitle.description; + + public floatSolrInputDocument::getFieldBoost + stringfieldName + + + Retrieves the boost value for a particular field. + + + + + + &reftitle.parameters; + + + + fieldName + + + The name of the field. + + + + + + + + + &reftitle.returnvalues; + + Returns the boost value for the field or &false; if there was an error. + + + + + + diff --git a/reference/solr/solrinputdocument/getfieldcount.xml b/reference/solr/solrinputdocument/getfieldcount.xml new file mode 100755 index 0000000000..6a1350d5ec --- /dev/null +++ b/reference/solr/solrinputdocument/getfieldcount.xml @@ -0,0 +1,55 @@ + + + + + + SolrInputDocument::getFieldCount + Returns the number of fields in the document + + + + &reftitle.description; + + public intSolrInputDocument::getFieldCount + + + + Returns the number of fields in the document. + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns an integer on success or &false; on failure. + + + + + + diff --git a/reference/solr/solrinputdocument/getfieldnames.xml b/reference/solr/solrinputdocument/getfieldnames.xml new file mode 100755 index 0000000000..3944ac525a --- /dev/null +++ b/reference/solr/solrinputdocument/getfieldnames.xml @@ -0,0 +1,55 @@ + + + + + + SolrInputDocument::getFieldNames + Returns an array containing all the fields in the document + + + + &reftitle.description; + + public arraySolrInputDocument::getFieldNames + + + + Returns an array containing all the fields in the document. + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns an array on success and &false; on failure. + + + + + + diff --git a/reference/solr/solrinputdocument/merge.xml b/reference/solr/solrinputdocument/merge.xml new file mode 100755 index 0000000000..6369a263c0 --- /dev/null +++ b/reference/solr/solrinputdocument/merge.xml @@ -0,0 +1,75 @@ + + + + + + SolrInputDocument::merge + Merges one input document into another + + + + &reftitle.description; + + public boolSolrInputDocument::merge + SolrInputDocumentsourceDoc + booloverwrite + + + Merges one input document into another. + + + + + + &reftitle.parameters; + + + + sourceDoc + + + The source document. + + + + + overwrite + + + If this is &true; it will replace matching fields in the destination document. + + + + + + + + + &reftitle.returnvalues; + + Returns &true; on success and &false; on failure. In the future, this will be modified to return the number of fields in the new document. + + + + + + diff --git a/reference/solr/solrinputdocument/reset.xml b/reference/solr/solrinputdocument/reset.xml new file mode 100755 index 0000000000..8ca9c018b1 --- /dev/null +++ b/reference/solr/solrinputdocument/reset.xml @@ -0,0 +1,58 @@ + + + + + + SolrInputDocument::reset + This is an alias of SolrInputDocument::clear + + + + &reftitle.description; + + public boolSolrInputDocument::reset + + + + This is an alias of SolrInputDocument::clear + + + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns &true; on success and &false; on failure. + + + + + + + diff --git a/reference/solr/solrinputdocument/setboost.xml b/reference/solr/solrinputdocument/setboost.xml new file mode 100755 index 0000000000..ef52151b09 --- /dev/null +++ b/reference/solr/solrinputdocument/setboost.xml @@ -0,0 +1,66 @@ + + + + + + SolrInputDocument::setBoost + Sets the boost value for this document + + + + &reftitle.description; + + public boolSolrInputDocument::setBoost + floatdocumentBoostValue + + + Sets the boost value for this document. + + + + + + &reftitle.parameters; + + + + documentBoostValue + + + The index-time boost value for this document. + + + + + + + + + &reftitle.returnvalues; + + Returns &true; on success and &false; on failure. + + + + + + diff --git a/reference/solr/solrinputdocument/setfieldboost.xml b/reference/solr/solrinputdocument/setfieldboost.xml new file mode 100755 index 0000000000..478dd7fc71 --- /dev/null +++ b/reference/solr/solrinputdocument/setfieldboost.xml @@ -0,0 +1,68 @@ + + + + + + SolrInputDocument::setFieldBoost + Sets the index-time boost value for a field. + + + + &reftitle.description; + + public boolSolrInputDocument::setFieldBoost + stringfieldName + floatfieldBoostValue + + + Sets the index-time boost value for a field. This replaces the current boost value for this field. + + + + + + &reftitle.parameters; + + + + fieldName + + + The name of the field. + + + + + fieldBoostValue + + + The index time boost value. + + + + + + + + + + diff --git a/reference/solr/solrinputdocument/sort.xml b/reference/solr/solrinputdocument/sort.xml new file mode 100755 index 0000000000..d20dc19d35 --- /dev/null +++ b/reference/solr/solrinputdocument/sort.xml @@ -0,0 +1,95 @@ + + + + + + SolrInputDocument::sort + Sorts the fields within the document + + + + &reftitle.description; + + public boolSolrInputDocument::sort + intsortOrderBy + intsortDirection + + + + + + + + + + + &reftitle.parameters; + + + + sortOrderBy + + + The sort criteria + + + + + sortDirection + + + The sort direction + + + + + + + + + &reftitle.returnvalues; + + Returns &true; on success and &false; on failure. + + + + + + diff --git a/reference/solr/solrinputdocument/toarray.xml b/reference/solr/solrinputdocument/toarray.xml new file mode 100755 index 0000000000..cb3d08d0d6 --- /dev/null +++ b/reference/solr/solrinputdocument/toarray.xml @@ -0,0 +1,55 @@ + + + + + + SolrInputDocument::toArray + Returns an array representation of the input document + + + + &reftitle.description; + + public voidSolrInputDocument::toArray + + + + Returns an array representation of the input document. + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns an array containing the fields. It returns &false; on failure. + + + + + + diff --git a/reference/solr/solrmodifiableparams.xml b/reference/solr/solrmodifiableparams.xml new file mode 100755 index 0000000000..ca3e4af284 --- /dev/null +++ b/reference/solr/solrmodifiableparams.xml @@ -0,0 +1,98 @@ + + + + + + The SolrModifiableParams class + SolrModifiableParams + + + + +
+ &reftitle.intro; + + Represents a collection of name-value pairs sent to the Solr server during a request. + +
+ + +
+ &reftitle.classsynopsis; + + + + SolrModifiableParams + + + + + SolrModifiableParams + + + + extends + SolrParams + + + + Serializable + + + + Properties + + + Methods + + + Inherited methods + + + + + +
+ + + +
+ &reftitle.properties; + + + _hashtable_index + + Used internally to track object instances. + + + +
+ + + + + + &reference.solr.entities.solrmodifiableparams; + + + + diff --git a/reference/solr/solrmodifiableparams/construct.xml b/reference/solr/solrmodifiableparams/construct.xml new file mode 100755 index 0000000000..73ab6a1965 --- /dev/null +++ b/reference/solr/solrmodifiableparams/construct.xml @@ -0,0 +1,55 @@ + + + + + + SolrModifiableParams::__construct + Constructor + + + + &reftitle.description; + + SolrModifiableParams::__construct + + + + Constructor + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + None + + + + + + diff --git a/reference/solr/solrmodifiableparams/destruct.xml b/reference/solr/solrmodifiableparams/destruct.xml new file mode 100755 index 0000000000..2fbf78fcfe --- /dev/null +++ b/reference/solr/solrmodifiableparams/destruct.xml @@ -0,0 +1,55 @@ + + + + + + SolrModifiableParams::__destruct + Destructor + + + + &reftitle.description; + + public voidSolrModifiableParams::__destruct + + + + Destructor + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + None + + + + + + diff --git a/reference/solr/solrobject.xml b/reference/solr/solrobject.xml new file mode 100755 index 0000000000..1ebec880d9 --- /dev/null +++ b/reference/solr/solrobject.xml @@ -0,0 +1,72 @@ + + + + + + The SolrObject class + SolrObject + + + + +
+ &reftitle.intro; + + This is an object whose properties can also by accessed using the array syntax. All its properties are read-only. + +
+ + +
+ &reftitle.classsynopsis; + + + + SolrObject + + + + + final + SolrObject + + + + ArrayAccess + + + + + Methods + + + + +
+ + + + &reference.solr.entities.solrobject; + + + + diff --git a/reference/solr/solrobject/construct.xml b/reference/solr/solrobject/construct.xml new file mode 100755 index 0000000000..a73bb308e5 --- /dev/null +++ b/reference/solr/solrobject/construct.xml @@ -0,0 +1,86 @@ + + + + + + SolrObject::__construct + Constructor + + + + &reftitle.description; + + SolrObject::__construct + + + + The method description goes here. + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Description... + + + + + &reftitle.examples; + + + <methodname>SolrObject::__construct</methodname> example + + +]]> + + &example.outputs.similar; + + + + + + + + + &reftitle.seealso; + + + Classname::Method + + + + + + + diff --git a/reference/solr/solrobject/destruct.xml b/reference/solr/solrobject/destruct.xml new file mode 100755 index 0000000000..2f228a1fe2 --- /dev/null +++ b/reference/solr/solrobject/destruct.xml @@ -0,0 +1,55 @@ + + + + + + SolrObject::__destruct + Destructor + + + + &reftitle.description; + + public voidSolrObject::__destruct + + + + The destructor + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + None. + + + + + + diff --git a/reference/solr/solrobject/getpropertynames.xml b/reference/solr/solrobject/getpropertynames.xml new file mode 100755 index 0000000000..227b19e4ac --- /dev/null +++ b/reference/solr/solrobject/getpropertynames.xml @@ -0,0 +1,55 @@ + + + + + + SolrObject::getPropertyNames + Returns an array of all the names of the properties + + + + &reftitle.description; + + public arraySolrObject::getPropertyNames + + + + Returns an array of all the names of the properties + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns an array. + + + + + + diff --git a/reference/solr/solrobject/offsetexists.xml b/reference/solr/solrobject/offsetexists.xml new file mode 100755 index 0000000000..9e4c0ee72c --- /dev/null +++ b/reference/solr/solrobject/offsetexists.xml @@ -0,0 +1,66 @@ + + + + + + SolrObject::offsetExists + Checks if the property exists + + + + &reftitle.description; + + public boolSolrObject::offsetExists + stringproperty_name + + + Checks if the property exists. This is used when the object is treated as an array. + + + + + + &reftitle.parameters; + + + + property_name + + + The name of the property. + + + + + + + + + &reftitle.returnvalues; + + Returns &true; on success and &false; on failure. + + + + + + diff --git a/reference/solr/solrobject/offsetget.xml b/reference/solr/solrobject/offsetget.xml new file mode 100755 index 0000000000..cb74756a46 --- /dev/null +++ b/reference/solr/solrobject/offsetget.xml @@ -0,0 +1,65 @@ + + + + + + SolrObject::offsetGet + Used to retrieve a property + + + + &reftitle.description; + + public mixedSolrObject::offsetGet + stringproperty_name + + + Used to get the value of a property. This is used when the object is treated as an array. + + + + + &reftitle.parameters; + + + + property_name + + + Name of the property. + + + + + + + + + &reftitle.returnvalues; + + Returns the property value. + + + + + + diff --git a/reference/solr/solrobject/offsetset.xml b/reference/solr/solrobject/offsetset.xml new file mode 100755 index 0000000000..c71d2a560f --- /dev/null +++ b/reference/solr/solrobject/offsetset.xml @@ -0,0 +1,75 @@ + + + + + + SolrObject::offsetSet + Sets the value for a property. + + + + &reftitle.description; + + public voidSolrObject::offsetSet + stringproperty_name + stringproperty_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. + + + + + + &reftitle.parameters; + + + + property_name + + + The name of the property. + + + + + property_value + + + The new value. + + + + + + + + + &reftitle.returnvalues; + + None. + + + + + + diff --git a/reference/solr/solrobject/offsetunset.xml b/reference/solr/solrobject/offsetunset.xml new file mode 100755 index 0000000000..c893743e45 --- /dev/null +++ b/reference/solr/solrobject/offsetunset.xml @@ -0,0 +1,97 @@ + + + + + + SolrObject::offsetUnset + Sets the value for the property. + + + + &reftitle.description; + + public voidSolrObject::offsetUnset + stringproperty_name + + + Sets 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. + + + + + + &reftitle.parameters; + + + + property_name + + + The name of the property. + + + + + + + + + &reftitle.returnvalues; + + Returns &true; on success and &false; on failure. + + + + + &reftitle.examples; + + + <methodname>SolrObject::offsetUnset</methodname> example + + +]]> + + &example.outputs.similar; + + + + + + + + + &reftitle.seealso; + + + Classname::Method + + + + + + + diff --git a/reference/solr/solrparams.xml b/reference/solr/solrparams.xml new file mode 100755 index 0000000000..ff36236c49 --- /dev/null +++ b/reference/solr/solrparams.xml @@ -0,0 +1,95 @@ + + + + + + The SolrParams class + SolrParams + + + + +
+ &reftitle.intro; + + Represents a collection of name-value pairs sent to the Solr server during a request. + +
+ + +
+ &reftitle.classsynopsis; + + + + SolrParams + + + + + abstract + SolrParams + + + + Serializable + + + + Properties + + protected + integer + _hashtable_index + + + + Methods + + + + +
+ + + +
+ &reftitle.properties; + + + _hashtable_index + + Used internally to track object instances. + + + +
+ + + + + + &reference.solr.entities.solrparams; + + + + diff --git a/reference/solr/solrparams/addparam.xml b/reference/solr/solrparams/addparam.xml new file mode 100755 index 0000000000..8767da6a1b --- /dev/null +++ b/reference/solr/solrparams/addparam.xml @@ -0,0 +1,74 @@ + + + + + + SolrParams::addParam + Adds a parameter to the object + + + + &reftitle.description; + + public SolrParamsSolrParams::addParam + stringname + stringvalue + + + Adds a parameter to the object. + + + + + &reftitle.parameters; + + + + name + + + Name of parameter + + + + + value + + + Value of parameter + + + + + + + + + &reftitle.returnvalues; + + Returns a SolrParam object on success and &false; on failure. + + + + + + diff --git a/reference/solr/solrparams/getparams.xml b/reference/solr/solrparams/getparams.xml new file mode 100755 index 0000000000..032682964e --- /dev/null +++ b/reference/solr/solrparams/getparams.xml @@ -0,0 +1,55 @@ + + + + + + SolrParams::getParams + Returns an array of non URL-encoded parameters + + + + &reftitle.description; + + final public arraySolrParams::getParams + + + + Returns an array of non URL-encoded parameters + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns an array of non URL-encoded parameters + + + + + + diff --git a/reference/solr/solrparams/getpreparedparams.xml b/reference/solr/solrparams/getpreparedparams.xml new file mode 100755 index 0000000000..ca7d5c45d0 --- /dev/null +++ b/reference/solr/solrparams/getpreparedparams.xml @@ -0,0 +1,55 @@ + + + + + + SolrParams::getPreparedParams + Returns an array of URL-encoded parameters + + + + &reftitle.description; + + final public arraySolrParams::getPreparedParams + + + + Returns an array on URL-encoded parameters + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns an array on URL-encoded parameters + + + + + + diff --git a/reference/solr/solrparams/serialize.xml b/reference/solr/solrparams/serialize.xml new file mode 100755 index 0000000000..b8f3c72950 --- /dev/null +++ b/reference/solr/solrparams/serialize.xml @@ -0,0 +1,54 @@ + + + + + + SolrParams::serialize + Used for custom serialization + + + + &reftitle.description; + + final public stringSolrParams::serialize + + + + Used for custom serialization + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Used for custom serialization + + + + + + diff --git a/reference/solr/solrparams/setparam.xml b/reference/solr/solrparams/setparam.xml new file mode 100755 index 0000000000..cca94a2b01 --- /dev/null +++ b/reference/solr/solrparams/setparam.xml @@ -0,0 +1,102 @@ + + + + + + SolrParams::setParam + Sets the parameter to the specified value + + + + &reftitle.description; + + public SolrParamsSolrParams::setParam + stringname + stringvalue + + + Sets the query parameter to the specified value + + + + + + &reftitle.parameters; + + + + name + + + Name of the parameter + + + + + value + + + Value of the parameter + + + + + + + + + &reftitle.returnvalues; + + Returns a SolrParam object on success and &false; on value. + + + + + &reftitle.examples; + + + <methodname>SolrParams::setParam</methodname> example + +setParam('q', 'solr')->setParam('rows', 2); + +?> +]]> + + &example.outputs.similar; + + + + + + + + + + diff --git a/reference/solr/solrparams/tostring.xml b/reference/solr/solrparams/tostring.xml new file mode 100755 index 0000000000..52a58307ea --- /dev/null +++ b/reference/solr/solrparams/tostring.xml @@ -0,0 +1,55 @@ + + + + + + SolrParams::__toString + Returns a string representation of the object + + + + &reftitle.description; + + public stringSolrParams::__toString + + + + Returns a string representation of the object + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns a string + + + + + + diff --git a/reference/solr/solrparams/unserialize.xml b/reference/solr/solrparams/unserialize.xml new file mode 100755 index 0000000000..528e41e050 --- /dev/null +++ b/reference/solr/solrparams/unserialize.xml @@ -0,0 +1,65 @@ + + + + + + SolrParams::unserialize + Used for custom serialization + + + + &reftitle.description; + + final public voidSolrParams::unserialize + stringserialized + + + Used for custom serialization + + + + + &reftitle.parameters; + + + + serialized + + + The serialized representation of the object + + + + + + + + + &reftitle.returnvalues; + + None + + + + + + diff --git a/reference/solr/solrpingresponse.xml b/reference/solr/solrpingresponse.xml new file mode 100755 index 0000000000..e1abd4df85 --- /dev/null +++ b/reference/solr/solrpingresponse.xml @@ -0,0 +1,190 @@ + + + + + + The SolrPingResponse class + SolrPingResponse + + + + +
+ &reftitle.intro; + + Represents a response to a ping request to the server + +
+ + +
+ &reftitle.classsynopsis; + + + + SolrPingResponse + + + + + final + SolrPingResponse + + + + extends + SolrResponse + + + + Constants + + const + integer + SolrPingResponse::PARSE_SOLR_OBJ + 0 + + + const + integer + SolrPingResponse::PARSE_SOLR_DOC + 1 + + + Properties + + + Methods + + + Inherited methods + + + + + +
+ + + +
+ &reftitle.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. + + + +
+ + + + +
+ &reftitle.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. + + + + +
+
+ + + + + + &reference.solr.entities.solrpingresponse; + + + + diff --git a/reference/solr/solrpingresponse/construct.xml b/reference/solr/solrpingresponse/construct.xml new file mode 100755 index 0000000000..3aef099f59 --- /dev/null +++ b/reference/solr/solrpingresponse/construct.xml @@ -0,0 +1,57 @@ + + + + + + SolrPingResponse::__construct + Constructor + + + + &reftitle.description; + + SolrPingResponse::__construct + + + + Constructor + + + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + None + + + + + + diff --git a/reference/solr/solrpingresponse/destruct.xml b/reference/solr/solrpingresponse/destruct.xml new file mode 100755 index 0000000000..e031dfc2b0 --- /dev/null +++ b/reference/solr/solrpingresponse/destruct.xml @@ -0,0 +1,54 @@ + + + + + + SolrPingResponse::__destruct + Destructor + + + + &reftitle.description; + + public voidSolrPingResponse::__destruct + + + + Destructor + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + None + + + + + + diff --git a/reference/solr/solrpingresponse/getresponse.xml b/reference/solr/solrpingresponse/getresponse.xml new file mode 100755 index 0000000000..202d5e7524 --- /dev/null +++ b/reference/solr/solrpingresponse/getresponse.xml @@ -0,0 +1,55 @@ + + + + + + SolrPingResponse::getResponse + Returns the response from the server + + + + &reftitle.description; + + public stringSolrPingResponse::getResponse + + + + Returns the response from the server. This should be empty because the request as a HEAD request. + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns an empty string. + + + + + + diff --git a/reference/solr/solrquery.xml b/reference/solr/solrquery.xml new file mode 100755 index 0000000000..a2988b8a70 --- /dev/null +++ b/reference/solr/solrquery.xml @@ -0,0 +1,191 @@ + + + + + + The SolrQuery class + SolrQuery + + + + +
+ &reftitle.intro; + + Represents a collection of name-value pairs sent to the Solr server during a request. + +
+ + +
+ &reftitle.classsynopsis; + + + + SolrQuery + + + + + SolrQuery + + + + extends + SolrModifiableParams + + + + 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 + + + Inherited methods + + + + + +
+ + + +
+ &reftitle.properties; + + + _hashtable_index + + Used internally to track object instances. + + + +
+ + + + +
+ &reftitle.constants; +
+ SolrQuery Node Types + + + + 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 + + + + +
+
+ + + + + + &reference.solr.entities.solrquery; + + + + diff --git a/reference/solr/solrquery/addfacetdatefield.xml b/reference/solr/solrquery/addfacetdatefield.xml new file mode 100755 index 0000000000..3130fb5c69 --- /dev/null +++ b/reference/solr/solrquery/addfacetdatefield.xml @@ -0,0 +1,67 @@ + + + + + + SolrQuery::addFacetDateField + Maps to facet.date + + + + &reftitle.description; + + public SolrQuerySolrQuery::addFacetDateField + stringdateField + + + 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 + + + + + &reftitle.parameters; + + + + dateField + + + The name of the date field. + + + + + + + + + &reftitle.returnvalues; + + Returns a SolrQuery object. + + + + + + diff --git a/reference/solr/solrquery/addfacetdateother.xml b/reference/solr/solrquery/addfacetdateother.xml new file mode 100755 index 0000000000..f45f744a43 --- /dev/null +++ b/reference/solr/solrquery/addfacetdateother.xml @@ -0,0 +1,75 @@ + + + + + + SolrQuery::addFacetDateOther + Adds another facet.date.other parameter + + + + &reftitle.description; + + publicSolrQuerySolrQuery::addFacetDateOther + stringvalue + stringfield_override + + + Sets the facet.date.other parameter. Accepts an optional field override + + + + + + &reftitle.parameters; + + + + value + + + The value to use. + + + + + field_override + + + The field name for the override. + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/addfacetfield.xml b/reference/solr/solrquery/addfacetfield.xml new file mode 100755 index 0000000000..995889501e --- /dev/null +++ b/reference/solr/solrquery/addfacetfield.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::addFacetField + Adds another field to the facet + + + + &reftitle.description; + + publicSolrQuerySolrQuery::addFacetField + stringfield + + + Adds another field to the facet + + + + + + &reftitle.parameters; + + + + field + + + The name of the field + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/addfacetquery.xml b/reference/solr/solrquery/addfacetquery.xml new file mode 100755 index 0000000000..750fc00b65 --- /dev/null +++ b/reference/solr/solrquery/addfacetquery.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::addFacetQuery + Adds a facet query + + + + &reftitle.description; + + publicSolrQuerySolrQuery::addFacetQuery + stringfacetQuery + + + Adds a facet query + + + + + + &reftitle.parameters; + + + + facetQuery + + + The facet query + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/addfield.xml b/reference/solr/solrquery/addfield.xml new file mode 100755 index 0000000000..385a0afd9a --- /dev/null +++ b/reference/solr/solrquery/addfield.xml @@ -0,0 +1,67 @@ + + + + + + SolrQuery::addField + Specifies which fields to return in the result + + + + &reftitle.description; + + publicSolrQuerySolrQuery::addField + stringfield + + + 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. + + + + + &reftitle.parameters; + + + + field + + + The name of the field + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object + + + + + + diff --git a/reference/solr/solrquery/addfilterquery.xml b/reference/solr/solrquery/addfilterquery.xml new file mode 100755 index 0000000000..415e5b69d1 --- /dev/null +++ b/reference/solr/solrquery/addfilterquery.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::addFilterQuery + Specifies a filter query + + + + &reftitle.description; + + publicSolrQuerySolrQuery::addFilterQuery + stringfq + + + Specifies a filter query + + + + + + &reftitle.parameters; + + + + fq + + + The filter query + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object. + + + + + + diff --git a/reference/solr/solrquery/addhighlightfield.xml b/reference/solr/solrquery/addhighlightfield.xml new file mode 100755 index 0000000000..791fd4a6e7 --- /dev/null +++ b/reference/solr/solrquery/addhighlightfield.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::addHighlightField + Maps to hl.fl + + + + &reftitle.description; + + publicSolrQuerySolrQuery::addHighlightField + stringfield + + + Maps to hl.fl. This is used to specify that highlighted snippets should be generated for a particular field + + + + + + &reftitle.parameters; + + + + field + + + Name of the field + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/addmltfield.xml b/reference/solr/solrquery/addmltfield.xml new file mode 100755 index 0000000000..1931e3ed61 --- /dev/null +++ b/reference/solr/solrquery/addmltfield.xml @@ -0,0 +1,65 @@ + + + + + + SolrQuery::addMltField + Sets a field to use for similarity + + + + &reftitle.description; + + publicSolrQuerySolrQuery::addMltField + stringfield + + + Maps to mlt.fl. It specifies that a field should be used for similarity. + + + + + &reftitle.parameters; + + + + field + + + The name of the field + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/addmltqueryfield.xml b/reference/solr/solrquery/addmltqueryfield.xml new file mode 100755 index 0000000000..4e27f2ca8e --- /dev/null +++ b/reference/solr/solrquery/addmltqueryfield.xml @@ -0,0 +1,75 @@ + + + + + + SolrQuery::addMltQueryField + Maps to mlt.qf + + + + &reftitle.description; + + publicSolrQuerySolrQuery::addMltQueryField + stringfield + floatboost + + + Maps to mlt.qf. It is used to specify query fields and their boosts + + + + + + &reftitle.parameters; + + + + field + + + The name of the field + + + + + boost + + + Its boost value + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/addsortfield.xml b/reference/solr/solrquery/addsortfield.xml new file mode 100755 index 0000000000..07784f5770 --- /dev/null +++ b/reference/solr/solrquery/addsortfield.xml @@ -0,0 +1,75 @@ + + + + + + SolrQuery::addSortField + Used to control how the results should be sorted + + + + &reftitle.description; + + publicSolrQuerySolrQuery::addSortField + stringfield + intorder + + + Used to control how the results should be sorted. + + + + + + &reftitle.parameters; + + + + field + + + The name of the field + + + + + order + + + The sort direction. This should be either SolrQuery::ORDER_ASC or SolrQuery::ORDER_DESC. + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object. + + + + + + diff --git a/reference/solr/solrquery/addstatsfacet.xml b/reference/solr/solrquery/addstatsfacet.xml new file mode 100755 index 0000000000..0bf170f55e --- /dev/null +++ b/reference/solr/solrquery/addstatsfacet.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::addStatsFacet + Requests a return of sub results for values within the given facet + + + + &reftitle.description; + + publicSolrQuerySolrQuery::addStatsFacet + stringfield + + + Requests a return of sub results for values within the given facet. Maps to the stats.facet field + + + + + + &reftitle.parameters; + + + + field + + + The name of the field + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/addstatsfield.xml b/reference/solr/solrquery/addstatsfield.xml new file mode 100755 index 0000000000..7069bacdf8 --- /dev/null +++ b/reference/solr/solrquery/addstatsfield.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::addStatsField + Maps to stats.field parameter + + + + &reftitle.description; + + public SolrQuerySolrQuery::addStatsField + stringfield + + + Maps to stats.field parameter This methods adds another stats.field parameter. + + + + + + &reftitle.parameters; + + + + field + + + The name of the field + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/construct.xml b/reference/solr/solrquery/construct.xml new file mode 100755 index 0000000000..1ab35435fe --- /dev/null +++ b/reference/solr/solrquery/construct.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::__construct + Constructor + + + + &reftitle.description; + + SolrQuery::__construct + stringq + + + Constructor. + + + + + + &reftitle.parameters; + + + + q + + + Optional search query + + + + + + + + + &reftitle.returnvalues; + + None + + + + + + diff --git a/reference/solr/solrquery/destruct.xml b/reference/solr/solrquery/destruct.xml new file mode 100755 index 0000000000..005b4d85fb --- /dev/null +++ b/reference/solr/solrquery/destruct.xml @@ -0,0 +1,55 @@ + + + + + + SolrQuery::__destruct + Destructor + + + + &reftitle.description; + + publicvoidSolrQuery::__destruct + + + + Destructor + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + None. + + + + + + diff --git a/reference/solr/solrquery/removefacetdatefield.xml b/reference/solr/solrquery/removefacetdatefield.xml new file mode 100755 index 0000000000..d8c1926aeb --- /dev/null +++ b/reference/solr/solrquery/removefacetdatefield.xml @@ -0,0 +1,97 @@ + + + + + + SolrQuery::removeFacetDateField + The removeFacetDateField purpose + + + + &reftitle.description; + + publicSolrQuerySolrQuery::removeFacetDateField + stringvalue + + + The method description goes here. + + + + + + &reftitle.parameters; + + + + value + + + Description... + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + &reftitle.examples; + + + <methodname>SolrQuery::removeFacetDateField</methodname> example + + +]]> + + &example.outputs.similar; + + + + + + + + + &reftitle.seealso; + + + Classname::Method + + + + + + + diff --git a/reference/solr/solrquery/removefacetdateother.xml b/reference/solr/solrquery/removefacetdateother.xml new file mode 100755 index 0000000000..88eedf92f9 --- /dev/null +++ b/reference/solr/solrquery/removefacetdateother.xml @@ -0,0 +1,76 @@ + + + + + + SolrQuery::removeFacetDateOther + Removes one of the facet.date.other parameters. + + + + &reftitle.description; + + publicSolrQuerySolrQuery::removeFacetDateOther + stringvalue + stringfield_override + + + Removes one of the facet.date.other parameters + + + + + + &reftitle.parameters; + + + + value + + + The value + + + + + field_override + + + The name of the field. + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + + diff --git a/reference/solr/solrquery/removefacetfield.xml b/reference/solr/solrquery/removefacetfield.xml new file mode 100755 index 0000000000..729e9c8e41 --- /dev/null +++ b/reference/solr/solrquery/removefacetfield.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::removeFacetField + Removes one of the facet.date parameters + + + + &reftitle.description; + + publicSolrQuerySolrQuery::removeFacetField + stringfield + + + Removes one of the facet.date parameters + + + + + + &reftitle.parameters; + + + + field + + + The name of the field + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/removefacetquery.xml b/reference/solr/solrquery/removefacetquery.xml new file mode 100755 index 0000000000..e64121ff23 --- /dev/null +++ b/reference/solr/solrquery/removefacetquery.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::removeFacetQuery + Removes one of the facet.query parameters + + + + &reftitle.description; + + publicSolrQuerySolrQuery::removeFacetQuery + stringvalue + + + Removes one of the facet.query parameters. + + + + + + &reftitle.parameters; + + + + value + + + The value + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/removefield.xml b/reference/solr/solrquery/removefield.xml new file mode 100755 index 0000000000..fe2a8abd19 --- /dev/null +++ b/reference/solr/solrquery/removefield.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::removeField + Removes a field from the list of fields + + + + &reftitle.description; + + publicSolrQuerySolrQuery::removeField + stringfield + + + Removes a field from the list of fields + + + + + + &reftitle.parameters; + + + + field + + + Name of the field. + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/removefilterquery.xml b/reference/solr/solrquery/removefilterquery.xml new file mode 100755 index 0000000000..edf3c42462 --- /dev/null +++ b/reference/solr/solrquery/removefilterquery.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::removeFilterQuery + Removes a filter query + + + + &reftitle.description; + + publicSolrQuerySolrQuery::removeFilterQuery + stringfq + + + Removes a filter query. + + + + + + &reftitle.parameters; + + + + fq + + + The filter query to remove + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/removehighlightfield.xml b/reference/solr/solrquery/removehighlightfield.xml new file mode 100755 index 0000000000..e7ad81a79f --- /dev/null +++ b/reference/solr/solrquery/removehighlightfield.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::removeHighlightField + Removes one of the fields used for highlighting + + + + &reftitle.description; + + publicSolrQuerySolrQuery::removeHighlightField + stringfield + + + Removes one of the fields used for highlighting. + + + + + + &reftitle.parameters; + + + + field + + + The name of the field + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/removemltfield.xml b/reference/solr/solrquery/removemltfield.xml new file mode 100755 index 0000000000..f1059484c9 --- /dev/null +++ b/reference/solr/solrquery/removemltfield.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::removeMltField + Removes one of the moreLikeThis fields + + + + &reftitle.description; + + publicSolrQuerySolrQuery::removeMltField + stringfield + + + Removes one of the moreLikeThis fields. + + + + + + &reftitle.parameters; + + + + field + + + Name of the field + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/removemltqueryfield.xml b/reference/solr/solrquery/removemltqueryfield.xml new file mode 100755 index 0000000000..a256782b83 --- /dev/null +++ b/reference/solr/solrquery/removemltqueryfield.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::removeMltQueryField + Removes one of the moreLikeThis query fields + + + + &reftitle.description; + + publicSolrQuerySolrQuery::removeMltQueryField + stringqueryField + + + Removes one of the moreLikeThis query fields. + + + + + + &reftitle.parameters; + + + + queryField + + + The query field + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/removesortfield.xml b/reference/solr/solrquery/removesortfield.xml new file mode 100755 index 0000000000..b1b3102ae9 --- /dev/null +++ b/reference/solr/solrquery/removesortfield.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::removeSortField + Removes one of the sort fields + + + + &reftitle.description; + + publicSolrQuerySolrQuery::removeSortField + stringfield + + + Removes one of the sort fields + + + + + + &reftitle.parameters; + + + + field + + + The name of the field + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/removestatsfacet.xml b/reference/solr/solrquery/removestatsfacet.xml new file mode 100755 index 0000000000..0640eafc03 --- /dev/null +++ b/reference/solr/solrquery/removestatsfacet.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::removeStatsFacet + Removes one of the stats.facet parameters + + + + &reftitle.description; + + publicSolrQuerySolrQuery::removeStatsFacet + stringvalue + + + Removes one of the stats.facet parameters + + + + + + &reftitle.parameters; + + + + value + + + The value + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/removestatsfield.xml b/reference/solr/solrquery/removestatsfield.xml new file mode 100755 index 0000000000..0732364ab5 --- /dev/null +++ b/reference/solr/solrquery/removestatsfield.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::removeStatsField + Removes one of the stats.field parameters + + + + &reftitle.description; + + publicSolrQuerySolrQuery::removeStatsField + stringfield + + + Removes one of the stats.field parameters + + + + + + &reftitle.parameters; + + + + field + + + The name of the field. + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/setechohandler.xml b/reference/solr/solrquery/setechohandler.xml new file mode 100755 index 0000000000..fcf8330ac0 --- /dev/null +++ b/reference/solr/solrquery/setechohandler.xml @@ -0,0 +1,65 @@ + + + + + + SolrQuery::setEchoHandler + Toggles the echoHandler parameter + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setEchoHandler + boolflag + + + If set to true, Solr places the name of the handle used in the response to the client for debugging purposes. + + + + + &reftitle.parameters; + + + + flag + + + &true; or &false; + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/setechoparams.xml b/reference/solr/solrquery/setechoparams.xml new file mode 100755 index 0000000000..953e001ac6 --- /dev/null +++ b/reference/solr/solrquery/setechoparams.xml @@ -0,0 +1,75 @@ + + + + + + SolrQuery::setEchoParams + Determines what kind of parameters to include in the response + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setEchoParams + stringtype + + + Instructs Solr what kinds of Request parameters should be included in the response for debugging purposes, legal values include: + + + + + + + + + + + &reftitle.parameters; + + + + type + + + The type of parameters to include + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/setexplainother.xml b/reference/solr/solrquery/setexplainother.xml new file mode 100755 index 0000000000..8d7d922943 --- /dev/null +++ b/reference/solr/solrquery/setexplainother.xml @@ -0,0 +1,65 @@ + + + + + + SolrQuery::setExplainOther + Sets the explainOther common query parameter + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setExplainOther + stringquery + + + Sets the explainOther common query parameter + + + + + &reftitle.parameters; + + + + query + + + The Lucene query to identify a set of documents + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/setfacet.xml b/reference/solr/solrquery/setfacet.xml new file mode 100755 index 0000000000..2d206cddfb --- /dev/null +++ b/reference/solr/solrquery/setfacet.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::setFacet + Maps to the facet parameter. Enables or disables facetting. + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setFacet + boolflag + + + Enables or disables faceting. + + + + + + &reftitle.parameters; + + + + value + + + &true; enables faceting and &false; disables it. + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/setfacetdateend.xml b/reference/solr/solrquery/setfacetdateend.xml new file mode 100755 index 0000000000..5cf810a727 --- /dev/null +++ b/reference/solr/solrquery/setfacetdateend.xml @@ -0,0 +1,75 @@ + + + + + + SolrQuery::setFacetDateEnd + Maps to facet.date.end + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setFacetDateEnd + stringvalue + stringfield_override + + + Maps to facet.date.end + + + + + + &reftitle.parameters; + + + + value + + + See facet.date.end + + + + + field_override + + + Name of the field + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/setfacetdategap.xml b/reference/solr/solrquery/setfacetdategap.xml new file mode 100755 index 0000000000..0c1066fff1 --- /dev/null +++ b/reference/solr/solrquery/setfacetdategap.xml @@ -0,0 +1,75 @@ + + + + + + SolrQuery::setFacetDateGap + Maps to facet.date.gap + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setFacetDateGap + stringvalue + stringfield_override + + + Maps to facet.date.gap + + + + + + &reftitle.parameters; + + + + value + + + See facet.date.gap + + + + + field_override + + + The name of the field + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/setfacetdatehardend.xml b/reference/solr/solrquery/setfacetdatehardend.xml new file mode 100755 index 0000000000..7ed1dae162 --- /dev/null +++ b/reference/solr/solrquery/setfacetdatehardend.xml @@ -0,0 +1,75 @@ + + + + + + SolrQuery::setFacetDateHardEnd + Maps to facet.date.hardend + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setFacetDateHardEnd + stringvalue + stringfield_override + + + Maps to facet.date.hardend + + + + + + &reftitle.parameters; + + + + value + + + See facet.date.hardend + + + + + field_override + + + The name of the field + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/setfacetdatestart.xml b/reference/solr/solrquery/setfacetdatestart.xml new file mode 100755 index 0000000000..71064e4b22 --- /dev/null +++ b/reference/solr/solrquery/setfacetdatestart.xml @@ -0,0 +1,74 @@ + + + + + + SolrQuery::setFacetDateStart + Maps to facet.date.start + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setFacetDateStart + stringvalue + stringfield_override + + + Maps to facet.date.start + + + + + &reftitle.parameters; + + + + value + + + See facet.date.start + + + + + field_override + + + The name of the field. + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/setfacetenumcachemindefaultfrequency.xml b/reference/solr/solrquery/setfacetenumcachemindefaultfrequency.xml new file mode 100755 index 0000000000..b7f4cffd93 --- /dev/null +++ b/reference/solr/solrquery/setfacetenumcachemindefaultfrequency.xml @@ -0,0 +1,74 @@ + + + + + + SolrQuery::setFacetEnumCacheMinDefaultFrequency + Sets the minimum document frequency used for determining term count + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setFacetEnumCacheMinDefaultFrequency + intfrequency + stringfield_override + + + Sets the minimum document frequency used for determining term count + + + + + &reftitle.parameters; + + + + value + + + The minimum frequency + + + + + field_override + + + The name of the field. + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/setfacetlimit.xml b/reference/solr/solrquery/setfacetlimit.xml new file mode 100755 index 0000000000..5118ca2398 --- /dev/null +++ b/reference/solr/solrquery/setfacetlimit.xml @@ -0,0 +1,75 @@ + + + + + + SolrQuery::setFacetLimit + Maps to facet.limit + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setFacetLimit + intlimit + stringfield_override + + + Maps to facet.limit. Sets the maximum number of constraint counts that should be returned for the facet fields. + + + + + + &reftitle.parameters; + + + + limit + + + The maximum number of constraint counts + + + + + field_override + + + The name of the field. + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/setfacetmethod.xml b/reference/solr/solrquery/setfacetmethod.xml new file mode 100755 index 0000000000..ec6480dc28 --- /dev/null +++ b/reference/solr/solrquery/setfacetmethod.xml @@ -0,0 +1,75 @@ + + + + + + SolrQuery::setFacetMethod + Specifies the type of algorithm to use when faceting a field + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setFacetMethod + stringmethod + stringfield_override + + + Specifies the type of algorithm to use when faceting a field. This method accepts optional field override. + + + + + + &reftitle.parameters; + + + + method + + + The method to use. + + + + + field_override + + + The name of the field. + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/setfacetmincount.xml b/reference/solr/solrquery/setfacetmincount.xml new file mode 100755 index 0000000000..c903cabc73 --- /dev/null +++ b/reference/solr/solrquery/setfacetmincount.xml @@ -0,0 +1,75 @@ + + + + + + SolrQuery::setFacetMinCount + Maps to facet.mincount + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setFacetMinCount + intmincount + stringfield_override + + + Sets the minimum counts for facet fields that should be included in the response + + + + + + &reftitle.parameters; + + + + mincount + + + The minimum count + + + + + field_override + + + The name of the field. + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/setfacetmissing.xml b/reference/solr/solrquery/setfacetmissing.xml new file mode 100755 index 0000000000..f1dc86a983 --- /dev/null +++ b/reference/solr/solrquery/setfacetmissing.xml @@ -0,0 +1,75 @@ + + + + + + SolrQuery::setFacetMissing + Maps to facet.missing + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setFacetMissing + boolflag + stringfield_override + + + Used to indicate that in addition to the Term-based constraints of a facet field, a count of all matching results which have no value for the field should be computed + + + + + + &reftitle.parameters; + + + + flag + + + &true; turns this feature on. &false; disables it. + + + + + field_override + + + The name of the field. + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/setfacetoffset.xml b/reference/solr/solrquery/setfacetoffset.xml new file mode 100755 index 0000000000..eb19245094 --- /dev/null +++ b/reference/solr/solrquery/setfacetoffset.xml @@ -0,0 +1,75 @@ + + + + + + SolrQuery::setFacetOffset + Sets the offset into the list of constraints to allow for pagination + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setFacetOffset + intoffset + stringfield_override + + + Sets the offset into the list of constraints to allow for pagination. + + + + + + &reftitle.parameters; + + + + offset + + + The offset + + + + + field_override + + + The name of the field. + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/setfacetprefix.xml b/reference/solr/solrquery/setfacetprefix.xml new file mode 100755 index 0000000000..a890d6088d --- /dev/null +++ b/reference/solr/solrquery/setfacetprefix.xml @@ -0,0 +1,75 @@ + + + + + + SolrQuery::setFacetPrefix + Specifies a string prefix with which to limits the terms on which to facet + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setFacetPrefix + stringprefix + stringfield_override + + + Specifies a string prefix with which to limits the terms on which to facet. + + + + + + &reftitle.parameters; + + + + prefix + + + The prefix string + + + + + field_override + + + The name of the field. + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/setfacetsort.xml b/reference/solr/solrquery/setfacetsort.xml new file mode 100755 index 0000000000..d87e76ac70 --- /dev/null +++ b/reference/solr/solrquery/setfacetsort.xml @@ -0,0 +1,75 @@ + + + + + + SolrQuery::setFacetSort + Determines the ordering of the facet field constraints + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setFacetSort + intfacetSort + stringfield_override + + + Determines the ordering of the facet field constraints + + + + + + &reftitle.parameters; + + + + facetSort + + + Use SolrQuery::FACET_SORT_INDEX for sorting by index order or SolrQuery::FACET_SORT_COUNT for sorting by count. + + + + + field_override + + + The name of the field. + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/sethighlight.xml b/reference/solr/solrquery/sethighlight.xml new file mode 100755 index 0000000000..13bf0394d8 --- /dev/null +++ b/reference/solr/solrquery/sethighlight.xml @@ -0,0 +1,67 @@ + + + + + + SolrQuery::setHighlight + Enables or disables highlighting + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setHighlight + boolflag + + + Setting it to &true; enables highlighted snippets to be generated in the query response. + + + Setting it to &false; disables highlighting + + + + &reftitle.parameters; + + + + flag + + + Enable or disable highlighting + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/sethighlightalternatefield.xml b/reference/solr/solrquery/sethighlightalternatefield.xml new file mode 100755 index 0000000000..d0c44f6e2e --- /dev/null +++ b/reference/solr/solrquery/sethighlightalternatefield.xml @@ -0,0 +1,75 @@ + + + + + + SolrQuery::setHighlightAlternateField + Specifies the backup field to use + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setHighlightAlternateField + stringfield + stringfield_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 + + + + + + &reftitle.parameters; + + + + field + + + The name of the backup field + + + + + field_override + + + The name of the field we are overriding this setting for. + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/sethighlightformatter.xml b/reference/solr/solrquery/sethighlightformatter.xml new file mode 100755 index 0000000000..6f59761996 --- /dev/null +++ b/reference/solr/solrquery/sethighlightformatter.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::setHighlightFormatter + Specify a formatter for the highlight output. + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setHighlightFormatter + stringformatter + stringfield_override + + + Specify a formatter for the highlight output. + + + + + &reftitle.parameters; + + + + formatter + + + Currently the only legal value is "simple" + + + + + field_override + + + The name of the field. + + + + + + + + + diff --git a/reference/solr/solrquery/sethighlightfragmenter.xml b/reference/solr/solrquery/sethighlightfragmenter.xml new file mode 100755 index 0000000000..fcec01ac84 --- /dev/null +++ b/reference/solr/solrquery/sethighlightfragmenter.xml @@ -0,0 +1,74 @@ + + + + + + SolrQuery::setHighlightFragmenter + Sets a text snippet generator for highlighted text + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setHighlightFragmenter + stringfragmenter + stringfield_override + + + Specify a text snippet generator for highlighted text. + + + + + &reftitle.parameters; + + + + 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. + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/sethighlightfragsize.xml b/reference/solr/solrquery/sethighlightfragsize.xml new file mode 100755 index 0000000000..f4495737c6 --- /dev/null +++ b/reference/solr/solrquery/sethighlightfragsize.xml @@ -0,0 +1,74 @@ + + + + + + SolrQuery::setHighlightFragsize + The size of fragments to consider for highlighting + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setHighlightFragsize + intsize + stringfield_override + + + Sets the size, in characters, of fragments to consider for highlighting. "0" indicates that the whole field value should be used (no fragmenting). + + + + + &reftitle.parameters; + + + + size + + + The size, in characters, of fragments to consider for highlighting + + + + + field_override + + + The name of the field. + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/sethighlighthighlightmultiterm.xml b/reference/solr/solrquery/sethighlighthighlightmultiterm.xml new file mode 100755 index 0000000000..b7d88bef1c --- /dev/null +++ b/reference/solr/solrquery/sethighlighthighlightmultiterm.xml @@ -0,0 +1,65 @@ + + + + + + SolrQuery::setHighlightHighlightMultiTerm + Use SpanScorer to highlight phrase terms + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setHighlightHighlightMultiTerm + boolflag + + + Use SpanScorer to highlight phrase terms only when they appear within the query phrase in the document. + + + + + &reftitle.parameters; + + + + flag + + + Whether or not to use SpanScorer to highlight phrase terms only when they appear within the query phrase in the document. + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/sethighlightmaxalternatefieldlength.xml b/reference/solr/solrquery/sethighlightmaxalternatefieldlength.xml new file mode 100755 index 0000000000..c17f7f1f12 --- /dev/null +++ b/reference/solr/solrquery/sethighlightmaxalternatefieldlength.xml @@ -0,0 +1,77 @@ + + + + + + SolrQuery::setHighlightMaxAlternateFieldLength + Sets the maximum number of characters of the field to return + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setHighlightMaxAlternateFieldLength + intfieldLength + stringfield_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. + + + + + &reftitle.parameters; + + + + fieldLength + + + The length of the field + + + + + field_override + + + The name of the field. + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/sethighlightmaxanalyzedchars.xml b/reference/solr/solrquery/sethighlightmaxanalyzedchars.xml new file mode 100755 index 0000000000..927ad1f96d --- /dev/null +++ b/reference/solr/solrquery/sethighlightmaxanalyzedchars.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::setHighlightMaxAnalyzedChars + Specifies the number of characters into a document to look for suitable snippets + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setHighlightMaxAnalyzedChars + intvalue + + + Specifies the number of characters into a document to look for suitable snippets + + + + + + &reftitle.parameters; + + + + value + + + The number of characters into a document to look for suitable snippets + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/sethighlightmergecontiguous.xml b/reference/solr/solrquery/sethighlightmergecontiguous.xml new file mode 100755 index 0000000000..5ae6f8db95 --- /dev/null +++ b/reference/solr/solrquery/sethighlightmergecontiguous.xml @@ -0,0 +1,75 @@ + + + + + + SolrQuery::setHighlightMergeContiguous + Whether or not to collapse contiguous fragments into a single fragment + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setHighlightMergeContiguous + boolflag + stringfield_override + + + Whether or not to collapse contiguous fragments into a single fragment + + + + + + &reftitle.parameters; + + + + value + + + Whether or not to collapse contiguous fragments into a single fragment + + + + + field_override + + + The name of the field. + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/sethighlightregexmaxanalyzedchars.xml b/reference/solr/solrquery/sethighlightregexmaxanalyzedchars.xml new file mode 100755 index 0000000000..b833d8b5e3 --- /dev/null +++ b/reference/solr/solrquery/sethighlightregexmaxanalyzedchars.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::setHighlightRegexMaxAnalyzedChars + Specify the maximum number of characters to analyze + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setHighlightRegexMaxAnalyzedChars + intmaxAnalyzedChars + + + Specify the maximum number of characters to analyze from a field when using the regex fragmenter + + + + + + &reftitle.parameters; + + + + maxAnalyzedChars + + + The maximum number of characters to analyze from a field when using the regex fragmenter + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/sethighlightregexpattern.xml b/reference/solr/solrquery/sethighlightregexpattern.xml new file mode 100755 index 0000000000..78a6ef349f --- /dev/null +++ b/reference/solr/solrquery/sethighlightregexpattern.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::setHighlightRegexPattern + Specify the regular expression for fragmenting + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setHighlightRegexPattern + stringvalue + + + Specifies the regular expression for fragmenting. This could be used to extract sentences + + + + + + &reftitle.parameters; + + + + value + + + The regular expression for fragmenting. This could be used to extract sentences + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/sethighlightregexslop.xml b/reference/solr/solrquery/sethighlightregexslop.xml new file mode 100755 index 0000000000..1192759c3d --- /dev/null +++ b/reference/solr/solrquery/sethighlightregexslop.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::setHighlightRegexSlop + Sets the factor by which the regex fragmenter can stray from the ideal fragment size + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setHighlightRegexSlop + floatfactor + + + The factor by which the regex fragmenter can stray from the ideal fragment size ( specfied by SolrQuery::setHighlightFragsize )to accomodate the regular expression + + + + + + &reftitle.parameters; + + + + factor + + + The factor by which the regex fragmenter can stray from the ideal fragment size + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/sethighlightrequirefieldmatch.xml b/reference/solr/solrquery/sethighlightrequirefieldmatch.xml new file mode 100755 index 0000000000..fb63c6dae8 --- /dev/null +++ b/reference/solr/solrquery/sethighlightrequirefieldmatch.xml @@ -0,0 +1,68 @@ + + + + + + SolrQuery::setHighlightRequireFieldMatch + Require field matching during highlighting + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setHighlightRequireFieldMatch + boolflag + + + If &true;, then a field will only be highlighted if the query matched in this particular field. + + + This will only work if SolrQuery::setHighlightUsePhraseHighlighter() was set to &true; + + + + + &reftitle.parameters; + + + + flag + + + &true; or &false; + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/sethighlightsimplepost.xml b/reference/solr/solrquery/sethighlightsimplepost.xml new file mode 100755 index 0000000000..ce5e5b9f9a --- /dev/null +++ b/reference/solr/solrquery/sethighlightsimplepost.xml @@ -0,0 +1,69 @@ + + + + + + SolrQuery::setHighlightSimplePost + Sets the text which appears after a highlighted term + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setHighlightSimplePost + stringsimplePost + stringfield_override + + + Sets the text which appears before a highlighted term + + + + + + &reftitle.parameters; + + + + simplePost + + + Sets the text which appears after a highlighted term + + ]]> + + + + field_override + + + The name of the field. + + + + + + + + + + diff --git a/reference/solr/solrquery/sethighlightsimplepre.xml b/reference/solr/solrquery/sethighlightsimplepre.xml new file mode 100755 index 0000000000..6bedc7d396 --- /dev/null +++ b/reference/solr/solrquery/sethighlightsimplepre.xml @@ -0,0 +1,75 @@ + + + + + + SolrQuery::setHighlightSimplePre + Sets the text which appears before a highlighted term + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setHighlightSimplePre + stringsimplePre + stringfield_override + + + Sets the text which appears before a highlighted term + + ]]> + + + + &reftitle.parameters; + + + + simplePre + + + The text which appears before a highlighted term + + + + + field_override + + + The name of the field. + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/sethighlightsnippets.xml b/reference/solr/solrquery/sethighlightsnippets.xml new file mode 100755 index 0000000000..c0aa139677 --- /dev/null +++ b/reference/solr/solrquery/sethighlightsnippets.xml @@ -0,0 +1,75 @@ + + + + + + SolrQuery::setHighlightSnippets + Sets the maximum number of highlighted snippets to generate per field + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setHighlightSnippets + intvalue + stringfield_override + + + Sets the maximum number of highlighted snippets to generate per field + + + + + + &reftitle.parameters; + + + + value + + + The maximum number of highlighted snippets to generate per field + + + + + field_override + + + The name of the field. + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/sethighlightusephrasehighlighter.xml b/reference/solr/solrquery/sethighlightusephrasehighlighter.xml new file mode 100755 index 0000000000..27a30cbc73 --- /dev/null +++ b/reference/solr/solrquery/sethighlightusephrasehighlighter.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::setHighlightUsePhraseHighlighter + Whether to highlight phrase terms only when they appear within the query phrase + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setHighlightUsePhraseHighlighter + boolflag + + + Sets whether or not to use SpanScorer to highlight phrase terms only when they appear within the query phrase in the document + + + + + + &reftitle.parameters; + + + + value + + + Whether or not to use SpanScorer to highlight phrase terms only when they appear within the query phrase in the document + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/setmlt.xml b/reference/solr/solrquery/setmlt.xml new file mode 100755 index 0000000000..9c4a21a279 --- /dev/null +++ b/reference/solr/solrquery/setmlt.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::setMlt + Enables or disables moreLikeThis + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setMlt + boolflag + + + Enables or disables moreLikeThis + + + + + + &reftitle.parameters; + + + + flag + + + &true; enables it and &false; turns it off. + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/setmltboost.xml b/reference/solr/solrquery/setmltboost.xml new file mode 100755 index 0000000000..6e2208ba53 --- /dev/null +++ b/reference/solr/solrquery/setmltboost.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::setMltBoost + Set if the query will be boosted by the interesting term relevance + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setMltBoost + boolflag + + + Set if the query will be boosted by the interesting term relevance + + + + + + &reftitle.parameters; + + + + value + + + Sets to &true; or &false; + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/setmltcount.xml b/reference/solr/solrquery/setmltcount.xml new file mode 100755 index 0000000000..b2090614dd --- /dev/null +++ b/reference/solr/solrquery/setmltcount.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::setMltCount + Set the number of similar documents to return for each result + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setMltCount + intcount + + + Set the number of similar documents to return for each result + + + + + + &reftitle.parameters; + + + + count + + + The number of similar documents to return for each result + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/setmltmaxnumqueryterms.xml b/reference/solr/solrquery/setmltmaxnumqueryterms.xml new file mode 100755 index 0000000000..f2c16d7ede --- /dev/null +++ b/reference/solr/solrquery/setmltmaxnumqueryterms.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::setMltMaxNumQueryTerms + Sets the maximum number of query terms included + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setMltMaxNumQueryTerms + intvalue + + + Sets the maximum number of query terms that will be included in any generated query. + + + + + + &reftitle.parameters; + + + + value + + + The maximum number of query terms that will be included in any generated query + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/setmltmaxnumtokens.xml b/reference/solr/solrquery/setmltmaxnumtokens.xml new file mode 100755 index 0000000000..0cf0acc806 --- /dev/null +++ b/reference/solr/solrquery/setmltmaxnumtokens.xml @@ -0,0 +1,65 @@ + + + + + + SolrQuery::setMltMaxNumTokens + Specifies the maximum number of tokens to parse + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setMltMaxNumTokens + intvalue + + + Specifies the maximum number of tokens to parse in each example doc field that is not stored with TermVector support. + + + + + &reftitle.parameters; + + + + value + + + The maximum number of tokens to parse + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/setmltmaxwordlength.xml b/reference/solr/solrquery/setmltmaxwordlength.xml new file mode 100755 index 0000000000..67df954694 --- /dev/null +++ b/reference/solr/solrquery/setmltmaxwordlength.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::setMltMaxWordLength + Sets the maximum word length + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setMltMaxWordLength + intmaxWordLength + + + Sets the maximum word length above which words will be ignored. + + + + + + &reftitle.parameters; + + + + maxWordLength + + + The maximum word length above which words will be ignored + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/setmltmindocfrequency.xml b/reference/solr/solrquery/setmltmindocfrequency.xml new file mode 100755 index 0000000000..97715b333b --- /dev/null +++ b/reference/solr/solrquery/setmltmindocfrequency.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::setMltMinDocFrequency + Sets the mltMinDoc frequency + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setMltMinDocFrequency + intminDocFrequency + + + The frequency at which words will be ignored which do not occur in at least this many docs. + + + + + + &reftitle.parameters; + + + + minDocFrequency + + + Sets the frequency at which words will be ignored which do not occur in at least this many docs. + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/setmltmintermfrequency.xml b/reference/solr/solrquery/setmltmintermfrequency.xml new file mode 100755 index 0000000000..ad2b0df057 --- /dev/null +++ b/reference/solr/solrquery/setmltmintermfrequency.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::setMltMinTermFrequency + Sets the frequency below which terms will be ignored in the source docs + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setMltMinTermFrequency + intminTermFrequency + + + Sets the frequency below which terms will be ignored in the source docs + + + + + + &reftitle.parameters; + + + + minTermFrequency + + + The frequency below which terms will be ignored in the source docs + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/setmltminwordlength.xml b/reference/solr/solrquery/setmltminwordlength.xml new file mode 100755 index 0000000000..1a4ead093e --- /dev/null +++ b/reference/solr/solrquery/setmltminwordlength.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::setMltMinWordLength + Sets the minimum word length + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setMltMinWordLength + intminWordLength + + + Sets the minimum word length below which words will be ignored. + + + + + + &reftitle.parameters; + + + + minWordLength + + + The minimum word length below which words will be ignored + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/setomitheader.xml b/reference/solr/solrquery/setomitheader.xml new file mode 100755 index 0000000000..a0f97168e0 --- /dev/null +++ b/reference/solr/solrquery/setomitheader.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::setOmitHeader + Exclude the header from the returned results. + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setOmitHeader + boolflag + + + Exclude the header from the returned results. + + + + + + &reftitle.parameters; + + + + flag + + + &true; excludes the header from the result. + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/setquery.xml b/reference/solr/solrquery/setquery.xml new file mode 100755 index 0000000000..d99988a75f --- /dev/null +++ b/reference/solr/solrquery/setquery.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::setQuery + Sets the search query + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setQuery + stringquery + + + Sets the search query. + + + + + + &reftitle.parameters; + + + + query + + + The search query + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object + + + + + + diff --git a/reference/solr/solrquery/setrows.xml b/reference/solr/solrquery/setrows.xml new file mode 100755 index 0000000000..bfe5421ad8 --- /dev/null +++ b/reference/solr/solrquery/setrows.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::setRows + Specifies the maximum number of rows to return in the result + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setRows + introws + + + Specifies the maximum number of rows to return in the result + + + + + + &reftitle.parameters; + + + + rows + + + The maximum number of rows to return + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object. + + + + + + diff --git a/reference/solr/solrquery/setshowdebuginfo.xml b/reference/solr/solrquery/setshowdebuginfo.xml new file mode 100755 index 0000000000..8b96120521 --- /dev/null +++ b/reference/solr/solrquery/setshowdebuginfo.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::setShowDebugInfo + Flag to show debug information + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setShowDebugInfo + boolflag + + + Whether to show debug info + + + + + + &reftitle.parameters; + + + + flag + + + Whether to show debug info. &true; or &false; + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/setstart.xml b/reference/solr/solrquery/setstart.xml new file mode 100755 index 0000000000..f10278a77c --- /dev/null +++ b/reference/solr/solrquery/setstart.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::setStart + Specifies the number of rows to skip + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setStart + intstart + + + Specifies the number of rows to skip. Useful in pagination of results. + + + + + + &reftitle.parameters; + + + + start + + + The number of rows to skip. + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object. + + + + + + diff --git a/reference/solr/solrquery/setstats.xml b/reference/solr/solrquery/setstats.xml new file mode 100755 index 0000000000..bd994afb1c --- /dev/null +++ b/reference/solr/solrquery/setstats.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::setStats + Enables or disables the Stats component + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setStats + boolflag + + + Enables or disables the Stats component. + + + + + + &reftitle.parameters; + + + + flag + + + &true; turns on the stats component and &false; disables it. + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/setterms.xml b/reference/solr/solrquery/setterms.xml new file mode 100755 index 0000000000..578dff2388 --- /dev/null +++ b/reference/solr/solrquery/setterms.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::setTerms + Enables or disables the TermsComponent + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setTerms + boolflag + + + Enables or disables the TermsComponent + + + + + + &reftitle.parameters; + + + + flag + + + &true; enables it. &false; turns it off + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/settermsfield.xml b/reference/solr/solrquery/settermsfield.xml new file mode 100755 index 0000000000..111e7463d8 --- /dev/null +++ b/reference/solr/solrquery/settermsfield.xml @@ -0,0 +1,65 @@ + + + + + + SolrQuery::setTermsField + Sets the name of the field to get the Terms from + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setTermsField + stringfieldname + + + Sets the name of the field to get the terms from + + + + + &reftitle.parameters; + + + + fieldname + + + The field name + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/settermsincludelowerbound.xml b/reference/solr/solrquery/settermsincludelowerbound.xml new file mode 100755 index 0000000000..405fb9b399 --- /dev/null +++ b/reference/solr/solrquery/settermsincludelowerbound.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::setTermsIncludeLowerBound + Include the lower bound term in the result set + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setTermsIncludeLowerBound + boolflag + + + Include the lower bound term in the result set. + + + + + + &reftitle.parameters; + + + + flag + + + Include the lower bound term in the result set + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/settermsincludeupperbound.xml b/reference/solr/solrquery/settermsincludeupperbound.xml new file mode 100755 index 0000000000..bc424847fb --- /dev/null +++ b/reference/solr/solrquery/settermsincludeupperbound.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::setTermsIncludeUpperBound + Include the upper bound term in the result set + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setTermsIncludeUpperBound + boolflag + + + Include the upper bound term in the result set. + + + + + + &reftitle.parameters; + + + + flag + + + &true; or &false; + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/settermslimit.xml b/reference/solr/solrquery/settermslimit.xml new file mode 100755 index 0000000000..4fbf2ec17b --- /dev/null +++ b/reference/solr/solrquery/settermslimit.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::setTermsLimit + Sets the maximum number of terms to return + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setTermsLimit + intlimit + + + Sets the maximum number of terms to return + + + + + + &reftitle.parameters; + + + + limit + + + The maximum number of terms to return. All the terms will be returned if the limit is negative. + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/settermslowerbound.xml b/reference/solr/solrquery/settermslowerbound.xml new file mode 100755 index 0000000000..6ddaf7e26c --- /dev/null +++ b/reference/solr/solrquery/settermslowerbound.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::setTermsLowerBound + Specifies the Term to start from + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setTermsLowerBound + stringlowerBound + + + Specifies the Term to start from + + + + + + &reftitle.parameters; + + + + lowerBound + + + The lower bound Term + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/settermsmaxcount.xml b/reference/solr/solrquery/settermsmaxcount.xml new file mode 100755 index 0000000000..cebf32108f --- /dev/null +++ b/reference/solr/solrquery/settermsmaxcount.xml @@ -0,0 +1,65 @@ + + + + + + SolrQuery::setTermsMaxCount + Sets the maximum document frequency + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setTermsMaxCount + intfrequency + + + Sets the maximum document frequency. + + + + + &reftitle.parameters; + + + + frequency + + + The maximum document frequency. + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/settermsmincount.xml b/reference/solr/solrquery/settermsmincount.xml new file mode 100755 index 0000000000..a4802ee5f3 --- /dev/null +++ b/reference/solr/solrquery/settermsmincount.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::setTermsMinCount + Sets the minimum document frequency + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setTermsMinCount + intfrequency + + + Sets the minimum doc frequency to return in order to be included + + + + + + &reftitle.parameters; + + + + frequency + + + The minimum frequency + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/settermsprefix.xml b/reference/solr/solrquery/settermsprefix.xml new file mode 100755 index 0000000000..69916d2171 --- /dev/null +++ b/reference/solr/solrquery/settermsprefix.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::setTermsPrefix + Restrict matches to terms that start with the prefix + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setTermsPrefix + stringprefix + + + Restrict matches to terms that start with the prefix + + + + + + &reftitle.parameters; + + + + prefix + + + Restrict matches to terms that start with the prefix + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/settermsreturnraw.xml b/reference/solr/solrquery/settermsreturnraw.xml new file mode 100755 index 0000000000..cf81388779 --- /dev/null +++ b/reference/solr/solrquery/settermsreturnraw.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::setTermsReturnRaw + Return the raw characters of the indexed term + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setTermsReturnRaw + boolflag + + + If true, return the raw characters of the indexed term, regardless of if it is human readable + + + + + + &reftitle.parameters; + + + + value + + + &true; or &false; + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/settermssort.xml b/reference/solr/solrquery/settermssort.xml new file mode 100755 index 0000000000..245b25b161 --- /dev/null +++ b/reference/solr/solrquery/settermssort.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::setTermsSort + Specifies how to sort the returned terms + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setTermsSort + intsortType + + + If SolrQuery::TERMS_SORT_COUNT, sorts the terms by the term frequency (highest count first). If SolrQuery::TERMS_SORT_INDEX, returns the terms in index order + + + + + + &reftitle.parameters; + + + + sortType + + + SolrQuery::TERMS_SORT_INDEX or SolrQuery::TERMS_SORT_COUNT + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/settermsupperbound.xml b/reference/solr/solrquery/settermsupperbound.xml new file mode 100755 index 0000000000..5a8a0710af --- /dev/null +++ b/reference/solr/solrquery/settermsupperbound.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::setTermsUpperBound + Sets the term to stop at + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setTermsUpperBound + stringupperBound + + + Sets the term to stop at + + + + + + &reftitle.parameters; + + + + upperBound + + + The term to stop at + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrquery/settimeallowed.xml b/reference/solr/solrquery/settimeallowed.xml new file mode 100755 index 0000000000..022d58cf6a --- /dev/null +++ b/reference/solr/solrquery/settimeallowed.xml @@ -0,0 +1,66 @@ + + + + + + SolrQuery::setTimeAllowed + The time allowed for search to finish + + + + &reftitle.description; + + publicSolrQuerySolrQuery::setTimeAllowed + inttimeAllowed + + + The time allowed for a search to finish. This value only applies to the search and not to requests in general. Time is in milliseconds. Values less than or equal to zero implies no time restriction. Partial results may be returned, if there are any. + + + + + + &reftitle.parameters; + + + + timeAllowed + + + The time allowed for a search to finish. + + + + + + + + + &reftitle.returnvalues; + + Returns the current SolrQuery object, if the return value is used. + + + + + + diff --git a/reference/solr/solrqueryresponse.xml b/reference/solr/solrqueryresponse.xml new file mode 100755 index 0000000000..3f38e54848 --- /dev/null +++ b/reference/solr/solrqueryresponse.xml @@ -0,0 +1,190 @@ + + + + + + The SolrQueryResponse class + SolrQueryResponse + + + + +
+ &reftitle.intro; + + Represents a response to a query request. + +
+ + +
+ &reftitle.classsynopsis; + + + + SolrQueryResponse + + + + + final + SolrQueryResponse + + + + extends + SolrResponse + + + + Constants + + const + integer + SolrQueryResponse::PARSE_SOLR_OBJ + 0 + + + const + integer + SolrQueryResponse::PARSE_SOLR_DOC + 1 + + + Properties + + + Methods + + + Inherited methods + + + + + +
+ + + +
+ &reftitle.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. + + + +
+ + + + +
+ &reftitle.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. + + + + +
+
+ + + + + + &reference.solr.entities.solrqueryresponse; + + + + diff --git a/reference/solr/solrqueryresponse/construct.xml b/reference/solr/solrqueryresponse/construct.xml new file mode 100755 index 0000000000..3379bbfcce --- /dev/null +++ b/reference/solr/solrqueryresponse/construct.xml @@ -0,0 +1,54 @@ + + + + + + SolrQueryResponse::__construct + Constructor + + + + &reftitle.description; + + SolrQueryResponse::__construct + + + + Constructor + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + None + + + + + + diff --git a/reference/solr/solrqueryresponse/destruct.xml b/reference/solr/solrqueryresponse/destruct.xml new file mode 100755 index 0000000000..2d220788cb --- /dev/null +++ b/reference/solr/solrqueryresponse/destruct.xml @@ -0,0 +1,55 @@ + + + + + + SolrQueryResponse::__destruct + Destructor + + + + &reftitle.description; + + public voidSolrQueryResponse::__destruct + + + + Destructor. + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + None + + + + + + diff --git a/reference/solr/solrresponse.xml b/reference/solr/solrresponse.xml new file mode 100755 index 0000000000..e1dc6be1cf --- /dev/null +++ b/reference/solr/solrresponse.xml @@ -0,0 +1,231 @@ + + + + + + The SolrResponse class + SolrResponse + + + + +
+ &reftitle.intro; + + Represents a response from the Solr server. + +
+ + +
+ &reftitle.classsynopsis; + + + + SolrResponse + + + + + abstract + 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 + + + + +
+ + + +
+ &reftitle.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. + + + +
+ + + + +
+ &reftitle.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. + + + + +
+
+ + + + + + &reference.solr.entities.solrresponse; + + + + diff --git a/reference/solr/solrresponse/getdigestedresponse.xml b/reference/solr/solrresponse/getdigestedresponse.xml new file mode 100755 index 0000000000..87c63eaad3 --- /dev/null +++ b/reference/solr/solrresponse/getdigestedresponse.xml @@ -0,0 +1,54 @@ + + + + + + SolrResponse::getDigestedResponse + Returns the XML response as serialized PHP data + + + + &reftitle.description; + + public stringSolrResponse::getDigestedResponse + + + + Returns the XML response as serialized PHP data + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns the XML response as serialized PHP data + + + + + + diff --git a/reference/solr/solrresponse/gethttpstatus.xml b/reference/solr/solrresponse/gethttpstatus.xml new file mode 100755 index 0000000000..6b8c26387f --- /dev/null +++ b/reference/solr/solrresponse/gethttpstatus.xml @@ -0,0 +1,55 @@ + + + + + + SolrResponse::getHttpStatus + Returns the HTTP status of the response + + + + &reftitle.description; + + public intSolrResponse::getHttpStatus + + + + Returns the HTTP status of the response. + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns the HTTP status of the response. + + + + + + diff --git a/reference/solr/solrresponse/gethttpstatusmessage.xml b/reference/solr/solrresponse/gethttpstatusmessage.xml new file mode 100755 index 0000000000..fcf48bf8f8 --- /dev/null +++ b/reference/solr/solrresponse/gethttpstatusmessage.xml @@ -0,0 +1,55 @@ + + + + + + SolrResponse::getHttpStatusMessage + Returns more details on the HTTP status + + + + &reftitle.description; + + public stringSolrResponse::getHttpStatusMessage + + + + Returns more details on the HTTP status. + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns more details on the HTTP status + + + + + + diff --git a/reference/solr/solrresponse/getrawrequest.xml b/reference/solr/solrresponse/getrawrequest.xml new file mode 100755 index 0000000000..f4c6ece2de --- /dev/null +++ b/reference/solr/solrresponse/getrawrequest.xml @@ -0,0 +1,55 @@ + + + + + + SolrResponse::getRawRequest + Returns the raw request sent to the Solr server + + + + &reftitle.description; + + public stringSolrResponse::getRawRequest + + + + Returns the raw request sent to the Solr server. + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns the raw request sent to the Solr server + + + + + + diff --git a/reference/solr/solrresponse/getrawrequestheaders.xml b/reference/solr/solrresponse/getrawrequestheaders.xml new file mode 100755 index 0000000000..6a941ca365 --- /dev/null +++ b/reference/solr/solrresponse/getrawrequestheaders.xml @@ -0,0 +1,55 @@ + + + + + + SolrResponse::getRawRequestHeaders + Returns the raw request headers sent to the Solr server + + + + &reftitle.description; + + public stringSolrResponse::getRawRequestHeaders + + + + Returns the raw request headers sent to the Solr server. + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns the raw request headers sent to the Solr server + + + + + + diff --git a/reference/solr/solrresponse/getrawresponse.xml b/reference/solr/solrresponse/getrawresponse.xml new file mode 100755 index 0000000000..1dd2ac6053 --- /dev/null +++ b/reference/solr/solrresponse/getrawresponse.xml @@ -0,0 +1,55 @@ + + + + + + SolrResponse::getRawResponse + Returns the raw response from the server. + + + + &reftitle.description; + + public stringSolrResponse::getRawResponse + + + + Returns the raw response from the server. + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns the raw response from the server. + + + + + + diff --git a/reference/solr/solrresponse/getrawresponseheaders.xml b/reference/solr/solrresponse/getrawresponseheaders.xml new file mode 100755 index 0000000000..072cf8a01c --- /dev/null +++ b/reference/solr/solrresponse/getrawresponseheaders.xml @@ -0,0 +1,55 @@ + + + + + + SolrResponse::getRawResponseHeaders + Returns the raw response headers from the server + + + + &reftitle.description; + + public stringSolrResponse::getRawResponseHeaders + + + + Returns the raw response headers from the server. + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns the raw response headers from the server. + + + + + + diff --git a/reference/solr/solrresponse/getrequesturl.xml b/reference/solr/solrresponse/getrequesturl.xml new file mode 100755 index 0000000000..9757405b1e --- /dev/null +++ b/reference/solr/solrresponse/getrequesturl.xml @@ -0,0 +1,54 @@ + + + + + + SolrResponse::getRequestUrl + Returns the full URL the request was sent to + + + + &reftitle.description; + + public stringSolrResponse::getRequestUrl + + + + Returns the full URL the request was sent to. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns the full URL the request was sent to + + + + + + diff --git a/reference/solr/solrresponse/getresponse.xml b/reference/solr/solrresponse/getresponse.xml new file mode 100755 index 0000000000..316dcb6b46 --- /dev/null +++ b/reference/solr/solrresponse/getresponse.xml @@ -0,0 +1,54 @@ + + + + + + SolrResponse::getResponse + Returns a SolrObject representing the XML response from the server + + + + &reftitle.description; + + public SolrObjectSolrResponse::getResponse + + + + Returns a SolrObject representing the XML response from the server. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns a SolrObject representing the XML response from the server + + + + + + diff --git a/reference/solr/solrresponse/setparsemode.xml b/reference/solr/solrresponse/setparsemode.xml new file mode 100755 index 0000000000..7e976a443f --- /dev/null +++ b/reference/solr/solrresponse/setparsemode.xml @@ -0,0 +1,66 @@ + + + + + + SolrResponse::setParseMode + Sets the parse mode. + + + + &reftitle.description; + + public boolSolrResponse::setParseMode + intparser_mode + + + The method description goes here. + + + + + + &reftitle.parameters; + + + + parser_mode + + + SolrResponse::PARSE_SOLR_DOC parses documents in SolrDocument instances. SolrResponse::PARSE_SOLR_OBJ parses document into SolrObjects. + + + + + + + + + &reftitle.returnvalues; + + Returns &true; on success and &false; on failure. + + + + + + diff --git a/reference/solr/solrresponse/success.xml b/reference/solr/solrresponse/success.xml new file mode 100755 index 0000000000..437e0f5fb4 --- /dev/null +++ b/reference/solr/solrresponse/success.xml @@ -0,0 +1,55 @@ + + + + + + SolrResponse::success + Was the request a success + + + + &reftitle.description; + + public boolSolrResponse::success + + + + Used to check if the request to the server was successful. + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns &true; if it was successful and &false; if it was not. + + + + + + diff --git a/reference/solr/solrupdateresponse.xml b/reference/solr/solrupdateresponse.xml new file mode 100755 index 0000000000..aa5b5587c8 --- /dev/null +++ b/reference/solr/solrupdateresponse.xml @@ -0,0 +1,190 @@ + + + + + + The SolrUpdateResponse class + SolrUpdateResponse + + + + +
+ &reftitle.intro; + + Represents a response to an update request. + +
+ + +
+ &reftitle.classsynopsis; + + + + SolrUpdateResponse + + + + + final + SolrUpdateResponse + + + + extends + SolrResponse + + + + Constants + + const + integer + SolrUpdateResponse::PARSE_SOLR_OBJ + 0 + + + const + integer + SolrUpdateResponse::PARSE_SOLR_DOC + 1 + + + Properties + + + Methods + + + Inherited methods + + + + + +
+ + + +
+ &reftitle.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. + + + +
+ + + + +
+ &reftitle.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. + + + + +
+
+ + + + + + &reference.solr.entities.solrupdateresponse; + + + + diff --git a/reference/solr/solrupdateresponse/construct.xml b/reference/solr/solrupdateresponse/construct.xml new file mode 100755 index 0000000000..abfca243b4 --- /dev/null +++ b/reference/solr/solrupdateresponse/construct.xml @@ -0,0 +1,55 @@ + + + + + + SolrUpdateResponse::__construct + Constructor + + + + &reftitle.description; + + SolrUpdateResponse::__construct + + + + Constructor + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + None + + + + + + diff --git a/reference/solr/solrupdateresponse/destruct.xml b/reference/solr/solrupdateresponse/destruct.xml new file mode 100755 index 0000000000..dcf2e2ab8d --- /dev/null +++ b/reference/solr/solrupdateresponse/destruct.xml @@ -0,0 +1,57 @@ + + + + + + SolrUpdateResponse::__destruct + Destructor + + + + &reftitle.description; + + public voidSolrUpdateResponse::__destruct + + + + Destructor + + + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + None + + + + + + diff --git a/reference/solr/solrutils.xml b/reference/solr/solrutils.xml new file mode 100755 index 0000000000..d13513bc1d --- /dev/null +++ b/reference/solr/solrutils.xml @@ -0,0 +1,69 @@ + + + + + + The SolrUtils class + SolrUtils + + + + +
+ &reftitle.intro; + + Contains utility methods for retrieving the current extension version and preparing query phrases. + + Also contains method for escaping query strings and parsing XML responses. +
+ + +
+ &reftitle.classsynopsis; + + + + SolrUtils + + + + + abstract + SolrUtils + + + + + Methods + + + + +
+ + + + &reference.solr.entities.solrutils; + + + + diff --git a/reference/solr/solrutils/digestxmlresponse.xml b/reference/solr/solrutils/digestxmlresponse.xml new file mode 100755 index 0000000000..933fe1701f --- /dev/null +++ b/reference/solr/solrutils/digestxmlresponse.xml @@ -0,0 +1,80 @@ + + + + + + SolrUtils::digestXmlResponse + Parses an response XML string into a SolrObject. + + + + &reftitle.description; + + public static SolrObjectSolrUtils::digestXmlResponse + stringxmlresponse + intparse_mode + + + This method parses an response XML string from the Apache Solr server into a SolrObject. It throws a SolrException if there was an error. + + + + + + &reftitle.parameters; + + + + xmlresponse + + + The XML response string from the Solr server. + + + + + parse_mode + + + Use SolrResponse::PARSE_SOLR_OBJ or SolrResponse::PARSE_SOLR_DOC + + + + + + + + + &reftitle.returnvalues; + + 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. + + + + + + diff --git a/reference/solr/solrutils/escapequerychars.xml b/reference/solr/solrutils/escapequerychars.xml new file mode 100755 index 0000000000..1351e6e859 --- /dev/null +++ b/reference/solr/solrutils/escapequerychars.xml @@ -0,0 +1,75 @@ + + + + + + SolrUtils::escapeQueryChars + Escapes a lucene query string + + + + &reftitle.description; + + public static stringSolrUtils::escapeQueryChars + stringstr + + + Lucene supports escaping special characters that are part of the query syntax. + + + The current list special characters are: + + + These characters are part of the query syntax and must be escaped + + + + + &reftitle.parameters; + + + + str + + + This is the query string to be escaped. + + + + + + + + + &reftitle.returnvalues; + + Returns the escaped string or &false; on failure. + + + + + + diff --git a/reference/solr/solrutils/getsolrversion.xml b/reference/solr/solrutils/getsolrversion.xml new file mode 100755 index 0000000000..4dc1273b76 --- /dev/null +++ b/reference/solr/solrutils/getsolrversion.xml @@ -0,0 +1,55 @@ + + + + + + SolrUtils::getSolrVersion + Returns the current version of the Solr extension + + + + &reftitle.description; + + public static stringSolrUtils::getSolrVersion + + + + Returns the current Solr version. + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + The current version of the Apache Solr extension. + + + + + + diff --git a/reference/solr/solrutils/queryphrase.xml b/reference/solr/solrutils/queryphrase.xml new file mode 100755 index 0000000000..423b4cf873 --- /dev/null +++ b/reference/solr/solrutils/queryphrase.xml @@ -0,0 +1,66 @@ + + + + + + SolrUtils::queryPhrase + Prepares a phrase from an unescaped lucene string. + + + + &reftitle.description; + + public static stringSolrUtils::queryPhrase + stringstr + + + Prepares a phrase from an unescaped lucene string. + + + + + + &reftitle.parameters; + + + + str + + + The lucene phrase. + + + + + + + + + &reftitle.returnvalues; + + Returns the phrase contained in double quotes. + + + + + + diff --git a/reference/solr/versions.xml b/reference/solr/versions.xml new file mode 100755 index 0000000000..7e46f20376 --- /dev/null +++ b/reference/solr/versions.xml @@ -0,0 +1,335 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +