php8.5
/
Download
Home/ Manual/ reference / solr/ The SolrDocument class

The SolrDocument class

Guide Edit on GitHub ✎

Represents a Solr document retrieved from a query response.

Intro

Represents a Solr document retrieved from a query response.

Class synopsis

class SolrDocument { }

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 their boost values.

Solrdocument

In this section

SolrDocument::__clone

Creates a copy of a SolrDocument object

SolrDocument::__construct

Constructor

SolrDocument::__destruct

Destructor

SolrDocument::__get

Access the field as a property

SolrDocument::__isset

Checks if a field exists

SolrDocument::__set

Adds another field to the document

SolrDocument::__unset

Removes a field from the document

SolrDocument::addField

Adds a field to the document

SolrDocument::clear

Drops all the fields in the document

SolrDocument::current

Retrieves the current field

SolrDocument::deleteField

Removes a field from the document

SolrDocument::fieldExists

Checks if a field exists in the document

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::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 SolrDocument::clear

SolrDocument::rewind

Resets the internal pointer to the beginning

SolrDocument::serialize

Used for custom serialization

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::valid

Checks if the current position internally is still valid

Source: reference/solr/solrdocument.xml · from the official PHP manual (php/doc-en)