yxorP Documentation

BulkWriteTest extends TestCase
in package

Base class for Operation unit tests.

Table of Contents

assertMatchesDocument()  : void
Asserts that a document has expected values for some fields.
assertSameDocument()  : void
Asserts that a document has expected values for all fields.
assertSameDocuments()  : void
dataDescription()  : string
Compatibility method as PHPUnit 9 no longer includes this method.
getUri()  : string
Return the connection URI.
provideInvalidArrayValues()  : mixed
provideInvalidBooleanValues()  : mixed
provideInvalidConstructorOptions()  : mixed
provideInvalidDocumentValues()  : mixed
testConstructorOptionTypeChecks()  : void
testDeleteManyCollationOptionTypeCheck()  : void
testDeleteManyFilterArgumentMissing()  : void
testDeleteManyFilterArgumentTypeCheck()  : void
testDeleteOneCollationOptionTypeCheck()  : void
testDeleteOneFilterArgumentMissing()  : void
testDeleteOneFilterArgumentTypeCheck()  : void
testInsertOneDocumentArgumentMissing()  : void
testInsertOneDocumentArgumentTypeCheck()  : void
testMultipleOperationsInOneElement()  : void
testOperationsMustBeAList()  : void
testOperationsMustNotBeEmpty()  : void
testReplaceOneCollationOptionTypeCheck()  : void
testReplaceOneFilterArgumentMissing()  : void
testReplaceOneFilterArgumentTypeCheck()  : void
testReplaceOneReplacementArgumentMissing()  : void
testReplaceOneReplacementArgumentRequiresNoOperators()  : void
testReplaceOneReplacementArgumentTypeCheck()  : void
testReplaceOneUpsertOptionTypeCheck()  : void
testUnknownOperation()  : void
testUpdateManyArrayFiltersOptionTypeCheck()  : void
testUpdateManyCollationOptionTypeCheck()  : void
testUpdateManyFilterArgumentMissing()  : void
testUpdateManyFilterArgumentTypeCheck()  : void
testUpdateManyUpdateArgumentMissing()  : void
testUpdateManyUpdateArgumentRequiresOperatorsOrPipeline()  : void
testUpdateManyUpdateArgumentTypeCheck()  : void
testUpdateManyUpsertOptionTypeCheck()  : void
testUpdateOneArrayFiltersOptionTypeCheck()  : void
testUpdateOneCollationOptionTypeCheck()  : void
testUpdateOneFilterArgumentMissing()  : void
testUpdateOneFilterArgumentTypeCheck()  : void
testUpdateOneUpdateArgumentMissing()  : void
testUpdateOneUpdateArgumentRequiresOperatorsOrPipeline()  : void
testUpdateOneUpdateArgumentTypeCheck()  : void
testUpdateOneUpsertOptionTypeCheck()  : void
assertDeprecated()  : void
getCollectionName()  : string
Return the test collection name.
getDatabaseName()  : string
Return the test database name.
getInvalidArrayValues()  : array<string|int, mixed>
Return a list of invalid array values.
getInvalidBooleanValues()  : array<string|int, mixed>
Return a list of invalid boolean values.
getInvalidDocumentValues()  : array<string|int, mixed>
Return a list of invalid document values.
getInvalidIntegerValues()  : array<string|int, mixed>
Return a list of invalid integer values.
getInvalidReadConcernValues()  : array<string|int, mixed>
Return a list of invalid ReadPreference values.
getInvalidReadPreferenceValues()  : array<string|int, mixed>
Return a list of invalid ReadPreference values.
getInvalidSessionValues()  : array<string|int, mixed>
Return a list of invalid Session values.
getInvalidStringValues()  : array<string|int, mixed>
Return a list of invalid string values.
getInvalidWriteConcernValues()  : array<string|int, mixed>
Return a list of invalid WriteConcern values.
getNamespace()  : string
Return the test namespace.
wrapValuesForDataProvider()  : array<string|int, mixed>
Wrap a list of values for use as a single-argument data provider.
normalizeBSON()  : BSONDocument|BSONArray
Normalizes a BSON document or array for use with assertEquals().

