php-doc-en/reference/mongo/mongodb/createdbref.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>
 <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
-->