1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
|
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="PDO" namespace="" name="PDO">
<constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact=" Creates a PDO instance representing a connection to a database "/>
<return type="void"/>
</docblock>
<parameter name="dsn" optional="false" byreference="false" type="string"/>
<parameter name="username" optional="true" byreference="false" type="string"/>
<parameter name="passwd" optional="true" byreference="false" type="string"/>
<parameter name="options" optional="true" byreference="false" type="object" class="array"/>
</constructor>
<method name="beginTransaction" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact=" Initiates a transaction ">Turns off autocommit mode. While autocommit mode is turned off, changes made to the database via the PDO object instance are not committed until you end the transaction by calling PDO::commit. Calling PDO::rollBack will roll back all changes to the database and return the connection to autocommit mode.</description>
<return type="bool"/>
</docblock>
</method>
<method name="commit" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact=" Commits a transaction "/>
<return type="bool"/>
</docblock>
</method>
<method name="errorCode" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact=" Fetch the SQLSTATE associated with the last operation on the database handle "/>
<return type="string"/>
</docblock>
</method>
<method name="errorInfo" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact=" Fetch extended error information associated with the last operation on the database handle "/>
<return type="array"/>
</docblock>
</method>
<method name="exec" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact=" Execute an SQL statement and return the number of affected rows ">PDO::exec executes an SQL statement in a single function call, returning the number of rows affected by the statement.</description>
<return type="int"/>
</docblock>
<parameter name="statement" optional="false" byreference="false" type="string"/>
</method>
<method name="getAttribute" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact=" Retrieve a database connection attribute ">This function returns the value of a database connection attribute. To retrieve PDOStatement attributes, refer to PDOStatement::getAttribute.</description>
<return type="mixed"/>
</docblock>
<parameter name="attribute" optional="false" byreference="false" type="int"/>
</method>
<method name="getAvailableDrivers" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact=" Return an array of available PDO drivers "/>
<return type="array"/>
</docblock>
</method>
<method name="inTransaction" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact=" Checks if inside a transaction "/>
<return type="bool"/>
</docblock>
</method>
<method name="lastInsertId" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact=" Returns the ID of the last inserted row or sequence value ">Returns the ID of the last inserted row, or the last value from a sequence object, depending on the underlying driver. For example, PDO_PGSQL requires you to specify the name of a sequence object for the name parameter.</description>
<return type="string"/>
</docblock>
<parameter name="name" optional="true" byreference="false" type="string"/>
</method>
<method name="prepare" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact=" Prepares a statement for execution and returns a statement object ">Prepares an SQL statement to be executed by the PDOStatement::execute method. The statement template can contain zero or more named (:name) or question mark (?) parameter markers for which real values will be substituted when the statement is executed. Both named and question mark parameter markers cannot be used within the same statement template; only one or the other parameter style. Use these parameters to bind any user-input, do not include the user-input directly in the query.</description>
<return type="PDOStatement"/>
</docblock>
<parameter name="statement" optional="false" byreference="false" type="string"/>
<parameter name="driver_options" optional="true" byreference="false" type="object" class="array"/>
</method>
<method name="query" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact=" Executes an SQL statement, returning a result set as a PDOStatement object ">PDO::query executes an SQL statement in a single function call, returning the result set (if any) returned by the statement as a PDOStatement object.</description>
<return type="PDOStatement"/>
</docblock>
<parameter name="statement" optional="false" byreference="false" type="string"/>
</method>
<method name="quote" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact=" Quotes a string for use in a query ">PDO::quote places quotes around the input string (if required) and escapes special characters within the input string, using a quoting style appropriate to the underlying driver.</description>
<return type="string"/>
</docblock>
<parameter name="string" optional="false" byreference="false" type="string"/>
<parameter name="parameter_type" optional="true" byreference="false" type="int"/>
</method>
<method name="rollBack" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact=" Rolls back a transaction ">Rolls back the current transaction, as initiated by PDO::beginTransaction.</description>
<return type="bool"/>
</docblock>
</method>
<method name="setAttribute" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact=" Set an attribute ">Sets an attribute on the database handle. Some of the available generic attributes are listed below; some drivers may make use of additional driver specific attributes. PDO::ATTR_CASE: Force column names to a specific case. PDO::CASE_LOWER: Force column names to lower case. PDO::CASE_NATURAL: Leave column names as returned by the database driver. PDO::CASE_UPPER: Force column names to upper case. PDO::ATTR_ERRMODE: Error reporting. PDO::ERRMODE_SILENT: Just set error codes. PDO::ERRMODE_WARNING: Raise E_WARNING. PDO::ERRMODE_EXCEPTION: Throw exceptions. PDO::ATTR_ORACLE_NULLS (available with all drivers, not just Oracle): Conversion of NULL and empty strings. PDO::NULL_NATURAL: No conversion. PDO::NULL_EMPTY_STRING: Empty string is converted to NULL. PDO::NULL_TO_STRING: NULL is converted to an empty string. PDO::ATTR_STRINGIFY_FETCHES: Convert numeric values to strings when fetching. Requires bool. PDO::ATTR_STATEMENT_CLASS: Set user-supplied statement class derived from PDOStatement. Cannot be used with persistent PDO instances. Requires array(string classname, array(mixed constructor_args)). PDO::ATTR_TIMEOUT: Specifies the timeout duration in seconds. Not all drivers support this option, and its meaning may differ from driver to driver. For example, sqlite will wait for up to this time value before giving up on obtaining an writable lock, but other drivers may interpret this as a connect or a read timeout interval. Requires int. PDO::ATTR_AUTOCOMMIT (available in OCI, Firebird and MySQL): Whether to autocommit every single statement. PDO::ATTR_EMULATE_PREPARES Enables or disables emulation of prepared statements. Some drivers do not support native prepared statements or have limited support for them. Use this setting to force PDO to either always emulate prepared statements (if TRUE and emulated prepares are supported by the driver), or to try to use native prepared statements (if FALSE). It will always fall back to emulating the prepared statement if the driver cannot successfully prepare the current query. Requires bool. PDO::MYSQL_ATTR_USE_BUFFERED_QUERY (available in MySQL): Use buffered queries. PDO::ATTR_DEFAULT_FETCH_MODE: Set default fetch mode. Description of modes is available in PDOStatement::fetch documentation.</description>
<return type="bool"/>
</docblock>
<parameter name="attribute" optional="false" byreference="false" type="int"/>
<parameter name="value" optional="false" byreference="false" type="object" class="mixed"/>
</method>
</class>
|
