* @link https://github.com/pjmazenot/phpsolr-phpdoc
*/
/**
* (PECL solr >= 0.9.2)
* Class SolrInputDocument
* This class represents a Solr document that is about to be submitted to the Solr index.
* @link https://php.net/manual/en/class.solrinputdocument.php
*/
final class SolrInputDocument
{
/** @var int Sorts the fields in ascending order. */
public const SORT_DEFAULT = 1;
/** @var int Sorts the fields in ascending order. */
public const SORT_ASC = 1;
/** @var int Sorts the fields in descending order. */
public const SORT_DESC = 2;
/** @var int Sorts the fields by name */
public const SORT_FIELD_NAME = 1;
/** @var int Sorts the fields by number of values. */
public const SORT_FIELD_VALUE_COUNT = 2;
/** @var int Sorts the fields by boost value. */
public const SORT_FIELD_BOOST_VALUE = 4;
/**
* (PECL solr >= 2.3.0)
* Adds a child document for block indexing
* @link https://php.net/manual/en/solrinputdocument.addchilddocument.php
* @param SolrInputDocument $child
* A SolrInputDocument object.
*
* @throws SolrIllegalArgumentException
* @throws SolrException
*/
public function addChildDocument(SolrInputDocument $child) {}
/**
* (PECL solr >= 2.3.0)
* Adds an array of child documents
* @link https://php.net/manual/en/solrinputdocument.addchilddocuments.php
* @param array &$docs
* An array of SolrInputDocument objects.
*
* @throws SolrIllegalArgumentException
* @throws SolrException
*/
public function addChildDocuments(array &$docs) {}
/**
* (PECL solr >= 0.9.2)
* Adds a field to the document
* @link https://php.net/manual/en/solrinputdocument.addfield.php
* @param string $fieldName
* The name of the field
*
* @param string $fieldValue
* The value for the field.
*
* @param float $fieldBoostValue [optional]
* The index time boost for the field. Though this cannot be negative, you can still pass values less than 1.0 but
* they must be greater than zero.
*
* @return bool
* Returns TRUE on success or FALSE on failure.
*
*/
public function addField($fieldName, $fieldValue, $fieldBoostValue = 0.0) {}
/**
* (PECL solr >= 0.9.2)
* Resets the input document
* @link https://php.net/manual/en/solrinputdocument.clear.php
* @return bool
* Returns TRUE on success or FALSE on failure.
*
*/
public function clear() {}
/**
* (PECL solr >= 0.9.2)
* Creates a copy of a SolrDocument
* @link https://php.net/manual/en/solrinputdocument.clone.php
*/
public function __clone() {}
/**
* (PECL solr >= 0.9.2)
* SolrInputDocument constructor.
* @link https://php.net/manual/en/solrinputdocument.construct.php
*/
public function __construct() {}
/**
* (PECL solr >= 0.9.2)
* Removes a field from the document
* @link https://php.net/manual/en/solrinputdocument.construct.php
* @param string $fieldName
* The name of the field.
*
* @return bool
* Returns TRUE on success or FALSE on failure.
*
*/
public function deleteField($fieldName) {}
/**
* (PECL solr >= 0.9.2)
* Destructor
* @link https://php.net/manual/en/solrinputdocument.destruct.php
*/
public function __destruct() {}
/**
* (PECL solr >= 0.9.2)
* Checks if a field exists
* @link https://php.net/manual/en/solrinputdocument.fieldexists.php
* @param string $fieldName
* Name of the field.
*
* @return bool
* Returns TRUE if the field was found and FALSE if it was not found.
*
*/
public function fieldExists($fieldName) {}
/**
* (PECL solr >= 0.9.2)
* Retrieves the current boost value for the document
* @link https://php.net/manual/en/solrinputdocument.getboost.php
* @return float|false
* Returns the boost value on success and FALSE on failure.
*
*/
public function getBoost() {}
/**
* (PECL solr >= 2.3.0)
* Returns an array of child documents (SolrInputDocument)
* @link https://php.net/manual/en/solrinputdocument.getchilddocuments.php
* @return SolrInputDocument[]
*/
public function getChildDocuments() {}
/**
* (PECL solr >= 2.3.0)
* Returns the number of child documents
* @link https://php.net/manual/en/solrinputdocument.getchilddocumentscount.php
* @return int
*/
public function getChildDocumentsCount() {}
/**
* (PECL solr >= 0.9.2)
* Retrieves a field by name
* @link https://php.net/manual/en/solrinputdocument.getfield.php
* @param string $fieldName
* The name of the field.
*
* @return SolrDocumentField|false Returns a SolrDocumentField object on success and FALSE on failure.
*/
public function getField($fieldName) {}
/**
* (PECL solr >= 0.9.2)
* Retrieves the boost value for a particular field
* @link https://php.net/manual/en/solrinputdocument.getfieldboost.php
* @param string $fieldName
* The name of the field.
*
* @return float|false
* Returns the boost value for the field or FALSE if there was an error.
*
*/
public function getFieldBoost($fieldName) {}
/**
* (PECL solr >= 0.9.2)
* Returns the number of fields in the document
* @link https://php.net/manual/en/solrinputdocument.getfieldcount.php
* @return int|false
* Returns an integer on success or FALSE on failure.
*
*/
public function getFieldCount() {}
/**
* (PECL solr >= 0.9.2)
* Returns an array containing all the fields in the document
* @link https://php.net/manual/en/solrinputdocument.getfieldnames.php
* @return array|false
* Returns an array on success and FALSE on failure.
*
*/
public function getFieldNames() {}
/**
* (PECL solr >= 2.3.0)
* Checks whether the document has any child documents
* @link https://php.net/manual/en/solrinputdocument.haschilddocuments.php
* @return bool
* Returns TRUE if the document has any child documents
*
*/
public function hasChildDocuments() {}
/**
* (PECL solr >= 0.9.2)
* Merges one input document into another
* @link https://php.net/manual/en/solrinputdocument.merge.php
* @param SolrInputDocument $sourceDoc
* The source document.
*
* @param bool $overwrite [optional]
* If this is TRUE it will replace matching fields in the destination document.
*
* @return bool
* Returns TRUE on success or FALSE on failure. In the future, this will be modified to return the
* number of fields in the new document.
*
*/
public function merge(SolrInputDocument $sourceDoc, $overwrite = true) {}
/**
* (PECL solr >= 0.9.2)
* This is an alias of SolrInputDocument::clear
* @link https://php.net/manual/en/solrinputdocument.reset.php
* @return bool
* Returns TRUE on success or FALSE on failure.
*
*/
public function reset() {}
/**
* (PECL solr >= 0.9.2)
* Sets the boost value for this document
* @link https://php.net/manual/en/solrinputdocument.setboost.php
* @param float $documentBoostValue
* The index-time boost value for this document.
*
* @return bool
* Returns TRUE on success or FALSE on failure.
*
*/
public function setBoost($documentBoostValue) {}
/**
* (PECL solr >= 0.9.2)
* Sets the index-time boost value for a field
* https://php.net/manual/en/solrinputdocument.setfieldboost.php
* @param string $fieldName
* The name of the field.
*
* @param float $fieldBoostValue
* The index time boost value.
*
*/
public function setFieldBoost($fieldName, $fieldBoostValue) {}
/**
* (PECL solr >= 0.9.2)
* Sorts the fields within the document
* @link https://php.net/manual/en/solrinputdocument.sort.php
* @param int $sortOrderBy
* The sort criteria, must be one of :
*
* - SolrInputDocument::SORT_FIELD_NAME
* - SolrInputDocument::SORT_FIELD_BOOST_VALUE
* - SolrInputDocument::SORT_FIELD_VALUE_COUNT
*
*
* @param int $sortDirection [optional]
* The sort direction, can be one of :
*
* - SolrInputDocument::SORT_DEFAULT
* - SolrInputDocument::SORT_ASC
* - SolrInputDocument::SORT_DESC
*
*
* @return bool
* Returns TRUE on success or FALSE on failure.
*
*/
public function sort($sortOrderBy, $sortDirection = SolrInputDocument::SORT_ASC) {}
/**
* (PECL solr >= 0.9.2)
* Returns an array representation of the input document
* @link https://php.net/manual/en/solrinputdocument.toarray.php
* @return array|false
* Returns an array containing the fields. It returns FALSE on failure.
*
*/
public function toArray() {}
}