File: int64.xml

package info (click to toggle)
php-doc 20241205~git.dfcbb86%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 70,956 kB
  • sloc: xml: 968,269; php: 23,883; javascript: 671; sh: 177; makefile: 37
file content (134 lines) | stat: -rw-r--r-- 3,986 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<reference xml:id="class.mongodb-bson-int64" role="class" 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;

</reference>

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