BlueSpice MediaWiki master
 All Classes Namespaces Files Functions Variables Groups Pages
Solarium\QueryType\Select\Result\Result Class Reference
Inheritance diagram for Solarium\QueryType\Select\Result\Result:
Collaboration diagram for Solarium\QueryType\Select\Result\Result:

Public Member Functions

 getStatus ()
 
 getQueryTime ()
 
 getNumFound ()
 
 getMaxScore ()
 
 getDocuments ()
 
 getIterator ()
 
 count ()
 
 getComponents ()
 
 getComponent ($key)
 
 getMoreLikeThis ()
 
 getHighlighting ()
 
 getGrouping ()
 
 getFacetSet ()
 
 getSpellcheck ()
 
 getStats ()
 
 getDebug ()
 
- Public Member Functions inherited from Solarium\Core\Query\Result\Result
 __construct ($client, $query, $response)
 
 getResponse ()
 
 getQuery ()
 
 getData ()
 

Protected Attributes

 $numfound
 
 $maxscore
 
 $documents
 
 $components
 
 $status
 
 $queryTime
 
- Protected Attributes inherited from Solarium\Core\Query\Result\QueryType
 $parsed = false
 
- Protected Attributes inherited from Solarium\Core\Query\Result\Result
 $response
 
 $data
 
 $query
 
 $client
 

Additional Inherited Members

- Protected Member Functions inherited from Solarium\Core\Query\Result\QueryType
 parseResponse ()
 
 mapData ($mapData)
 

Detailed Description

Select query result

This is the standard resulttype for a select query. Example usage: // total solr results $result->getNumFound();

// results fetched count($result);

// get a single facet by key $result->getFacet('category');

// iterate over fetched docs foreach ($result as $doc) { .... }

Member Function Documentation

Solarium\QueryType\Select\Result\Result::count ( )

Countable implementation

Returns
int

Implements Countable.

Solarium\QueryType\Select\Result\Result::getComponent (   $key)

Get a component result by key

Parameters
string$key
Returns
mixed
Solarium\QueryType\Select\Result\Result::getComponents ( )

Get all component results

Returns
array
Solarium\QueryType\Select\Result\Result::getDebug ( )

Get debug component result

This is a convenience method that maps presets to getComponent

Returns
Solarium\QueryType\Select\Result\Result::getDocuments ( )

Get all documents

Returns
DocumentInterface[]
Solarium\QueryType\Select\Result\Result::getFacetSet ( )

Get facetset component result

This is a convenience method that maps presets to getComponent

Returns
FacetSet
Solarium\QueryType\Select\Result\Result::getGrouping ( )

Get grouping component result

This is a convenience method that maps presets to getComponent

Returns
Solarium\QueryType\Select\Result\Result::getHighlighting ( )

Get highlighting component result

This is a convenience method that maps presets to getComponent

Returns
Solarium\QueryType\Select\Result\Result::getIterator ( )

IteratorAggregate implementation

Returns

Implements IteratorAggregate.

Solarium\QueryType\Select\Result\Result::getMaxScore ( )

get Solr maxscore

Returns the highest score of the documents in the total result for your current query (ignoring paging) Will only be available if 'score' was one of the requested fields in your query

Returns
float
Solarium\QueryType\Select\Result\Result::getMoreLikeThis ( )

Get morelikethis component result

This is a convenience method that maps presets to getComponent

Returns
Solarium\QueryType\Select\Result\Result::getNumFound ( )

get Solr numFound

Returns the total number of documents found by Solr (this is NOT the number of document fetched from Solr!)

Returns
int
Solarium\QueryType\Select\Result\Result::getQueryTime ( )

Get Solr query time

This doesn't include things like the HTTP responsetime. Purely the Solr query execution time.

Returns
int
Solarium\QueryType\Select\Result\Result::getSpellcheck ( )

Get spellcheck component result

This is a convenience method that maps presets to getComponent

Returns
Solarium\QueryType\Select\Result\Result::getStats ( )

Get stats component result

This is a convenience method that maps presets to getComponent

Returns
Solarium\QueryType\Select\Result\Result::getStatus ( )

Get Solr status code

This is not the HTTP status code! The normal value for success is 0.

Returns
int

Member Data Documentation

Solarium\QueryType\Select\Result\Result::$components
protected

Component results


The documentation for this class was generated from the following file: