MongoCollection::toIndexString

(PECL mongo >=0.9.0)

MongoCollection::toIndexString — Converts keys specifying an index to its identifying string

说明

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

Warning

This method is deprecated since version 1.5.0.

参数

keys: Field or fields to convert to the identifying string

返回值

Returns a string that describes the index.

范例

Example #1 MongoCollection::toIndexString() example

This example shows how you can create an index name out of keys. Because this is a protected (static) method, you need to overload it in a child class first.

  <?php
 // Create inherited class to make the method "public".
 class  MyCollection  extends  MongoCollection
 {
    static public function  toIndexString ( $a )
    {
        return  parent :: toIndexString ( $a );
    }
}

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

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

参见

MongoDB core docs on » indexes.

更新日志

版本	说明
1.5.0	This method has been deprecated.