mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 14:28:56 +00:00
88fb3e60e4
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@331115 c90b9560-bf6c-de11-be94-00142212c4b1
101 lines
2.6 KiB
XML
101 lines
2.6 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="mongocollection.createdbref" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>MongoCollection::createDBRef</refname>
|
|
<refpurpose>Creates a database reference</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>public</modifier> <type>array</type><methodname>MongoCollection::createDBRef</methodname>
|
|
<methodparam><type>mixed</type><parameter>document_or_id</parameter></methodparam>
|
|
</methodsynopsis>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term>
|
|
<parameter>document_or_id</parameter>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
If an array or object is given, its <literal>_id</literal> field will be
|
|
used as the reference ID. If a <classname>MongoId</classname> or scalar
|
|
is given, it will be used as the reference ID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns a database reference array.
|
|
</para>
|
|
<para>
|
|
If an array without an <literal>_id</literal> field was provided as the
|
|
<literal>document_or_id</literal> parameter, &null; will be returned.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<example>
|
|
<title><methodname>MongoCollection::createDBRef</methodname> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
$songs = $db->songs;
|
|
$playlists = $db->playlists;
|
|
|
|
// create a reference to a song
|
|
$manamana = $songs->findOne(array('title' => 'Ma na ma na'));
|
|
$refToSong = $songs->createDBRef($manamana);
|
|
|
|
// add the reference to my playlist
|
|
$playlists->update(array('username' => 'me'), array('$push' => array('songlist' => $refToSong)));
|
|
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><methodname>MongoCollection::getDBRef</methodname></member>
|
|
</simplelist>
|
|
</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
|
|
-->
|