Merge pull request #296

Author: jmikola

source/includes/extracts-error.yaml

@@ -31,4 +31,14 @@ content: |
   :phpclass:`MongoDB\\Exception\\UnsupportedException` if options are used and
   not supported by the selected server (e.g. ``collation``, ``readConcern``,
   ``writeConcern``).
+---
+ref: error-gridfs-filenotfoundexception
+content: |
+  :phpclass:`MongoDB\\GridFS\\Exception\\FileNotFoundException` if no file was
+  found for the selection criteria.
+---
+ref: error-gridfs-corruptfileexception
+content: |
+  :phpclass:`MongoDB\\GridFS\\Exception\\CorruptFileException` if the file's
+  metadata or chunk documents contain unexpected or invalid data.
 ...

source/reference/exception-classes.txt

@@ -77,8 +77,7 @@ MongoDB\\Exception\\UnsupportedException
    unintended document being deleted.
 
    This class extends the library's :phpclass:`RuntimeException
-   <MongoDB\\Exception\\RuntimeException>` class and implements the
-   library's :phpclass:`Exception <MongoDB\\Exception\\Exception>` interface.
+   <MongoDB\\Exception\\RuntimeException>` class.
 
    .. note::
 
@@ -89,6 +88,37 @@ MongoDB\\Exception\\UnsupportedException
 
 ----
 
+MongoDB\\GridFS\\Exception\\CorruptFileException
+----------------------------------------
+
+.. phpclass:: MongoDB\\GridFS\\Exception\\CorruptFileException
+
+   This exception is thrown if a GridFS file's metadata or chunk documents
+   contain unexpected or invalid data.
+
+   When selecting a GridFS file, this may be thrown if a metadata field has an
+   incorrect type or its value is out of range (e.g. negative ``length``). When
+   reading a GridFS file, this may be thrown if a chunk's index is out of
+   sequence or its binary data's length out of range.
+
+   This class extends the library's :phpclass:`RuntimeException
+   <MongoDB\\Exception\\RuntimeException>` class.
+
+----
+
+MongoDB\\GridFS\\Exception\\FileNotFoundException
+----------------------------------------
+
+.. phpclass:: MongoDB\\GridFS\\Exception\\FileNotFoundException
+
+   This exception is thrown if no GridFS file was found for the selection
+   criteria (e.g. ``id``, ``filename``).
+
+   This class extends the library's :phpclass:`RuntimeException
+   <MongoDB\\Exception\\RuntimeException>` class.
+
+----
+
 MongoDB\\Exception\\Exception
 -----------------------------
 

source/reference/method/MongoDBGridFSBucket-delete.txt

@@ -25,6 +25,12 @@ Definition
 
    .. include:: /includes/apiargs/MongoDBGridFSBucket-method-delete-param.rst
 
+Errors/Exceptions
+-----------------
+
+.. include:: /includes/extracts/error-gridfs-filenotfoundexception.rst
+.. include:: /includes/extracts/error-driver-runtimeexception.rst
+
 Behavior
 --------
 

source/reference/method/MongoDBGridFSBucket-downloadToStream.txt

@@ -28,6 +28,13 @@ Definition
 
 .. todo: add examples
 
+Errors/Exceptions
+-----------------
+
+.. include:: /includes/extracts/error-gridfs-filenotfoundexception.rst
+.. include:: /includes/extracts/error-invalidargumentexception.rst
+.. include:: /includes/extracts/error-driver-runtimeexception.rst
+
 See Also
 --------
 

source/reference/method/MongoDBGridFSBucket-downloadToStreamByName.txt

@@ -32,6 +32,13 @@ Definition
 
 .. todo: add examples
 
+Errors/Exceptions
+-----------------
+
+.. include:: /includes/extracts/error-gridfs-filenotfoundexception.rst
+.. include:: /includes/extracts/error-invalidargumentexception.rst
+.. include:: /includes/extracts/error-driver-runtimeexception.rst
+
 See Also
 --------
 

source/reference/method/MongoDBGridFSBucket-drop.txt

@@ -21,4 +21,9 @@ Definition
 
       function drop(): void
 
+Errors/Exceptions
+-----------------
+
+.. include:: /includes/extracts/error-driver-runtimeexception.rst
+
 .. todo: add examples

source/reference/method/MongoDBGridFSBucket-find.txt

@@ -34,6 +34,13 @@ Return Values
 
 A :php:`MongoDB\\Driver\\Cursor <class.mongodb-driver-cursor>` object.
 
+Errors/Exceptions
+-----------------
+
+.. include:: /includes/extracts/error-unsupportedexception.rst
+.. include:: /includes/extracts/error-invalidargumentexception.rst
+.. include:: /includes/extracts/error-driver-runtimeexception.rst
+
 .. todo: add examples
 
 See Also

source/reference/method/MongoDBGridFSBucket-findOne.txt

@@ -37,6 +37,13 @@ An array or object for the :term:`first document <natural order>` that matched
 the query, or ``null`` if no document matched the query. The return type will
 depend on the ``typeMap`` option.
 
+Errors/Exceptions
+-----------------
+
+.. include:: /includes/extracts/error-unsupportedexception.rst
+.. include:: /includes/extracts/error-invalidargumentexception.rst
+.. include:: /includes/extracts/error-driver-runtimeexception.rst
+
 .. todo: add examples
 
 See Also

source/reference/method/MongoDBGridFSBucket-getFileDocumentForStream.txt

@@ -31,6 +31,12 @@ Return Values
 The metadata document associated with the GridFS stream. The return type will
 depend on the bucket's ``typeMap`` option.
 
+Errors/Exceptions
+-----------------
+
+.. include:: /includes/extracts/error-invalidargumentexception.rst
+.. include:: /includes/extracts/error-driver-runtimeexception.rst
+
 .. todo: add examples
 
 See Also

source/reference/method/MongoDBGridFSBucket-getFileIdForStream.txt

@@ -31,6 +31,13 @@ Return Values
 The ``_id`` field of the metadata document associated with the GridFS stream.
 The return type will depend on the bucket's ``typeMap`` option.
 
+Errors/Exceptions
+-----------------
+
+.. include:: /includes/extracts/error-gridfs-corruptfileexception.rst
+.. include:: /includes/extracts/error-invalidargumentexception.rst
+.. include:: /includes/extracts/error-driver-runtimeexception.rst
+
 .. todo: add examples
 
 See Also