The SolrDocument class

Introduction

Represents a Solr document retrieved from a query response.

Class synopsis

SolrDocument

final class SolrDocument implements ArrayAccess, Iterator, Serializable {

/* Constants */

const int SolrDocument::SORT_DEFAULT = 1;

const int SolrDocument::SORT_ASC = 1;

const int SolrDocument::SORT_DESC = 2;

const int SolrDocument::SORT_FIELD_NAME = 1;

const int SolrDocument::SORT_FIELD_VALUE_COUNT = 2;

const int SolrDocument::SORT_FIELD_BOOST_VALUE = 4;

/* Methods */

public __construct()

public bool addField(string $fieldName, string $fieldValue)

public bool clear()

public void __clone()

public SolrDocumentField current()

public bool deleteField(string $fieldName)

public bool fieldExists(string $fieldName)

public SolrDocumentField __get(string $fieldName)

public array getChildDocuments()

public int getChildDocumentsCount()

public SolrDocumentField getField(string $fieldName)

public int getFieldCount()

public array getFieldNames()

public SolrInputDocument getInputDocument()

public bool hasChildDocuments()

public bool __isset(string $fieldName)

public string key()

public bool merge(SolrDocument $sourceDoc, bool $overwrite = true)

public void next()

public bool offsetExists(string $fieldName)

public SolrDocumentField offsetGet(string $fieldName)

public void offsetSet(string $fieldName, string $fieldValue)

public void offsetUnset(string $fieldName)

public bool reset()

public void rewind()

public string serialize()

public bool __set(string $fieldName, string $fieldValue)

public bool sort(int $sortOrderBy, int $sortDirection = SolrDocument::SORT_ASC)

public array toArray()

public void unserialize(string $serialized)

public bool __unset(string $fieldName)

public bool valid()

public __destruct()

}

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

SolrDocument::addField — Adds a field to the document
SolrDocument::clear — Drops all the fields in the document
SolrDocument::__clone — Creates a copy of a SolrDocument object
SolrDocument::__construct — Constructor
SolrDocument::current — Retrieves the current field
SolrDocument::deleteField — Removes a field from the document
SolrDocument::__destruct — Destructor
SolrDocument::fieldExists — Checks if a field exists in the document
SolrDocument::__get — Access the field as a property
SolrDocument::getChildDocuments — Returns an array of child documents (SolrDocument)
SolrDocument::getChildDocumentsCount — Returns the number of child documents
SolrDocument::getField — Retrieves a field by name
SolrDocument::getFieldCount — Returns the number of fields in this document
SolrDocument::getFieldNames — Returns an array of fields names in the document
SolrDocument::getInputDocument — Returns a SolrInputDocument equivalent of the object
SolrDocument::hasChildDocuments — Checks whether the document has any child documents
SolrDocument::__isset — Checks if a field exists
SolrDocument::key — Retrieves the current key
SolrDocument::merge — Merges source to the current SolrDocument
SolrDocument::next — Moves the internal pointer to the next field
SolrDocument::offsetExists — Checks if a particular field exists
SolrDocument::offsetGet — Retrieves a field
SolrDocument::offsetSet — Adds a field to the document
SolrDocument::offsetUnset — Removes a field
SolrDocument::reset — Alias of SolrDocument::clear
SolrDocument::rewind — Resets the internal pointer to the beginning
SolrDocument::serialize — Used for custom serialization
SolrDocument::__set — Adds another field to the document
SolrDocument::sort — Sorts the fields in the document
SolrDocument::toArray — Returns an array representation of the document
SolrDocument::unserialize — Custom serialization of SolrDocument objects
SolrDocument::__unset — Removes a field from the document
SolrDocument::valid — Checks if the current position internally is still valid