<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Gets a collection</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongodb.forceerror.html">MongoDB::forceError</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongodb.getcollectionnames.html">MongoDB::getCollectionNames</a></div>
<div class="up"><a href="class.mongodb.html">MongoDB</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="mongodb.get" class="refentry">
<div class="refnamediv">
<h1 class="refname">MongoDB::__get</h1>
<p class="verinfo">(PECL mongo >=1.0.2)</p><p class="refpurpose"><span class="refname">MongoDB::__get</span> — <span class="dc-title">Gets a collection</span></p>
</div>
<div class="refsect1 description" id="refsect1-mongodb.get-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type"><a href="class.mongocollection.html" class="type MongoCollection">MongoCollection</a></span> <span class="methodname"><strong>MongoDB::__get</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span>
)</div>
<p class="para rdfs-comment">
This is the easiest way of getting a collection from a database object. If a
collection name contains strange characters, you may have to use
<span class="function"><a href="mongodb.selectcollection.html" class="function">MongoDB::selectCollection()</a></span> instead.
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$mongo </span><span style="color: #007700">= new </span><span style="color: #0000BB">MongoClient</span><span style="color: #007700">();<br /><br /></span><span style="color: #FF8000">// the following two lines are equivalent<br /></span><span style="color: #0000BB">$collection </span><span style="color: #007700">= </span><span style="color: #0000BB">$mongo</span><span style="color: #007700">-></span><span style="color: #0000BB">selectDB</span><span style="color: #007700">(</span><span style="color: #DD0000">"foo"</span><span style="color: #007700">)-></span><span style="color: #0000BB">selectCollection</span><span style="color: #007700">(</span><span style="color: #DD0000">"bar"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$collection </span><span style="color: #007700">= </span><span style="color: #0000BB">$mongo</span><span style="color: #007700">-></span><span style="color: #0000BB">foo</span><span style="color: #007700">-></span><span style="color: #0000BB">bar</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</p>
</div>
<div class="refsect1 parameters" id="refsect1-mongodb.get-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term">
<em><code class="parameter">name</code></em>
</span>
<dd>
<p class="para">
The name of the collection.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-mongodb.get-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the collection.
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongodb.forceerror.html">MongoDB::forceError</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongodb.getcollectionnames.html">MongoDB::getCollectionNames</a></div>
<div class="up"><a href="class.mongodb.html">MongoDB</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
