MongoDBRef::create

Creates a new database reference

Note:

This extension that defines this class is deprecated. Instead, the MongoDB extension should be used. There is no equivalent for this class in the new extension.

The concept of database references, and hence this class, has been deprecated.

Description

public static array MongoDBRef::create ( string $collection , mixed $id [, string $database ] )

If no database is given, the current database is used.

Parameters

collection

Collection name (without the database name).

id

The _id field of the object to which to link.

database

Database name.

Return Values

Returns the reference.

Examples

Example #1 MongoDBRef::create example

This creates a database reference to a document in the addresses collection. The MongoCollection::getName function returns the name of the collection (not including the database name).

<?php
$addresses 
$db->addresses;
$people $db->people;

// save $address so it has an _id
$addresses->insert($address);

// create a reference
$ref MongoDBRef::create($addresses->getName(), $address['_id']);

// set the field in $person
$person['address'] = $ref;
$people->save($person);
?>

See Also

  • MongoDB::createDBRef
  • MongoCollection::createDBRef