File: SQLite3.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-- 7,991 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="SQLite3" namespace="" name="SQLite3">
  <method name="busyTimeout" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets the busy connection handler"/>
      <return type="bool"/>
    </docblock>
    <parameter name="msecs" optional="false" byreference="false" type="int"/>
  </method>
  <method name="changes" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="&#10;   Returns the number of database rows that were changed (or inserted or&#10;   deleted) by the most recent SQL statement&#10;  "/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="close" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Closes the database connection"/>
      <return type="bool"/>
    </docblock>
  </method>
  <constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="&#10;   Instantiates an SQLite3 object and opens an SQLite 3 database&#10;  "/>
      <return type="void"/>
    </docblock>
    <parameter name="filename" optional="false" byreference="false" type="string"/>
    <parameter name="flags" optional="true" byreference="false" type="int"/>
    <parameter name="encryption_key" optional="true" byreference="false" type="string"/>
  </constructor>
  <method name="createAggregate" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Registers a PHP function for use as an SQL aggregate function"/>
      <return type="bool"/>
    </docblock>
    <parameter name="name" optional="false" byreference="false" type="string"/>
    <parameter name="step_callback" optional="false" byreference="false" type="object" class="mixed"/>
    <parameter name="final_callback" optional="false" byreference="false" type="object" class="mixed"/>
    <parameter name="argument_count" optional="true" byreference="false" type="int"/>
  </method>
  <method name="createCollation" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Registers a PHP function for use as an SQL collating function"/>
      <return type="bool"/>
    </docblock>
    <parameter name="name" optional="false" byreference="false" type="string"/>
    <parameter name="callback" optional="false" byreference="false" type="object" class="callable"/>
  </method>
  <method name="createFunction" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Registers a PHP function for use as an SQL scalar function"/>
      <return type="bool"/>
    </docblock>
    <parameter name="name" optional="false" byreference="false" type="string"/>
    <parameter name="callback" optional="false" byreference="false" type="object" class="mixed"/>
    <parameter name="argument_count" optional="true" byreference="false" type="int"/>
    <parameter name="flags" optional="true" byreference="false" type="int"/>
  </method>
  <method name="enableExceptions" abstract="false" static="false" final="false">
    <docblock>
      <description compact="&#10;   Enable throwing exceptions&#10;  "/>
      <return type="bool"/>
    </docblock>
    <parameter name="enableExceptions" optional="true" byreference="false" type="object" class="bool"/>
  </method>
  <method name="escapeString" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns a string that has been properly escaped">Returns a string that has been properly escaped for safe inclusion in an SQL statement.</description>
      <return type="string"/>
    </docblock>
    <parameter name="value" optional="false" byreference="false" type="string"/>
  </method>
  <method name="exec" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Executes a result-less query against a given database"/>
      <return type="bool"/>
    </docblock>
    <parameter name="query" optional="false" byreference="false" type="string"/>
  </method>
  <method name="lastErrorCode" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="&#10;   Returns the numeric result code of the most recent failed SQLite request&#10;  "/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="lastErrorMsg" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="&#10;   Returns English text describing the most recent failed SQLite request&#10;  "/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="lastInsertRowID" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the row ID of the most recent INSERT into the database"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="loadExtension" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Attempts to load an SQLite extension library"/>
      <return type="bool"/>
    </docblock>
    <parameter name="shared_library" optional="false" byreference="false" type="string"/>
  </method>
  <method name="open" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Opens an SQLite database"/>
      <return type="void"/>
    </docblock>
    <parameter name="filename" optional="false" byreference="false" type="string"/>
    <parameter name="flags" optional="true" byreference="false" type="int"/>
    <parameter name="encryption_key" optional="true" byreference="false" type="string"/>
  </method>
  <method name="openBlob" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Opens a stream resource to read a BLOB">Opens a stream resource to read or write a BLOB, which would be selected by:</description>
      <return type="resource"/>
    </docblock>
    <parameter name="table" optional="false" byreference="false" type="string"/>
    <parameter name="column" optional="false" byreference="false" type="string"/>
    <parameter name="rowid" optional="false" byreference="false" type="int"/>
    <parameter name="dbname" optional="true" byreference="false" type="string"/>
    <parameter name="flags" optional="true" byreference="false" type="int"/>
  </method>
  <method name="prepare" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Prepares an SQL statement for execution"/>
      <return type="SQLite3Stmt"/>
    </docblock>
    <parameter name="query" optional="false" byreference="false" type="string"/>
  </method>
  <method name="query" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Executes an SQL query"/>
      <return type="SQLite3Result"/>
    </docblock>
    <parameter name="query" optional="false" byreference="false" type="string"/>
  </method>
  <method name="querySingle" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Executes a query and returns a single result"/>
      <return type="mixed"/>
    </docblock>
    <parameter name="query" optional="false" byreference="false" type="string"/>
    <parameter name="entire_row" optional="true" byreference="false" type="object" class="bool"/>
  </method>
  <method name="version" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="&#10;   Returns the SQLite3 library version as a string constant and as a number&#10;  "/>
      <return type="array"/>
    </docblock>
  </method>
</class>