php-doc-en/reference/solr/solrinputdocument.xml
George Peter Banyard ecaa214642
Fix de/constructor synopsis tag usage (#1457)
In Solr, Stomp, Yaf.

Also include constructor and destructor in StreamWrapper interface synopsis
2022-03-15 16:36:11 +00:00

162 lines
5.5 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.solrinputdocument" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The SolrInputDocument class</title>
<titleabbrev>SolrInputDocument</titleabbrev>
<partintro>
<!-- {{{ SolrInputDocument intro -->
<section xml:id="solrinputdocument.intro">
&reftitle.intro;
<para>
This class represents a Solr document that is about to be submitted to the Solr index.
</para>
</section>
<!-- }}} -->
<section xml:id="solrinputdocument.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>SolrInputDocument</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<modifier>final</modifier>
<classname>SolrInputDocument</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="solrinputdocument.constants.sort-default">SolrInputDocument::SORT_DEFAULT</varname>
<initializer>1</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="solrinputdocument.constants.sort-asc">SolrInputDocument::SORT_ASC</varname>
<initializer>1</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="solrinputdocument.constants.sort-desc">SolrInputDocument::SORT_DESC</varname>
<initializer>2</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="solrinputdocument.constants.sort-field-name">SolrInputDocument::SORT_FIELD_NAME</varname>
<initializer>1</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="solrinputdocument.constants.sort-field-value-count">SolrInputDocument::SORT_FIELD_VALUE_COUNT</varname>
<initializer>2</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="solrinputdocument.constants.sort-field-boost-value">SolrInputDocument::SORT_FIELD_BOOST_VALUE</varname>
<initializer>4</initializer>
</fieldsynopsis>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.solrinputdocument')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])"/>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.solrinputdocument')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.solrinputdocument')/db:refentry/db:refsect1[@role='description']/descendant::db:destructorsynopsis[not(@role='procedural')])"/>
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ SolrInputDocument constants -->
<section xml:id="solrinputdocument.constants">
&reftitle.constants;
<section xml:id="solrinputdocument.constants.types">
<title>SolrInputDocument Class Constants</title>
<variablelist>
<varlistentry xml:id="solrinputdocument.constants.sort-default">
<term><constant>SolrInputDocument::SORT_DEFAULT</constant></term>
<listitem>
<para>Sorts the fields in ascending order.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="solrinputdocument.constants.sort-asc">
<term><constant>SolrInputDocument::SORT_ASC</constant></term>
<listitem>
<para>Sorts the fields in ascending order.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="solrinputdocument.constants.sort-desc">
<term><constant>SolrInputDocument::SORT_DESC</constant></term>
<listitem>
<para>Sorts the fields in descending order.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="solrinputdocument.constants.sort-field-name">
<term><constant>SolrInputDocument::SORT_FIELD_NAME</constant></term>
<listitem>
<para>Sorts the fields by name</para>
</listitem>
</varlistentry>
<varlistentry xml:id="solrinputdocument.constants.sort-field-value-count">
<term><constant>SolrInputDocument::SORT_FIELD_VALUE_COUNT</constant></term>
<listitem>
<para>Sorts the fields by number of values.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="solrinputdocument.constants.sort-field-boost-value">
<term><constant>SolrInputDocument::SORT_FIELD_BOOST_VALUE</constant></term>
<listitem>
<para>Sorts the fields by boost value.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
</section>
<!-- }}} -->
</partintro>
&reference.solr.entities.solrinputdocument;
</phpdoc:classref>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->