yxorP Documentation

Context
in package

Execution context for spec tests.

This object tracks state that would be difficult to store on the test itself due to the design of PHPUnit's data providers and setUp/tearDown methods.

Table of Contents

$bucketName  : string|null
$collectionName  : string|null
$databaseName  : string
$defaultWriteOptions  : array<string|int, mixed>
$outcomeCollectionName  : string|null
$outcomeReadOptions  : array<string|int, mixed>
$session0  : Session|null
$session0Lsid  : object
$session1  : Session|null
$session1Lsid  : object
$client  : Client|null
$encryptedClient  : Client|null
$useEncryptedClient  : bool
disableEncryption()  : void
enableEncryption()  : void
fromChangeStreams()  : mixed
fromClientSideEncryption()  : mixed
fromCommandMonitoring()  : mixed
fromCrud()  : mixed
fromReadWriteConcern()  : mixed
fromRetryableReads()  : mixed
fromRetryableWrites()  : mixed
fromTransactions()  : mixed
getAWSCredentials()  : array<string|int, mixed>
getAzureCredentials()  : array<string|int, mixed>
getClient()  : Client
getCollection()  : mixed
getDatabase()  : mixed
getGCPCredentials()  : array<string|int, mixed>
getGridFSBucket()  : mixed
getKmipEndpoint()  : string
getKmsTlsOptions()  : array<string|int, mixed>
prepareOptions()  : array<string|int, mixed>
Prepare options readConcern, readPreference, and writeConcern options by creating value objects.
replaceArgumentSessionPlaceholder()  : void
Replace a session placeholder in an operation arguments array.
replaceCommandSessionPlaceholder()  : void
Replace a logical session ID placeholder in a command document.
selectCollection()  : mixed
selectDatabase()  : mixed
selectGridFSBucket()  : mixed
__construct()  : mixed
prepareGridFSBucketOptions()  : mixed
prepareSessionOptions()  : mixed

Properties

$bucketName

public string|null $bucketName

$collectionName

public string|null $collectionName

$databaseName

public string $databaseName

$defaultWriteOptions

public array<string|int, mixed> $defaultWriteOptions = []

$outcomeCollectionName

public string|null $outcomeCollectionName

$outcomeReadOptions

public array<string|int, mixed> $outcomeReadOptions = []

$session0

public Session|null $session0

$session0Lsid

public object $session0Lsid

$session1

public Session|null $session1

$session1Lsid

public object $session1Lsid

$useEncryptedClient

private bool $useEncryptedClient = false

Methods

disableEncryption()

public disableEncryption() : void
Return values
void

enableEncryption()

public enableEncryption() : void
Return values
void

fromChangeStreams()

public static fromChangeStreams(stdClass $test, mixed $databaseName, mixed $collectionName) : mixed
Parameters
$test : stdClass
$databaseName : mixed
$collectionName : mixed
Return values
mixed

fromClientSideEncryption()

public static fromClientSideEncryption(stdClass $test, mixed $databaseName, mixed $collectionName) : mixed
Parameters
$test : stdClass
$databaseName : mixed
$collectionName : mixed
Return values
mixed

fromCommandMonitoring()

public static fromCommandMonitoring(stdClass $test, mixed $databaseName, mixed $collectionName) : mixed
Parameters
$test : stdClass
$databaseName : mixed
$collectionName : mixed
Return values
mixed

fromCrud()

public static fromCrud(stdClass $test, mixed $databaseName, mixed $collectionName) : mixed
Parameters
$test : stdClass
$databaseName : mixed
$collectionName : mixed
Return values
mixed

fromReadWriteConcern()

public static fromReadWriteConcern(stdClass $test, mixed $databaseName, mixed $collectionName) : mixed
Parameters
$test : stdClass
$databaseName : mixed
$collectionName : mixed
Return values
mixed

fromRetryableReads()

public static fromRetryableReads(stdClass $test, mixed $databaseName, mixed $collectionName, mixed $bucketName) : mixed
Parameters
$test : stdClass
$databaseName : mixed
$collectionName : mixed
$bucketName : mixed
Return values
mixed

fromRetryableWrites()

