1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 331115 $ -->
<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>document_or_id</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>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><function>MongoDB::createDBRef</function> example</title>
<para>
Example demonstrating how to programatically create a DB reference array from
a document.
</para>
<programlisting role="php">
<![CDATA[
<?php
$articles = $db->articles;
$article = array(
'title' => 'Test article',
'description' => 'Test article description'
);
$articles->insert($article);
$ref = $db->createDBRef('articles', $article);
print_r($article);
print_r($ref);
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
Array
(
[title] => Test article
[description] => Test article description
[_id] => MongoId Object
(
)
)
Array
(
[$ref] => articles
[$id] => MongoId Object
(
)
)
]]>
</screen>
<para>
Now the $ref can be stored on another document and retrieved later with
<methodname>MongoDB::getDBRef</methodname> or <methodname>MongoCollection::getDBRef</methodname>.
</para>
</example>
<example>
<title><function>MongoDB::createDBRef</function> example</title>
<para>
Example demonstrating how to programatically create a DB reference from just an id.
</para>
<programlisting role="php">
<![CDATA[
<?php
$id = new MongoId('47cc67093475061e3d9536d2');
$ref = $db->createDBRef('articles', $id);
?>
]]>
</programlisting>
</example>
</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
-->
|
