• Reference >
• Enumeration Classes >
• MongoDB\Model\IndexInfo::isText()

MongoDB\Model\IndexInfo::isText()

New in version 1.4.

Definition

MongoDB\Model\IndexInfo::isText

Return whether the index is a text index.

copy

function isText(): boolean

Return Values

A boolean indicating whether the index is a text index.

Examples

copy

<?php

$collection = (new MongoDB\Client)->selectCollection('test', 'restaurants');

$collection->createIndex(['name' => 'text']);

foreach ($collection->listIndexes() as $index) {
    if ($index->isText()) {
        printf("%s has default language: %d\n", $index->getName(), $index['default_language']);
    }
}

The output would then resemble:

copy

name_text has default language: english

See Also

• MongoDB\Collection::createIndex()
• MongoDB\Collection::listIndexes()
• Text Indexes reference in the MongoDB manual

←   MongoDB\Model\IndexInfo::isSparse() MongoDB\Model\IndexInfo::isTtl()  →

© MongoDB, Inc 2008-present. MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc.