DOCSP-50772: isView()

Author: rustagir

source/read/change-streams.txt

@@ -26,7 +26,7 @@ allows your application to subscribe to data changes on a collection, database,
 or deployment.
 
 When using the {+php-library+}, you can call the ``watch()`` method to return an
-instance of ``MongoDB\ChangeStream``. Then, you can iterate through the 
+instance of ``MongoDB\ChangeStream``. Then, you can iterate through the
 ``MongoDB\ChangeStream`` instance to monitor data changes, such as updates,
 insertions, and deletions.
 
@@ -38,18 +38,18 @@ database from the :atlas:`Atlas sample datasets </sample-data>`. To access this
 from your PHP application, instantiate a ``MongoDB\Client`` that connects to an Atlas cluster
 and assign the following value to your ``$collection`` variable:
 
-.. literalinclude:: /includes/read/change/streams/change-stream.php
+.. literalinclude:: /includes/read/change-streams/change-stream.php
    :language: php
    :dedent:
    :start-after: start-db-coll
    :end-before: end-db-coll
 
-.. tip:: 
+.. tip::
 
    To learn how to create a free MongoDB Atlas cluster and load the sample datasets, see the
    :atlas:`Get Started with Atlas </getting-started>` guide.
 
-Some examples use the ``toJSON()`` function to represent change events, which are BSON 
+Some examples use the ``toJSON()`` function to represent change events, which are BSON
 documents, as Extended JSON. To use this function, paste the following code into your
 application file:
 
@@ -100,7 +100,7 @@ as it occurs. The printed change event resembles the following output:
 
    { "_id" : { "_data" : "..." }, "operationType" : "update", "clusterTime" :
    { "$timestamp" : { ... } }, "wallTime" : { "$date" : "..." }, "ns" : { "db" :
-   "sample_restaurants", "coll" : "restaurants" }, "documentKey" : { "_id" : 
+   "sample_restaurants", "coll" : "restaurants" }, "documentKey" : { "_id" :
    { "$oid" : "..." } }, "updateDescription" : { "updatedFields" : { "cuisine" : "Irish" },
    "removedFields" : [  ], "truncatedArrays" : [  ] } }
 
@@ -170,7 +170,7 @@ can set in the array:
 
    * - ``startAtOperationTime``
      - | Instructs the change stream to only provide changes that occurred at or after
-         the specified timestamp. 
+         the specified timestamp.
        | This option is mutually exclusive with ``startAfter`` and ``resumeAfter``.
 
    * - ``collation``
@@ -205,7 +205,7 @@ to one of the following values:
   change event field has a ``null`` value.
 - ``MongoDB\Operation\Watch::FULL_DOCUMENT_BEFORE_CHANGE_REQUIRED``: The change event includes a pre-image
   of the modified document for change events. If the pre-image is not available, the
-  server raises an error.  
+  server raises an error.
 
 The **post-image** is the full version of a document *after* a change. To include the
 post-image in the change stream event, set the ``fullDocument`` option to
