Skip to content

Commit 00d44d4

Browse files
norareidynorareidy
authored
DOCSP-36027: Shorten class headings in nav (#1229)
Also consolidates result classes to a single section
1 parent 12229e6 commit 00d44d4

23 files changed

+664
-517
lines changed

‎docs/reference/class/MongoDBBulkWriteResult.txt

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
==============================
2+
MongoDB\\BulkWriteResult Class
3+
==============================
4+
5+
Definition
6+
----------
7+
8+
.. phpclass:: MongoDB\\BulkWriteResult
9+
10+
This class contains information about an executed bulk write operation. It
11+
encapsulates a :php:`MongoDB\\Driver\\WriteResult
12+
<class.mongodb-driver-writeresult>` object and is returned from
13+
:phpmethod:`MongoDB\\Collection::bulkWrite()`.
14+
15+
Methods
16+
-------
17+
18+
.. toctree::
19+
:titlesonly:
20+
21+
getDeletedCount() </reference/method/MongoDBBulkWriteResult-getDeletedCount>
22+
getInsertedCount() </reference/method/MongoDBBulkWriteResult-getInsertedCount>
23+
getInsertedIds() </reference/method/MongoDBBulkWriteResult-getInsertedIds>
24+
getMatchedCount() </reference/method/MongoDBBulkWriteResult-getMatchedCount>
25+
getModifiedCount() </reference/method/MongoDBBulkWriteResult-getModifiedCount>
26+
getUpsertedCount() </reference/method/MongoDBBulkWriteResult-getUpsertedCount>
27+
getUpsertedIds() </reference/method/MongoDBBulkWriteResult-getUpsertedIds>
28+
isAcknowledged() </reference/method/MongoDBBulkWriteResult-isAcknowledged>
29+
30+
- :phpmethod:`MongoDB\\BulkWriteResult::getDeletedCount()`
31+
- :phpmethod:`MongoDB\\BulkWriteResult::getInsertedCount()`
32+
- :phpmethod:`MongoDB\\BulkWriteResult::getInsertedIds()`
33+
- :phpmethod:`MongoDB\\BulkWriteResult::getMatchedCount()`
34+
- :phpmethod:`MongoDB\\BulkWriteResult::getModifiedCount()`
35+
- :phpmethod:`MongoDB\\BulkWriteResult::getUpsertedCount()`
36+
- :phpmethod:`MongoDB\\BulkWriteResult::getUpsertedIds()`
37+
- :phpmethod:`MongoDB\\BulkWriteResult::isAcknowledged()`

‎docs/reference/class/MongoDBChangeStream.txt

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
===========================
2+
MongoDB\\ChangeStream Class
3+
===========================
4+
5+
.. versionadded:: 1.3
6+
7+
Definition
8+
----------
9+
10+
.. phpclass:: MongoDB\\ChangeStream
11+
12+
This class extends PHP's :php:`Iterator <manual/en/class.iterator.php>`
13+
interface. An instance of this class is returned by
14+
:phpmethod:`MongoDB\\Client::watch()`,
15+
:phpmethod:`MongoDB\\Database::watch()`, and
16+
:phpmethod:`MongoDB\\Collection::watch()`.
17+
18+
This class allows for iteration of events in a change stream. It also allows
19+
iteration to automatically resume after certain errors, such as a replica set
20+
failover.
21+
22+
Methods
23+
-------
24+
25+
.. toctree::
26+
:titlesonly:
27+
28+
current() </reference/method/MongoDBChangeStream-current>
29+
getCursorId() </reference/method/MongoDBChangeStream-getCursorId>
30+
getResumeToken() </reference/method/MongoDBChangeStream-getResumeToken>
31+
key() </reference/method/MongoDBChangeStream-key>
32+
next() </reference/method/MongoDBChangeStream-next>
33+
rewind() </reference/method/MongoDBChangeStream-rewind>
34+
valid() </reference/method/MongoDBChangeStream-valid>
35+
36+
- :phpmethod:`MongoDB\\ChangeStream::current()`
37+
- :phpmethod:`MongoDB\\ChangeStream::getCursorId()`
38+
- :phpmethod:`MongoDB\\ChangeStream::getResumeToken()`
39+
- :phpmethod:`MongoDB\\ChangeStream::key()`
40+
- :phpmethod:`MongoDB\\ChangeStream::next()`
41+
- :phpmethod:`MongoDB\\ChangeStream::rewind()`
42+
- :phpmethod:`MongoDB\\ChangeStream::valid()`

‎docs/reference/class/MongoDBClient.txt

+35-17
Original file line numberDiff line numberDiff line change
@@ -28,20 +28,38 @@ Methods
2828
.. toctree::
2929
:titlesonly:
3030

31-
/reference/method/MongoDBClient__construct
32-
/reference/method/MongoDBClient__get
33-
/reference/method/MongoDBClient-addSubscriber
34-
/reference/method/MongoDBClient-createClientEncryption
35-
/reference/method/MongoDBClient-dropDatabase
36-
/reference/method/MongoDBClient-getManager
37-
/reference/method/MongoDBClient-getReadConcern
38-
/reference/method/MongoDBClient-getReadPreference
39-
/reference/method/MongoDBClient-getTypeMap
40-
/reference/method/MongoDBClient-getWriteConcern
41-
/reference/method/MongoDBClient-listDatabaseNames
42-
/reference/method/MongoDBClient-listDatabases
43-
/reference/method/MongoDBClient-removeSubscriber
44-
/reference/method/MongoDBClient-selectCollection
45-
/reference/method/MongoDBClient-selectDatabase
46-
/reference/method/MongoDBClient-startSession
47-
/reference/method/MongoDBClient-watch
31+
__construct() </reference/method/MongoDBClient__construct>
32+
__get() </reference/method/MongoDBClient__get>
33+
addSubscriber() </reference/method/MongoDBClient-addSubscriber>
34+
createClientEncryption() </reference/method/MongoDBClient-createClientEncryption>
35+
dropDatabase() </reference/method/MongoDBClient-dropDatabase>
36+
getManager() </reference/method/MongoDBClient-getManager>
37+
getReadConcern() </reference/method/MongoDBClient-getReadConcern>
38+
getReadPreference() </reference/method/MongoDBClient-getReadPreference>
39+
getTypeMap() </reference/method/MongoDBClient-getTypeMap>
40+
getWriteConcern() </reference/method/MongoDBClient-getWriteConcern>
41+
listDatabaseNames() </reference/method/MongoDBClient-listDatabaseNames>
42+
listDatabases() </reference/method/MongoDBClient-listDatabases>
43+
removeSubscriber() </reference/method/MongoDBClient-removeSubscriber>
44+
selectCollection() </reference/method/MongoDBClient-selectCollection>
45+
selectDatabase() </reference/method/MongoDBClient-selectDatabase>
46+
startSession() </reference/method/MongoDBClient-startSession>
47+
watch() </reference/method/MongoDBClient-watch>
48+
49+
- :phpmethod:`MongoDB\\Client::__construct()`
50+
- :phpmethod:`MongoDB\\Client::__get()`
51+
- :phpmethod:`MongoDB\\Client::addSubscriber()`
52+
- :phpmethod:`MongoDB\\Client::createClientEncryption()`
53+
- :phpmethod:`MongoDB\\Client::dropDatabase()`
54+
- :phpmethod:`MongoDB\\Client::getManager()`
55+
- :phpmethod:`MongoDB\\Client::getReadConcern()`
56+
- :phpmethod:`MongoDB\\Client::getReadPreference()`
57+
- :phpmethod:`MongoDB\\Client::getTypeMap()`
58+
- :phpmethod:`MongoDB\\Client::getWriteConcern()`
59+
- :phpmethod:`MongoDB\\Client::listDatabaseNames()`
60+
- :phpmethod:`MongoDB\\Client::listDatabases()`
61+
- :phpmethod:`MongoDB\\Client::removeSubscriber()`
62+
- :phpmethod:`MongoDB\\Client::selectCollection()`
63+
- :phpmethod:`MongoDB\\Client::selectDatabase()`
64+
- :phpmethod:`MongoDB\\Client::startSession()`
65+
- :phpmethod:`MongoDB\\Client::watch()`

‎docs/reference/class/MongoDBCollection.txt

+87-43
Original file line numberDiff line numberDiff line change
@@ -58,46 +58,90 @@ Methods
5858
.. toctree::
5959
:titlesonly:
6060

61-
/reference/method/MongoDBCollection__construct
62-
/reference/method/MongoDBCollection-aggregate
63-
/reference/method/MongoDBCollection-bulkWrite
64-
/reference/method/MongoDBCollection-count
65-
/reference/method/MongoDBCollection-countDocuments
66-
/reference/method/MongoDBCollection-createIndex
67-
/reference/method/MongoDBCollection-createIndexes
68-
/reference/method/MongoDBCollection-createSearchIndex
69-
/reference/method/MongoDBCollection-createSearchIndexes
70-
/reference/method/MongoDBCollection-deleteMany
71-
/reference/method/MongoDBCollection-deleteOne
72-
/reference/method/MongoDBCollection-distinct
73-
/reference/method/MongoDBCollection-drop
74-
/reference/method/MongoDBCollection-dropIndex
75-
/reference/method/MongoDBCollection-dropIndexes
76-
/reference/method/MongoDBCollection-dropSearchIndex
77-
/reference/method/MongoDBCollection-estimatedDocumentCount
78-
/reference/method/MongoDBCollection-explain
79-
/reference/method/MongoDBCollection-find
80-
/reference/method/MongoDBCollection-findOne
81-
/reference/method/MongoDBCollection-findOneAndDelete
82-
/reference/method/MongoDBCollection-findOneAndReplace
83-
/reference/method/MongoDBCollection-findOneAndUpdate
84-
/reference/method/MongoDBCollection-getCollectionName
85-
/reference/method/MongoDBCollection-getDatabaseName
86-
/reference/method/MongoDBCollection-getManager
87-
/reference/method/MongoDBCollection-getNamespace
88-
/reference/method/MongoDBCollection-getReadConcern
89-
/reference/method/MongoDBCollection-getReadPreference
90-
/reference/method/MongoDBCollection-getTypeMap
91-
/reference/method/MongoDBCollection-getWriteConcern
92-
/reference/method/MongoDBCollection-insertMany
93-
/reference/method/MongoDBCollection-insertOne
94-
/reference/method/MongoDBCollection-listIndexes
95-
/reference/method/MongoDBCollection-listSearchIndexes
96-
/reference/method/MongoDBCollection-mapReduce
97-
/reference/method/MongoDBCollection-rename
98-
/reference/method/MongoDBCollection-replaceOne
99-
/reference/method/MongoDBCollection-updateMany
100-
/reference/method/MongoDBCollection-updateOne
101-
/reference/method/MongoDBCollection-updateSearchIndex
102-
/reference/method/MongoDBCollection-watch
103-
/reference/method/MongoDBCollection-withOptions
61+
__construct() </reference/method/MongoDBCollection__construct>
62+
aggregate() </reference/method/MongoDBCollection-aggregate>
63+
bulkWrite() </reference/method/MongoDBCollection-bulkWrite>
64+
count() </reference/method/MongoDBCollection-count>
65+
countDocuments() </reference/method/MongoDBCollection-countDocuments>
66+
createIndex() </reference/method/MongoDBCollection-createIndex>
67+
createIndexes() </reference/method/MongoDBCollection-createIndexes>
68+
createSearchIndex() </reference/method/MongoDBCollection-createSearchIndex>
69+
createSearchIndexes() </reference/method/MongoDBCollection-createSearchIndexes>
70+
deleteMany() </reference/method/MongoDBCollection-deleteMany>
71+
deleteOne() </reference/method/MongoDBCollection-deleteOne>
72+
distinct() </reference/method/MongoDBCollection-distinct>
73+
drop() </reference/method/MongoDBCollection-drop>
74+
dropIndex() </reference/method/MongoDBCollection-dropIndex>
75+
dropIndexes() </reference/method/MongoDBCollection-dropIndexes>
76+
dropSearchIndex() </reference/method/MongoDBCollection-dropSearchIndex>
77+
estimatedDocumentCount() </reference/method/MongoDBCollection-estimatedDocumentCount>
78+
explain() </reference/method/MongoDBCollection-explain>
79+
find() </reference/method/MongoDBCollection-find>
80+
findOne() </reference/method/MongoDBCollection-findOne>
81+
findOneAndDelete() </reference/method/MongoDBCollection-findOneAndDelete>
82+
findOneAndReplace() </reference/method/MongoDBCollection-findOneAndReplace>
83+
findOneAndUpdate() </reference/method/MongoDBCollection-findOneAndUpdate>
84+
getCollectionName() </reference/method/MongoDBCollection-getCollectionName>
85+
getDatabaseName() </reference/method/MongoDBCollection-getDatabaseName>
86+
getManager() </reference/method/MongoDBCollection-getManager>
87+
getNamespace() </reference/method/MongoDBCollection-getNamespace>
88+
getReadConcern() </reference/method/MongoDBCollection-getReadConcern>
89+
getReadPreference() </reference/method/MongoDBCollection-getReadPreference>
90+
getTypeMap() </reference/method/MongoDBCollection-getTypeMap>
91+
getWriteConcern() </reference/method/MongoDBCollection-getWriteConcern>
92+
insertMany() </reference/method/MongoDBCollection-insertMany>
93+
insertOne() </reference/method/MongoDBCollection-insertOne>
94+
listIndexes() </reference/method/MongoDBCollection-listIndexes>
95+
listSearchIndexes() </reference/method/MongoDBCollection-listSearchIndexes>
96+
mapReduce() </reference/method/MongoDBCollection-mapReduce>
97+
rename() </reference/method/MongoDBCollection-rename>
98+
replaceOne() </reference/method/MongoDBCollection-replaceOne>
99+
updateMany() </reference/method/MongoDBCollection-updateMany>
100+
updateOne() </reference/method/MongoDBCollection-updateOne>
101+
updateSearchIndex() </reference/method/MongoDBCollection-updateSearchIndex>
102+
watch() </reference/method/MongoDBCollection-watch>
103+
withOptions() </reference/method/MongoDBCollection-withOptions>
104+
105+
- :phpmethod:`MongoDB\\Collection::__construct()`
106+
- :phpmethod:`MongoDB\\Collection::aggregate()`
107+
- :phpmethod:`MongoDB\\Collection::bulkWrite()`
108+
- :phpmethod:`MongoDB\\Collection::count()`
109+
- :phpmethod:`MongoDB\\Collection::countDocuments()`
110+
- :phpmethod:`MongoDB\\Collection::createIndex()`
111+
- :phpmethod:`MongoDB\\Collection::createIndexes()`
112+
- :phpmethod:`MongoDB\\Collection::createSearchIndex()`
113+
- :phpmethod:`MongoDB\\Collection::createSearchIndexes()`
114+
- :phpmethod:`MongoDB\\Collection::deleteMany()`
115+
- :phpmethod:`MongoDB\\Collection::deleteOne()`
116+
- :phpmethod:`MongoDB\\Collection::distinct()`
117+
- :phpmethod:`MongoDB\\Collection::drop()`
118+
- :phpmethod:`MongoDB\\Collection::dropIndex()`
119+
- :phpmethod:`MongoDB\\Collection::dropIndexes()`
120+
- :phpmethod:`MongoDB\\Collection::dropSearchIndex()`
121+
- :phpmethod:`MongoDB\\Collection::estimatedDocumentCount()`
122+
- :phpmethod:`MongoDB\\Collection::explain()`
123+
- :phpmethod:`MongoDB\\Collection::find()`
124+
- :phpmethod:`MongoDB\\Collection::findOne()`
125+
- :phpmethod:`MongoDB\\Collection::findOneAndDelete()`
126+
- :phpmethod:`MongoDB\\Collection::findOneAndReplace()`
127+
- :phpmethod:`MongoDB\\Collection::findOneAndUpdate()`
128+
- :phpmethod:`MongoDB\\Collection::getCollectionName()`
129+
- :phpmethod:`MongoDB\\Collection::getDatabaseName()`
130+
- :phpmethod:`MongoDB\\Collection::getManager()`
131+
- :phpmethod:`MongoDB\\Collection::getNamespace()`
132+
- :phpmethod:`MongoDB\\Collection::getReadConcern()`
133+
- :phpmethod:`MongoDB\\Collection::getReadPreference()`
134+
- :phpmethod:`MongoDB\\Collection::getTypeMap()`
135+
- :phpmethod:`MongoDB\\Collection::getWriteConcern()`
136+
- :phpmethod:`MongoDB\\Collection::insertMany()`
137+
- :phpmethod:`MongoDB\\Collection::insertOne()`
138+
- :phpmethod:`MongoDB\\Collection::listIndexes()`
139+
- :phpmethod:`MongoDB\\Collection::listSearchIndexes()`
140+
- :phpmethod:`MongoDB\\Collection::mapReduce()`
141+
- :phpmethod:`MongoDB\\Collection::rename()`
142+
- :phpmethod:`MongoDB\\Collection::replaceOne()`
143+
- :phpmethod:`MongoDB\\Collection::updateMany()`
144+
- :phpmethod:`MongoDB\\Collection::updateOne()`
145+
- :phpmethod:`MongoDB\\Collection::updateSearchIndex()`
146+
- :phpmethod:`MongoDB\\Collection::watch()`
147+
- :phpmethod:`MongoDB\\Collection::withOptions()`

‎docs/reference/class/MongoDBDatabase.txt

+44-22
Original file line numberDiff line numberDiff line change
@@ -43,26 +43,48 @@ Methods
4343
.. toctree::
4444
:titlesonly:
4545

46-
/reference/method/MongoDBDatabase__construct
47-
/reference/method/MongoDBDatabase__get
48-
/reference/method/MongoDBDatabase-aggregate
49-
/reference/method/MongoDBDatabase-command
50-
/reference/method/MongoDBDatabase-createCollection
51-
/reference/method/MongoDBDatabase-createEncryptedCollection
52-
/reference/method/MongoDBDatabase-drop
53-
/reference/method/MongoDBDatabase-dropCollection
54-
/reference/method/MongoDBDatabase-getDatabaseName
55-
/reference/method/MongoDBDatabase-getManager
56-
/reference/method/MongoDBDatabase-getReadConcern
57-
/reference/method/MongoDBDatabase-getReadPreference
58-
/reference/method/MongoDBDatabase-getTypeMap
59-
/reference/method/MongoDBDatabase-getWriteConcern
60-
/reference/method/MongoDBDatabase-listCollectionNames
61-
/reference/method/MongoDBDatabase-listCollections
62-
/reference/method/MongoDBDatabase-modifyCollection
63-
/reference/method/MongoDBDatabase-renameCollection
64-
/reference/method/MongoDBDatabase-selectCollection
65-
/reference/method/MongoDBDatabase-selectGridFSBucket
66-
/reference/method/MongoDBDatabase-watch
67-
/reference/method/MongoDBDatabase-withOptions
46+
__construct() </reference/method/MongoDBDatabase__construct>
47+
__get() </reference/method/MongoDBDatabase__get>
48+
aggregate() </reference/method/MongoDBDatabase-aggregate>
49+
command() </reference/method/MongoDBDatabase-command>
50+
createCollection() </reference/method/MongoDBDatabase-createCollection>
51+
createEncryptedCollection() </reference/method/MongoDBDatabase-createEncryptedCollection>
52+
drop() </reference/method/MongoDBDatabase-drop>
53+
dropCollection() </reference/method/MongoDBDatabase-dropCollection>
54+
getDatabaseName() </reference/method/MongoDBDatabase-getDatabaseName>
55+
getManager() </reference/method/MongoDBDatabase-getManager>
56+
getReadConcern() </reference/method/MongoDBDatabase-getReadConcern>
57+
getReadPreference() </reference/method/MongoDBDatabase-getReadPreference>
58+
getTypeMap() </reference/method/MongoDBDatabase-getTypeMap>
59+
getWriteConcern() </reference/method/MongoDBDatabase-getWriteConcern>
60+
listCollectionNames() </reference/method/MongoDBDatabase-listCollectionNames>
61+
listCollections() </reference/method/MongoDBDatabase-listCollections>
62+
modifyCollection() </reference/method/MongoDBDatabase-modifyCollection>
63+
renameCollection() </reference/method/MongoDBDatabase-renameCollection>
64+
selectCollection() </reference/method/MongoDBDatabase-selectCollection>
65+
selectGridFSBucket() </reference/method/MongoDBDatabase-selectGridFSBucket>
66+
watch() </reference/method/MongoDBDatabase-watch>
67+
withOptions() </reference/method/MongoDBDatabase-withOptions>
6868

69+
- :phpmethod:`MongoDB\\Database::__construct()`
70+
- :phpmethod:`MongoDB\\Database::__get()`
71+
- :phpmethod:`MongoDB\\Database::aggregate()`
72+
- :phpmethod:`MongoDB\\Database::command()`
73+
- :phpmethod:`MongoDB\\Database::createCollection()`
74+
- :phpmethod:`MongoDB\\Database::createEncryptedCollection()`
75+
- :phpmethod:`MongoDB\\Database::drop()`
76+
- :phpmethod:`MongoDB\\Database::dropCollection()`
77+
- :phpmethod:`MongoDB\\Database::getDatabaseName()`
78+
- :phpmethod:`MongoDB\\Database::getManager()`
79+
- :phpmethod:`MongoDB\\Database::getReadConcern()`
80+
- :phpmethod:`MongoDB\\Database::getReadPreference()`
81+
- :phpmethod:`MongoDB\\Database::getTypeMap()`
82+
- :phpmethod:`MongoDB\\Database::getWriteConcern()`
83+
- :phpmethod:`MongoDB\\Database::listCollectionNames()`
84+
- :phpmethod:`MongoDB\\Database::listCollections()`
85+
- :phpmethod:`MongoDB\\Database::modifyCollection()`
86+
- :phpmethod:`MongoDB\\Database::renameCollection()`
87+
- :phpmethod:`MongoDB\\Database::selectCollection()`
88+
- :phpmethod:`MongoDB\\Database::selectGridFSBucket()`
89+
- :phpmethod:`MongoDB\\Database::watch()`
90+
- :phpmethod:`MongoDB\\Database::withOptions()`

‎docs/reference/class/MongoDBDeleteResult.txt

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
===========================
2+
MongoDB\\DeleteResult Class
3+
===========================
4+
5+
Definition
6+
----------
7+
8+
.. phpclass:: MongoDB\\DeleteResult
9+
10+
This class contains information about an executed delete operation. It
11+
encapsulates a :php:`MongoDB\\Driver\\WriteResult
12+
<class.mongodb-driver-writeresult>` object and is returned from
13+
:phpmethod:`MongoDB\\Collection::deleteMany()` or
14+
:phpmethod:`MongoDB\\Collection::deleteOne()`.
15+
16+
Methods
17+
-------
18+
19+
.. toctree::
20+
:titlesonly:
21+
22+
getDeletedCount() </reference/method/MongoDBDeleteResult-getDeletedCount>
23+
isAcknowledged() </reference/method/MongoDBDeleteResult-isAcknowledged>
24+
25+
- :phpmethod:`MongoDB\\DeleteResult::getDeletedCount()`
26+
- :phpmethod:`MongoDB\\DeleteResult::isAcknowledged()`

0 commit comments

Comments
 (0)