International PHP Conference Munich 2021

The SolrDocument class

(PECL solr >= 0.9.2)


Represents a Solr document retrieved from a query response.

Class synopsis

final SolrDocument implements ArrayAccess , Iterator , Serializable {
/* Constants */
const int SORT_DEFAULT = 1 ;
const int SORT_ASC = 1 ;
const int SORT_DESC = 2 ;
const int SORT_FIELD_NAME = 1 ;
const int SORT_FIELD_VALUE_COUNT = 2 ;
const int SORT_FIELD_BOOST_VALUE = 4 ;
/* Methods */
public addField(string $fieldName, string $fieldValue): bool
public clear(): bool
public __clone(): void
public __construct()
public deleteField(string $fieldName): bool
public __destruct(): void
public fieldExists(string $fieldName): bool
public __get(string $fieldName): SolrDocumentField
public getChildDocuments(): array
public getField(string $fieldName): SolrDocumentField
public getFieldCount(): int
public getFieldNames(): array
public hasChildDocuments(): bool
public __isset(string $fieldName): bool
public key(): string
public merge(SolrDocument $sourceDoc, bool $overwrite = true): bool
public next(): 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(): bool
public rewind(): void
public serialize(): string
public __set(string $fieldName, string $fieldValue): bool
public sort(int $sortOrderBy, int $sortDirection = SolrDocument::SORT_ASC): bool
public toArray(): array
public unserialize(string $serialized): void
public __unset(string $fieldName): bool
public valid(): bool

Predefined Constants


Default mode for sorting fields within the document.


Sorts the fields in ascending order


Sorts the fields in descending order


Sorts the fields by field name.


Sorts the fields by number of values in each field.


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