Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Convert MongoDB documentation from a top element of set to book #3627

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Convert MongoDB documentation from a top element of set to book #3627

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
39c4613
Convert MongoDB documentation from a top element of set to book
Jul 28, 2024
af828bf
[skip-revcheck] Remove trailing whitespace
Jul 28, 2024
46f531d
Add extension membership
Jul 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions appendices/extensions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,7 @@
<listitem><simpara><xref linkend="book.memcached"/></simpara></listitem>
<listitem><simpara><xref linkend="book.mhash"/></simpara></listitem>
<listitem><simpara><xref linkend="book.misc"/></simpara></listitem>
<listitem><simpara><xref linkend="book.mongodb"/></simpara></listitem>
<listitem><simpara><xref linkend="book.mqseries"/></simpara></listitem>
<listitem><simpara><xref linkend="book.mysql"/></simpara></listitem>
<listitem><simpara><xref linkend="book.mysql-xdevapi"/></simpara></listitem>
Expand Down Expand Up @@ -342,6 +343,7 @@
<listitem><para><xref linkend="book.mcrypt"/></para></listitem>
<listitem><para><xref linkend="book.memcache"/></para></listitem>
<listitem><para><xref linkend="book.memcached"/></para></listitem>
<listitem><para><xref linkend="book.mongodb"/></para></listitem>
<listitem><para><xref linkend="book.mqseries"/></para></listitem>
<listitem><para><xref linkend="book.mysql"/></para></listitem>
<listitem><para><xref linkend="book.mysql-xdevapi"/></para></listitem>
Expand Down
2 changes: 1 addition & 1 deletion language-snippets.ent
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3585,7 +3585,7 @@ local: {
</para>
<note>
<simpara>
When evaluating query criteria, MongoDB compares types and values according to its own <link xlink:href="&url.mongodb.docs;reference/bson-type-comparison-order/" xmlns:xlink="http://www.w3.org/1999/xlink">comparison rules for BSON types</link>, which differs from PHP&apos;s <link linkend="types.comparisons">comparison</link> and <link linkend="language.types.type-juggling">type juggling</link> rules. When matching a special BSON type the query criteria should use the respective <link linkend="book.bson">BSON class</link> (e.g. use <classname>MongoDB\BSON\ObjectId</classname> to match an <link xlink:href="&url.mongodb.docs.objectid;" xmlns:xlink="http://www.w3.org/1999/xlink">ObjectId</link>).
When evaluating query criteria, MongoDB compares types and values according to its own <link xlink:href="&url.mongodb.docs;reference/bson-type-comparison-order/" xmlns:xlink="http://www.w3.org/1999/xlink">comparison rules for BSON types</link>, which differs from PHP&apos;s <link linkend="types.comparisons">comparison</link> and <link linkend="language.types.type-juggling">type juggling</link> rules. When matching a special BSON type the query criteria should use the respective <link linkend="mongodb.bson">BSON class</link> (e.g. use <classname>MongoDB\BSON\ObjectId</classname> to match an <link xlink:href="&url.mongodb.docs.objectid;" xmlns:xlink="http://www.w3.org/1999/xlink">ObjectId</link>).
</simpara>
</note>
</listitem>
Expand Down
16 changes: 8 additions & 8 deletions reference/mongodb/architecture.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<book xml:id="mongodb.architecture" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<chapter xml:id="mongodb.architecture" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<titleabbrev>Driver Architecture and Internals</titleabbrev>
<title>Explains the driver architecture, and special features</title>

<article xml:id="mongodb.overview">
<section xml:id="mongodb.overview">
<titleabbrev>Architecture</titleabbrev>
<title>Architecture Overview</title>

Expand Down Expand Up @@ -87,9 +87,9 @@
</tgroup>
</table>
</para>
</article>
</section>

<article xml:id="mongodb.connection-handling">
<section xml:id="mongodb.connection-handling">
<titleabbrev>Connections</titleabbrev>
<title>Connection handling and persistence</title>

Expand Down Expand Up @@ -208,9 +208,9 @@ foreach ($managers as $manager) {
PHP&apos;s Streams API.
</para>
</section>
</article>
</section>

<article xml:id="mongodb.persistence">
<section xml:id="mongodb.persistence">
<titleabbrev>Persisting Data</titleabbrev>
<title>Serialization and deserialization of PHP variables into MongoDB</title>

Expand Down Expand Up @@ -967,8 +967,8 @@ function bsonUnserialize( array $map )
</section>
</section>

</article>
</book>
</section>
</chapter>

<!-- Keep this comment at the end of the file
Local variables:
Expand Down
8 changes: 5 additions & 3 deletions reference/mongodb/set.xml → reference/mongodb/book.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<set xml:id="set.mongodb" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<book xml:id="book.mongodb" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<?phpdoc extension-membership="pecl" ?>
<title>MongoDB Extension</title>
<titleabbrev>MongoDB</titleabbrev>

Expand All @@ -16,7 +17,7 @@
<link linkend="class.mongodb-driver-query">queries</link>,
<link linkend="class.mongodb-driver-bulkwrite">writes</link>,
<link linkend="class.mongodb-driver-manager">connection management</link>,
and <link linkend="book.bson">BSON serialization</link>.
and <link linkend="mongodb.bson">BSON serialization</link>.
</simpara>
<simpara>
Userland PHP libraries that depend on this extension may provide higher
Expand All @@ -33,6 +34,7 @@
</info>

&reference.mongodb.setup;
&reference.mongodb.constants;
&reference.mongodb.tutorial;
&reference.mongodb.architecture;
&reference.mongodb.security;
Expand All @@ -41,7 +43,7 @@
&reference.mongodb.bson;
&reference.mongodb.monitoring;
&reference.mongodb.exceptions;
</set>
</book>

<!-- Keep this comment at the end of the file
Local variables:
Expand Down
5 changes: 2 additions & 3 deletions reference/mongodb/bson.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<book xml:id="book.bson" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<part xml:id="mongodb.bson" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<?phpdoc extension-membership="pecl" ?>
<title>MongoDB BSON Classes and Functions</title>
<titleabbrev>MongoDB\BSON</titleabbrev>
Expand Down Expand Up @@ -44,5 +44,4 @@
&reference.mongodb.bson.int64;
&reference.mongodb.bson.symbol;
&reference.mongodb.bson.undefined;
</book>

</part>
4 changes: 2 additions & 2 deletions reference/mongodb/configure.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<article xml:id="mongodb.installation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<section xml:id="mongodb.installation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.install;

<section xml:id="mongodb.installation.pecl">
Expand Down Expand Up @@ -270,7 +270,7 @@ extension=mongodb.so
</para>
</section>

</article>
</section>


<!-- Keep this comment at the end of the file
Expand Down
4 changes: 2 additions & 2 deletions reference/mongodb/exceptions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<book xml:id="mongodb.exceptions" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<part xml:id="mongodb.exceptions" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<titleabbrev>MongoDB\Driver\Exception</titleabbrev>
<title>Exception classes</title>

Expand Down Expand Up @@ -66,4 +66,4 @@
</itemizedlist>
</article>

</book>
</part>
4 changes: 2 additions & 2 deletions reference/mongodb/ini.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<article xml:id="mongodb.configuration" xmlns="http://docbook.org/ns/docbook">
<section xml:id="mongodb.configuration" xmlns="http://docbook.org/ns/docbook">
&reftitle.runtime;
&extension.runtime;
<para>
Expand Down Expand Up @@ -74,7 +74,7 @@
</varlistentry>
</variablelist>
</para>
</article>
</section>

<!-- Keep this comment at the end of the file
Local variables:
Expand Down
5 changes: 2 additions & 3 deletions reference/mongodb/mongodb.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<book xml:id="book.mongodb" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<part xml:id="mongodb.mongodb" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<?phpdoc extension-membership="pecl" ?>
<title>MongoDB Extension Classes</title>
<titleabbrev>MongoDB\Driver</titleabbrev>
Expand Down Expand Up @@ -29,5 +29,4 @@
&reference.mongodb.mongodb.driver.writeconcernerror;
&reference.mongodb.mongodb.driver.writeerror;
&reference.mongodb.mongodb.driver.writeresult;
</book>

</part>
5 changes: 2 additions & 3 deletions reference/mongodb/monitoring.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<book xml:id="mongodb.monitoring" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<part xml:id="mongodb.monitoring" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Monitoring classes and subscriber functions</title>
<titleabbrev>MongoDB\Driver\Monitoring</titleabbrev>

Expand All @@ -28,5 +28,4 @@
&reference.mongodb.mongodb.driver.monitoring.logsubscriber;
&reference.mongodb.mongodb.driver.monitoring.sdamsubscriber;
&reference.mongodb.mongodb.driver.monitoring.subscriber;
</book>

</part>
13 changes: 6 additions & 7 deletions reference/mongodb/security.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<book xml:id="mongodb.security" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<chapter xml:id="mongodb.security" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Security</title>

<article xml:id="mongodb.security.request_injection">
<section xml:id="mongodb.security.request_injection">
<title>Request Injection Attacks</title>
<para>
If you are passing <literal>$_GET</literal> (or <literal>$_POST</literal>)
Expand Down Expand Up @@ -44,9 +44,9 @@
See <link xlink:href="&url.mongodb.dochub.security;">the main documentation</link>
for more information about SQL-injection-like issues with MongoDB.
</para>
</article>
</section>

<article xml:id="mongodb.security.script_injection">
<section xml:id="mongodb.security.script_injection">
<title>Script Injection Attacks</title>
<para>
If you are using JavaScript, make sure that any variables that cross the PHP-
Expand Down Expand Up @@ -157,8 +157,8 @@ $r = $m->executeCommand( 'dramio', $cmd );
xlink:href="&url.mongodb.docs;reference/command/eval/">eval command</link>
has been deprecated since MongoDB 3.0, and should also be avoided.
</para>
</article>
</book>
</section>
</chapter>

<!-- Keep this comment at the end of the file
Local variables:
Expand All @@ -180,4 +180,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

13 changes: 6 additions & 7 deletions reference/mongodb/setup.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<book xml:id="mongodb.setup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<chapter xml:id="mongodb.setup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.setup;

<article xml:id="mongodb.requirements">
<section xml:id="mongodb.requirements">
&reftitle.required;
<para>
As of version 1.16.0, the extension requires PHP 7.2 or higher. Previous
Expand Down Expand Up @@ -43,21 +43,20 @@
integer type.
</simpara>
</note>
</article>
</section>

&reference.mongodb.configure;
&reference.mongodb.ini;
<!--
<article xml:id="mongodb.resources">
<section xml:id="mongodb.resources">
&reftitle.resources;
<para>

</para>
</article>
</section>
-->
&reference.mongodb.constants;

</book>
</chapter>

<!-- Keep this comment at the end of the file
Local variables:
Expand Down
4 changes: 2 additions & 2 deletions reference/mongodb/tutorial.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<book xml:id="mongodb.tutorial" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<chapter xml:id="mongodb.tutorial" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Tutorials</title>
<titleabbrev>Tutorials</titleabbrev>

Expand All @@ -16,7 +16,7 @@

&reference.mongodb.tutorial.library;
&reference.mongodb.tutorial.apm;
</book>
</chapter>


<!-- Keep this comment at the end of the file
Expand Down
4 changes: 2 additions & 2 deletions reference/mongodb/tutorial/apm.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<chapter xml:id="mongodb.tutorial.apm" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<section xml:id="mongodb.tutorial.apm" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Application Performance Monitoring (APM)</title>

<para>
Expand Down Expand Up @@ -185,7 +185,7 @@ $cursor = $m->executeQuery( 'dramio.whisky', $query );
</programlisting>
</section>

</chapter>
</section>

<!-- Keep this comment at the end of the file
Local variables:
Expand Down
4 changes: 2 additions & 2 deletions reference/mongodb/tutorial/library.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<chapter xml:id="mongodb.tutorial.library" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<section xml:id="mongodb.tutorial.library" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Using the PHP Library for MongoDB (PHPLIB)</title>

<para>
Expand Down Expand Up @@ -155,7 +155,7 @@ foreach ($result as $entry) {
how values are converted between PHP and BSON.
</para>
</section>
</chapter>
</section>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Expand Down
Loading