FunctionsTest
extends TestCase
in package
Unit tests for utility functions.
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.
- provideDocumentAndTypeMap() : mixed
- provideIndexSpecificationDocumentsAndGeneratedNames() : mixed
- provideInvalidArrayValues() : mixed
- provideInvalidDocumentValues() : mixed
- provideIsFirstKeyOperatorDocuments() : mixed
- provideMapReduceOutValues() : mixed
- providePipelines() : mixed
- provideTypeMapValues() : mixed
- provideWriteConcerns() : array<string|int, mixed>
- testApplyTypeMapToDocument() : void
- testCreateFieldPathTypeMap() : void
- testGenerateIndexName() : void
- testGenerateIndexNameArgumentTypeCheck() : void
- testIsFirstKeyOperator() : void
- testIsFirstKeyOperatorArgumentTypeCheck() : void
- testIsMapReduceOutputInline() : void
- testIsPipeline() : void
- testIsWriteConcernAcknowledged() : 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 —provideDocumentAndTypeMap()
public
provideDocumentAndTypeMap() : mixed
Return values
mixed —provideIndexSpecificationDocumentsAndGeneratedNames()
public
provideIndexSpecificationDocumentsAndGeneratedNames() : mixed
Return values
mixed —provideInvalidArrayValues()
public
provideInvalidArrayValues() : mixed
Return values
mixed —provideInvalidDocumentValues()
public
provideInvalidDocumentValues() : mixed
Return values
mixed —provideIsFirstKeyOperatorDocuments()
public
provideIsFirstKeyOperatorDocuments() : mixed
Return values
mixed —provideMapReduceOutValues()
public
provideMapReduceOutValues() : mixed
Return values
mixed —providePipelines()
public
providePipelines() : mixed
Return values
mixed —provideTypeMapValues()
public
provideTypeMapValues() : mixed
Return values
mixed —provideWriteConcerns()
public
provideWriteConcerns() : array<string|int, mixed>
Return values
array<string|int, mixed> —testApplyTypeMapToDocument()
public
testApplyTypeMapToDocument(mixed $document, array<string|int, mixed> $typeMap, mixed $expectedDocument) : void
Parameters
- $document : mixed
- $typeMap : array<string|int, mixed>
- $expectedDocument : mixed
Tags
Return values
void —testCreateFieldPathTypeMap()
public
testCreateFieldPathTypeMap(array<string|int, mixed> $expected, array<string|int, mixed> $typeMap[, mixed $fieldPath = 'field' ]) : void
Parameters
- $expected : array<string|int, mixed>
- $typeMap : array<string|int, mixed>
- $fieldPath : mixed = 'field'
Tags
Return values
void —testGenerateIndexName()
public
testGenerateIndexName(mixed $document, mixed $expectedName) : void
Parameters
- $document : mixed
- $expectedName : mixed
Tags
Return values
void —testGenerateIndexNameArgumentTypeCheck()
public
testGenerateIndexNameArgumentTypeCheck(mixed $document) : void
Parameters
- $document : mixed
Tags
Return values
void —testIsFirstKeyOperator()
public
testIsFirstKeyOperator(mixed $document, mixed $isFirstKeyOperator) : void
Parameters
- $document : mixed
- $isFirstKeyOperator : mixed
Tags
Return values
void —testIsFirstKeyOperatorArgumentTypeCheck()
public
testIsFirstKeyOperatorArgumentTypeCheck(mixed $document) : void
Parameters
- $document : mixed
Tags
Return values
void —testIsMapReduceOutputInline()
public
testIsMapReduceOutputInline(mixed $out, mixed $isInline) : void
Parameters
- $out : mixed
- $isInline : mixed
Tags
Return values
void —testIsPipeline()
public
testIsPipeline(mixed $expected, mixed $pipeline) : void
Parameters
- $expected : mixed
- $pipeline : mixed
Tags
Return values
void —testIsWriteConcernAcknowledged()
public
testIsWriteConcernAcknowledged(mixed $expected, WriteConcern $writeConcern) : void
Parameters
- $expected : mixed
- $writeConcern : WriteConcern
Tags
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