MongoIndex

A MongoDB Index definition

class MongoIndex
Copyright
2015-2016 Appertly
License
Apache-2.0

Constructors / Destructors

Public
ReturnsSignature and Description
void
__construct(KeyedTraversable<string,mixed> $keys, ?string $name = null, ?KeyedContainer<string,mixed> $options = null)

Creates an immutable MongoDB Index creation definition

Instance Methods

Public
ReturnsSignature and Description
array<string,mixed>
toArray()

Gets the array version of this index.

Method Details

__construct

public function __construct(KeyedTraversable<string,mixed> $keys, ?string $name = null, ?KeyedContainer<string,mixed> $options = null)

Creates an immutable MongoDB Index creation definition

See
https://docs.mongodb.com/manual/reference/command/createIndexes/
Parameters
NameTypeDescription
$keysKeyedTraversable<string,mixed>

The key definition

$name?string

Optional. The index name.

$options?KeyedContainer<string,mixed>

Optional. Any index creation options.

toArray

public function toArray()

Gets the array version of this index.

Returns
TypeDescription
array<string,mixed>

The array version