php-doc-en/reference/solr/solrdocumentfield.xml

118 lines
3.5 KiB
XML
Raw Permalink Normal View History

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.solrdocumentfield" 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 SolrDocumentField class</title>
<titleabbrev>SolrDocumentField</titleabbrev>
<partintro>
<!-- {{{ SolrDocumentField intro -->
<section xml:id="solrdocumentfield.intro">
&reftitle.intro;
<para>
This represents a field in a Solr document. All its properties are read-only.
</para>
</section>
<!-- }}} -->
<section xml:id="solrdocumentfield.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>SolrDocumentField</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<modifier>final</modifier>
<classname>SolrDocumentField</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type>string</type>
<varname linkend="solrdocumentfield.props.name">name</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type>float</type>
<varname linkend="solrdocumentfield.props.boost">boost</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type>array</type>
<varname linkend="solrdocumentfield.props.values">values</varname>
</fieldsynopsis>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.solrdocumentfield')/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.solrdocumentfield')/db:refentry/db:refsect1[@role='description']/descendant::db:destructorsynopsis[not(@role='procedural')])" />
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ SolrDocumentField properties -->
<section xml:id="solrdocumentfield.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="solrdocumentfield.props.name">
<term><varname>name</varname></term>
<listitem>
<para>The name of the field.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="solrdocumentfield.props.boost">
<term><varname>boost</varname></term>
<listitem>
<para>The boost value for the field</para>
</listitem>
</varlistentry>
<varlistentry xml:id="solrdocumentfield.props.values">
<term><varname>values</varname></term>
<listitem>
<para>An array of values for this field</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
</partintro>
&reference.solr.entities.solrdocumentfield;
</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
-->