Revise arg names in MongoCollection::aggregate()

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@327601 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Jeremy Mikola 2012-09-10 22:05:37 +00:00
parent 50c959fc2e
commit 0da49ccb6d

View file

@ -11,46 +11,48 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>array</type><methodname>MongoCollection::aggregate</methodname>
<methodparam><type>array</type><parameter>pipelines</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>pipeline</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>..</parameter></methodparam>
<methodparam><type>array</type><parameter>pipeline</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>op</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>...</parameter></methodparam>
</methodsynopsis>
<para>
The MongoDB <link xlink:href="&url.mongodb.docs.aggregation;">aggregation framework</link> provides a means to calculate aggregated
values without having to use map-reduce. While map-reduce is powerful, it is
often more difficult than necessary for many simple aggregation tasks, such
as totaling or averaging field values.
The MongoDB
<link xlink:href="&url.mongodb.docs.aggregation;">aggregation framework</link>
provides a means to calculate aggregated values without having to use
MapReduce. While MapReduce is powerful, it is often more difficult than
necessary for many simple aggregation tasks, such as totaling or averaging
field values.
</para>
<para>
This method accepts both variable amount of
<parameter>pipeline</parameter>s, or an array of <parameter>pipelines</parameter>.
This method accepts either a variable amount of pipeline operators, or a
single array of operators constituting the pipeline.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>pipelines</parameter></term>
<listitem>
<para>
An array of <parameter>pipeline</parameter>s, or just the first part.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>pipeline</parameter></term>
<listitem>
<para>
Second array of pipes.
An array of pipeline operators, or just the first operator.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>..</parameter></term>
<term><parameter>op</parameter></term>
<listitem>
<para>
More pipes...
The second pipeline operator.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>...</parameter></term>
<listitem>
<para>
Additional pipeline operators.
</para>
</listitem>
</varlistentry>