mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-15 16:38:54 +00:00
Update BSON docs for MongoDB driver
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@338287 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Jeremy Mikola
parent
424e4bdde8
commit
dedcfce805
23 changed files with 521 additions and 246 deletions
|
|
@ -4,56 +4,47 @@
|
|||
<refentry xml:id="mongodb-bson-binary.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>MongoDB\BSON\Binary::__construct</refname>
|
||||
<refpurpose>Description</refpurpose>
|
||||
<refpurpose>Construct a new Binary</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<modifier>public</modifier> <methodname>MongoDB\BSON\Binary::__construct</methodname>
|
||||
<modifier>final</modifier> <modifier>public</modifier> <methodname>MongoDB\BSON\Binary::__construct</methodname>
|
||||
<methodparam><type>string</type><parameter>data</parameter></methodparam>
|
||||
<methodparam><type>string</type><parameter>subtype</parameter></methodparam>
|
||||
<methodparam><type>integer</type><parameter>type</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>data</parameter></term>
|
||||
<term><parameter>data</parameter> (<type>string</type>)</term>
|
||||
<listitem>
|
||||
<para>
|
||||
|
||||
Binary data.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>subtype</parameter></term>
|
||||
<term><parameter>type</parameter> (<type>integer</type>)</term>
|
||||
<listitem>
|
||||
<para>
|
||||
|
||||
Binary type.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="errors">
|
||||
&reftitle.errors;
|
||||
<para>
|
||||
|
||||
</para>
|
||||
<simplelist>
|
||||
&mongodb.throws.argumentparsing;
|
||||
</simplelist>
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
|
@ -65,15 +56,21 @@
|
|||
<![CDATA[
|
||||
<?php
|
||||
|
||||
/* ... */
|
||||
$binary = new MongoDB\BSON\Binary('foo', MongoDB\BSON\Binary::TYPE_GENERIC);
|
||||
var_dump($binary);
|
||||
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
&example.outputs.similar;
|
||||
&example.outputs;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
...
|
||||
object(MongoDB\BSON\Binary)#1 (2) {
|
||||
["data"]=>
|
||||
string(3) "foo"
|
||||
["type"]=>
|
||||
int(0)
|
||||
}
|
||||
]]>
|
||||
</screen>
|
||||
</example>
|
||||
|
|
@ -83,7 +80,7 @@
|
|||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member></member>
|
||||
<member><link xlink:href="&url.mongodb.docs.bson;">BSON Types</link></member>
|
||||
</simplelist>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
|||
92
reference/mongodb/bson/binary/getdata.xml
Normal file
92
reference/mongodb/bson/binary/getdata.xml
Normal file
|
|
@ -0,0 +1,92 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision: 337902 $ -->
|
||||
|
||||
<refentry xml:id="mongodb-bson-binary.getdata" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>MongoDB\BSON\Binary::getData</refname>
|
||||
<refpurpose>Returns the Binary's data</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<modifier>final</modifier> <modifier>public</modifier> <type>string</type><methodname>MongoDB\BSON\Binary::getData</methodname>
|
||||
<void />
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
&no.function.parameters;
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the Binary's data
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="errors">
|
||||
&reftitle.errors;
|
||||
<simplelist>
|
||||
&mongodb.throws.argumentparsing;
|
||||
</simplelist>
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<example>
|
||||
<title><function>MongoDB\BSON\Binary::getData</function> example</title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
|
||||
$binary = new MongoDB\BSON\Binary('foo', MongoDB\BSON\Binary::TYPE_GENERIC);
|
||||
var_dump($binary->getData());
|
||||
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
&example.outputs;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
string(3) "foo"
|
||||
]]>
|
||||
</screen>
|
||||
</example>
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member><link xlink:href="&url.mongodb.docs.bson;">BSON Types</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
|
||||
-->
|
||||
92
reference/mongodb/bson/binary/gettype.xml
Normal file
92
reference/mongodb/bson/binary/gettype.xml
Normal file
|
|
@ -0,0 +1,92 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision: 337902 $ -->
|
||||
|
||||
<refentry xml:id="mongodb-bson-binary.gettype" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>MongoDB\BSON\Binary::getType</refname>
|
||||
<refpurpose>Returns the Binary's type</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<modifier>final</modifier> <modifier>public</modifier> <type>integer</type><methodname>MongoDB\BSON\Binary::getType</methodname>
|
||||
<void />
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
&no.function.parameters;
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the Binary's type.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="errors">
|
||||
&reftitle.errors;
|
||||
<simplelist>
|
||||
&mongodb.throws.argumentparsing;
|
||||
</simplelist>
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<example>
|
||||
<title><function>MongoDB\BSON\Binary::getType</function> example</title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
|
||||
$binary = new MongoDB\BSON\Binary('foo', MongoDB\BSON\Binary::TYPE_GENERIC);
|
||||
var_dump($binary->getType());
|
||||
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
&example.outputs;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
int(0)
|
||||
]]>
|
||||
</screen>
|
||||
</example>
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member><link xlink:href="&url.mongodb.docs.bson;">BSON Types</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
|
||||
-->
|
||||
|
|
@ -4,56 +4,47 @@
|
|||
<refentry xml:id="mongodb-bson-javascript.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>MongoDB\BSON\Javascript::__construct</refname>
|
||||
<refpurpose>Description</refpurpose>
|
||||
<refpurpose>Construct a new Javascript</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<modifier>final</modifier> <modifier>public</modifier> <methodname>MongoDB\BSON\Javascript::__construct</methodname>
|
||||
<methodparam><type>string</type><parameter>javascript</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>string</type><parameter>scope</parameter></methodparam>
|
||||
<methodparam><type>string</type><parameter>code</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>array|object</type><parameter>scope</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>javascript</parameter></term>
|
||||
<term><parameter>code</parameter> (<type>string</type>)</term>
|
||||
<listitem>
|
||||
<para>
|
||||
|
||||
Javascript code.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>scope</parameter></term>
|
||||
<term><parameter>scope</parameter> (<type>array|object</type>)</term>
|
||||
<listitem>
|
||||
<para>
|
||||
|
||||
Javascript scope.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="errors">
|
||||
&reftitle.errors;
|
||||
<para>
|
||||
|
||||
</para>
|
||||
<simplelist>
|
||||
&mongodb.throws.argumentparsing;
|
||||
</simplelist>
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
|
@ -65,15 +56,34 @@
|
|||
<![CDATA[
|
||||
<?php
|
||||
|
||||
/* ... */
|
||||
$code = new MongoDB\BSON\Javascript('function() { return 1; }');
|
||||
var_dump($code);
|
||||
|
||||
$codews = new MongoDB\BSON\Javascript('function() { return foo; }', ['foo' => 'bar']);
|
||||
var_dump($codews);
|
||||
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
&example.outputs.similar;
|
||||
&example.outputs;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
...
|
||||
object(MongoDB\BSON\Javascript)#1 (2) {
|
||||
["javascript"]=>
|
||||
string(24) "function() { return 1; }"
|
||||
["scope"]=>
|
||||
object(stdClass)#2 (0) {
|
||||
}
|
||||
}
|
||||
object(MongoDB\BSON\Javascript)#2 (2) {
|
||||
["javascript"]=>
|
||||
string(26) "function() { return foo; }"
|
||||
["scope"]=>
|
||||
object(stdClass)#1 (1) {
|
||||
["foo"]=>
|
||||
string(3) "bar"
|
||||
}
|
||||
}
|
||||
]]>
|
||||
</screen>
|
||||
</example>
|
||||
|
|
@ -83,7 +93,7 @@
|
|||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member></member>
|
||||
<member><link xlink:href="&url.mongodb.docs.bson;">BSON Types</link></member>
|
||||
</simplelist>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
|
||||
<!-- $Revision$ -->
|
||||
|
||||
<phpdoc:classref xml:id="class.mongodb-bson-maxkey" 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\MaxKey class</title>
|
||||
|
|
@ -36,6 +36,8 @@
|
|||
</classsynopsisinfo>
|
||||
<!-- }}} -->
|
||||
|
||||
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
|
||||
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.mongodb-bson-maxkey')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
|
||||
</classsynopsis>
|
||||
<!-- }}} -->
|
||||
|
||||
|
|
@ -43,6 +45,8 @@
|
|||
|
||||
</partintro>
|
||||
|
||||
&reference.mongodb.bson.entities.maxkey;
|
||||
|
||||
</phpdoc:classref>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
|||
|
|
@ -1,22 +1,20 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
<!-- $Revision: 337902 $ -->
|
||||
|
||||
<refentry xml:id="mongodb-bson-binary.getsubtype" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refentry xml:id="mongodb-bson-maxkey.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>MongoDB\BSON\Binary::getSubType</refname>
|
||||
<refpurpose>Description</refpurpose>
|
||||
<refname>MongoDB\BSON\MaxKey::__construct</refname>
|
||||
<refpurpose>Construct a new MaxKey</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<modifier>public</modifier> <type>ReturnType</type><methodname>MongoDB\BSON\Binary::getSubType</methodname>
|
||||
<void />
|
||||
<modifier>final</modifier> <modifier>public</modifier> <methodname>MongoDB\BSON\MaxKey::__construct</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
|
|
@ -24,38 +22,32 @@
|
|||
&no.function.parameters;
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="errors">
|
||||
&reftitle.errors;
|
||||
<para>
|
||||
|
||||
</para>
|
||||
<simplelist>
|
||||
&mongodb.throws.argumentparsing;
|
||||
</simplelist>
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<example>
|
||||
<title><function>MongoDB\BSON\Binary::getSubType</function> example</title>
|
||||
<title><function>MongoDB\BSON\MaxKey::__construct</function> example</title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
|
||||
/* ... */
|
||||
var_dump(new MongoDB\BSON\MaxKey());
|
||||
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
&example.outputs.similar;
|
||||
&example.outputs;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
...
|
||||
object(MongoDB\BSON\MaxKey)#1 (0) {
|
||||
}
|
||||
]]>
|
||||
</screen>
|
||||
</example>
|
||||
|
|
@ -65,7 +57,7 @@
|
|||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member></member>
|
||||
<member><link xlink:href="&url.mongodb.docs.bson;">BSON Types</link></member>
|
||||
</simplelist>
|
||||
</refsect1>
|
||||
|
||||
|
|
@ -36,6 +36,8 @@
|
|||
</classsynopsisinfo>
|
||||
<!-- }}} -->
|
||||
|
||||
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
|
||||
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.mongodb-bson-minkey')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
|
||||
</classsynopsis>
|
||||
<!-- }}} -->
|
||||
|
||||
|
|
@ -43,6 +45,8 @@
|
|||
|
||||
</partintro>
|
||||
|
||||
&reference.mongodb.bson.entities.minkey;
|
||||
|
||||
</phpdoc:classref>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
|||
85
reference/mongodb/bson/minkey/construct.xml
Normal file
85
reference/mongodb/bson/minkey/construct.xml
Normal file
|
|
@ -0,0 +1,85 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision: 337902 $ -->
|
||||
|
||||
<refentry xml:id="mongodb-bson-minkey.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>MongoDB\BSON\MinKey::__construct</refname>
|
||||
<refpurpose>Construct a new MinKey</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<modifier>final</modifier> <modifier>public</modifier> <methodname>MongoDB\BSON\MinKey::__construct</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
&no.function.parameters;
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="errors">
|
||||
&reftitle.errors;
|
||||
<simplelist>
|
||||
&mongodb.throws.argumentparsing;
|
||||
</simplelist>
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<example>
|
||||
<title><function>MongoDB\BSON\MinKey::__construct</function> example</title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
|
||||
var_dump(new MongoDB\BSON\MinKey());
|
||||
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
&example.outputs;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
object(MongoDB\BSON\MinKey)#1 (0) {
|
||||
}
|
||||
]]>
|
||||
</screen>
|
||||
</example>
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member><link xlink:href="&url.mongodb.docs.bson;">BSON Types</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
|
||||
-->
|
||||
|
|
@ -4,47 +4,40 @@
|
|||
<refentry xml:id="mongodb-bson-objectid.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>MongoDB\BSON\ObjectID::__construct</refname>
|
||||
<refpurpose>Description</refpurpose>
|
||||
<refpurpose>Construct a new ObjectID</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<modifier>public</modifier> <methodname>MongoDB\BSON\ObjectID::__construct</methodname>
|
||||
<modifier>final</modifier> <modifier>public</modifier> <methodname>MongoDB\BSON\ObjectID::__construct</methodname>
|
||||
<methodparam choice="opt"><type>string</type><parameter>id</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>id</parameter></term>
|
||||
<term><parameter>id</parameter> (<type>string</type>)</term>
|
||||
<listitem>
|
||||
<para>
|
||||
|
||||
A 24-character hexadecimal string. If not provided, the driver will
|
||||
generate an ObjectID.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="errors">
|
||||
&reftitle.errors;
|
||||
<para>
|
||||
|
||||
</para>
|
||||
<simplelist>
|
||||
&mongodb.throws.argumentparsing;
|
||||
<member>Throws <classname>MongoDB\Driver\Exception\InvalidArgumentException</classname> if <parameter>id</parameter> is not a 24-character hexadecimal string.</member>
|
||||
</simplelist>
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
|
@ -56,7 +49,9 @@
|
|||
<![CDATA[
|
||||
<?php
|
||||
|
||||
/* ... */
|
||||
var_dump(new MongoDB\BSON\ObjectId());
|
||||
|
||||
var_dump(new MongoDB\BSON\ObjectId('000000000000000000000001'));
|
||||
|
||||
?>
|
||||
]]>
|
||||
|
|
@ -64,7 +59,15 @@
|
|||
&example.outputs.similar;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
...
|
||||
object(MongoDB\BSON\ObjectID)#1 (1) {
|
||||
["oid"]=>
|
||||
string(24) "56732d3dda14d81214634921"
|
||||
}
|
||||
object(MongoDB\BSON\ObjectID)#1 (1) {
|
||||
["oid"]=>
|
||||
string(24) "000000000000000000000001"
|
||||
}
|
||||
|
||||
]]>
|
||||
</screen>
|
||||
</example>
|
||||
|
|
@ -74,7 +77,8 @@
|
|||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member></member>
|
||||
<member><link xlink:href="&url.mongodb.docs.objectid;">ObjectID Reference</link></member>
|
||||
<member><link xlink:href="&url.mongodb.docs.bson;#objectid">BSON Types: ObjectID</link></member>
|
||||
</simplelist>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
|||
|
|
@ -4,19 +4,17 @@
|
|||
<refentry xml:id="mongodb-bson-objectid.tostring" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>MongoDB\BSON\ObjectID::__toString</refname>
|
||||
<refpurpose>Description</refpurpose>
|
||||
<refpurpose>Returns the hexidecimal representation of this ObjectID</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<modifier>public</modifier> <type>ReturnType</type><methodname>MongoDB\BSON\ObjectID::__toString</methodname>
|
||||
<modifier>final</modifier> <modifier>public</modifier> <type>string</type><methodname>MongoDB\BSON\ObjectID::__toString</methodname>
|
||||
<void />
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
|
|
@ -27,15 +25,15 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
|
||||
Returns the hexidecimal representation of this ObjectID.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="errors">
|
||||
&reftitle.errors;
|
||||
<para>
|
||||
|
||||
</para>
|
||||
<simplelist>
|
||||
&mongodb.throws.argumentparsing;
|
||||
</simplelist>
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
|
@ -47,7 +45,8 @@
|
|||
<![CDATA[
|
||||
<?php
|
||||
|
||||
/* ... */
|
||||
var_dump((string) new MongoDB\BSON\ObjectId());
|
||||
var_dump((string) new MongoDB\BSON\ObjectId('000000000000000000000001'));
|
||||
|
||||
?>
|
||||
]]>
|
||||
|
|
@ -55,7 +54,8 @@
|
|||
&example.outputs.similar;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
...
|
||||
string(24) "56731b49da14d8747d701211"
|
||||
string(24) "000000000000000000000001"
|
||||
]]>
|
||||
</screen>
|
||||
</example>
|
||||
|
|
@ -65,7 +65,8 @@
|
|||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member></member>
|
||||
<member><link xlink:href="&url.mongodb.docs.objectid;">ObjectID Reference</link></member>
|
||||
<member><link xlink:href="&url.mongodb.docs.bson;#objectid">BSON Types: ObjectID</link></member>
|
||||
</simplelist>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
|||
|
|
@ -4,56 +4,47 @@
|
|||
<refentry xml:id="mongodb-bson-regex.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>MongoDB\BSON\Regex::__construct</refname>
|
||||
<refpurpose>Description</refpurpose>
|
||||
<refpurpose>Construct a new Regex</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<modifier>public</modifier> <methodname>MongoDB\BSON\Regex::__construct</methodname>
|
||||
<modifier>final</modifier> <modifier>public</modifier> <methodname>MongoDB\BSON\Regex::__construct</methodname>
|
||||
<methodparam><type>string</type><parameter>pattern</parameter></methodparam>
|
||||
<methodparam><type>string</type><parameter>flags</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>pattern</parameter></term>
|
||||
<term><parameter>pattern</parameter> (<type>string</type>)</term>
|
||||
<listitem>
|
||||
<para>
|
||||
|
||||
The regular expression pattern.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>flags</parameter></term>
|
||||
<term><parameter>flags</parameter> (<type>string</type>)</term>
|
||||
<listitem>
|
||||
<para>
|
||||
|
||||
The regular expression flags.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="errors">
|
||||
&reftitle.errors;
|
||||
<para>
|
||||
|
||||
</para>
|
||||
<simplelist>
|
||||
&mongodb.throws.argumentparsing;
|
||||
</simplelist>
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
|
@ -65,15 +56,21 @@
|
|||
<![CDATA[
|
||||
<?php
|
||||
|
||||
/* ... */
|
||||
$regex = new MongoDB\BSON\Regex('regex', 'i');
|
||||
var_dump($regex);
|
||||
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
&example.outputs.similar;
|
||||
&example.outputs;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
...
|
||||
object(MongoDB\BSON\Regex)#1 (2) {
|
||||
["pattern"]=>
|
||||
string(5) "regex"
|
||||
["flags"]=>
|
||||
string(1) "i"
|
||||
}
|
||||
]]>
|
||||
</screen>
|
||||
</example>
|
||||
|
|
@ -83,7 +80,7 @@
|
|||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member></member>
|
||||
<member><link xlink:href="&url.mongodb.docs.bson;">BSON Types</link></member>
|
||||
</simplelist>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
|||
|
|
@ -4,19 +4,17 @@
|
|||
<refentry xml:id="mongodb-bson-regex.getflags" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>MongoDB\BSON\Regex::getFlags</refname>
|
||||
<refpurpose>Description</refpurpose>
|
||||
<refpurpose>Returns the Regex's flags</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<modifier>public</modifier> <type>ReturnType</type><methodname>MongoDB\BSON\Regex::getFlags</methodname>
|
||||
<modifier>final</modifier> <modifier>public</modifier> <type>ReturnType</type><methodname>MongoDB\BSON\Regex::getFlags</methodname>
|
||||
<void />
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
|
|
@ -27,15 +25,15 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
|
||||
Returns the Regex's flags
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="errors">
|
||||
&reftitle.errors;
|
||||
<para>
|
||||
|
||||
</para>
|
||||
<simplelist>
|
||||
&mongodb.throws.argumentparsing;
|
||||
</simplelist>
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
|
@ -47,7 +45,8 @@
|
|||
<![CDATA[
|
||||
<?php
|
||||
|
||||
/* ... */
|
||||
$regex = new MongoDB\BSON\Regex('regex', 'i');
|
||||
var_dump($regex->getFlags());
|
||||
|
||||
?>
|
||||
]]>
|
||||
|
|
@ -55,7 +54,7 @@
|
|||
&example.outputs.similar;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
...
|
||||
string(1) "i"
|
||||
]]>
|
||||
</screen>
|
||||
</example>
|
||||
|
|
@ -65,7 +64,7 @@
|
|||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member></member>
|
||||
<member><link xlink:href="&url.mongodb.docs.bson;">BSON Types</link></member>
|
||||
</simplelist>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
|||
|
|
@ -4,19 +4,17 @@
|
|||
<refentry xml:id="mongodb-bson-regex.getpattern" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>MongoDB\BSON\Regex::getPattern</refname>
|
||||
<refpurpose>Description</refpurpose>
|
||||
<refpurpose>Returns the Regex's pattern</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<modifier>public</modifier> <type>ReturnType</type><methodname>MongoDB\BSON\Regex::getPattern</methodname>
|
||||
<modifier>final</modifier> <modifier>public</modifier> <type>string</type><methodname>MongoDB\BSON\Regex::getPattern</methodname>
|
||||
<void />
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
|
|
@ -27,15 +25,15 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
|
||||
Returns the Regex's pattern.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="errors">
|
||||
&reftitle.errors;
|
||||
<para>
|
||||
|
||||
</para>
|
||||
<simplelist>
|
||||
&mongodb.throws.argumentparsing;
|
||||
</simplelist>
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
|
@ -47,7 +45,8 @@
|
|||
<![CDATA[
|
||||
<?php
|
||||
|
||||
/* ... */
|
||||
$regex = new MongoDB\BSON\Regex('regex', 'i');
|
||||
var_dump($regex->getPattern());
|
||||
|
||||
?>
|
||||
]]>
|
||||
|
|
@ -55,7 +54,7 @@
|
|||
&example.outputs.similar;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
...
|
||||
string(5) "regex"
|
||||
]]>
|
||||
</screen>
|
||||
</example>
|
||||
|
|
@ -65,7 +64,7 @@
|
|||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member></member>
|
||||
<member><link xlink:href="&url.mongodb.docs.bson;">BSON Types</link></member>
|
||||
</simplelist>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
|||
|
|
@ -4,19 +4,17 @@
|
|||
<refentry xml:id="mongodb-bson-regex.tostring" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>MongoDB\BSON\Regex::__toString</refname>
|
||||
<refpurpose>Description</refpurpose>
|
||||
<refpurpose>Returns the string representation of this Regex</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<modifier>public</modifier> <type>ReturnType</type><methodname>MongoDB\BSON\Regex::__toString</methodname>
|
||||
<modifier>final</modifier> <modifier>public</modifier> <type>string</type><methodname>MongoDB\BSON\Regex::__toString</methodname>
|
||||
<void />
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
|
|
@ -27,15 +25,15 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
|
||||
Returns the string representation of this Regex.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="errors">
|
||||
&reftitle.errors;
|
||||
<para>
|
||||
|
||||
</para>
|
||||
<simplelist>
|
||||
&mongodb.throws.argumentparsing;
|
||||
</simplelist>
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
|
@ -47,15 +45,16 @@
|
|||
<![CDATA[
|
||||
<?php
|
||||
|
||||
/* ... */
|
||||
$regex = new MongoDB\BSON\Regex('regex', 'i');
|
||||
var_dump((string) $regex);
|
||||
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
&example.outputs.similar;
|
||||
&example.outputs;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
...
|
||||
string(8) "/regex/i"
|
||||
]]>
|
||||
</screen>
|
||||
</example>
|
||||
|
|
@ -65,7 +64,7 @@
|
|||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member></member>
|
||||
<member><link xlink:href="&url.mongodb.docs.bson;">BSON Types</link></member>
|
||||
</simplelist>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
|||
|
|
@ -162,7 +162,7 @@ echo MongoDB\BSON\toJSON($bson), "\n";
|
|||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member><function>MongoDB\BSON\Unzerializable::bsonUnserialize</function></member>
|
||||
<member><function>MongoDB\BSON\Unserializable::bsonUnserialize</function></member>
|
||||
<member><classname>MongoDB\BSON\Persistable</classname></member>
|
||||
<member><xref linkend="mongodb.persistence"/></member>
|
||||
</simplelist>
|
||||
|
|
|
|||
|
|
@ -12,7 +12,9 @@
|
|||
<section xml:id="mongodb-bson-timestamp.intro">
|
||||
&reftitle.intro;
|
||||
<para>
|
||||
|
||||
Represents a
|
||||
<link xlink:href="&url.mongodb.docs.bson;#timestamps">BSON timestamp</link>,
|
||||
which is an internal MongoDB type not intended for general date storage.
|
||||
</para>
|
||||
</section>
|
||||
<!-- }}} -->
|
||||
|
|
|
|||
|
|
@ -4,56 +4,48 @@
|
|||
<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>Description</refpurpose>
|
||||
<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>string</type><parameter>increment</parameter></methodparam>
|
||||
<methodparam><type>string</type><parameter>timestamp</parameter></methodparam>
|
||||
<methodparam><type>integer</type><parameter>increment</parameter></methodparam>
|
||||
<methodparam><type>integer</type><parameter>timestamp</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>increment</parameter></term>
|
||||
<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></term>
|
||||
<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="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="errors">
|
||||
&reftitle.errors;
|
||||
<para>
|
||||
|
||||
</para>
|
||||
<simplelist>
|
||||
&mongodb.throws.argumentparsing;
|
||||
</simplelist>
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
|
@ -65,15 +57,20 @@
|
|||
<![CDATA[
|
||||
<?php
|
||||
|
||||
/* ... */
|
||||
$timestamp = new MongoDB\BSON\Timestamp(1234, 5678);
|
||||
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
&example.outputs.similar;
|
||||
&example.outputs;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
...
|
||||
object(MongoDB\BSON\Timestamp)#1 (2) {
|
||||
["increment"]=>
|
||||
int(1234)
|
||||
["timestamp"]=>
|
||||
int(5678)
|
||||
}
|
||||
]]>
|
||||
</screen>
|
||||
</example>
|
||||
|
|
@ -83,7 +80,7 @@
|
|||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member></member>
|
||||
<member><link xlink:href="&url.mongodb.docs.bson;#timestamps">BSON Types: Timestamps</link></member>
|
||||
</simplelist>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
|||
|
|
@ -4,19 +4,17 @@
|
|||
<refentry xml:id="mongodb-bson-timestamp.tostring" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>MongoDB\BSON\Timestamp::__toString</refname>
|
||||
<refpurpose>Description</refpurpose>
|
||||
<refpurpose>Returns the string representation of this Timestamp</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<modifier>final</modifier> <modifier>public</modifier> <type>ReturnType</type><methodname>MongoDB\BSON\Timestamp::__toString</methodname>
|
||||
<modifier>final</modifier> <modifier>public</modifier> <type>string</type><methodname>MongoDB\BSON\Timestamp::__toString</methodname>
|
||||
<void />
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
|
|
@ -27,15 +25,15 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
|
||||
Returns the string representation of this Timestamp.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="errors">
|
||||
&reftitle.errors;
|
||||
<para>
|
||||
|
||||
</para>
|
||||
<simplelist>
|
||||
&mongodb.throws.argumentparsing;
|
||||
</simplelist>
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
|
@ -47,7 +45,8 @@
|
|||
<![CDATA[
|
||||
<?php
|
||||
|
||||
/* ... */
|
||||
$timestamp = new MongoDB\BSON\Timestamp(1234, 5678);
|
||||
var_dump((string) $timestamp);
|
||||
|
||||
?>
|
||||
]]>
|
||||
|
|
@ -55,7 +54,7 @@
|
|||
&example.outputs.similar;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
...
|
||||
string(11) "[1234:5678]"
|
||||
]]>
|
||||
</screen>
|
||||
</example>
|
||||
|
|
@ -65,7 +64,7 @@
|
|||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member></member>
|
||||
<member><link xlink:href="&url.mongodb.docs.bson;#timestamps">BSON Types: Timestamps</link></member>
|
||||
</simplelist>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
|||
|
|
@ -3,8 +3,8 @@
|
|||
|
||||
<phpdoc:classref xml:id="class.mongodb-bson-utcdatetime" 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\UTCDatetime class</title>
|
||||
<titleabbrev>MongoDB\BSON\UTCDatetime</titleabbrev>
|
||||
<title>The MongoDB\BSON\UTCDateTime class</title>
|
||||
<titleabbrev>MongoDB\BSON\UTCDateTime</titleabbrev>
|
||||
|
||||
<partintro>
|
||||
|
||||
|
|
@ -23,12 +23,12 @@
|
|||
|
||||
<!-- {{{ Synopsis -->
|
||||
<classsynopsis>
|
||||
<ooclass><classname>MongoDB\BSON\UTCDatetime</classname></ooclass>
|
||||
<ooclass><classname>MongoDB\BSON\UTCDateTime</classname></ooclass>
|
||||
|
||||
<!-- {{{ Class synopsis -->
|
||||
<classsynopsisinfo>
|
||||
<ooclass>
|
||||
<classname>MongoDB\BSON\UTCDatetime</classname>
|
||||
<classname>MongoDB\BSON\UTCDateTime</classname>
|
||||
</ooclass>
|
||||
|
||||
<oointerface>
|
||||
|
|
|
|||
|
|
@ -3,60 +3,56 @@
|
|||
|
||||
<refentry xml:id="mongodb-bson-utcdatetime.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>MongoDB\BSON\UTCDatetime::__construct</refname>
|
||||
<refpurpose>Description</refpurpose>
|
||||
<refname>MongoDB\BSON\UTCDateTime::__construct</refname>
|
||||
<refpurpose>Construct a new UTCDateTime</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<modifier>final</modifier> <modifier>public</modifier> <methodname>MongoDB\BSON\UTCDatetime::__construct</methodname>
|
||||
<methodparam><type>string</type><parameter>milliseconds</parameter></methodparam>
|
||||
<modifier>final</modifier> <modifier>public</modifier> <methodname>MongoDB\BSON\UTCDateTime::__construct</methodname>
|
||||
<methodparam><type>integer</type><parameter>milliseconds</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>milliseconds</parameter></term>
|
||||
<term><parameter>milliseconds</parameter> (<type>integer</type>)</term>
|
||||
<listitem>
|
||||
<para>
|
||||
|
||||
64-bit integer that represents the number of milliseconds since the Unix
|
||||
epoch (Jan 1, 1970). Negative values represent dates before 1970.
|
||||
</para>
|
||||
<para>
|
||||
On 32-bit systems, this parameter may be provided as a string.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="errors">
|
||||
&reftitle.errors;
|
||||
<para>
|
||||
|
||||
</para>
|
||||
<simplelist>
|
||||
&mongodb.throws.argumentparsing;
|
||||
</simplelist>
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<example>
|
||||
<title><function>MongoDB\BSON\UTCDatetime::__construct</function> example</title>
|
||||
<title><function>MongoDB\BSON\UTCDateTime::__construct</function> example</title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
|
||||
/* ... */
|
||||
$utcdatetime = new MongoDB\BSON\UTCDateTime(1416445411987);
|
||||
var_dump($utcdatetime);
|
||||
|
||||
?>
|
||||
]]>
|
||||
|
|
@ -64,7 +60,10 @@
|
|||
&example.outputs.similar;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
...
|
||||
object(MongoDB\BSON\UTCDateTime)#1 (1) {
|
||||
["milliseconds"]=>
|
||||
int(1416445411987)
|
||||
}
|
||||
]]>
|
||||
</screen>
|
||||
</example>
|
||||
|
|
@ -74,7 +73,7 @@
|
|||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member></member>
|
||||
<member><link xlink:href="&url.mongodb.docs.bson;#date">BSON Types: Date</link></member>
|
||||
</simplelist>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
|||
|
|
@ -3,20 +3,18 @@
|
|||
|
||||
<refentry xml:id="mongodb-bson-utcdatetime.todatetime" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>MongoDB\BSON\UTCDatetime::toDateTime</refname>
|
||||
<refpurpose>Description</refpurpose>
|
||||
<refname>MongoDB\BSON\UTCDateTime::toDateTime</refname>
|
||||
<refpurpose>Returns the DateTime representation of this UTCDateTime</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<modifier>final</modifier> <modifier>public</modifier> <type>ReturnType</type><methodname>MongoDB\BSON\UTCDatetime::toDateTime</methodname>
|
||||
<modifier>final</modifier> <modifier>public</modifier> <type>DateTime</type><methodname>MongoDB\BSON\UTCDateTime::toDateTime</methodname>
|
||||
<void />
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
|
|
@ -27,15 +25,16 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
|
||||
Returns the <classname>DateTime</classname> representation of this
|
||||
UTCDateTime.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="errors">
|
||||
&reftitle.errors;
|
||||
<para>
|
||||
|
||||
</para>
|
||||
<simplelist>
|
||||
&mongodb.throws.argumentparsing;
|
||||
</simplelist>
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
|
@ -47,7 +46,9 @@
|
|||
<![CDATA[
|
||||
<?php
|
||||
|
||||
/* ... */
|
||||
$utcdatetime = new MongoDB\BSON\UTCDateTime(1416445411987);
|
||||
$datetime = $utcdatetime->toDateTime();
|
||||
var_dump($datetime->format(DATE_RSS));
|
||||
|
||||
?>
|
||||
]]>
|
||||
|
|
@ -55,7 +56,7 @@
|
|||
&example.outputs.similar;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
...
|
||||
string(31) "Thu, 20 Nov 2014 01:03:31 +0000"
|
||||
]]>
|
||||
</screen>
|
||||
</example>
|
||||
|
|
@ -65,7 +66,7 @@
|
|||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member></member>
|
||||
<member><link xlink:href="&url.mongodb.docs.bson;#date">BSON Types: Date</link></member>
|
||||
</simplelist>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
|||
|
|
@ -3,20 +3,18 @@
|
|||
|
||||
<refentry xml:id="mongodb-bson-utcdatetime.tostring" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>MongoDB\BSON\UTCDatetime::__toString</refname>
|
||||
<refpurpose>Description</refpurpose>
|
||||
<refname>MongoDB\BSON\UTCDateTime::__toString</refname>
|
||||
<refpurpose>Returns the string representation of this UTCDateTime</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<modifier>final</modifier> <modifier>public</modifier> <type>ReturnType</type><methodname>MongoDB\BSON\UTCDatetime::__toString</methodname>
|
||||
<modifier>final</modifier> <modifier>public</modifier> <type>string</type><methodname>MongoDB\BSON\UTCDateTime::__toString</methodname>
|
||||
<void />
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
|
|
@ -27,35 +25,36 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
|
||||
Returns the string representation of this UTCDateTime.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="errors">
|
||||
&reftitle.errors;
|
||||
<para>
|
||||
|
||||
</para>
|
||||
<simplelist>
|
||||
&mongodb.throws.argumentparsing;
|
||||
</simplelist>
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<example>
|
||||
<title><function>MongoDB\BSON\UTCDatetime::__toString</function> example</title>
|
||||
<title><function>MongoDB\BSON\UTCDateTime::__toString</function> example</title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
|
||||
/* ... */
|
||||
$utcdatetime = new MongoDB\BSON\UTCDateTime(1416445411987);
|
||||
var_dump((string) $utcdatetime);
|
||||
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
&example.outputs.similar;
|
||||
&example.outputs;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
...
|
||||
string(13) "1416445411987"
|
||||
]]>
|
||||
</screen>
|
||||
</example>
|
||||
|
|
@ -65,7 +64,7 @@
|
|||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member></member>
|
||||
<member><link xlink:href="&url.mongodb.docs.bson;#date">BSON Types: Date</link></member>
|
||||
</simplelist>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
|||
|
|
@ -126,14 +126,17 @@
|
|||
<!-- BSON type classes -->
|
||||
<function name='mongodb\bson\binary' from='mongodb >=1.0.0'/>
|
||||
<function name='mongodb\bson\binary::__construct' from='mongodb >=1.0.0'/>
|
||||
<function name='mongodb\bson\binary::getsubtype' from='mongodb >=1.0.0'/>
|
||||
<function name='mongodb\bson\binary::gettype' from='mongodb >=1.0.0'/>
|
||||
<function name='mongodb\bson\binary::getdata' from='mongodb >=1.0.0'/>
|
||||
|
||||
<function name='mongodb\bson\javascript' from='mongodb >=1.0.0'/>
|
||||
<function name='mongodb\bson\javascript::__construct' from='mongodb >=1.0.0'/>
|
||||
|
||||
<function name='mongodb\bson\maxkey' from='mongodb >=1.0.0'/>
|
||||
<function name='mongodb\bson\maxkey::__construct' from='mongodb >=1.0.0'/>
|
||||
|
||||
<function name='mongodb\bson\minkey' from='mongodb >=1.0.0'/>
|
||||
<function name='mongodb\bson\minkey::__construct' from='mongodb >=1.0.0'/>
|
||||
|
||||
<function name='mongodb\bson\objectid' from='mongodb >=1.0.0'/>
|
||||
<function name='mongodb\bson\objectid::__construct' from='mongodb >=1.0.0'/>
|
||||
|
|
|
|||
Loading…
Reference in a new issue