# SolrInputDocument クラス

(PECL solr >= 0.9.2)

## はじめに

このクラスは、Solr インデックスにサブミットされようとしている Solr 文書を表現します。

## クラス概要

final class SolrInputDocument {
/* 定数 */
const int SORT_DEFAULT = 1;
const int SORT_ASC = 1;
const int SORT_DESC = 2;
const int SORT_FIELD_NAME = 1;
const int SORT_FIELD_VALUE_COUNT = 2;
const int SORT_FIELD_BOOST_VALUE = 4;
/* メソッド */
public function __construct()
public function addChildDocument(SolrInputDocument `$child`): void
public function addChildDocuments(array `&$docs`): void
public function addField(string `$fieldName`, string `$fieldValue`, float `$fieldBoostValue` = 0.0): bool
public function clear(): bool
public function __clone(): void
public function deleteField(string `$fieldName`): bool
public function fieldExists(string `$fieldName`): bool
public function getBoost(): float
public function getChildDocuments(): array
public function getChildDocumentsCount(): int
public function getField(string `$fieldName`): SolrDocumentField
public function getFieldBoost(string `$fieldName`): float
public function getFieldCount(): int|false
public function getFieldNames(): array
public function hasChildDocuments(): bool
public function merge(SolrInputDocument `$sourceDoc`, bool `$overwrite` = `true`): bool
public function reset(): bool
public function setBoost(float `$documentBoostValue`): bool
public function setFieldBoost(string `$fieldName`, float `$fieldBoostValue`): bool
public function sort(int `$sortOrderBy`, int `$sortDirection` = SolrInputDocument::SORT_ASC): bool
public function toArray(): array
public function __destruct()
}

## 定義済み定数

## SolrInputDocument クラス定数

`SolrInputDocument::SORT_DEFAULT`

  フィールドを昇順でソート

`SolrInputDocument::SORT_ASC`

  フィールドを昇順でソート

`SolrInputDocument::SORT_DESC`

  フィールドを降順でソート

`SolrInputDocument::SORT_FIELD_NAME`

  フィールドを名前でソート

`SolrInputDocument::SORT_FIELD_VALUE_COUNT`

  フィールドを値の数でソート

`SolrInputDocument::SORT_FIELD_BOOST_VALUE`

  boost 値でフィールドをソート

## 目次

- SolrInputDocument::addChildDocument — Adds a child document for block indexing
- SolrInputDocument::addChildDocuments — Adds an array of child documents
- SolrInputDocument::addField — 文書にフィールドを追加
- SolrInputDocument::clear — 入力した文書をリセット
- SolrInputDocument::__clone — SolrDocument のコピーを作成
- SolrInputDocument::__construct — コンストラクタ
- SolrInputDocument::deleteField — 文書からフィールドを除去
- SolrInputDocument::__destruct — デストラクタ
- SolrInputDocument::fieldExists — フィールドが存在するかチェック
- SolrInputDocument::getBoost — 文書に対する現行の boost 値を取得
- SolrInputDocument::getChildDocuments — Returns an array of child documents (SolrInputDocument)
- SolrInputDocument::getChildDocumentsCount — Returns the number of child documents
- SolrInputDocument::getField — 名前でフィールドを取得
- SolrInputDocument::getFieldBoost — 特定のフィールドに対する boost 値を取得
- SolrInputDocument::getFieldCount — 文書内のフィールド数を返す
- SolrInputDocument::getFieldNames — 文書内のフィールドを全て含む配列を返す
- SolrInputDocument::hasChildDocuments — Returns true if the document has any child documents
- SolrInputDocument::merge — Merges one input document into another
- SolrInputDocument::reset — SolrInputDocument::clear のエイリアス
- SolrInputDocument::setBoost — この文書に対する boost 値を設定
- SolrInputDocument::setFieldBoost — フィールドに対するインデキシング時間の boost 値を設定
- SolrInputDocument::sort — Sorts the fields within the document
- SolrInputDocument::toArray — 入力した文書の配列表現を返す

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open