mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 00:48:54 +00:00
organization: better api layout and manual structure
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@294154 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Kristina Chodorow
parent
680ebf4a47
commit
3b51539eee
5 changed files with 169 additions and 127 deletions
30
reference/mongo/api.xml
Normal file
30
reference/mongo/api.xml
Normal file
|
|
@ -0,0 +1,30 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
|
||||
<chapter xml:id="mongo.api" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<title>API</title>
|
||||
|
||||
|
||||
</chapter>
|
||||
|
||||
<!-- 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
|
||||
-->
|
||||
|
||||
|
|
@ -16,35 +16,49 @@
|
|||
|
||||
</preface>
|
||||
|
||||
&reference.mongo.setup;
|
||||
|
||||
&reference.mongo.manual;
|
||||
|
||||
&reference.mongo.reference;
|
||||
<part>
|
||||
<title>Core Classes</title>
|
||||
&reference.mongo.mongo;
|
||||
&reference.mongo.mongodb;
|
||||
&reference.mongo.mongocollection;
|
||||
&reference.mongo.mongocursor;
|
||||
</part>
|
||||
|
||||
&reference.mongo.mongo;
|
||||
&reference.mongo.mongodb;
|
||||
&reference.mongo.mongocollection;
|
||||
&reference.mongo.mongocursor;
|
||||
&reference.mongo.mongogridfs;
|
||||
&reference.mongo.mongogridfsfile;
|
||||
&reference.mongo.mongogridfscursor;
|
||||
<part>
|
||||
<title>Types</title>
|
||||
&reference.mongo.mongoid;
|
||||
&reference.mongo.mongocode;
|
||||
&reference.mongo.mongodate;
|
||||
&reference.mongo.mongoregex;
|
||||
&reference.mongo.mongobindata;
|
||||
&reference.mongo.mongodbref;
|
||||
&reference.mongo.mongominkey;
|
||||
&reference.mongo.mongomaxkey;
|
||||
&reference.mongo.mongotimestamp;
|
||||
</part>
|
||||
|
||||
&reference.mongo.mongoid;
|
||||
&reference.mongo.mongocode;
|
||||
&reference.mongo.mongodate;
|
||||
&reference.mongo.mongoregex;
|
||||
&reference.mongo.mongobindata;
|
||||
&reference.mongo.mongodbref;
|
||||
<part>
|
||||
<title>GridFS</title>
|
||||
&reference.mongo.mongogridfs;
|
||||
&reference.mongo.mongogridfsfile;
|
||||
&reference.mongo.mongogridfscursor;
|
||||
</part>
|
||||
|
||||
&reference.mongo.mongoexception;
|
||||
&reference.mongo.mongocursorexception;
|
||||
&reference.mongo.mongoconnectionexception;
|
||||
&reference.mongo.mongogridfsexception;
|
||||
<part>
|
||||
<title>Functions</title>
|
||||
&reference.mongo.reference;
|
||||
</part>
|
||||
|
||||
&reference.mongo.mongominkey;
|
||||
&reference.mongo.mongomaxkey;
|
||||
&reference.mongo.mongotimestamp;
|
||||
<part>
|
||||
<title>Exceptions</title>
|
||||
&reference.mongo.mongoexception;
|
||||
&reference.mongo.mongocursorexception;
|
||||
&reference.mongo.mongocursortimeoutexception;
|
||||
&reference.mongo.mongoconnectionexception;
|
||||
&reference.mongo.mongogridfsexception;
|
||||
</part>
|
||||
</book>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
|||
|
|
@ -9,8 +9,9 @@
|
|||
<link xlink:href="&url.pecl.package;mongo">&url.pecl.package;mongo</link>.
|
||||
</para>
|
||||
|
||||
<simplesect>
|
||||
<section>
|
||||
<title>Installing on *NIX</title>
|
||||
<subtitle>Unix, Linux, OS X, Cygwin</subtitle>
|
||||
|
||||
<para>
|
||||
Run:
|
||||
|
|
@ -31,32 +32,9 @@ extension=mongo.so
|
|||
]]>
|
||||
</programlisting>
|
||||
</para>
|
||||
</simplesect>
|
||||
</section>
|
||||
|
||||
<simplesect>
|
||||
<title>Installing on Windows</title>
|
||||
|
||||
<para>
|
||||
VC8 and VC9 precompiled binaries are available for thread safe and
|
||||
non-thread-safe PHP 5.3 on
|
||||
<link xlink:href="http://github.com/mongodb/mongo-php-driver/downloads">Github</link>.
|
||||
VC6 precompiled binaries are available for thread safe and non-thread-safe
|
||||
PHP 5.2 and 5.3 from <link xlink:href="http://downloads.php.net/pierre/">php.net</link>.
|
||||
Unzip the archive and put php_mongo.dll in your PHP extension directory
|
||||
("ext" by default).
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Add the following line to your php.ini file:
|
||||
<programlisting>
|
||||
<![CDATA[
|
||||
extension=php_mongo.dll
|
||||
]]>
|
||||
</programlisting>
|
||||
</para>
|
||||
</simplesect>
|
||||
|
||||
<simplesect>
|
||||
<section>
|
||||
<title>Manual Installation</title>
|
||||
|
||||
<para>For driver developers and people interested in the latest bugfixes, you
|
||||
|
|
@ -103,7 +81,7 @@ $ sudo make install
|
|||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
2. To load the extension on PHP startup, add a line: Github
|
||||
2. To load the extension on PHP startup, add a line:
|
||||
|
||||
<programlisting>
|
||||
<![CDATA[
|
||||
|
|
@ -114,46 +92,112 @@ $ sudo make install
|
|||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</simplesect>
|
||||
|
||||
<simplesect>
|
||||
<title>OS X</title>
|
||||
<section>
|
||||
<title>OS X</title>
|
||||
|
||||
<para>
|
||||
If your system is unable to find autoconf, you'll need to install Xcode
|
||||
(available on your installation DVD).
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Precompiled binaries are available from
|
||||
<link xlink:href="http://www.github.com/mongodb/mongo-php-driver/downloads">Github</link>
|
||||
(download the latest one with "osx" in the name that matches your version of
|
||||
PHP). These for use with MAMP and XAMPP, which come without the headers
|
||||
necessary to compile the extension from scratch. Extract mongo.so from the
|
||||
archive and add it to MAMP or XAMPP's extension directory. Add
|
||||
<programlisting>
|
||||
<para>
|
||||
If your system is unable to find autoconf, you'll need to install Xcode
|
||||
(available on your installation DVD).
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Precompiled binaries are available from
|
||||
<link xlink:href="http://www.github.com/mongodb/mongo-php-driver/downloads">Github</link>
|
||||
(download the latest one with "osx" in the name that matches your version of
|
||||
PHP). These for use with MAMP and XAMPP, which come without the headers
|
||||
necessary to compile the extension from scratch. Extract mongo.so from the
|
||||
archive and add it to MAMP or XAMPP's extension directory. Add
|
||||
<programlisting>
|
||||
<![CDATA[
|
||||
extension=mongo.so
|
||||
]]>
|
||||
</programlisting>
|
||||
to the php.ini file being used and restart the server.
|
||||
</para>
|
||||
</simplesect>
|
||||
</programlisting>
|
||||
to the php.ini file being used and restart the server.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<simplesect>
|
||||
<title>Gentoo</title>
|
||||
<para>On Gentoo using PECL you might get an error that libtool is the wrong
|
||||
version. Compiling from source you'll need to run aclocal and autoconf.
|
||||
|
||||
<programlisting>
|
||||
<section>
|
||||
<title>Gentoo</title>
|
||||
<para>On Gentoo using PECL you might get an error that libtool is the wrong
|
||||
version. Compiling from source you'll need to run aclocal and autoconf.
|
||||
|
||||
<programlisting>
|
||||
<![CDATA[
|
||||
$ phpize && aclocal && autoconf && ./configure && make && make install
|
||||
]]>
|
||||
</programlisting>
|
||||
</programlisting>
|
||||
|
||||
(Thanks to <link xlink:href="http://twitter.com/riklaunim/status/5015388622">@riklaunim</link>)
|
||||
(Thanks to <link xlink:href="http://twitter.com/riklaunim/status/5015388622">@riklaunim</link>)
|
||||
</para>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
<section>
|
||||
<title>Installing on Windows</title>
|
||||
|
||||
<para>
|
||||
VC8 and VC9 precompiled binaries are available for thread safe and
|
||||
non-thread-safe PHP 5.3 on
|
||||
<link xlink:href="http://github.com/mongodb/mongo-php-driver/downloads">Github</link>.
|
||||
VC6 precompiled binaries are available for thread safe and non-thread-safe
|
||||
PHP 5.2 and 5.3 from <link xlink:href="http://downloads.php.net/pierre/">php.net</link>.
|
||||
Unzip the archive and put php_mongo.dll in your PHP extension directory
|
||||
("ext" by default).
|
||||
</para>
|
||||
</simplesect>
|
||||
|
||||
<para>
|
||||
The latest (non-release) code is compiled into Windows binaries on every
|
||||
commit. The zip consists of a .zip with php_mongo.dll and a version.txt.
|
||||
Please keep the version.txt around so that if you have a question or problem,
|
||||
you can give the developers the exact version you're using. (The number is
|
||||
long and nonsensical, but it will make sense to the developers!)
|
||||
</para>
|
||||
<para>
|
||||
To get the latest bug fixes (and possibly bugs), download the binary
|
||||
corresponding to the PHP you have installed:
|
||||
</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
<link xlink:href="http://downloads.mongodb.org/mongo-latest-php5.3vc8.zip">
|
||||
PHP 5.3 VC8 Non-Thread-Safe Mongo extension
|
||||
</link>
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<link xlink:href="http://downloads.mongodb.org/mongo-latest-php5.3vc8ts.zip">
|
||||
PHP 5.3 VC8 Thread-Safe Mongo extension
|
||||
</link>
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<link xlink:href="http://downloads.mongodb.org/mongo-latest-php5.3vc9.zip">
|
||||
PHP 5.3 VC9 Non-Thread-Safe Mongo extension
|
||||
</link>
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<link xlink:href="http://downloads.mongodb.org/mongo-latest-php5.3vc9ts.zip">
|
||||
PHP 5.3 VC9 Thread-Safe Mongo extension
|
||||
</link>
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
|
||||
<para>
|
||||
Add the following line to your php.ini file:
|
||||
<programlisting>
|
||||
<![CDATA[
|
||||
extension=php_mongo.dll
|
||||
]]>
|
||||
</programlisting>
|
||||
</para>
|
||||
</section>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -4,6 +4,8 @@
|
|||
<chapter xml:id="mongo.manual" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<title>Manual</title>
|
||||
|
||||
&reference.mongo.configure;
|
||||
&reference.mongo.ini;
|
||||
&reference.mongo.tutorial;
|
||||
&reference.mongo.examples;
|
||||
&reference.mongo.datatypes;
|
||||
|
|
|
|||
|
|
@ -1,48 +0,0 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
|
||||
<chapter xml:id="mongo.setup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
&reftitle.setup;
|
||||
|
||||
<section xml:id="mongo.requirements">
|
||||
&reftitle.required;
|
||||
<para>
|
||||
Requires PHP 5.1 or greater.
|
||||
</para>
|
||||
<para>
|
||||
Requires a MongoDB database server, which can download MongoDB from
|
||||
<link xlink:href="&url.mongodb;">&url.mongodb;</link>.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<!-- {{{ Installation -->
|
||||
&reference.mongo.configure;
|
||||
<!-- }}} -->
|
||||
|
||||
<!-- {{{ Configuration -->
|
||||
&reference.mongo.ini;
|
||||
<!-- }}} -->
|
||||
|
||||
</chapter>
|
||||
|
||||
<!-- 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
|
||||
-->
|
||||
|
||||
Loading…
Reference in a new issue