Methods

assertMatchesDocument()

Asserts that a document has expected values for some fields.

public assertMatchesDocument(array<string|int, mixed>|object $expectedDocument, array<string|int, mixed>|object $actualDocument) : void

Only fields in the expected document will be checked. The actual document may contain additional fields.

Parameters
$expectedDocument : array<string|int, mixed>|object
$actualDocument : array<string|int, mixed>|object
Return values
void

assertSameDocument()

Asserts that a document has expected values for all fields.

public assertSameDocument(array<string|int, mixed>|object $expectedDocument, array<string|int, mixed>|object $actualDocument) : void

The actual document will be compared directly with the expected document and may not contain extra fields.

Parameters
$expectedDocument : array<string|int, mixed>|object
$actualDocument : array<string|int, mixed>|object
Return values
void

assertSameDocuments()

public assertSameDocuments(array<string|int, mixed> $expectedDocuments, mixed $actualDocuments) : void
Parameters
$expectedDocuments : array<string|int, mixed>
$actualDocuments : mixed
Return values
void

dataDescription()

Compatibility method as PHPUnit 9 no longer includes this method.

public dataDescription() : string
Return values
string

getUri()

Return the connection URI.

public static getUri() : string
Return values
string

provideInvalidArrayValues()

public provideInvalidArrayValues() : mixed
Return values
mixed

provideInvalidBooleanValues()

public provideInvalidBooleanValues() : mixed
Return values
mixed

provideInvalidConstructorOptions()

public provideInvalidConstructorOptions() : mixed
Return values
mixed

provideInvalidDocumentValues()

public provideInvalidDocumentValues() : mixed
Return values
mixed

testConstructorOptionTypeChecks()

public testConstructorOptionTypeChecks(array<string|int, mixed> $options) : void
Parameters
$options : array<string|int, mixed>
Tags
dataProvider

provideInvalidConstructorOptions

Return values
void

testDeleteManyCollationOptionTypeCheck()

public testDeleteManyCollationOptionTypeCheck(mixed $collation) : void
Parameters
$collation : mixed
Tags
dataProvider

provideInvalidDocumentValues

Return values
void

testDeleteManyFilterArgumentMissing()

public testDeleteManyFilterArgumentMissing() : void
Return values
void

testDeleteManyFilterArgumentTypeCheck()

public testDeleteManyFilterArgumentTypeCheck(mixed $document) : void
Parameters
$document : mixed
Tags
dataProvider

provideInvalidDocumentValues

Return values
void

testDeleteOneCollationOptionTypeCheck()

public testDeleteOneCollationOptionTypeCheck(mixed $collation) : void
Parameters
$collation : mixed
Tags
dataProvider

provideInvalidDocumentValues

Return values
void

testDeleteOneFilterArgumentMissing()

public testDeleteOneFilterArgumentMissing() : void
Return values
void

testDeleteOneFilterArgumentTypeCheck()

public testDeleteOneFilterArgumentTypeCheck(mixed $document) : void
Parameters
$document : mixed
Tags
dataProvider

provideInvalidDocumentValues

Return values
void

testInsertOneDocumentArgumentMissing()

public testInsertOneDocumentArgumentMissing() : void
Return values
void

testInsertOneDocumentArgumentTypeCheck()

public testInsertOneDocumentArgumentTypeCheck(mixed $document) : void
Parameters
$document : mixed
Tags
dataProvider

provideInvalidDocumentValues

Return values
void

testMultipleOperationsInOneElement()

public testMultipleOperationsInOneElement() : void
Return values
void

testOperationsMustBeAList()

public testOperationsMustBeAList() : void
Return values
void

testOperationsMustNotBeEmpty()

public testOperationsMustNotBeEmpty() : void
Return values
void

testReplaceOneCollationOptionTypeCheck()

public testReplaceOneCollationOptionTypeCheck(mixed $collation) : void
Parameters
$collation : mixed
Tags
dataProvider

