<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.bson.functions.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ru',
  ),
  'this' => 
  array (
    0 => 'function.mongodb.bson-tophp.php',
    1 => 'MongoDB\\BSON\\toPHP',
    2 => 'Возвращает PHP-представление BSON-значения',
  ),
  'up' => 
  array (
    0 => 'ref.bson.functions.php',
    1 => 'Функции',
  ),
  'prev' => 
  array (
    0 => 'function.mongodb.bson-tojson.php',
    1 => 'MongoDB\\BSON\\toJSON',
  ),
  'next' => 
  array (
    0 => 'function.mongodb.bson-torelaxedextendedjson.php',
    1 => 'MongoDB\\BSON\\toRelaxedExtendedJSON',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ru',
    'path' => 'reference/mongodb/functions/bson/tophp.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.mongodb.bson-tophp" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">MongoDB\BSON\toPHP</h1>
  <p class="verinfo">(mongodb &gt;=1.0.0)</p><p class="refpurpose"><span class="refname">MongoDB\BSON\toPHP</span> &mdash; <span class="dc-title">Возвращает PHP-представление BSON-значения</span></p>

 </div>

 <div id="function.mongodb.bson-tophp-refsynopsisdiv">
  <div class="warning"><strong class="warning">Внимание</strong>
   <p class="para">
    Метод <em>УСТАРЕЛ</em> с модуля версии
    1.20.0, а в версии 2.0 метод удалили. Вместо этого метода приложениям лучше вызывать метод
    <span class="methodname"><a href="mongodb-bson-document.tophp.php" class="methodname">MongoDB\BSON\Document::toPHP()</a></span>.
   </p>
  </div>
 </div>

 <div class="refsect1 description" id="refsect1-function.mongodb.bson-tophp-description">
  <h3 class="title">Описание</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>MongoDB\BSON\toPHP</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$bson</code></span>, <span class="methodparam"><span class="type"><a href="language.types.array.php" class="type array">array</a></span> <code class="parameter">$typeMap</code><span class="initializer"> = array()</span></span>): <span class="type"><span class="type"><a href="language.types.array.php" class="type array">array</a></span>|<span class="type"><a href="language.types.object.php" class="type object">object</a></span></span></div>

  <p class="para rdfs-comment">
   Метод десериализует BSON-документ — двоичную строку — в его PHP-представление.
   Через параметр <code class="parameter">typeMap</code> управляют PHP-типами,
   через которые преобразовывают BSON-массивы и BSON-документы (как корневые, так и встроенные).
  </p>
  
   <div class="warning"><strong class="warning">Внимание</strong>
    <p class="simpara">
      Документы BSON технически могут содержать повторяющиеся ключи, поскольку документы хранятся в виде списка пар ключ-значение;
      однако приложениям следует воздерживаться от создания документов с дубликатами ключей,
      поскольку поведение сервера и драйвера может быть неопределённым.
      Поскольку объекты и массивы PHP не могут иметь повторяющихся ключей,
      данные также могут быть потеряны при декодировании документа BSON с повторяющимися ключами.
    </p>
   </div>

 </div>


 <div class="refsect1 parameters" id="refsect1-function.mongodb.bson-tophp-parameters">
  <h3 class="title">Список параметров</h3>
  <dl>
   
    <dt><code class="parameter">bson</code> (<span class="type"><a href="language.types.string.php" class="type string">string</a></span>)</dt>
    <dd>
     <p class="para">
      BSON-значение для десериализации.
     </p>
    </dd>
   
   

 <dt><code class="parameter">typeMap</code> (<span class="type"><a href="language.types.array.php" class="type array">array</a></span>)</dt>
 <dd>
  <p class="para">
   <a href="mongodb.persistence.php#mongodb.persistence.typemaps" class="link">Конфигурация карты типов</a>.
  </p>
 </dd>


  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.mongodb.bson-tophp-returnvalues">
  <h3 class="title">Возвращаемые значения</h3>
  <p class="para">
   Метод возвращает PHP-значение, которое сгенерировал путём десериализации BSON-документа.
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-function.mongodb.bson-tophp-errors">
  <h3 class="title">Ошибки</h3>
  <ul class="simplelist">
   <li>
    Метод выбрасывает исключение
    <span class="classname"><a href="class.mongodb-driver-exception-invalidargumentexception.php" class="classname">MongoDB\Driver\Exception\InvalidArgumentException</a></span>,
    если класс в карте типов невозможно создать или класс не реализует интерфейс
    <span class="interfacename"><a href="class.mongodb-bson-unserializable.php" class="interfacename">MongoDB\BSON\Unserializable</a></span>.
   </li>
   
