Skip to content

Commit da3f71f

Browse files
committed
Reword "list of pipeline operations"
As used in the doc
1 parent 23f5f55 commit da3f71f

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
@@ -599,7 +599,7 @@ public function selectGridFSBucket(array $options = [])
599599
* Create a change stream for watching changes to the database.
600600
*
601601
* @see Watch::__construct() for supported options
602-
* @param array $pipeline List of pipeline operations
602+
* @param array $pipeline Aggregation pipeline
603603
* @param array $options Command options
604604
* @return ChangeStream
605605
* @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
@@ -132,15 +132,15 @@ class Aggregate implements Executable, Explainable
132132
*
133133
* @param string $databaseName Database name
134134
* @param string|null $collectionName Collection name
135-
* @param array $pipeline List of pipeline operations
135+
* @param array $pipeline Aggregation pipeline
136136
* @param array $options Command options
137137
* @throws InvalidArgumentException for parameter/option parsing errors
138138
*/
139139
public function __construct(string $databaseName, ?string $collectionName, array $pipeline, array $options = [])
140140
{
141141
// Empty pipelines are allowed
142142
if ($pipeline !== [] && ! is_pipeline($pipeline)) {
143-
throw new InvalidArgumentException('$pipeline is not a valid list of pipeline operations');
143+
throw new InvalidArgumentException('$pipeline is not a valid aggregation pipeline');
144144
}
145145

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

src/Operation/CreateCollection.php

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

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

248248
$this->databaseName = $databaseName;

src/Operation/Watch.php

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

src/functions.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -262,7 +262,7 @@ function is_in_transaction(array $options): bool
262262
* executed against a primary server.
263263
*
264264
* @internal
265-
* @param array $pipeline List of pipeline operations
265+
* @param array $pipeline Aggregation pipeline
266266
*/
267267
function is_last_pipeline_operator_write(array $pipeline): bool
268268
{

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)