php-doc-en/reference/mongo/mongogridfs/construct.xml
Jakub Vrana 065dd47a92 Replace _ by - in IDs
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@322131 c90b9560-bf6c-de11-be94-00142212c4b1
2012-01-12 12:40:04 +00:00

78 lines
2.2 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="mongogridfs.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>MongoGridFS::__construct</refname>
<refpurpose>Creates new file collections</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <methodname>MongoGridFS::__construct</methodname>
<methodparam><type>MongoDB</type><parameter>db</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>prefix</parameter><initializer>&quot;fs&quot;</initializer></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>chunks</parameter><initializer>&quot;fs&quot;</initializer></methodparam>
</methodsynopsis>
<para>
Files as stored across two collections, the first containing file meta information, the
second containing chunks of the actual file. By default, fs.files and fs.chunks are the
collection names used.
</para>
<para>
Use one argument to specify a prefix other than "fs":
<![CDATA[
$fs = new MongoGridFS($db, "myfiles");
]]>
uses myfiles.files and myfiles.chunks collections.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term>
<parameter>db</parameter>
</term>
<listitem>
<para>
Database.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>files</parameter>
</term>
<listitem>
<para>
Optional collection name prefix.
</para>
</listitem>
</varlistentry>
</variablelist>
</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
-->