Updated SQLite3::__construct() and SQLite3::open() with optional parameters and listed valid flags for the flags parameter; also corrected a misspelling.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@261988 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Ben Ramsey 2008-07-03 18:21:08 +00:00
parent a09ee572d5
commit e1a0754601
2 changed files with 50 additions and 10 deletions

View file

@ -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>

View file

@ -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>