<li>
Метод выбрасывает исключение <span class="classname"><a href="class.mongodb-driver-exception-unexpectedvalueexception.php" class="classname">MongoDB\Driver\Exception\UnexpectedValueException</a></span>,
если во входных данных передали больше одного BSON-документа. Возможные причины включают, но не ограничиваются
недопустимым BSON-форматом, лишними данными или неожиданной ошибкой
<a href="https://github.com/mongodb/mongo-c-driver/tree/master/src/libbson" class="link external">&raquo;&nbsp;libbson</a>.
</li>

  </ul>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.mongodb.bson-tophp-changelog">
  <h3 class="title">Список изменений</h3>
  <p class="para">
   <table class="doctable informaltable">
    
     <thead>
      <tr>
       <th>Версия</th>
       <th>Описание</th>
      </tr>

     </thead>

     <tbody class="tbody">
      
       <tr>
        <td>PECL-модуль mongodb 2.0.0</td>
        <td>
         Функцию удалили.
        </td>
       </tr>


      <tr>
       <td>PECL-модуль mongodb 1.4.0</td>
       <td>
        <p class="para">
         Модуль больше не записывает предупреждение в журнал отладки,
         если входные данные содержат устаревший BSON-тип, который не поддерживается модулем.
         Вместо этого метод создаст объект, который представляет такой тип.
        </p>
       </td>
      </tr>

      <tr>
       <td>PECL-модуль mongodb 1.3.2</td>
       <td>
        <p class="para">
         Метод больше не выбрасывает исключение <span class="classname"><a href="class.mongodb-driver-exception-unexpectedvalueexception.php" class="classname">MongoDB\Driver\Exception\UnexpectedValueException</a></span>
         если входные данные содержат устаревший BSON-тип, который не поддерживается модулем.
         Метод проигнорирует такие типы (как и в версиях до 1.3.0),
         хотя модуль теперь записывает предупреждение в журнал отладки
         (смотрите описание директивы <a href="mongodb.configuration.php#ini.mongodb.debug" class="link">mongodb.debug</a>).
        </p>
       </td>
      </tr>

      <tr>
       <td>PECL-модуль mongodb 1.3.0</td>
       <td>
        <p class="para">
         Метод выбрасывает исключение <span class="classname"><a href="class.mongodb-driver-exception-unexpectedvalueexception.php" class="classname">MongoDB\Driver\Exception\UnexpectedValueException</a></span>,
         если входные данные содержат устаревший BSON-тип, который не поддерживается модулем.
         Раньше модуль игнорировал такие типы.
        </p>
       </td>
      </tr>

     </tbody>
    
   </table>

  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.mongodb.bson-tophp-examples">
  <h3 class="title">Примеры</h3>
  <div class="example" id="example-1">
   <p><strong>Пример #1 Пример преобразования BSON-значения в PHP-представление методом <span class="function"><strong>MongoDB\BSON\toPHP()</strong></span></strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br />$bson </span><span style="color: #007700">= </span><span style="color: #0000BB">hex2bin</span><span style="color: #007700">(</span><span style="color: #DD0000">'0e00000010666f6f000100000000'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$value </span><span style="color: #007700">= </span><span style="color: #0000BB">MongoDB\BSON\toPHP</span><span style="color: #007700">(</span><span style="color: #0000BB">$bson</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$value</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

   
<div class="example-contents"><p>
 Результат выполнения приведённого примера:
</p></div>

   <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">object(stdClass)#1 (1) {
  [&quot;foo&quot;]=&gt;
  int(1)
}</pre>
</div>
   </div>
  </div>
 </div>



 <div class="refsect1 seealso" id="refsect1-function.mongodb.bson-tophp-seealso">
  <h3 class="title">Смотрите также</h3>
  <ul class="simplelist">
   <li><span class="methodname"><a href="mongodb-bson-document.tophp.php" class="methodname" rel="rdfs-seeAlso">MongoDB\BSON\Document::toPHP()</a> - Возвращает PHP-представление BSON-документа</span></li>
   <li><span class="function"><a href="function.mongodb.bson-fromphp.php" class="function" rel="rdfs-seeAlso">MongoDB\BSON\fromPHP()</a> - Возвращает BSON-представление PHP-значения</span></li>
   <li><a href="https://www.mongodb.com/docs/manual/reference/bson-types/" class="link external">&raquo;&nbsp;BSON-типы БД MongoDB</a></li>
   <li><a href="mongodb.persistence.php" class="xref">Сохранение данных</a></li>
  </ul>
 </div>


</div><?php manual_footer($setup); ?>