<?xml version="1.0"?><phpdoc><class name="DB" extends="" undoc="false" access="private"><file>c:/www/apache/doc2//pear/DB.php</file><doc><author email="ssb@fast.no">Stig Bakken</author><description>methods for creating DB objects as well as some utility functionscommon to all parts of DB.The object model of DB is as follows (indentation means inheritance):DB           The main DB class.  This is simply a utility classwith some &amp;quot;static&amp;quot; methods for creating DB objects aswell as common utility functions for other DB classes.DB_common    The base for each DB implementation.  Provides default|            implementations (in OO lingo virtual methods) for|            the actual DB implementations as well as a bunch of|            query utility functions.|+-DB_mysql   The DB implementation for MySQL.  Inherits DB_common.When calling DB::factory or DB::connect for MySQLconnections, the object returned is an instance of thisclass.</description><shortdescription>The main &amp;quot;DB&amp;quot; class is simply a container class with some static</shortdescription><version>2</version><since>PHP 4.0</since></doc><function name="&amp;factory" undoc="false" access="private"><doc><parameter name="$type" type="string">type, for example &amp;quot;mysql&amp;quot;</parameter><return name="" type="object a">newly created DB object, or a DB error code on&#x0a;error</return><description/><shortdescription>Create a new DB object for the specified database type</shortdescription></doc></function><function name="&amp;connect" undoc="false" access="private"><doc><parameter name="$dsn" type="string">&amp;quot;data source name&amp;quot;, see the DB::parseDSN&#x0a;method for a description of the dsn format.</parameter><parameter name="$persistent" default="false" type="boolean">this connection should be&#x0a;persistent.  Ignored if the backend extension does not support&#x0a;persistent connections.</parameter><return name="" type="object a">newly created DB object, or a DB error code on&#x0a;error</return><description/><shortdescription>Create a new DB object and connect to the specified database</shortdescription></doc></function><function name="apiVersion" undoc="false" access="private"><doc><return name="" type="int">the DB API version number</return><description/><shortdescription>Return the DB API version</shortdescription></doc></function><function name="isError" undoc="false" access="private"><doc><parameter name="$value" type="int">code</parameter><return name="$value" type="bool">whether is an error</return><description/><shortdescription>Tell whether a result code from a DB method is an error</shortdescription></doc></function><function name="isWarning" undoc="false" access="private"><doc><parameter name="$value" type="mixed">value</parameter><return name="$value" type="bool">whether is a warning</return><description>Warnings differ from errors in that they are generated by DB,and are not fatal.</description><shortdescription>Tell whether a result code from a DB method is a warning.</shortdescription></doc></function><function name="errorMessage" undoc="false" access="private"><doc><parameter name="$value" type="int">code</parameter><return name="" type="string">error message, or false if the error code was&#x0a;not recognized</return><description/><shortdescription>Return a textual error message for a DB error code</shortdescription></doc></function><function name="parseDSN" undoc="false" access="private"><doc><parameter name="$dsn" type="string">Source Name to be parsed</parameter><return name="" type="array">an associative array with the following keys:&#x0a;&amp;lt;dl&amp;gt;&#x0a;&amp;lt;dt&amp;gt;phptype&amp;lt;/dt&amp;gt;&#x0a;&amp;lt;dd&amp;gt;Database backend used in PHP (mysql, odbc etc.)&amp;lt;/dd&amp;gt;&#x0a;&amp;lt;dt&amp;gt;dbsyntax&amp;lt;/dt&amp;gt;&#x0a;&amp;lt;dd&amp;gt;Database used with regards to SQL syntax etc.&amp;lt;/dd&amp;gt;&#x0a;&amp;lt;dt&amp;gt;protocol&amp;lt;/dt&amp;gt;&#x0a;&amp;lt;dd&amp;gt;Communication protocol to use (tcp, unix etc.)&amp;lt;/dd&amp;gt;&#x0a;&amp;lt;dt&amp;gt;hostspec&amp;lt;/dt&amp;gt;&#x0a;&amp;lt;dd&amp;gt;Host specification (hostname[:port])&amp;lt;/dd&amp;gt;&#x0a;&amp;lt;dt&amp;gt;database&amp;lt;/dt&amp;gt;&#x0a;&amp;lt;dd&amp;gt;Database to use on the DBMS server&amp;lt;/dd&amp;gt;&#x0a;&amp;lt;dt&amp;gt;username&amp;lt;/dt&amp;gt;&#x0a;&amp;lt;dd&amp;gt;User name for login&amp;lt;/dd&amp;gt;&#x0a;&amp;lt;dt&amp;gt;password&amp;lt;/dt&amp;gt;&#x0a;&amp;lt;dd&amp;gt;Password for login&amp;lt;/dd&amp;gt;&#x0a;&amp;lt;/dl&amp;gt;&#x0a;&amp;lt;/p&amp;gt;&#x0a;&#x0a;&amp;lt;p&amp;gt;&#x0a;The format of the supplied DSN is in its fullest form:&#x0a;&amp;lt;ul&amp;gt;&#x0a;&amp;lt;li&amp;gt;phptype(dbsyntax)://username:password@protocol+hostspec/database&amp;lt;/li&amp;gt;&#x0a;&amp;lt;/ul&amp;gt;&#x0a;Most variations are allowed:&#x0a;&amp;lt;ul&amp;gt;&#x0a;&amp;lt;li&amp;gt;phptype://username:password@protocol+hostspec/database&amp;lt;/li&amp;gt;&#x0a;&amp;lt;li&amp;gt;phptype://username:password@hostspec/database&amp;lt;/li&amp;gt;&#x0a;&amp;lt;li&amp;gt;phptype://username:password@hostspec&amp;lt;/li&amp;gt;&#x0a;&amp;lt;li&amp;gt;phptype://hostspec/database&amp;lt;/li&amp;gt;&#x0a;&amp;lt;li&amp;gt;phptype://hostspec&amp;lt;/li&amp;gt;&#x0a;&amp;lt;li&amp;gt;phptype(dbsyntax)&amp;lt;/li&amp;gt;&#x0a;&amp;lt;li&amp;gt;phptype&amp;lt;/li&amp;gt;&#x0a;&amp;lt;/ul&amp;gt;&#x0a;&amp;lt;/p&amp;gt;</return><description/><shortdescription>Parse a data source name</shortdescription></doc></function><function name="DB_result" undoc="false" access="private"><doc><parameter name="&amp;$dbh" type="object reference"/><parameter name="$result" undoc="true"/><return type="void"/><description/><shortdescription>DB_result constructor.</shortdescription></doc></function><function name="fetchRow" undoc="false" access="private"><doc><parameter name="$fetchmode" type="string" undoc="true"/><return name="" type="array">a row of data, or false on error</return><description/><shortdescription>Fetch and return a row of data.</shortdescription></doc></function><function name="fetchInto" undoc="false" access="private"><doc><parameter name="&amp;$arr" type="array"/><parameter name="$fetchmode" type="string" undoc="true"/><return name="" type="int">error code</return><description/><shortdescription>Fetch a row of data into an existing array.</shortdescription></doc></function><function name="numCols" undoc="false" access="private"><doc><return name="" type="int">the number of columns, or a DB error code</return><description/><shortdescription>Get the the number of columns in a result set.</shortdescription></doc></function><function name="free" undoc="false" access="private"><doc><return name="" type="int">error code</return><description/><shortdescription>Frees the resources allocated for this result set.</shortdescription></doc></function><function name="DB_Error" undoc="false" access="public"><doc><parameter name="$code" default="DB_ERROR," type="mixed">error code, or string with error message.</parameter><parameter name="$mode" default="PEAR_ERROR_RETURN," type="string">&amp;quot;error mode&amp;quot; to operate in</parameter><parameter name="$level" type="string" undoc="true"/><parameter name="$debuginfo" type="string" undoc="true"/><return type="void"/><description/><shortdescription>DB_Error constructor.</shortdescription></doc></function><function name="DB_Warning" undoc="false" access="public"><doc><parameter name="$code" default="DB_WARNING," type="mixed">error code, or string with error message.</parameter><parameter name="$mode" default="PEAR_ERROR_RETURN," type="string">&amp;quot;error mode&amp;quot; to operate in</parameter><parameter name="$level" type="string" undoc="true"/><parameter name="$debuginfo" type="string" undoc="true"/><return type="void"/><description/><shortdescription>DB_Warning constructor.</shortdescription></doc></function><variable name="$dbh" access="private" type="unknown"><doc></doc></variable><variable name="$result" access="private" type="unknown"><doc></doc></variable><uses type="include_once" file="DB/${type}.php" undoc="true"><doc></doc></uses><constant name="DB_FETCHMODE_DEFAULT" undoc="false" access="private" case="default: case sensitive">0<doc><description>any particular get mode, so the default should be used.</description><shortdescription>This is a special constant that tells DB the user hasn&amp;apos;t specified</shortdescription></doc></constant><constant name="DB_FETCHMODE_ORDERED" undoc="false" access="private" case="default: case sensitive">1<doc><description/><shortdescription>Column data indexed by numbers, ordered from 0 and up</shortdescription></doc></constant><constant name="DB_FETCHMODE_ASSOC" undoc="false" access="private" case="default: case sensitive">2<doc><description/><shortdescription>Column data indexed by column names</shortdescription></doc></constant><constant name="DB_FETCHMODE_FLIPPED" undoc="false" access="private" case="default: case sensitive">4<doc><description>is the row number, and the second level indexed by column number or name.DB_FETCHMODE_FLIPPED switches this order, so the first level of arraysis the column name, and the second level the row number.</description><shortdescription>For multi-dimensional results: normally the first level of arrays</shortdescription></doc></constant><constant name="DB_OK" undoc="true" access="private" case="default: case sensitive">0<doc></doc></constant><constant name="DB_ERROR" undoc="true" access="private" case="default: case sensitive">-1<doc></doc></constant><constant name="DB_ERROR_SYNTAX" undoc="true" access="private" case="default: case sensitive">-2<doc></doc></constant><constant name="DB_ERROR_CONSTRAINT" undoc="true" access="private" case="default: case sensitive">-3<doc></doc></constant><constant name="DB_ERROR_NOT_FOUND" undoc="true" access="private" case="default: case sensitive">-4<doc></doc></constant><constant name="DB_ERROR_ALREADY_EXISTS" undoc="true" access="private" case="default: case sensitive">-5<doc></doc></constant><constant name="DB_ERROR_UNSUPPORTED" undoc="true" access="private" case="default: case sensitive">-6<doc></doc></constant><constant name="DB_ERROR_MISMATCH" undoc="true" access="private" case="default: case sensitive">-7<doc></doc></constant><constant name="DB_ERROR_INVALID" undoc="true" access="private" case="default: case sensitive">-8<doc></doc></constant><constant name="DB_ERROR_NOT_CAPABLE" undoc="true" access="private" case="default: case sensitive">-9<doc></doc></constant><constant name="DB_ERROR_TRUNCATED" undoc="true" access="private" case="default: case sensitive">-10<doc></doc></constant><constant name="DB_ERROR_INVALID_NUMBER" undoc="true" access="private" case="default: case sensitive">-11<doc></doc></constant><constant name="DB_ERROR_INVALID_DATE" undoc="true" access="private" case="default: case sensitive">-12<doc></doc></constant><constant name="DB_ERROR_DIVZERO" undoc="true" access="private" case="default: case sensitive">-13<doc></doc></constant><constant name="DB_ERROR_NODBSELECTED" undoc="true" access="private" case="default: case sensitive">-14<doc></doc></constant><constant name="DB_ERROR_CANNOT_CREATE" undoc="true" access="private" case="default: case sensitive">-15<doc></doc></constant><constant name="DB_ERROR_CANNOT_DELETE" undoc="true" access="private" case="default: case sensitive">-16<doc></doc></constant><constant name="DB_ERROR_CANNOT_DROP" undoc="true" access="private" case="default: case sensitive">-17<doc></doc></constant><constant name="DB_ERROR_NOSUCHTABLE" undoc="true" access="private" case="default: case sensitive">-18<doc></doc></constant><constant name="DB_ERROR_NOSUCHFIELD" undoc="true" access="private" case="default: case sensitive">-19<doc></doc></constant><constant name="DB_ERROR_NEED_MORE_DATA" undoc="true" access="private" case="default: case sensitive">-20<doc></doc></constant><constant name="DB_ERROR_NOT_LOCKED" undoc="true" access="private" case="default: case sensitive">-21<doc></doc></constant><constant name="DB_ERROR_VALUE_COUNT_ON_ROW" undoc="true" access="private" case="default: case sensitive">-22<doc></doc></constant><constant name="DB_WARNING" undoc="true" access="private" case="default: case sensitive">-1000<doc></doc></constant><constant name="DB_WARNING_READ_ONLY" undoc="true" access="private" case="default: case sensitive">-1001<doc></doc></constant><constant name="DB_PARAM_SCALAR" undoc="true" access="private" case="default: case sensitive">1<doc></doc></constant><constant name="DB_PARAM_OPAQUE" undoc="true" access="private" case="default: case sensitive">2<doc></doc></constant><constant name="DB_BINMODE_PASSTHRU" undoc="true" access="private" case="default: case sensitive">1<doc></doc></constant><constant name="DB_BINMODE_RETURN" undoc="true" access="private" case="default: case sensitive">2<doc></doc></constant><constant name="DB_BINMODE_CONVERT" undoc="true" access="private" case="default: case sensitive">3<doc></doc></constant><constant name="DB_GETMODE_ORDERED" undoc="true" access="private" case="default: case sensitive">DB_FETCHMODE_ORDERED<doc></doc></constant><constant name="DB_GETMODE_ASSOC" undoc="true" access="private" case="default: case sensitive">DB_FETCHMODE_ASSOC<doc></doc></constant><constant name="DB_GETMODE_FLIPPED" undoc="true" access="private" case="default: case sensitive">DB_FETCHMODE_FLIPPED<doc></doc></constant></class></phpdoc>
