php-doc-en/reference/mongodb/bson/timestamp/construct.xml
2018-01-25 15:56:34 +00:00

106 lines
2.5 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="mongodb-bson-timestamp.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>MongoDB\BSON\Timestamp::__construct</refname>
<refpurpose>Construct a new Timestamp</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>final</modifier> <modifier>public</modifier> <methodname>MongoDB\BSON\Timestamp::__construct</methodname>
<methodparam><type>int</type><parameter>increment</parameter></methodparam>
<methodparam><type>int</type><parameter>timestamp</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>increment</parameter> (<type>integer</type>)</term>
<listitem>
<para>
32-bit integer denoting the incrementing ordinal for operations within a
given second.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>timestamp</parameter> (<type>integer</type>)</term>
<listitem>
<para>
32-bit integer denoting seconds since the Unix epoch.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<simplelist>
&mongodb.throws.argumentparsing;
</simplelist>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>MongoDB\BSON\Timestamp::__construct</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$timestamp = new MongoDB\BSON\Timestamp(1234, 5678);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
object(MongoDB\BSON\Timestamp)#1 (2) {
["increment"]=>
int(1234)
["timestamp"]=>
int(5678)
}
]]>
</screen>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><link xlink:href="&url.mongodb.docs.bson;#timestamps">BSON Types: Timestamps</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
-->