Files
php-doc-ru/reference/mongodb/bson/packedarray/tophp.xml
2023-07-12 12:04:21 +03:00

78 lines
2.6 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 52c3812df42c03188138c6930e49ecd7188f0e86 Maintainer: sergey Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="mongodb-bson-packedarray.tophp" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>MongoDB\BSON\PackedArray::toPHP</refname>
<refpurpose>Возвращает PHP-представление массива BSON</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>final</modifier> <modifier>public</modifier> <type class="union"><type>array</type><type>object</type></type><methodname>MongoDB\BSON\PackedArray::toPHP</methodname>
<methodparam choice="opt"><type class="union"><type>array</type><type>null</type></type><parameter>typeMap</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
&mongodb.parameter.typeMap;
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Декодированное значение PHP.
</para>
<note>
<simpara>
Если в массиве BSON встречается значение, закодированное как 64-битное целое число,
то возвращаемым значением метода будет экземпляр <classname>MongoDB\BSON\Int64</classname>.
</simpara>
</note>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<simplelist>
<member>
Выбрасывает исключение <classname>MongoDB\Driver\Exception\InvalidArgumentException</classname>,
если класс в карте типов не может быть инициализирован
или не реализует интерфейс <interfacename>MongoDB\BSON\Unserializable</interfacename>.
</member>
</simplelist>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>MongoDB\BSON\toPHP</function></member>
<member><link xlink:href="&url.mongodb.docs.bson;">Типы BSON</link></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-packedarray:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->