MongoDBClient-getTypeMap.txt 1.1 KB
Newer Older
1
=============================
2
MongoDB\\Client::getTypeMap()
3
=============================
4

5 6
.. versionadded:: 1.2

7 8 9 10 11 12 13 14 15 16 17 18 19
.. default-domain:: mongodb

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

Definition
----------

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

20
   Returns the type map for this client.
21 22 23 24 25 26 27 28

   .. code-block:: php

      function getTypeMap(): array

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

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

Example
-------

.. code-block:: php

   <?php

38 39 40 41 42 43 44 45
   $client = new MongoDB\Client('mongodb://127.0.0.1/', [], [
       'typeMap' => [
           'root' => 'array',
           'document' => 'array',
           'array' => 'array',
       ],
   ]);

46 47
   var_dump($client->getTypeMap());

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

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

See Also
--------

62
- :doc:`/reference/bson`
63 64
- :phpmethod:`MongoDB\\Collection::getTypeMap()`
- :phpmethod:`MongoDB\\Database::getTypeMap()`
65
- :phpmethod:`MongoDB\\GridFS\\Bucket::getTypeMap()`