mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-21 03:18:55 +00:00
8ef6cf9b7c
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@324735 c90b9560-bf6c-de11-be94-00142212c4b1
285 lines
7.4 KiB
XML
285 lines
7.4 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.dbx-connect" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>dbx_connect</refname>
|
|
<refpurpose>Open a connection/database</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>object</type><methodname>dbx_connect</methodname>
|
|
<methodparam><type>mixed</type><parameter>module</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>host</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>database</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>username</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>password</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>persistent</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Opens a connection to a database.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>module</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The <parameter>module</parameter> parameter can be either a string or a
|
|
constant, though the latter form is preferred. The possible values are
|
|
given below, but keep in mind that they only work if the module is
|
|
actually loaded.
|
|
</para>
|
|
<para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>DBX_MYSQL</constant> or <literal>"mysql"</literal>
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>DBX_ODBC</constant> or <literal>"odbc"</literal>
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>DBX_PGSQL</constant> or <literal>"pgsql"</literal>
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>DBX_MSSQL</constant> or <literal>"mssql"</literal>
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>DBX_FBSQL</constant> or <literal>"fbsql"</literal>
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>DBX_SYBASECT</constant> or <literal>"sybase_ct"</literal>
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>DBX_OCI8</constant> or <literal>"oci8"</literal>
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>DBX_SQLITE</constant> or <literal>"sqlite"</literal>
|
|
</simpara>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>host</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The SQL server host
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>database</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The database name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>username</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The username
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>password</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The password
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>persistent</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The <parameter>persistent</parameter> parameter can be set to
|
|
<constant>DBX_PERSISTENT</constant>, if so, a persistent connection
|
|
will be created.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
<para>
|
|
The <parameter>host</parameter>, <parameter>database</parameter>,
|
|
<parameter>username</parameter> and <parameter>password</parameter>
|
|
parameters are expected, but not always used depending on the connect
|
|
functions for the abstracted module.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns an object on success, &false; on error. If a connection has been
|
|
made but the database could not be selected, the connection is closed and
|
|
&false; is returned.
|
|
</para>
|
|
<para>
|
|
The returned <varname>object</varname> has three properties:
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term>
|
|
<property>database</property>
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
It is the name of the currently selected database.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<property>handle</property>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
It is a valid handle for the connected database, and as such it can be
|
|
used in module-specific functions (if required).
|
|
<informalexample>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$link = dbx_connect(DBX_MYSQL, "localhost", "db", "username", "password");
|
|
mysql_close($link->handle); // dbx_close($link) would be better here
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</informalexample>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<property>module</property>
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
It is used internally by dbx only, and is actually the module number
|
|
mentioned above.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="changelog">
|
|
&reftitle.changelog;
|
|
<para>
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>&Version;</entry>
|
|
<entry>&Description;</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>5.0.0</entry>
|
|
<entry>
|
|
Introduced <constant>DBX_SQLITE</constant>.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>4.3.0</entry>
|
|
<entry>
|
|
Introduced <constant>DBX_OCI8</constant>.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>4.2.0</entry>
|
|
<entry>
|
|
Introduced <constant>DBX_SYBASECT</constant>.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>4.1.0</entry>
|
|
<entry>
|
|
Introduced <constant>DBX_FBSQL</constant>.
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>dbx_connect</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$link = dbx_connect(DBX_ODBC, "", "db", "username", "password", DBX_PERSISTENT)
|
|
or die("Could not connect");
|
|
|
|
echo "Connected successfully";
|
|
dbx_close($link);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="notes">
|
|
&reftitle.notes;
|
|
<note>
|
|
<para>
|
|
Always refer to the module-specific documentation as well.
|
|
</para>
|
|
</note>
|
|
</refsect1>
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>dbx_close</function></member>
|
|
</simplelist>
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<!-- 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
|
|
-->
|