@@ -240,7 +240,7 @@ output:
 
    { "_id" : { "_data" : "..." }, "operationType" : "update", "clusterTime" :
    { "$timestamp" : { ... } }, "wallTime" : { "$date" : "..." },
-   "fullDocument" : { "_id" : { "$oid" : "..." }, "address" : { "building" : 
+   "fullDocument" : { "_id" : { "$oid" : "..." }, "address" : { "building" :
    "202-24", "coord" : [ -73.925044200000002093, 40.559546199999999772 ], "street"
    : "Rockaway Point Boulevard", "zipcode" : "11697" }, "borough" : "Queens",
    "cuisine" : "Irish", "grades" : [ ...], "name" : "Blarney Castle", "restaurant_id" :
@@ -251,8 +251,8 @@ output:
 
 .. tip::
 
-   To learn more about pre-images and post-images, see 
-   :manual:`Change Streams with Document Pre- and Post-Images </changeStreams#change-streams-with-document-pre--and-post-images>` 
+   To learn more about pre-images and post-images, see
+   :manual:`Change Streams with Document Pre- and Post-Images </changeStreams#change-streams-with-document-pre--and-post-images>`
    in the {+mdb-server+} manual.
 
 Additional Information

source/reference/class/MongoDBModelCollectionInfo.txt

@@ -39,6 +39,7 @@ Methods
    getOptions() </reference/method/MongoDBModelCollectionInfo-getOptions>
    getType() </reference/method/MongoDBModelCollectionInfo-getType>
    isCapped() </reference/method/MongoDBModelCollectionInfo-isCapped>
+   isView() </reference/method/MongoDBModelCollectionInfo-isView>
 
 - :phpmethod:`MongoDB\Model\CollectionInfo::getCappedMax()`
 - :phpmethod:`MongoDB\Model\CollectionInfo::getCappedSize()`
@@ -47,4 +48,5 @@ Methods
 - :phpmethod:`MongoDB\Model\CollectionInfo::getName()`
 - :phpmethod:`MongoDB\Model\CollectionInfo::getOptions()`
 - :phpmethod:`MongoDB\Model\CollectionInfo::getType()`
-- :phpmethod:`MongoDB\Model\CollectionInfo::isCapped()`
+- :phpmethod:`MongoDB\Model\CollectionInfo::isCapped()`
+- :phpmethod:`MongoDB\Model\CollectionInfo::isView()`

source/reference/method/MongoDBModelCollectionInfo-isView.txt

@@ -0,0 +1,52 @@
+========================================
+MongoDB\\Model\\CollectionInfo::isView()
+========================================
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+Definition
+----------
+
+.. phpmethod:: MongoDB\Model\CollectionInfo::isView()
+
+   Return whether the collection is a :manual:`view </core/views/>`.
+
+   .. code-block:: php
+
+      function isView(): boolean
+
+Return Values
+-------------
+
+A boolean indicating whether the collection is a view.
+
+Examples
+--------
+
+.. code-block:: php
+
+   <?php
+
+   $info = new CollectionInfo([
+       'name' => 'foo',
+       'type' => 'view',
+       'info' => ['readOnly' => true],
+   ]);
+
+   var_dump($info->isView());
+
+The output would then resemble:
+
+.. code-block:: none
+
+   bool(true)
+
+See Also
+--------
+
+- :manual:`Views </core/views/>` in the {+mdb-server+} manual
+- :manual:`Create and Query a View </views/create-view/>` in the {+mdb-server+} manual

source/whats-new.txt

@@ -20,6 +20,7 @@ What's New
 Learn about new features, improvements, and fixes introduced in the
 following versions of the {+php-library+}:
 
+* :ref:`Version 2.2 <php-lib-version-2.2>`
 * :ref:`Version 2.1 <php-lib-version-2.1>`
 * :ref:`Version 2.0 <php-lib-version-2.0>`
 * :ref:`Version 1.21 <php-lib-version-1.21>`
@@ -28,6 +29,17 @@ following versions of the {+php-library+}:
 * :ref:`Version 1.18 <php-lib-version-1.18>`
 * :ref:`Version 1.17 <php-lib-version-1.17>`
 
+.. _php-lib-version-2.2:
+
+What's New in 2.2
+-----------------
+
+The {+library-short+} v2.2 release includes the following features,
+improvements, and fixes:
+
+- Adds the :phpmethod:`MongoDB\Model\CollectionInfo::isView()` method to
+  determine whether a collection is a :manual:`view </core/views/>`.
+
 .. _php-lib-version-2.1:
 
 What's New in 2.1
@@ -61,13 +73,13 @@ What's New in 2.0
 
    - The following methods return ``void`` instead of the raw command
      response:
-   
+
      - ``MongoDB\Client``: ``dropDatabase()``
      - ``MongoDB\Collection``: ``drop()``, ``dropIndex()``,
        ``dropIndexes()``, ``dropSearchIndex()``, ``rename()``
      - ``MongoDB\Database``: ``createCollection()``, ``drop()``,
        ``dropCollection()``, ``renameCollection()``
-   
+
    To learn more about breaking changes in this release, see the
    :ref:`Version 2.0 Breaking Changes <php-v2-breaking-changes>` section
    in the Upgrade Library Versions guide.
@@ -80,7 +92,7 @@ and removals:
   - :phpmethod:`MongoDB\Client::getDatabase()`: alias for :phpmethod:`MongoDB\Client::selectDatabase()`
   - :phpmethod:`MongoDB\Client::getCollection()`: alias for :phpmethod:`MongoDB\Client::selectCollection()`
   - :phpmethod:`MongoDB\Database::getCollection()`: alias for :phpmethod:`MongoDB\Database::selectCollection()`
-  
+
   The ``Client::selectCollection()``, ``Client::selectDatabase()``, and
   ``Database::selectCollection()`` methods will be deprecated and
   replaced by these new methods in a future driver release, so consider
@@ -177,7 +189,7 @@ improvements, and fixes:
   more type-safe and organized way. To learn more, see the
   :ref:`php-atlas-search` and :ref:`php-vector-search` guides.
 
-- Deprecates the ``flags`` option, used for the deprecated MMAPv1 storage engine. 
+- Deprecates the ``flags`` option, used for the deprecated MMAPv1 storage engine.
   This option will be removed in {+library-short+} v2.0.
 
 - Adds a sort option to the :phpmethod:`MongoDB\Collection::updateOne()`
@@ -189,7 +201,7 @@ improvements, and fixes:
 
   - :phpmethod:`Database constructor <MongoDB\Database::__construct()>`
   - :phpmethod:`MongoDB\Database::withOptions()`
-  - :phpmethod:`Collection constructor <MongoDB\Collection::__construct()>`  
+  - :phpmethod:`Collection constructor <MongoDB\Collection::__construct()>`
   - :phpmethod:`MongoDB\Collection::withOptions()`
 
 For more information about the changes in this version, see the
@@ -246,48 +258,48 @@ and was added to keep version parity with the {+extension-short+}.
 What's New in 1.18
 ------------------
 
-- Adds a new GridFS API to make it more convenient to work with files using PHP's 
-  existing filesystem functions. The :phpmethod:`MongoDB\GridFS\Bucket::registerGlobalStreamWrapperAlias()` 
-  method may be used to register a global alias for a GridFS bucket. After 
-  doing so, files within that bucket can be accessed by using only a file URI 
+- Adds a new GridFS API to make it more convenient to work with files using PHP's
+  existing filesystem functions. The :phpmethod:`MongoDB\GridFS\Bucket::registerGlobalStreamWrapperAlias()`
+  method may be used to register a global alias for a GridFS bucket. After
+  doing so, files within that bucket can be accessed by using only a file URI
   (e.g. "gridfs://mybucket/hello.txt"). A demonstration of this API can be found
-  in the `gridfs_stream_wrapper.php <https://github.com/mongodb/mongo-php-library/blob/1.18.0/examples/gridfs_stream_wrapper.php>`__ 
+  in the `gridfs_stream_wrapper.php <https://github.com/mongodb/mongo-php-library/blob/1.18.0/examples/gridfs_stream_wrapper.php>`__
   example script.
 
-- Adds :phpmethod:`MongoDB\Client::addSubscriber()` and 
-  :phpmethod:`MongoDB\Client::removeSubscriber()` methods to the 
-  ``MongoDB\Client`` class to make it easier to register monitoring classes 
+- Adds :phpmethod:`MongoDB\Client::addSubscriber()` and
+  :phpmethod:`MongoDB\Client::removeSubscriber()` methods to the
+  ``MongoDB\Client`` class to make it easier to register monitoring classes
   scoped to the underlying ``MongoDB\Driver\Manager`` object.
 
-To learn more about this release, see the `v1.18 Release Notes 
+To learn more about this release, see the `v1.18 Release Notes
 <https://github.com/mongodb/mongo-php-library/releases/tag/1.18.0>`__ on GitHub.
 
 .. _php-lib-version-1.17:
 
 What's New in 1.17
 ------------------
 
-- Introduces a new "codec" API for converting BSON to and from PHP objects. 
-  More information on this feature may be found in the 
+- Introduces a new "codec" API for converting BSON to and from PHP objects.
+  More information on this feature may be found in the
   :ref:`Codecs tutorial <php-codecs>`.
 
-- Adds :phpmethod:`MongoDB\add_logger()` and 
-  :phpmethod:`MongoDB\remove_logger()` functions to the library. 
+- Adds :phpmethod:`MongoDB\add_logger()` and
+  :phpmethod:`MongoDB\remove_logger()` functions to the library.
   These functions allow applications to register a `PSR-3 Logger <https://www.php-fig.org/psr/psr-3/>`__
-  to receive log messages emitted by the driver. Previously, logs were only 
-  available through the extension's `mongodb.debug <https://www.php.net/manual/en/mongodb.configuration.php#ini.mongodb.debug>`__ 
+  to receive log messages emitted by the driver. Previously, logs were only
+  available through the extension's `mongodb.debug <https://www.php.net/manual/en/mongodb.configuration.php#ini.mongodb.debug>`__
   ``INI`` setting.
 
-- Introduces new :phpclass:`MongoDB\Collection` methods to create and manage 
-  Atlas Search indexes. Atlas Search indexes can be queried using the ``$search`` 
+- Introduces new :phpclass:`MongoDB\Collection` methods to create and manage
+  Atlas Search indexes. Atlas Search indexes can be queried using the ``$search``
   aggregation pipeline stage, which is supported in all versions of the library.
-  To learn more about Atlas Search indexes and the specifics of the ``$search`` 
-  aggregation stage, see the :atlas:`Atlas Search indexes </atlas-search>` 
+  To learn more about Atlas Search indexes and the specifics of the ``$search``
+  aggregation stage, see the :atlas:`Atlas Search indexes </atlas-search>`
   documentation and :manual:`$search </reference/operator/aggregation/search/>`.
 
-- Upgrades the ``mongodb`` extension requirement to 1.17.0. Support for PHP 
+- Upgrades the ``mongodb`` extension requirement to 1.17.0. Support for PHP
   7.2 and 7.3 has been removed and the library now requires PHP 7.4 or newer.
 
-To learn more about this release, see the `v1.17 Release Notes 
+To learn more about this release, see the `v1.17 Release Notes
 <https://github.com/mongodb/mongo-php-library/releases/tag/1.17.0>`__ on
 GitHub.