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

The SolrInputDocument class

Guide Edit on GitHub ✎

This class represents a Solr document that is about to be submitted to the Solr index.

Intro

This class represents a Solr document that is about to be submitted to the Solr index.

Class synopsis

class SolrInputDocument { }

Predefined Constants

SolrInputDocument Class Constants

SolrInputDocument::SORT_DEFAULT

Sorts the fields in ascending order.

SolrInputDocument::SORT_ASC

Sorts the fields in ascending order.

SolrInputDocument::SORT_DESC

Sorts the fields in descending order.

SolrInputDocument::SORT_FIELD_NAME

Sorts the fields by name

SolrInputDocument::SORT_FIELD_VALUE_COUNT

Sorts the fields by number of values.

SolrInputDocument::SORT_FIELD_BOOST_VALUE

Sorts the fields by boost value.

Solrinputdocument

In this section

SolrInputDocument::__clone

Creates a copy of a SolrDocument

SolrInputDocument::__construct

Constructor

SolrInputDocument::__destruct

Destructor

SolrInputDocument::addChildDocument

Adds a child document for block indexing

SolrInputDocument::addChildDocuments

Adds an array of child documents

SolrInputDocument::addField

Adds a field to the document

SolrInputDocument::clear

Resets the input document

SolrInputDocument::deleteField

Removes a field from the document

SolrInputDocument::fieldExists

Checks if a field exists

SolrInputDocument::getBoost

Retrieves the current boost value for the document

SolrInputDocument::getChildDocuments

Returns an array of child documents (SolrInputDocument)

SolrInputDocument::getChildDocumentsCount

Returns the number of child documents

SolrInputDocument::getField

Retrieves a field by name

SolrInputDocument::getFieldBoost

Retrieves the boost value for a particular field

SolrInputDocument::getFieldCount

Returns the number of fields in the document

SolrInputDocument::getFieldNames

Returns an array containing all the fields in the document

SolrInputDocument::hasChildDocuments

Returns true if the document has any child documents

SolrInputDocument::merge

Merges one input document into another

SolrInputDocument::reset

Alias SolrInputDocument::clear

SolrInputDocument::setBoost

Sets the boost value for this document

SolrInputDocument::setFieldBoost

Sets the index-time boost value for a field

SolrInputDocument::sort

Sorts the fields within the document

SolrInputDocument::toArray

Returns an array representation of the input document

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