mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 14:28:56 +00:00
e278c8f3a5
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@294254 c90b9560-bf6c-de11-be94-00142212c4b1
78 lines
2 KiB
XML
78 lines
2 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="mongodb.createdbref" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>MongoDB::createDBRef</refname>
|
|
<refpurpose>Creates a database reference</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>public</modifier> <type>array</type><methodname>MongoDB::createDBRef</methodname>
|
|
<methodparam><type>string</type><parameter>collection</parameter></methodparam>
|
|
<methodparam><type>mixed</type><parameter>a</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
This method is a flexible interface for creating database refrences (see
|
|
<classname>MongoDBRef</classname>).
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term>
|
|
<parameter>collection</parameter>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
The collection to which the database reference will point.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<parameter>a</parameter>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
Object or _id to which to create a reference. If an object or
|
|
associative array is given, this will create a reference using
|
|
the <literal>_id</literal> field.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns a database reference array.
|
|
</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
|
|
-->
|