provideInvalidDocumentValues

Return values
void

testReplaceOneFilterArgumentMissing()

public testReplaceOneFilterArgumentMissing() : void
Return values
void

testReplaceOneFilterArgumentTypeCheck()

public testReplaceOneFilterArgumentTypeCheck(mixed $filter) : void
Parameters
$filter : mixed
Tags
dataProvider

provideInvalidDocumentValues

Return values
void

testReplaceOneReplacementArgumentMissing()

public testReplaceOneReplacementArgumentMissing() : void
Return values
void

testReplaceOneReplacementArgumentRequiresNoOperators()

public testReplaceOneReplacementArgumentRequiresNoOperators() : void
Return values
void

testReplaceOneReplacementArgumentTypeCheck()

public testReplaceOneReplacementArgumentTypeCheck(mixed $replacement) : void
Parameters
$replacement : mixed
Tags
dataProvider

provideInvalidDocumentValues

Return values
void

testReplaceOneUpsertOptionTypeCheck()

public testReplaceOneUpsertOptionTypeCheck(mixed $upsert) : void
Parameters
$upsert : mixed
Tags
dataProvider

provideInvalidBooleanValues

Return values
void

testUnknownOperation()

public testUnknownOperation() : void
Return values
void

testUpdateManyArrayFiltersOptionTypeCheck()

public testUpdateManyArrayFiltersOptionTypeCheck(mixed $arrayFilters) : void
Parameters
$arrayFilters : mixed
Tags
dataProvider

provideInvalidArrayValues

Return values
void

testUpdateManyCollationOptionTypeCheck()

public testUpdateManyCollationOptionTypeCheck(mixed $collation) : void
Parameters
$collation : mixed
Tags
dataProvider

provideInvalidDocumentValues

Return values
void

testUpdateManyFilterArgumentMissing()

public testUpdateManyFilterArgumentMissing() : void
Return values
void

testUpdateManyFilterArgumentTypeCheck()

public testUpdateManyFilterArgumentTypeCheck(mixed $filter) : void
Parameters
$filter : mixed
Tags
dataProvider

provideInvalidDocumentValues

Return values
void

testUpdateManyUpdateArgumentMissing()

public testUpdateManyUpdateArgumentMissing() : void
Return values
void

testUpdateManyUpdateArgumentRequiresOperatorsOrPipeline()

public testUpdateManyUpdateArgumentRequiresOperatorsOrPipeline() : void
Return values
void

testUpdateManyUpdateArgumentTypeCheck()

public testUpdateManyUpdateArgumentTypeCheck(mixed $update) : void
Parameters
$update : mixed
Tags
dataProvider

provideInvalidDocumentValues

Return values
void

testUpdateManyUpsertOptionTypeCheck()

public testUpdateManyUpsertOptionTypeCheck(mixed $upsert) : void
Parameters
$upsert : mixed
Tags
dataProvider

provideInvalidBooleanValues

Return values
void

testUpdateOneArrayFiltersOptionTypeCheck()

public testUpdateOneArrayFiltersOptionTypeCheck(mixed $arrayFilters) : void
Parameters
$arrayFilters : mixed
Tags
dataProvider

provideInvalidArrayValues

Return values
void

testUpdateOneCollationOptionTypeCheck()

public testUpdateOneCollationOptionTypeCheck(mixed $collation) : void
Parameters
$collation : mixed
Tags
dataProvider

provideInvalidDocumentValues

Return values
void

testUpdateOneFilterArgumentMissing()

public testUpdateOneFilterArgumentMissing() : void
Return values
void

testUpdateOneFilterArgumentTypeCheck()

public testUpdateOneFilterArgumentTypeCheck(mixed $filter) : void
Parameters
$filter : mixed
Tags
dataProvider

provideInvalidDocumentValues

Return values
void

testUpdateOneUpdateArgumentMissing()

public testUpdateOneUpdateArgumentMissing() : void
Return values
void

