Commit 7a5d66cb authored by Jeremy Mikola's avatar Jeremy Mikola

PHPLIB-226: Document ArrayAccess for Collection and DatabaseInfo

parent bccc4f79
...@@ -22,6 +22,19 @@ Definition ...@@ -22,6 +22,19 @@ Definition
returned by traversing a :phpclass:`MongoDB\\Model\\CollectionInfoIterator`, returned by traversing a :phpclass:`MongoDB\\Model\\CollectionInfoIterator`,
which is returned by :phpmethod:`MongoDB\\Database::listCollections()`. 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 Methods
~~~~~~~ ~~~~~~~
...@@ -70,6 +83,19 @@ Definition ...@@ -70,6 +83,19 @@ Definition
returned by traversing a :phpclass:`MongoDB\\Model\\DatabaseInfoIterator`, returned by traversing a :phpclass:`MongoDB\\Model\\DatabaseInfoIterator`,
which is returned by :phpmethod:`MongoDB\\Client::listDatabases()`. 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 Methods
~~~~~~~ ~~~~~~~
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment