mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 22:38:55 +00:00
be295015d0
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@343891 c90b9560-bf6c-de11-be94-00142212c4b1
115 lines
3.2 KiB
XML
115 lines
3.2 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<refentry xml:id="solrquery.addgroupsortfield" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>SolrQuery::addGroupSortField</refname>
|
|
<refpurpose>Add a group sort field (group.sort parameter)</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>public</modifier> <type>SolrQuery</type><methodname>SolrQuery::addGroupSortField</methodname>
|
|
<methodparam><type>string</type><parameter>field</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>order</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Allow sorting group documents, using group sort field (group.sort parameter).
|
|
</para>
|
|
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>field</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Field name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>order</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Order ASC/DESC, utilizes SolrQuery::ORDER_* constants
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<example>
|
|
<title><function>SolrQuery::addGroupSortField</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
$solrQuery = new SolrQuery('*:*');
|
|
$solrQuery
|
|
->setGroup(true)
|
|
->addGroupSortField('price', SolrQuery::ORDER_ASC);
|
|
|
|
echo $solrQuery;
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
q=*:*&group=true&group.sort=price asc
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</refsect1>
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<simplelist>
|
|
<member><methodname>SolrQuery::setGroup</methodname></member>
|
|
<member><methodname>SolrQuery::addGroupField</methodname></member>
|
|
<member><methodname>SolrQuery::addGroupFunction</methodname></member>
|
|
<member><methodname>SolrQuery::addGroupQuery</methodname></member>
|
|
<member><methodname>SolrQuery::setGroupFacet</methodname></member>
|
|
<member><methodname>SolrQuery::setGroupOffset</methodname></member>
|
|
<member><methodname>SolrQuery::setGroupLimit</methodname></member>
|
|
<member><methodname>SolrQuery::setGroupMain</methodname></member>
|
|
<member><methodname>SolrQuery::setGroupNGroups</methodname></member>
|
|
<member><methodname>SolrQuery::setGroupTruncate</methodname></member>
|
|
<member><methodname>SolrQuery::setGroupFormat</methodname></member>
|
|
<member><methodname>SolrQuery::setGroupCachePercent</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
|
|
-->
|