php-doc-en/reference/solr/solrdismaxquery/removequeryfield.xml
2016-01-30 12:57:31 +00:00

104 lines
2.6 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="solrdismaxquery.removequeryfield" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SolrDisMaxQuery::removeQueryField</refname>
<refpurpose>Removes a Query Field (qf parameter)</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>SolrDisMaxQuery</type><methodname>SolrDisMaxQuery::removeQueryField</methodname>
<methodparam><type>string</type><parameter>field</parameter></methodparam>
</methodsynopsis>
<para>
Removes a Query Field (qf parameter) from the field list added by <methodname>SolrDisMaxQuery::addQueryField</methodname>
</para>
<para>
qf: When building DisjunctionMaxQueries from the user's query it specifies the fields to search in, and boosts for those fields.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>field</parameter></term>
<listitem>
<para>
Field Name
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<type>SolrDisMaxQuery</type>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>SolrDisMaxQuery::removeQueryField</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$dismaxQuery = new SolrDisMaxQuery('lucene');
$dismaxQuery
->addQueryField('first', 3)
->addQueryField('second', 0.2)
->addQueryField('cat');
echo $dismaxQuery . PHP_EOL;
// remove field 'second'
echo $dismaxQuery->removeQueryField('second');
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
q=lucene&defType=edismax&qf=first^3 second^0.2 cat
q=lucene&defType=edismax&qf=first^3 cat
]]>
</screen>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><methodname>SolrDisMaxQuery::addQueryField</methodname></member>
</simplelist>
</refsect1>
</refentry>
<!-- 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
-->