# 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

final SolrInputDocument {
/* Constants */
const integer SORT_DEFAULT = 1 ;
const integer SORT_ASC = 1 ;
const integer SORT_DESC = 2 ;
const integer SORT_FIELD_NAME = 1 ;
const integer SORT_FIELD_VALUE_COUNT = 2 ;
const integer SORT_FIELD_BOOST_VALUE = 4 ;
/* Methods */
public addChildDocument ( SolrInputDocument `$child` ) : void
public addChildDocuments ( array `&$docs` ) : void
public addField ( string `$fieldName` , string `$fieldValue` [, float `$fieldBoostValue` = 0.0 ] ) : bool
public clear ( void ) : bool
public __clone ( void ) : void
public __construct ( void )
public deleteField ( string `$fieldName` ) : bool
public __destruct ( void ) : void
public fieldExists ( string `$fieldName` ) : bool
public getBoost ( void ) : float
public getChildDocuments ( void ) : array
public getChildDocumentsCount ( void ) : int
public getField ( string `$fieldName` ) : SolrDocumentField
public getFieldBoost ( string `$fieldName` ) : float
public getFieldCount ( void ) : int
public getFieldNames ( void ) : array
public hasChildDocuments ( void ) : bool
public merge ( SolrInputDocument `$sourceDoc` [, bool `$overwrite` = `TRUE` ] ) : bool
public reset ( void ) : bool
public setBoost ( float `$documentBoostValue` ) : bool
public setFieldBoost ( string `$fieldName` , float `$fieldBoostValue` ) : bool
public sort ( int `$sortOrderBy` [, int `$sortDirection` = SolrInputDocument::SORT_ASC ] ) : bool
public toArray ( void ) : array
}

## 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.

## Table of Contents

- 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 — This is an 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