Skip to content

Commit f1cc097

Browse files
committed
Reword "list of pipeline operations"
As used in the doc
1 parent 08109a5 commit f1cc097

File tree

10 files changed

+13
-13
lines changed

10 files changed

+13
-13
lines changed

src/Client.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -354,7 +354,7 @@ public function startSession(array $options = [])
354354
* Create a change stream for watching changes to the cluster.
355355
*
356356
* @see Watch::__construct() for supported options
357-
* @param array $pipeline List of pipeline operations
357+
* @param array $pipeline Aggregation pipeline
358358
* @param array $options Command options
359359
* @return ChangeStream
360360
* @throws InvalidArgumentException for parameter/option parsing errors

src/Collection.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ public function __toString()
201201
* "result" array from the command response document.
202202
*
203203
* @see Aggregate::__construct() for supported options
204-
* @param array $pipeline List of pipeline operations
204+
* @param array $pipeline Aggregation pipeline
205205
* @param array $options Command options
206206
* @return Traversable
207207
* @throws UnexpectedValueException if the command response was malformed
@@ -1107,7 +1107,7 @@ public function updateOne($filter, $update, array $options = [])
11071107
* Create a change stream for watching changes to the collection.
11081108
*
11091109
* @see Watch::__construct() for supported options
1110-
* @param array $pipeline List of pipeline operations
1110+
* @param array $pipeline Aggregation pipeline
11111111
* @param array $options Command options
11121112
* @return ChangeStream
11131113
* @throws InvalidArgumentException for parameter/option parsing errors

src/Database.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ public function __toString()
189189
* and $listLocalSessions. Requires MongoDB >= 3.6
190190
*
191191
* @see Aggregate::__construct() for supported options
192-
* @param array $pipeline List of pipeline operations
192+
* @param array $pipeline Aggregation pipeline
193193
* @param array $options Command options
194194
* @return Traversable
195195
* @throws UnexpectedValueException if the command response was malformed
@@ -600,7 +600,7 @@ public function selectGridFSBucket(array $options = [])
600600
* Create a change stream for watching changes to the database.
601601
*
602602
* @see Watch::__construct() for supported options
603-
* @param array $pipeline List of pipeline operations
603+
* @param array $pipeline Aggregation pipeline
604604
* @param array $options Command options
605605
* @return ChangeStream
606606
* @throws InvalidArgumentException for parameter/option parsing errors

src/Operation/Aggregate.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -131,15 +131,15 @@ class Aggregate implements Executable, Explainable
131131
*
132132
* @param string $databaseName Database name
133133
* @param string|null $collectionName Collection name
134-
* @param array $pipeline List of pipeline operations
134+
* @param array $pipeline Aggregation pipeline
135135
* @param array $options Command options
136136
* @throws InvalidArgumentException for parameter/option parsing errors
137137
*/
138138
public function __construct(string $databaseName, ?string $collectionName, array $pipeline, array $options = [])
139139
{
140140
// Empty pipelines are allowed
141141
if ($pipeline !== [] && ! is_pipeline($pipeline)) {
142-
throw new InvalidArgumentException('$pipeline is not a valid list of pipeline operations');
142+
throw new InvalidArgumentException('$pipeline is not a valid aggregation pipeline');
143143
}
144144

145145
$options += ['useCursor' => true];

src/Operation/CreateCollection.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,7 @@ public function __construct(string $databaseName, string $collectionName, array
241241
}
242242

243243
if (isset($options['pipeline']) && ! is_pipeline($options['pipeline'])) {
244-
throw new InvalidArgumentException('"pipeline" option is not a valid list of pipeline operations');
244+
throw new InvalidArgumentException('"pipeline" option is not a valid aggregation pipeline');
245245
}
246246

247247
$this->databaseName = $databaseName;

src/Operation/Watch.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ class Watch implements Executable, /* @internal */ CommandSubscriber
197197
* @param Manager $manager Manager instance from the driver
198198
* @param string|null $databaseName Database name
199199
* @param string|null $collectionName Collection name
200-
* @param array $pipeline List of pipeline operations
200+
* @param array $pipeline Aggregation pipeline
201201
* @param array $options Command options
202202
* @throws InvalidArgumentException for parameter/option parsing errors
203203
*/

src/functions.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -290,7 +290,7 @@ function is_in_transaction(array $options): bool
290290
* executed against a primary server.
291291
*
292292
* @internal
293-
* @param array $pipeline List of pipeline operations
293+
* @param array $pipeline Aggregation pipeline
294294
*/
295295
function is_last_pipeline_operator_write(array $pipeline): bool
296296
{

tests/Operation/AggregateTest.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ class AggregateTest extends TestCase
1010
public function testConstructorPipelineArgumentMustBeAList(): void
1111
{
1212
$this->expectException(InvalidArgumentException::class);
13-
$this->expectExceptionMessage('$pipeline is not a valid list of pipeline operations');
13+
$this->expectExceptionMessage('$pipeline is not a valid aggregation pipeline');
1414
new Aggregate($this->getDatabaseName(), $this->getCollectionName(), [1 => ['$match' => ['x' => 1]]]);
1515
}
1616

tests/Operation/CreateCollectionTest.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ class CreateCollectionTest extends TestCase
1010
public function testConstructorPipelineOptionMustBeAList(): void
1111
{
1212
$this->expectException(InvalidArgumentException::class);
13-
$this->expectExceptionMessage('"pipeline" option is not a valid list of pipeline operations');
13+
$this->expectExceptionMessage('"pipeline" option is not a valid aggregation pipeline');
1414
new CreateCollection($this->getDatabaseName(), $this->getCollectionName(), ['pipeline' => [1 => ['$match' => ['x' => 1]]]]);
1515
}
1616

tests/Operation/WatchTest.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ public function testConstructorCollectionNameShouldBeNullIfDatabaseNameIsNull():
2323
public function testConstructorPipelineArgumentMustBeAList(): void
2424
{
2525
$this->expectException(InvalidArgumentException::class);
26-
$this->expectExceptionMessage('$pipeline is not a valid list of pipeline operations');
26+
$this->expectExceptionMessage('$pipeline is not a valid aggregation pipeline');
2727

2828
/* Note: Watch uses array_unshift() to prepend the $changeStream stage
2929
* to the pipeline. Since array_unshift() reindexes numeric keys, we'll

0 commit comments

Comments
 (0)