svn: /phpdoc/en/trunk/reference/solr/solrquery/ collapse.xml

From: Date: Fri, 09 Oct 2015 17:02:39 +0000
Subject: svn: /phpdoc/en/trunk/reference/solr/solrquery/ collapse.xml
Groups: php.doc.cvs 
Request: Send a blank email to doc-cvs+get-13773@lists.php.net to get a copy of this message
omars Fri, 09 Oct 2015 17:02:39 +0000 Revision: http://svn.php.net/viewvc?view=revision&revision=337980 Log: Solr - SolrQuery::collapse docs Changed paths: A phpdoc/en/trunk/reference/solr/solrquery/collapse.xml Added: phpdoc/en/trunk/reference/solr/solrquery/collapse.xml =================================================================== --- phpdoc/en/trunk/reference/solr/solrquery/collapse.xml (rev 0) +++ phpdoc/en/trunk/reference/solr/solrquery/collapse.xml 2015-10-09 17:02:39 UTC (rev 337980) @@ -0,0 +1,71 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 317663 $ --> + +<refentry xml:id="solrquery.collapse" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv> + <refname>SolrQuery::collapse</refname> + <refpurpose>Collapses the result set to a single document per group</refpurpose> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <modifier>public</modifier> <type>SolrQuery</type><methodname>SolrQuery::collapse</methodname> + <methodparam><type>SolrCollapseFunction</type><parameter>collapseFunction</parameter></methodparam> + </methodsynopsis> + <para> + Collapses the result set to a single document per group before it forwards + the result set to the rest of the search components. + </para> + <para> + So all downstream components (faceting, highlighting, etc...) will work with + the collapsed result set. + </para> + + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>collapseFunction</parameter></term> + <listitem> + <para> + + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the current <type>SolrQuery</type> object + </para> + </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 +-->

« previous php.doc.cvs (#13773) next »