mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 14:28:56 +00:00
0aa774414a
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@333548 c90b9560-bf6c-de11-be94-00142212c4b1
128 lines
3 KiB
XML
128 lines
3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="mongocollection.toindexstring" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>MongoCollection::toIndexString</refname>
|
|
<refpurpose>Converts keys specifying an index to its identifying string</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>static protected</modifier> <type>string</type><methodname>MongoCollection::toIndexString</methodname>
|
|
<methodparam><type>mixed</type><parameter>keys</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<warning>
|
|
<para>
|
|
This method is deprecated since version 1.5.0.
|
|
</para>
|
|
</warning>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term>
|
|
<parameter>keys</parameter>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
Field or fields to convert to the identifying string
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns a string that describes the index.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<example>
|
|
<title><function>MongoCollection::toIndexString</function> example</title>
|
|
<para>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.</para>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?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
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
MongoDB core docs on <link xlink:href="&url.mongodb.dochub.indexes;">indexes</link>.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="changelog">
|
|
&reftitle.changelog;
|
|
<para>
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>&Version;</entry>
|
|
<entry>&Description;</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>1.5.0</entry>
|
|
<entry>
|
|
This method has been deprecated.
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</para>
|
|
</refsect1>
|
|
|
|
</refentry>
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|