MongoDBDatabase-getTypeMap.txt 1.09 KB
Newer Older
1
===============================
2
MongoDB\\Database::getTypeMap()
3
===============================
4 5 6 7 8 9 10 11 12 13 14 15 16 17

.. default-domain:: mongodb

.. contents:: On this page
   :local:
   :backlinks: none
   :depth: 1
   :class: singlecol

Definition
----------

.. phpmethod:: MongoDB\\Database::getTypeMap()

18
   Returns the type map for this database.
19 20 21 22 23 24 25 26

   .. code-block:: php

      function getTypeMap(): array

Return Values
-------------

27
A :ref:`type map <php-type-map>` array.
28 29 30 31 32 33 34 35

Example
-------

.. code-block:: php

   <?php

36 37 38 39 40 41 42
   $database = (new MongoDB\Client)->selectDatabase('test', [
       'typeMap' => [
           'root' => 'array',
           'document' => 'array',
           'array' => 'array',
       ],
   ]);
43 44 45

   var_dump($database->getTypeMap());

46
The output would then resemble::
47 48 49 50 51 52 53 54 55 56 57 58 59

   array(3) {
     ["root"]=>
     string(5) "array"
     ["document"]=>
     string(5) "array"
     ["array"]=>
     string(5) "array"
   }

See Also
--------

60
- :doc:`/reference/bson`
61 62 63
- :phpmethod:`MongoDB\\Client::getTypeMap()`
- :phpmethod:`MongoDB\\Collection::getTypeMap()`
- :phpmethod:`MongoDB\\GridFS\\Bucket::getTypeMap()`