No cache version.

Caching disabled. Default setting for this page:enabled (code LNG204)
If the display is too slow, you can disable the user mode to view the cached version.

The SolrInputDocument class

Contents

(PECL solr >= 0.9.2)

Introduction

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

PHP: SolrInputDocument - Manual Home of Manuel PHP Contents Haut

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

}

PHP: SolrInputDocument - Manual Home of Manuel PHP Contents Haut

Predefined Constants

PHP: SolrInputDocument - Manual Home of Manuel PHP Contents Haut

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.

PHP: SolrInputDocument - Manual Home of Manuel PHP Contents Haut

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

Find a PHP function

English translation

You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.

If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.

Thank you in advance.

Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-class.solrinputdocument.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

Manuel PHP : http://php.net

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.

Contents Haut

The SolrInputDocument class

Introduction

Class synopsis

Predefined Constants

SolrInputDocument Class Constants

Table of Contents

References