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
|
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="MongoGridFS" namespace="" name="MongoGridFS">
<extends name="MongoCollection" full="MongoCollection"/>
<member name="chunks" static="false" visibility="public">
<default>null</default>
<docblock>
<var type="MongoCollection"/>
</docblock>
</member>
<member name="filesName" static="false" visibility="protected">
<default>null</default>
<docblock>
<var type="string"/>
</docblock>
</member>
<member name="chunksName" static="false" visibility="protected">
<default>null</default>
<docblock>
<var type="string"/>
</docblock>
</member>
<constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Creates new file collections">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.</description>
<return type="void"/>
</docblock>
<parameter name="db" optional="false" byreference="false" type="object" class="MongoDB"/>
<parameter name="prefix" optional="true" byreference="false" type="string"/>
<parameter name="chunks" optional="true" byreference="false" type="object" class="mixed"/>
</constructor>
<method name="delete" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Remove a file and its chunks from the database"/>
<return type="bool|array"/>
</docblock>
<parameter name="id" optional="false" byreference="false" type="object" class="mixed"/>
</method>
<method name="drop" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Drops the files and chunks collections"/>
<return type="array"/>
</docblock>
</method>
<method name="find" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Queries for files"/>
<return type="MongoGridFSCursor"/>
</docblock>
<parameter name="query" optional="true" byreference="false" type="object" class="array"/>
<parameter name="fields" optional="true" byreference="false" type="object" class="array"/>
</method>
<method name="findOne" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Returns a single file matching the criteria"/>
<return type="MongoGridFSFile"/>
</docblock>
<parameter name="query" optional="true" byreference="false" type="object" class="mixed"/>
<parameter name="fields" optional="true" byreference="false" type="object" class="mixed"/>
</method>
<method name="get" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Retrieve a file from the database"/>
<return type="MongoGridFSFile"/>
</docblock>
<parameter name="id" optional="false" byreference="false" type="object" class="mixed"/>
</method>
<method name="put" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Stores a file in the database"/>
<return type="mixed"/>
</docblock>
<parameter name="filename" optional="false" byreference="false" type="string"/>
<parameter name="metadata" optional="true" byreference="false" type="object" class="array"/>
<parameter name="options" optional="true" byreference="false" type="object" class="array"/>
</method>
<method name="remove" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Remove files and their chunks from the database"/>
<return type="bool|array"/>
</docblock>
<parameter name="criteria" optional="true" byreference="false" type="object" class="array"/>
<parameter name="options" optional="true" byreference="false" type="object" class="array"/>
</method>
<method name="storeBytes" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Stores a string of bytes in the database"/>
<return type="mixed"/>
</docblock>
<parameter name="bytes" optional="false" byreference="false" type="string"/>
<parameter name="metadata" optional="true" byreference="false" type="object" class="array"/>
<parameter name="options" optional="true" byreference="false" type="object" class="array"/>
</method>
<method name="storeFile" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Stores a file in the database"/>
<return type="mixed"/>
</docblock>
<parameter name="filename" optional="false" byreference="false" type="object" class="string|resource"/>
<parameter name="metadata" optional="true" byreference="false" type="object" class="array"/>
<parameter name="options" optional="true" byreference="false" type="object" class="array"/>
</method>
<method name="storeUpload" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Stores an uploaded file in the database"/>
<return type="mixed"/>
</docblock>
<parameter name="name" optional="false" byreference="false" type="string"/>
<parameter name="metadata" optional="true" byreference="false" type="object" class="array"/>
</method>
</class>
|