public static fromRetryableWrites(stdClass $test, mixed $databaseName, mixed $collectionName, mixed $useMultipleMongoses) : mixed
Parameters
$test : stdClass
$databaseName : mixed
$collectionName : mixed
$useMultipleMongoses : mixed
Return values
mixed

fromTransactions()

public static fromTransactions(stdClass $test, mixed $databaseName, mixed $collectionName, mixed $useMultipleMongoses) : mixed
Parameters
$test : stdClass
$databaseName : mixed
$collectionName : mixed
$useMultipleMongoses : mixed
Return values
mixed

getAWSCredentials()

public static getAWSCredentials() : array<string|int, mixed>
Return values
array<string|int, mixed>

getAzureCredentials()

public static getAzureCredentials() : array<string|int, mixed>
Return values
array<string|int, mixed>

getCollection()

public getCollection([array<string|int, mixed> $collectionOptions = [] ][, array<string|int, mixed> $databaseOptions = [] ]) : mixed
Parameters
$collectionOptions : array<string|int, mixed> = []
$databaseOptions : array<string|int, mixed> = []
Return values
mixed

getDatabase()

public getDatabase([array<string|int, mixed> $databaseOptions = [] ]) : mixed
Parameters
$databaseOptions : array<string|int, mixed> = []
Return values
mixed

getGCPCredentials()

public static getGCPCredentials() : array<string|int, mixed>
Return values
array<string|int, mixed>

getGridFSBucket()

public getGridFSBucket([array<string|int, mixed> $bucketOptions = [] ]) : mixed
Parameters
$bucketOptions : array<string|int, mixed> = []
Return values
mixed

getKmipEndpoint()

public static getKmipEndpoint() : string
Return values
string

getKmsTlsOptions()

public static getKmsTlsOptions() : array<string|int, mixed>
Return values
array<string|int, mixed>

prepareOptions()

Prepare options readConcern, readPreference, and writeConcern options by creating value objects.

public prepareOptions(array<string|int, mixed> $options) : array<string|int, mixed>
Parameters
$options : array<string|int, mixed>
Tags
throws
LogicException

if any option keys are unsupported

Return values
array<string|int, mixed>

replaceArgumentSessionPlaceholder()

Replace a session placeholder in an operation arguments array.

public replaceArgumentSessionPlaceholder(array<string|int, mixed> &$args) : void

Note: this method will modify the $args parameter.

Parameters
$args : array<string|int, mixed>

Operation arguments

Tags
throws
LogicException

if the session placeholder is unsupported

Return values
void

replaceCommandSessionPlaceholder()

Replace a logical session ID placeholder in a command document.

public replaceCommandSessionPlaceholder(stdClass $command) : void

Note: this method will modify the $command parameter.

Parameters
$command : stdClass

Command document

Tags
throws
LogicException

if the session placeholder is unsupported

Return values
void

selectCollection()

public selectCollection(mixed $databaseName, mixed $collectionName[, array<string|int, mixed> $collectionOptions = [] ][, array<string|int, mixed> $databaseOptions = [] ]) : mixed
Parameters
$databaseName : mixed
$collectionName : mixed
$collectionOptions : array<string|int, mixed> = []
$databaseOptions : array<string|int, mixed> = []
Return values
mixed

selectDatabase()

public selectDatabase(mixed $databaseName[, array<string|int, mixed> $databaseOptions = [] ]) : mixed
Parameters
$databaseName : mixed
$databaseOptions : array<string|int, mixed> = []
Return values
mixed

selectGridFSBucket()

public selectGridFSBucket(mixed $databaseName, mixed $bucketName[, array<string|int, mixed> $bucketOptions = [] ]) : mixed
Parameters
$databaseName : mixed
$bucketName : mixed
$bucketOptions : array<string|int, mixed> = []
Return values
mixed

__construct()

private __construct(string $databaseName, string|null $collectionName) : mixed
Parameters
$databaseName : string
$collectionName : string|null
Return values
mixed

prepareGridFSBucketOptions()

private prepareGridFSBucketOptions(array<string|int, mixed> $options, mixed $bucketPrefix) : mixed
Parameters
$options : array<string|int, mixed>
$bucketPrefix : mixed
Return values
mixed

prepareSessionOptions()

private prepareSessionOptions(array<string|int, mixed> $options) : mixed
Parameters
$options : array<string|int, mixed>
Return values
mixed

Search results