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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
===================
Enumeration Classes
===================
.. default-domain:: mongodb
.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol
MongoDB\\Model\\CollectionInfo
------------------------------
Definition
~~~~~~~~~~
.. phpclass:: MongoDB\\Model\\CollectionInfo
This class models information about a collection. Instances of this class are
returned by traversing a :phpclass:`MongoDB\\Model\\CollectionInfoIterator`,
which is returned by :phpmethod:`MongoDB\\Database::listCollections()`.
.. versionchanged:: 1.4
This class implements PHP's :php:`ArrayAccess <arrayaccess>` interface. This
provides a mechanism for accessing index fields for which there exists no
helper method. :php:`isset() <isset>` may be used to check for the existence
of a field before accessing it with ``[]``.
.. note::
The :phpclass:`MongoDB\\Model\\CollectionInfo` class is immutable. Attempting
to modify it via the :php:`ArrayAccess <arrayaccess>` interface will
result in a :phpclass:`MongoDB\\Exception\\BadMethodCallException`.
Methods
~~~~~~~
.. toctree::
:titlesonly:
/reference/method/MongoDBModelCollectionInfo-getCappedMax
/reference/method/MongoDBModelCollectionInfo-getCappedSize
/reference/method/MongoDBModelCollectionInfo-getName
/reference/method/MongoDBModelCollectionInfo-getOptions
/reference/method/MongoDBModelCollectionInfo-isCapped
----
MongoDB\\Model\\CollectionInfoIterator
--------------------------------------
Definition
~~~~~~~~~~
.. phpclass:: MongoDB\\Model\\CollectionInfoIterator
This interface extends PHP's :php:`Iterator <manual/en/class.iterator.php>`
interface. An instance of this interface is returned by
:phpmethod:`MongoDB\\Database::listCollections()`.
Methods
~~~~~~~
This interface adds no new methods to :php:`Iterator
<manual/en/class.iterator.php>`, but specifies that :php:`current()
<manual/en/iterator.current.php>` will return an instance of
:phpclass:`MongoDB\\Model\\CollectionInfo`.
----
MongoDB\\Model\\DatabaseInfo
----------------------------
Definition
~~~~~~~~~~
.. phpclass:: MongoDB\\Model\\DatabaseInfo
This class models information about a database. Instances of this class are
returned by traversing a :phpclass:`MongoDB\\Model\\DatabaseInfoIterator`,
which is returned by :phpmethod:`MongoDB\\Client::listDatabases()`.
.. versionchanged:: 1.4
This class implements PHP's :php:`ArrayAccess <arrayaccess>` interface. This
provides a mechanism for accessing index fields for which there exists no
helper method. :php:`isset() <isset>` may be used to check for the existence
of a field before accessing it with ``[]``.
.. note::
The :phpclass:`MongoDB\\Model\\DatabaseInfo` class is immutable. Attempting
to modify it via the :php:`ArrayAccess <arrayaccess>` interface will
result in a :phpclass:`MongoDB\\Exception\\BadMethodCallException`.
Methods
~~~~~~~
.. toctree::
:titlesonly:
/reference/method/MongoDBModelDatabaseInfo-getName
/reference/method/MongoDBModelDatabaseInfo-getSizeOnDisk
/reference/method/MongoDBModelDatabaseInfo-isEmpty
----
MongoDB\\Model\\DatabaseInfoIterator
------------------------------------
Definition
~~~~~~~~~~
.. phpclass:: MongoDB\\Model\\DatabaseInfoIterator
This interface extends PHP's :php:`Iterator <manual/en/class.iterator.php>`
interface. An instance of this interface is returned by
:phpmethod:`MongoDB\\Client::listDatabases()`.
Methods
~~~~~~~
This interface adds no new methods to :php:`Iterator
<manual/en/class.iterator.php>`, but specifies that :php:`current()
<manual/en/iterator.current.php>` will return an instance of
:phpclass:`MongoDB\\Model\\DatabaseInfo`.
----
MongoDB\\Model\\IndexInfo
-------------------------
.. phpclass:: MongoDB\\Model\\IndexInfo
This class models information about an index. Instances of this class are
returned by traversing a :phpclass:`MongoDB\\Model\\IndexInfoIterator`,
which is returned by :phpmethod:`MongoDB\\Collection::listIndexes()`.
This class implements PHP's :php:`ArrayAccess <arrayaccess>` interface. This
provides a mechanism for accessing index fields for which there exists no
helper method. :php:`isset() <isset>` may be used to check for the existence
of a field before accessing it with ``[]``.
.. note::
The :phpclass:`MongoDB\\Model\\IndexInfo` class is immutable. Attempting
to modify it via the :php:`ArrayAccess <arrayaccess>` interface will
result in a :phpclass:`MongoDB\\Exception\\BadMethodCallException`.
Methods
~~~~~~~
.. toctree::
:titlesonly:
/reference/method/MongoDBModelIndexInfo-getKey
/reference/method/MongoDBModelIndexInfo-getName
/reference/method/MongoDBModelIndexInfo-getNamespace
/reference/method/MongoDBModelIndexInfo-getVersion
/reference/method/MongoDBModelIndexInfo-is2dSphere
/reference/method/MongoDBModelIndexInfo-isGeoHaystack
/reference/method/MongoDBModelIndexInfo-isSparse
/reference/method/MongoDBModelIndexInfo-isText
/reference/method/MongoDBModelIndexInfo-isTtl
/reference/method/MongoDBModelIndexInfo-isUnique
----
MongoDB\\Model\\IndexInfoIterator
---------------------------------
Definition
~~~~~~~~~~
.. phpclass:: MongoDB\\Model\\IndexInfoIterator
This interface extends PHP's :php:`Iterator <manual/en/class.iterator.php>`
interface. An instance of this interface is returned by
:phpmethod:`MongoDB\\Collection::listIndexes()`.
Methods
~~~~~~~
This interface adds no new methods to :php:`Iterator
<manual/en/class.iterator.php>`, but specifies that :php:`current()
<manual/en/iterator.current.php>` will return an instance of
:phpclass:`MongoDB\\Model\\IndexInfo`.