php-doc-en/reference/solr/solrquery/setgroupformat.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<refentry xml:id="solrquery.setgroupformat" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>SolrQuery::setGroupFormat</refname>
  <refpurpose>Sets the group format, result structure (group.format parameter)</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <type>SolrQuery</type><methodname>SolrQuery::setGroupFormat</methodname>
   <methodparam><type>string</type><parameter>value</parameter></methodparam>
  </methodsynopsis>
  <para>
    Sets the group.format parameter.
    If this parameter is set to simple, the grouped documents are presented in a single flat list, and the start and rows parameters affect the numbers of documents instead of groups.
    Accepts: grouped/simple
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>value</parameter></term>
    <listitem>
     <para>
      
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   
  </para>
 </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::addGroupSortField</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::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
-->