File: construct.xml

package info (click to toggle)
php-doc 20140201-1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 74,084 kB
  • ctags: 4,040
  • sloc: xml: 998,137; php: 20,812; cpp: 500; sh: 177; makefile: 63; awk: 28
file content (78 lines) | stat: -rw-r--r-- 2,212 bytes parent folder | download
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
<?xml version="1.0" encoding="utf-8"?>

<!-- $Revision: 322131 $ -->
<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
-->