File: PDOStatement.xml

package info (click to toggle)
phpdox 0.12.0-6
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, sid
  • size: 7,672 kB
  • sloc: xml: 80,724; php: 9,167; makefile: 13
file content (153 lines) | stat: -rw-r--r-- 10,525 bytes parent folder | download | duplicates (2)
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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="PDOStatement" namespace="" name="PDOStatement">
  <implements name="Traversable" full="Traversable"/>
  <member name="queryString" static="false">
    <default>null</default>
    <docblock>
      <description compact="Used query string."/>
      <var type="string"/>
    </docblock>
  </member>
  <method name="bindColumn" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="&#10;   Bind a column to a PHP variable&#10;  ">PDOStatement::bindColumn arranges to have a particular variable bound to a given column in the result-set from a query. Each call to PDOStatement::fetch or PDOStatement::fetchAll will update all the variables that are bound to columns.</description>
      <return type="bool"/>
    </docblock>
    <parameter name="column" optional="false" byreference="false" type="object" class="mixed"/>
    <parameter name="param" optional="false" byreference="false" type="object" class="mixed"/>
    <parameter name="type" optional="true" byreference="false" type="int"/>
    <parameter name="maxlen" optional="true" byreference="false" type="int"/>
    <parameter name="driverdata" optional="true" byreference="false" type="object" class="mixed"/>
  </method>
  <method name="bindParam" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="&#10;   Binds a parameter to the specified variable name&#10;  ">Binds a PHP variable to a corresponding named or question mark placeholder in the SQL statement that was used to prepare the statement. Unlike PDOStatement::bindValue, the variable is bound as a reference and will only be evaluated at the time that PDOStatement::execute is called.</description>
      <return type="bool"/>
    </docblock>
    <parameter name="parameter" optional="false" byreference="false" type="object" class="mixed"/>
    <parameter name="variable" optional="false" byreference="false" type="object" class="mixed"/>
    <parameter name="data_type" optional="true" byreference="false" type="int"/>
    <parameter name="length" optional="true" byreference="false" type="int"/>
    <parameter name="driver_options" optional="true" byreference="false" type="object" class="mixed"/>
  </method>
  <method name="bindValue" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="&#10;   Binds a value to a parameter&#10;  "/>
      <return type="bool"/>
    </docblock>
    <parameter name="parameter" optional="false" byreference="false" type="object" class="mixed"/>
    <parameter name="value" optional="false" byreference="false" type="object" class="mixed"/>
    <parameter name="data_type" optional="true" byreference="false" type="int"/>
  </method>
  <method name="closeCursor" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="&#10;   Closes the cursor, enabling the statement to be executed again&#10;  ">PDOStatement::closeCursor frees up the connection to the server so that other SQL statements may be issued, but leaves the statement in a state that enables it to be executed again.</description>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="columnCount" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="&#10;   Returns the number of columns in the result set&#10;  ">Use PDOStatement::columnCount to return the number of columns in the result set represented by the PDOStatement object.</description>
      <return type="int"/>
    </docblock>
  </method>
  <method name="debugDumpParams" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="&#10;   Dump an SQL prepared command&#10;  ">Dumps the information contained by a prepared statement directly on the output. It will provide the SQL query in use, the number of parameters used (Params), the list of parameters with their key name or position, their name, their position in the query (if this is supported by the PDO driver, otherwise, it will be -1), type (param_type) as an integer, and a boolean value is_param.</description>
      <return type="void"/>
    </docblock>
  </method>
  <method name="errorCode" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="&#10;   Fetch the SQLSTATE associated with the last operation on the statement handle&#10;  "/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="errorInfo" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="&#10;   Fetch extended error information associated with the last operation on the statement handle&#10;  "/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="execute" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="&#10;   Executes a prepared statement&#10;  ">Execute the prepared statement. If the prepared statement included parameter markers, either: PDOStatement::bindParam and/or PDOStatement::bindValue has to be called to bind either variables or values (respectively) to the parameter markers. Bound variables pass their value as input and receive the output value, if any, of their associated parameter markers or an array of input-only parameter values has to be passed</description>
      <return type="bool"/>
    </docblock>
    <parameter name="input_parameters" optional="true" byreference="false" type="object" class="array"/>
  </method>
  <method name="fetch" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="&#10;   Fetches the next row from a result set&#10;  "/>
      <return type="mixed"/>
    </docblock>
    <parameter name="fetch_style" optional="true" byreference="false" type="int"/>
    <parameter name="cursor_orientation" optional="true" byreference="false" type="int"/>
    <parameter name="cursor_offset" optional="true" byreference="false" type="int"/>
  </method>
  <method name="fetchAll" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="&#10;   Returns an array containing all of the result set rows&#10;  "/>
      <return type="array"/>
    </docblock>
    <parameter name="fetch_style" optional="true" byreference="false" type="int"/>
    <parameter name="fetch_argument" optional="true" byreference="false" type="object" class="mixed"/>
    <parameter name="ctor_args" optional="true" byreference="false" type="object" class="array"/>
  </method>
  <method name="fetchColumn" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="&#10;   Returns a single column from the next row of a result set&#10;  ">Returns a single column from the next row of a result set or FALSE if there are no more rows.</description>
      <return type="mixed"/>
    </docblock>
    <parameter name="column_number" optional="true" byreference="false" type="int"/>
  </method>
  <method name="fetchObject" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Fetches the next row and returns it as an object">Fetches the next row and returns it as an object. This function is an alternative to PDOStatement::fetch with PDO::FETCH_CLASS or PDO::FETCH_OBJ style.</description>
      <return type="mixed"/>
    </docblock>
    <parameter name="class_name" optional="true" byreference="false" type="string"/>
    <parameter name="ctor_args" optional="true" byreference="false" type="object" class="array"/>
  </method>
  <method name="getAttribute" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="&#10;   Retrieve a statement attribute&#10;  ">Gets an attribute of the statement. Currently, no generic attributes exist but only driver specific: PDO::ATTR_CURSOR_NAME (Firebird and ODBC specific): Get the name of cursor for UPDATE ... WHERE CURRENT OF.</description>
      <return type="mixed"/>
    </docblock>
    <parameter name="attribute" optional="false" byreference="false" type="int"/>
  </method>
  <method name="getColumnMeta" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="&#10;   Returns metadata for a column in a result set&#10;  ">Retrieves the metadata for a 0-indexed column in a result set as an associative array.</description>
      <return type="array"/>
    </docblock>
    <parameter name="column" optional="false" byreference="false" type="int"/>
  </method>
  <method name="nextRowset" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="&#10;   Advances to the next rowset in a multi-rowset statement handle&#10;  "/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="rowCount" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="&#10;   Returns the number of rows affected by the last SQL statement&#10;  ">PDOStatement::rowCount returns the number of rows affected by the last DELETE, INSERT, or UPDATE statement executed by the corresponding PDOStatement object.</description>
      <return type="int"/>
    </docblock>
  </method>
  <method name="setAttribute" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="&#10;   Set a statement attribute&#10;  ">Sets an attribute on the statement. Currently, no generic attributes are set but only driver specific: PDO::ATTR_CURSOR_NAME (Firebird and ODBC specific): Set the name of cursor for UPDATE ... WHERE CURRENT OF.</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>
  <method name="setFetchMode" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="&#10;   Set the default fetch mode for this statement&#10;  "/>
      <return type="bool"/>
    </docblock>
    <parameter name="mode" optional="false" byreference="false" type="int"/>
  </method>
</class>