MongoCollection::toIndexString

(PECL mongo >=0.9.0)

MongoCollection::toIndexString — インデックスを指定するキーを、インデックスを指す文字列に変換する

説明

static protected MongoCollection::toIndexString ( mixed $keys ) : string
警告

このメソッドは、バージョン 1.5.0 以降は非推奨となりました。

パラメータ

keys

指し示す文字列に変換したいフィールド。

返り値

インデックスを表す文字列を返します。

例

例1 MongoCollection::toIndexString() の例

この例は、キーからインデックス名を作成する方法を示します。 このメソッドは protected (static) メソッドなので、まずは子クラスでオーバーロードしなければなりません。

<?php
// 派生クラスを作ってメソッドを "public" にします
class MyCollection extends MongoCollection
{
    static public function toIndexString($a)
    {
        return parent::toIndexString($a);
    }
}

echo MyCollection::toIndexString("foo"), "\n";
// 出力: foo_1

echo MyCollection::toIndexString(array('name' => 1, 'age' => -1)), "\n";
// 出力: name_1_age_-1
?>

参考

MongoDB コアドキュメントの » indexes

変更履歴

バージョン 説明
1.5.0 このメソッドは非推奨になりました。