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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 328496 $ -->
<refentry xml:id="mongodb.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>MongoDB::__construct</refname>
<refpurpose>Creates a new database</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <methodname>MongoDB::__construct</methodname>
<methodparam><type>MongoClient</type><parameter>conn</parameter></methodparam>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>
<para>
This method is not meant to be called directly. The preferred way to create
an instance of MongoDB is through <function>MongoClient::__get</function> or
<function>MongoClient::selectDB</function>.
</para>
<para>
If you're ignoring the previous paragraph and want to call it directly you
can do so:
</para>
<programlisting role="php">
<![CDATA[
<?php
$m = new MongoClient();
$db = new MongoDB($m, 'mydbname');
?>
]]>
</programlisting>
<para>
But don't. Isn't this much nicer:
</para>
<programlisting role="php">
<![CDATA[
<?php
$m = new MongoClient();
$db = $m->mydbname;
// or, if the name contains weird characters:
$db = $m->selectDB('my,db:name');
?>
]]>
</programlisting>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term>
<type>MongoClient</type>
<parameter>conn</parameter>
</term>
<listitem>
<para>
Database connection.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>name</parameter>
</term>
<listitem>
<para>
Database name.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the database.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Throws default exception if the database name is invalid.
</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
-->
|