The SolrInputDocument class

(PECL solr >= 0.9.2)

Introduction

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

Class synopsis

finalclassSolrInputDocument {

constintSORT_DEFAULT = 1;

constintSORT_ASC = 1;

constintSORT_DESC = 2;

constintSORT_FIELD_NAME = 1;

constintSORT_FIELD_VALUE_COUNT = 2;

constintSORT_FIELD_BOOST_VALUE = 4;

public__construct()

publicaddChildDocument(SolrInputDocument$child): void

publicaddChildDocuments(array&$docs): void

publicaddField(string$fieldName, string$fieldValue, float$fieldBoostValue = 0.0): bool

publicclear(): bool

public__clone(): void

publicdeleteField(string$fieldName): bool

publicfieldExists(string$fieldName): bool

publicgetBoost(): float

publicgetChildDocuments(): array

publicgetChildDocumentsCount(): int

publicgetField(string$fieldName): SolrDocumentField

publicgetFieldBoost(string$fieldName): float

publicgetFieldCount(): int|false

publicgetFieldNames(): array

publichasChildDocuments(): bool

publicmerge(SolrInputDocument$sourceDoc, bool$overwrite = true): bool

publicreset(): bool

publicsetBoost(float$documentBoostValue): bool

publicsetFieldBoost(string$fieldName, float$fieldBoostValue): bool

publicsort(int$sortOrderBy, int$sortDirection = SolrInputDocument::SORT_ASC): bool

publictoArray(): array

public__destruct()

}

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::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::__clone — Creates a copy of a SolrDocument
SolrInputDocument::__construct — Constructor
SolrInputDocument::deleteField — Removes a field from the document
SolrInputDocument::__destruct — Destructor
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 of 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

The SolrInputDocument class

Introduction

Class synopsis

Predefined Constants

SolrInputDocument Class Constants

Table of Contents