cvs: peardoc /en/package/database/db intro-connect.xml

From: Date: Fri, 30 Apr 2004 04:32:51 +0000
Subject: cvs: peardoc /en/package/database/db intro-connect.xml
Groups: php.pear.doc 
Request: Send a blank email to pear-doc+get-3793@lists.php.net to get a copy of this message
danielc Fri Apr 30 00:32:51 2004 EDT Modified files: /peardoc/en/package/database/db intro-connect.xml Log: Add mysqli ssl info. http://cvs.php.net/diff.php/peardoc/en/package/database/db/intro-connect.xml?r1=1.22&r2=1.23&ty=u Index: peardoc/en/package/database/db/intro-connect.xml diff -u peardoc/en/package/database/db/intro-connect.xml:1.22 peardoc/en/package/database/db/intro-connect.xml:1.23 --- peardoc/en/package/database/db/intro-connect.xml:1.22 Mon Apr 26 00:39:08 2004 +++ peardoc/en/package/database/db/intro-connect.xml Fri Apr 30 00:32:51 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1" ?> -<!-- $Revision: 1.22 $ --> +<!-- $Revision: 1.23 $ --> <refentry id="package.database.db.intro-connect"> <refnamediv> @@ -30,11 +30,12 @@ 'socket' => false, 'database' => false, ); -]]> + ]]> </programlisting> Any elements you set override the defaults and the remainder stay at their defaults. </para> + <simpara> The second parameter is the optional <parameter>$options</parameter> array that can contain runtime configuration settings for this package. @@ -42,18 +43,21 @@ <function>setOption</function></link> for more information on the available settings. </simpara> + <simpara> In case of success you get a new instance of the database class. It is strongly recommened to check this return value with <link linkend="package.database.db.db.iserror"> <function>isError</function></link>. </simpara> + <simpara> To disconnect use the method <link linkend="package.database.db.db-common.disconnect"> <function>disconnect</function></link> from your database class instance. </simpara> + <example> <title>Connect and disconnect</title> <programlisting role="php"> @@ -109,7 +113,51 @@ </programlisting> </example> + <example> + <title> + Connect to MySQLi via SSL + using an array for the DSN information + </title> + <para> + The <varname>ssl</varname> element of the + <parameter>$options</parameter> array must be set to + &true; in order for SSL to work. Each of the extra + elements in the <parameter>$dsn</parameter> array + (<varname>key</varname> through <varname>cipher</varname> + in the example below) are optional. + </para> + <programlisting role="php"> + <![CDATA[ +<?php +require_once 'DB.php'; + +$dsn = array( + 'phptype' => 'mysqli', + 'username' => 'someuser', + 'password' => 'apasswd', + 'hostspec' => 'localhost', + 'database' => 'thedb', + 'key', => 'client-key.pem', + 'cert' => 'client-cert.pem', + 'ca' => 'cacert.pem', + 'capath' => '/path/to/ca/dir', + 'cipher' => 'AES', +); + +$options = array( + 'ssl' => true, +); + +$db =& DB::connect($dsn, $options); +if (DB::isError($db)) { + die($db->getMessage()); +} +?> + ]]> + </programlisting> + </example> </refsect1> + <refsect1 id="package.database.db.db-common.intro-connect.see"> &title.see; <para> @@ -141,4 +189,3 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> -

« previous php.pear.doc (#3793) next »