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

<phpdoc:classref xml:id="class.mongodb-bson-int64" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">

 <title>The MongoDB\BSON\Int64 class</title>
 <titleabbrev>MongoDB\BSON\Int64</titleabbrev>

 <partintro>

<!-- {{{ MongoDB\BSON\Int64 intro -->
  <section xml:id="mongodb-bson-int64.intro">
   &reftitle.intro;
   <para>
    BSON type for a 64-bit integer. When decoding BSON to PHP data, this class
    is used when a 64-bit integer cannot be represented as a PHP integer on
    32-bit platforms. These objects support overloaded
    <link linkend="language.operators.arithmetic">arithmetic</link>,
    <link linkend="language.operators.bitwise">bitwise</link>, and
    <link linkend="language.operators.comparison">comparison</link> operators.
   </para>
   <para>
    When working with raw BSON data through the
    <classname>MongoDB\BSON\Document</classname>,
    <classname>MongoDB\BSON\PackedArray</classname>, and
    <classname>MongoDB\BSON\Iterator</classname> classes, any 64-bit integer
    will be returned as an instance of this class, regardless of platform and
    whether the value can be represented as a PHP integer. This ensures that
    values can be roundtripped without changing the type.
   </para>
   <para>
    During BSON encoding, objects of this class will convert back to a 64-bit
    integer type, even when the value would fit in a 32-bit integer. This
    allows explicitly storing values as 64-bit integers in BSON.
   </para>
  </section>
<!-- }}} -->

  <section xml:id="mongodb-bson-int64.synopsis">
   &reftitle.classsynopsis;

<!-- {{{ Synopsis -->
   <classsynopsis>
    <ooclass><classname>MongoDB\BSON\Int64</classname></ooclass>

<!-- {{{ Class synopsis -->
    <classsynopsisinfo>
     <modifier>final</modifier>
     <ooclass>
      <classname>MongoDB\BSON\Int64</classname>
     </ooclass>

     <oointerface>
      <interfacename>MongoDB\BSON\Type</interfacename>
     </oointerface>

     <oointerface>
      <interfacename>Serializable</interfacename>
     </oointerface>

     <oointerface>
      <interfacename>JsonSerializable</interfacename>
     </oointerface>

     <oointerface>
      <interfacename>Stringable</interfacename>
     </oointerface>
    </classsynopsisinfo>
<!-- }}} -->

    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.mongodb-bson-int64')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
   </classsynopsis>
<!-- }}} -->

  </section>

  <section role="changelog">
   &reftitle.changelog;
   <para>
    <informaltable>
     <tgroup cols="2">
      <thead>
       <row>
        <entry>&Version;</entry>
        <entry>&Description;</entry>
       </row>
      </thead>
      <tbody>
       <row>
        <entry>PECL mongodb 1.16.0</entry>
        <entry>
         The class can now be instantiated on all platforms. Added support for
         overloaded arithmetic, bitwise, and comparison operators.
        </entry>
       </row>
       <row>
        <entry>PECL mongodb 1.12.0</entry>
        <entry>
         Implements <interfacename>Stringable</interfacename> for PHP 8.0+.
        </entry>
       </row>
      </tbody>
     </tgroup>
    </informaltable>
   </para>
  </section>

 </partintro>

 &reference.mongodb.bson.entities.int64;

</phpdoc:classref>

<!-- 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
-->