testUpdateOneUpdateArgumentRequiresOperatorsOrPipeline()

public testUpdateOneUpdateArgumentRequiresOperatorsOrPipeline() : void
Return values
void

testUpdateOneUpdateArgumentTypeCheck()

public testUpdateOneUpdateArgumentTypeCheck(mixed $update) : void
Parameters
$update : mixed
Tags
dataProvider

provideInvalidDocumentValues

Return values
void

testUpdateOneUpsertOptionTypeCheck()

public testUpdateOneUpsertOptionTypeCheck(mixed $upsert) : void
Parameters
$upsert : mixed
Tags
dataProvider

provideInvalidBooleanValues

Return values
void

assertDeprecated()

protected assertDeprecated(callable $execution) : void
Parameters
$execution : callable
Return values
void

getCollectionName()

Return the test collection name.

protected getCollectionName() : string
Return values
string

getDatabaseName()

Return the test database name.

protected getDatabaseName() : string
Return values
string

getInvalidArrayValues()

Return a list of invalid array values.

protected getInvalidArrayValues([bool $includeNull = false ]) : array<string|int, mixed>
Parameters
$includeNull : bool = false
Return values
array<string|int, mixed>

getInvalidBooleanValues()

Return a list of invalid boolean values.

protected getInvalidBooleanValues([bool $includeNull = false ]) : array<string|int, mixed>
Parameters
$includeNull : bool = false
Return values
array<string|int, mixed>

getInvalidDocumentValues()

Return a list of invalid document values.

protected getInvalidDocumentValues([bool $includeNull = false ]) : array<string|int, mixed>
Parameters
$includeNull : bool = false
Return values
array<string|int, mixed>

getInvalidIntegerValues()

Return a list of invalid integer values.

protected getInvalidIntegerValues([bool $includeNull = false ]) : array<string|int, mixed>
Parameters
$includeNull : bool = false
Return values
array<string|int, mixed>

getInvalidReadConcernValues()

Return a list of invalid ReadPreference values.

protected getInvalidReadConcernValues([bool $includeNull = false ]) : array<string|int, mixed>
Parameters
$includeNull : bool = false
Return values
array<string|int, mixed>

getInvalidReadPreferenceValues()

Return a list of invalid ReadPreference values.

protected getInvalidReadPreferenceValues([bool $includeNull = false ]) : array<string|int, mixed>
Parameters
$includeNull : bool = false
Return values
array<string|int, mixed>

getInvalidSessionValues()

Return a list of invalid Session values.

protected getInvalidSessionValues([bool $includeNull = false ]) : array<string|int, mixed>
Parameters
$includeNull : bool = false
Return values
array<string|int, mixed>

getInvalidStringValues()

Return a list of invalid string values.

protected getInvalidStringValues([bool $includeNull = false ]) : array<string|int, mixed>
Parameters
$includeNull : bool = false
Return values
array<string|int, mixed>

getInvalidWriteConcernValues()

Return a list of invalid WriteConcern values.

protected getInvalidWriteConcernValues([bool $includeNull = false ]) : array<string|int, mixed>
Parameters
$includeNull : bool = false
Return values
array<string|int, mixed>

getNamespace()

Return the test namespace.

protected getNamespace() : string
Return values
string

wrapValuesForDataProvider()

Wrap a list of values for use as a single-argument data provider.

protected wrapValuesForDataProvider(array<string|int, mixed> $values) : array<string|int, mixed>
Parameters
$values : array<string|int, mixed>

List of values

Return values
array<string|int, mixed>

normalizeBSON()

Normalizes a BSON document or array for use with assertEquals().

private normalizeBSON(array<string|int, mixed>|object $bson) : BSONDocument|BSONArray

The argument will be converted to a BSONArray or BSONDocument based on its type and keys. Document fields will be sorted alphabetically. Each value within the array or document will then be normalized recursively.

Parameters
$bson : array<string|int, mixed>|object
Tags
throws
InvalidArgumentException

if $bson is not an array or object

Return values
BSONDocument|BSONArray

Search results