jsonserialize.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ --> 

<refentry xml:id="mongodb-bson-int64.jsonserialize" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>MongoDB\BSON\Int64::jsonSerialize</refname>
  <refpurpose>Returns a representation that can be converted to JSON</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>final</modifier> <modifier>public</modifier> <type>mixed</type><methodname>MongoDB\BSON\Int64::jsonSerialize</methodname>
   <void />
  </methodsynopsis>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  &no.function.parameters;
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns data which can be serialized by <function>json_encode</function> to
   produce an extended JSON representation of the
   <classname>MongoDB\BSON\Int64</classname>.
  </para>
  <note>
   <simpara>
    The output is consistent with the
    <function>MongoDB\BSON\toCanonicalExtendedJSON</function> function, which
    uses the
    <link xlink:href="&url.mongodb.specs.extendedjson;#canonical-extended-json-example">canonical</link>
    extended JSON format. This differs from other BSON classes, which use the
    driver-specific legacy extended JSON format
    (<function>MongoDB\BSON\toJSON</function>), in order to ensure that the
    64-bit integer value is correctly represented on 32-bit platforms.
   </simpara>
  </note>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <simplelist>
   &mongodb.throws.argumentparsing;
  </simplelist>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><methodname>JsonSerializable::jsonSerialize</methodname></member>
   <member><function>json_encode</function></member>
   <member><function>MongoDB\BSON\toCanonicalExtendedJSON</function></member>
   <member><function>MongoDB\BSON\toRelaxedExtendedJSON</function></member>
   <member><link xlink:href="&url.mongodb.docs.extendedjson;">MongoDB Extended JSON</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-document: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
-->