The SolrDocument class

(PECL solr >= 0.9.2)

Introduction

Represents a Solr document retrieved from a query response.

Class synopsis

final SolrDocument implements ArrayAccess , Iterator , Serializable {
/* Constants */
const integer SORT_DEFAULT = 1 ;
const integer SORT_ASC = 1 ;
const integer SORT_DESC = 2 ;
const integer SORT_FIELD_NAME = 1 ;
const integer SORT_FIELD_VALUE_COUNT = 2 ;
const integer SORT_FIELD_BOOST_VALUE = 4 ;
/* Methods */
public addField ( string $fieldName , string $fieldValue ) : bool
public clear ( void ) : bool
public __clone ( void ) : void
public __construct ( void )
public current ( void ) : SolrDocumentField
public deleteField ( string $fieldName ) : bool
public __destruct ( void ) : void
public fieldExists ( string $fieldName ) : bool
public __get ( string $fieldName ) : SolrDocumentField
public getChildDocuments ( void ) : array
public getChildDocumentsCount ( void ) : int
public getField ( string $fieldName ) : SolrDocumentField
public getFieldCount ( void ) : int
public getFieldNames ( void ) : array
public hasChildDocuments ( void ) : bool
public __isset ( string $fieldName ) : bool
public key ( void ) : string
public merge ( SolrDocument $sourceDoc [, bool $overwrite = TRUE ] ) : bool
public next ( void ) : void
public offsetExists ( string $fieldName ) : bool
public offsetGet ( string $fieldName ) : SolrDocumentField
public offsetSet ( string $fieldName , string $fieldValue ) : void
public offsetUnset ( string $fieldName ) : void
public reset ( void ) : bool
public rewind ( void ) : void
public serialize ( void ) : string
public __set ( string $fieldName , string $fieldValue ) : bool
public sort ( int $sortOrderBy [, int $sortDirection = SolrDocument::SORT_ASC ] ) : bool
public toArray ( void ) : array
public unserialize ( string $serialized ) : void
public __unset ( string $fieldName ) : bool
public valid ( void ) : bool
}

Predefined Constants

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.

Table of Contents

add a note add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top