cvs: phpdoc /en/reference/sqlite3/sqlite3 construct.xml open.xml
| From: | Ben Ramsey | Date: | Thu, 03 Jul 2008 18:21:08 +0000 |
| Subject: | cvs: phpdoc /en/reference/sqlite3/sqlite3 construct.xml open.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-1828@lists.php.net to get a copy of this message | ||
ramsey Thu Jul 3 18:21:08 2008 UTC
Modified files:
/phpdoc/en/reference/sqlite3/sqlite3 construct.xml open.xml
Log:
Updated SQLite3::__construct() and SQLite3::open() with optional parameters and listed valid flags
for the flags parameter; also corrected a misspelling.
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sqlite3/sqlite3/construct.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/sqlite3/sqlite3/construct.xml
diff -u phpdoc/en/reference/sqlite3/sqlite3/construct.xml:1.2
phpdoc/en/reference/sqlite3/sqlite3/construct.xml:1.3
--- phpdoc/en/reference/sqlite3/sqlite3/construct.xml:1.2 Thu Jul 3 16:31:57 2008
+++ phpdoc/en/reference/sqlite3/sqlite3/construct.xml Thu Jul 3 18:21:08 2008
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry xml:id="sqlite3.construct" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
@@ -14,8 +14,8 @@
<methodsynopsis>
<methodname>SQLite3::__construct</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
-
<methodparam><type>int</type><parameter>flags</parameter></methodparam>
-
<methodparam><type>string</type><parameter>encryption_key</parameter></methodparam>
+ <methodparam
choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
+ <methodparam
choice="opt"><type>string</type><parameter>encryption_key</parameter></methodparam>
</methodsynopsis>
<para>
Instantiates an SQLite3 object and opens a connection to an
@@ -41,7 +41,27 @@
<listitem>
<para>
Optional flags used to determine how to open the SQLite database. By
- default, open uses SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE.
+ default, open uses <literal>SQLITE3_OPEN_READWRITE |
SQLITE3_OPEN_CREATE</literal>.
+ <itemizedlist>
+ <listitem>
+ <para>
+ <literal>SQLITE3_OPEN_READONLY</literal>: Open the database for
+ reading only.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>SQLITE3_OPEN_READWRITE</literal>: Open the database for
+ reading and writing.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>SQLITE3_OPEN_CREATE</literal>: Create the database if it
+ does not exist.
+ </para>
+ </listitem>
+ </itemizedlist>
</para>
</listitem>
</varlistentry>
@@ -49,7 +69,7 @@
<term><parameter>encryption_key</parameter></term>
<listitem>
<para>
- An optional encryption key used when encyrpting and decrypting an
+ An optional encryption key used when encrypting and decrypting an
SQLite database.
</para>
</listitem>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sqlite3/sqlite3/open.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/sqlite3/sqlite3/open.xml
diff -u phpdoc/en/reference/sqlite3/sqlite3/open.xml:1.2
phpdoc/en/reference/sqlite3/sqlite3/open.xml:1.3
--- phpdoc/en/reference/sqlite3/sqlite3/open.xml:1.2 Thu Jul 3 16:31:57 2008
+++ phpdoc/en/reference/sqlite3/sqlite3/open.xml Thu Jul 3 18:21:08 2008
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry xml:id="sqlite3.open" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
@@ -12,8 +12,8 @@
<methodsynopsis>
<modifier>public</modifier>
<type>bool</type><methodname>SQLite3::open</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
-
<methodparam><type>int</type><parameter>flags</parameter></methodparam>
-
<methodparam><type>string</type><parameter>encryption_key</parameter></methodparam>
+ <methodparam
choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
+ <methodparam
choice="opt"><type>string</type><parameter>encryption_key</parameter></methodparam>
</methodsynopsis>
<para>
Opens an SQLite 3 Database. If the build includes encryption, then it will
@@ -38,7 +38,27 @@
<listitem>
<para>
Optional flags used to determine how to open the SQLite database. By
- default, open uses SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE.
+ default, open uses <literal>SQLITE3_OPEN_READWRITE |
SQLITE3_OPEN_CREATE</literal>.
+ <itemizedlist>
+ <listitem>
+ <para>
+ <literal>SQLITE3_OPEN_READONLY</literal>: Open the database for
+ reading only.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>SQLITE3_OPEN_READWRITE</literal>: Open the database for
+ reading and writing.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>SQLITE3_OPEN_CREATE</literal>: Create the database if it
+ does not exist.
+ </para>
+ </listitem>
+ </itemizedlist>
</para>
</listitem>
</varlistentry>
@@ -46,7 +66,7 @@
<term><parameter>encryption_key</parameter></term>
<listitem>
<para>
- An optional encryption key used when encyrpting and decrypting an
+ An optional encryption key used when encrypting and decrypting an
SQLite database.
</para>
</listitem>