@@ -67,19 +67,19 @@ discard block |
||
67 | 67 | */ |
68 | 68 | interface BaseResult |
69 | 69 | { |
70 | - /** |
|
71 | - * Fetch warnings from last operation |
|
72 | - * @link https://www.php.net/manual/en/mysql-xdevapi-baseresult.getwarnings.php |
|
73 | - * @return array |
|
74 | - */ |
|
75 | - public function getWarnings(): array; |
|
76 | - |
|
77 | - /** |
|
78 | - * Fetch warning count from last operation |
|
79 | - * @link https://www.php.net/manual/en/mysql-xdevapi-baseresult.getwarningscount.php |
|
80 | - * @return int |
|
81 | - */ |
|
82 | - public function getWarningsCount(): int; |
|
70 | + /** |
|
71 | + * Fetch warnings from last operation |
|
72 | + * @link https://www.php.net/manual/en/mysql-xdevapi-baseresult.getwarnings.php |
|
73 | + * @return array |
|
74 | + */ |
|
75 | + public function getWarnings(): array; |
|
76 | + |
|
77 | + /** |
|
78 | + * Fetch warning count from last operation |
|
79 | + * @link https://www.php.net/manual/en/mysql-xdevapi-baseresult.getwarningscount.php |
|
80 | + * @return int |
|
81 | + */ |
|
82 | + public function getWarningsCount(): int; |
|
83 | 83 | } |
84 | 84 | |
85 | 85 | /** |
@@ -89,129 +89,129 @@ discard block |
||
89 | 89 | */ |
90 | 90 | class Collection |
91 | 91 | { |
92 | - /** |
|
93 | - * Collection constructor |
|
94 | - * @link https://www.php.net/manual/en/mysql-xdevapi-collection.construct.php |
|
95 | - */ |
|
96 | - public function __construct() {} |
|
97 | - |
|
98 | - /** |
|
99 | - * Add collection document |
|
100 | - * @link https://www.php.net/manual/en/mysql-xdevapi-collection.add.php |
|
101 | - * @param mixed $document |
|
102 | - * @return \mysql_xdevapi\CollectionAdd |
|
103 | - */ |
|
104 | - public function add($document): CollectionAdd {} |
|
105 | - |
|
106 | - /** |
|
107 | - * Add or replace collection document |
|
108 | - * @link https://www.php.net/manual/en/mysql-xdevapi-collection.addorreplaceone.php |
|
109 | - * @param string $id |
|
110 | - * @param mixed $document |
|
111 | - * @return \mysql_xdevapi\Result |
|
112 | - */ |
|
113 | - public function addOrReplaceOne($id, $document): Result {} |
|
114 | - |
|
115 | - /** |
|
116 | - * Get document count |
|
117 | - * @link https://www.php.net/manual/en/mysql-xdevapi-collection.count.php |
|
118 | - * @return int The number of documents in the collection. |
|
119 | - */ |
|
120 | - public function count(): int {} |
|
121 | - |
|
122 | - /** |
|
123 | - * Create collection index |
|
124 | - * @link https://www.php.net/manual/en/mysql-xdevapi-collection.createindex.php |
|
125 | - * @param string $index_name |
|
126 | - * @param string $index_desc_json |
|
127 | - */ |
|
128 | - public function createIndex($index_name, $index_desc_json) {} |
|
129 | - |
|
130 | - /** |
|
131 | - * Drop collection index |
|
132 | - * @link https://www.php.net/manual/en/mysql-xdevapi-collection.dropindex.php |
|
133 | - * @param string $index_name |
|
134 | - * @return bool |
|
135 | - */ |
|
136 | - public function dropIndex($index_name): bool {} |
|
137 | - |
|
138 | - /** |
|
139 | - * Check if collection exists in database |
|
140 | - * @link https://www.php.net/manual/en/mysql-xdevapi-collection.existsindatabase.php |
|
141 | - * @return bool |
|
142 | - */ |
|
143 | - public function existsInDatabase(): bool {} |
|
144 | - |
|
145 | - /** |
|
146 | - * @link https://secure.php.net/manual/en/mysql-xdevapi-collection.find.php |
|
147 | - * @param string $search_condition |
|
148 | - * @return \mysql_xdevapi\CollectionFind |
|
149 | - */ |
|
150 | - public function find($search_condition): CollectionFind {} |
|
151 | - |
|
152 | - /** |
|
153 | - * Get collection name |
|
154 | - * @link https://www.php.net/manual/en/mysql-xdevapi-collection.getname.php |
|
155 | - * @return string |
|
156 | - */ |
|
157 | - public function getName(): string {} |
|
158 | - |
|
159 | - /** |
|
160 | - * Get one document |
|
161 | - * This is a shortcut for Collection.find("_id = :id").bind("id", id).execute().fetchOne();. |
|
162 | - * @link https://www.php.net/manual/en/mysql-xdevapi-collection.getone.php |
|
163 | - * @param string $id |
|
164 | - * @return mixed Null if object is not found |
|
165 | - */ |
|
166 | - public function getOne($id) {} |
|
167 | - |
|
168 | - /** |
|
169 | - * Retrieve the schema object that contains the collection. |
|
170 | - * @link https://www.php.net/manual/en/mysql-xdevapi-collection.getschema.php |
|
171 | - * @return \mysql_xdevapi\Schema |
|
172 | - */ |
|
173 | - public function getSchema(): Schema {} |
|
174 | - |
|
175 | - /** |
|
176 | - * Get a new Session object from the Collection object. |
|
177 | - * @link https://www.php.net/manual/en/mysql-xdevapi-collection.getsession.php |
|
178 | - * @return \mysql_xdevapi\Session |
|
179 | - */ |
|
180 | - public function getSession(): Session {} |
|
181 | - |
|
182 | - /** |
|
183 | - * Modify collections that meet specific search conditions. Multiple operations are allowed, and parameter binding is supported. |
|
184 | - * @link https://www.php.net/manual/en/mysql-xdevapi-collection.modify.php |
|
185 | - * @param string $search_condition |
|
186 | - * @return \mysql_xdevapi\CollectionModify |
|
187 | - */ |
|
188 | - public function modify($search_condition): CollectionModify {} |
|
189 | - |
|
190 | - /** |
|
191 | - * Remove collections that meet specific search conditions. Multiple operations are allowed, and parameter binding is supported. |
|
192 | - * @link https://www.php.net/manual/en/mysql-xdevapi-collection.remove.php |
|
193 | - * @param string $search_condition |
|
194 | - * @return \mysql_xdevapi\CollectionRemove |
|
195 | - */ |
|
196 | - public function remove($search_condition): CollectionRemove {} |
|
197 | - |
|
198 | - /** |
|
199 | - * Remove one collection document |
|
200 | - * Remove one document from the collection with the corresponding ID. This is a shortcut for Collection.remove("_id = :id").bind("id", id).execute(). |
|
201 | - * @link https://www.php.net/manual/en/mysql-xdevapi-collection.removeone.php |
|
202 | - * @param string $id |
|
203 | - * @return \mysql_xdevapi\Result |
|
204 | - */ |
|
205 | - public function removeOne($id): Result {} |
|
206 | - |
|
207 | - /** |
|
208 | - * Updates (or replaces) the document identified by ID, if it exists. |
|
209 | - * @link https://www.php.net/manual/en/mysql-xdevapi-collection.removeone.php |
|
210 | - * @param string $id |
|
211 | - * @param string $doc |
|
212 | - * @return \mysql_xdevapi\Result |
|
213 | - */ |
|
214 | - public function replaceOne($id, $doc): Result {} |
|
92 | + /** |
|
93 | + * Collection constructor |
|
94 | + * @link https://www.php.net/manual/en/mysql-xdevapi-collection.construct.php |
|
95 | + */ |
|
96 | + public function __construct() {} |
|
97 | + |
|
98 | + /** |
|
99 | + * Add collection document |
|
100 | + * @link https://www.php.net/manual/en/mysql-xdevapi-collection.add.php |
|
101 | + * @param mixed $document |
|
102 | + * @return \mysql_xdevapi\CollectionAdd |
|
103 | + */ |
|
104 | + public function add($document): CollectionAdd {} |
|
105 | + |
|
106 | + /** |
|
107 | + * Add or replace collection document |
|
108 | + * @link https://www.php.net/manual/en/mysql-xdevapi-collection.addorreplaceone.php |
|
109 | + * @param string $id |
|
110 | + * @param mixed $document |
|
111 | + * @return \mysql_xdevapi\Result |
|
112 | + */ |
|
113 | + public function addOrReplaceOne($id, $document): Result {} |
|
114 | + |
|
115 | + /** |
|
116 | + * Get document count |
|
117 | + * @link https://www.php.net/manual/en/mysql-xdevapi-collection.count.php |
|
118 | + * @return int The number of documents in the collection. |
|
119 | + */ |
|
120 | + public function count(): int {} |
|
121 | + |
|
122 | + /** |
|
123 | + * Create collection index |
|
124 | + * @link https://www.php.net/manual/en/mysql-xdevapi-collection.createindex.php |
|
125 | + * @param string $index_name |
|
126 | + * @param string $index_desc_json |
|
127 | + */ |
|
128 | + public function createIndex($index_name, $index_desc_json) {} |
|
129 | + |
|
130 | + /** |
|
131 | + * Drop collection index |
|
132 | + * @link https://www.php.net/manual/en/mysql-xdevapi-collection.dropindex.php |
|
133 | + * @param string $index_name |
|
134 | + * @return bool |
|
135 | + */ |
|
136 | + public function dropIndex($index_name): bool {} |
|
137 | + |
|
138 | + /** |
|
139 | + * Check if collection exists in database |
|
140 | + * @link https://www.php.net/manual/en/mysql-xdevapi-collection.existsindatabase.php |
|
141 | + * @return bool |
|
142 | + */ |
|
143 | + public function existsInDatabase(): bool {} |
|
144 | + |
|
145 | + /** |
|
146 | + * @link https://secure.php.net/manual/en/mysql-xdevapi-collection.find.php |
|
147 | + * @param string $search_condition |
|
148 | + * @return \mysql_xdevapi\CollectionFind |
|
149 | + */ |
|
150 | + public function find($search_condition): CollectionFind {} |
|
151 | + |
|
152 | + /** |
|
153 | + * Get collection name |
|
154 | + * @link https://www.php.net/manual/en/mysql-xdevapi-collection.getname.php |
|
155 | + * @return string |
|
156 | + */ |
|
157 | + public function getName(): string {} |
|
158 | + |
|
159 | + /** |
|
160 | + * Get one document |
|
161 | + * This is a shortcut for Collection.find("_id = :id").bind("id", id).execute().fetchOne();. |
|
162 | + * @link https://www.php.net/manual/en/mysql-xdevapi-collection.getone.php |
|
163 | + * @param string $id |
|
164 | + * @return mixed Null if object is not found |
|
165 | + */ |
|
166 | + public function getOne($id) {} |
|
167 | + |
|
168 | + /** |
|
169 | + * Retrieve the schema object that contains the collection. |
|
170 | + * @link https://www.php.net/manual/en/mysql-xdevapi-collection.getschema.php |
|
171 | + * @return \mysql_xdevapi\Schema |
|
172 | + */ |
|
173 | + public function getSchema(): Schema {} |
|
174 | + |
|
175 | + /** |
|
176 | + * Get a new Session object from the Collection object. |
|
177 | + * @link https://www.php.net/manual/en/mysql-xdevapi-collection.getsession.php |
|
178 | + * @return \mysql_xdevapi\Session |
|
179 | + */ |
|
180 | + public function getSession(): Session {} |
|
181 | + |
|
182 | + /** |
|
183 | + * Modify collections that meet specific search conditions. Multiple operations are allowed, and parameter binding is supported. |
|
184 | + * @link https://www.php.net/manual/en/mysql-xdevapi-collection.modify.php |
|
185 | + * @param string $search_condition |
|
186 | + * @return \mysql_xdevapi\CollectionModify |
|
187 | + */ |
|
188 | + public function modify($search_condition): CollectionModify {} |
|
189 | + |
|
190 | + /** |
|
191 | + * Remove collections that meet specific search conditions. Multiple operations are allowed, and parameter binding is supported. |
|
192 | + * @link https://www.php.net/manual/en/mysql-xdevapi-collection.remove.php |
|
193 | + * @param string $search_condition |
|
194 | + * @return \mysql_xdevapi\CollectionRemove |
|
195 | + */ |
|
196 | + public function remove($search_condition): CollectionRemove {} |
|
197 | + |
|
198 | + /** |
|
199 | + * Remove one collection document |
|
200 | + * Remove one document from the collection with the corresponding ID. This is a shortcut for Collection.remove("_id = :id").bind("id", id).execute(). |
|
201 | + * @link https://www.php.net/manual/en/mysql-xdevapi-collection.removeone.php |
|
202 | + * @param string $id |
|
203 | + * @return \mysql_xdevapi\Result |
|
204 | + */ |
|
205 | + public function removeOne($id): Result {} |
|
206 | + |
|
207 | + /** |
|
208 | + * Updates (or replaces) the document identified by ID, if it exists. |
|
209 | + * @link https://www.php.net/manual/en/mysql-xdevapi-collection.removeone.php |
|
210 | + * @param string $id |
|
211 | + * @param string $doc |
|
212 | + * @return \mysql_xdevapi\Result |
|
213 | + */ |
|
214 | + public function replaceOne($id, $doc): Result {} |
|
215 | 215 | } |
216 | 216 | |
217 | 217 | /** |
@@ -220,10 +220,10 @@ discard block |
||
220 | 220 | */ |
221 | 221 | class CollectionAdd implements \mysql_xdevapi\Executable |
222 | 222 | { |
223 | - /** |
|
224 | - * @return \mysql_xdevapi\Result |
|
225 | - */ |
|
226 | - public function execute(): Result {} |
|
223 | + /** |
|
224 | + * @return \mysql_xdevapi\Result |
|
225 | + */ |
|
226 | + public function execute(): Result {} |
|
227 | 227 | } |
228 | 228 | |
229 | 229 | /** |
@@ -233,106 +233,106 @@ discard block |
||
233 | 233 | */ |
234 | 234 | class CollectionFind implements \mysql_xdevapi\Executable, \mysql_xdevapi\CrudOperationBindable, \mysql_xdevapi\CrudOperationLimitable, \mysql_xdevapi\CrudOperationSortable |
235 | 235 | { |
236 | - /** |
|
237 | - * Bind value to query placeholder |
|
238 | - * It allows the user to bind a parameter to the placeholder in the search condition of the find operation. The placeholder has the form of :NAME where ':' is a common prefix that must always exists before any NAME, NAME is the actual name of the placeholder. The bind function accepts a list of placeholders if multiple entities have to be substituted in the search condition. |
|
239 | - * @link https://www.php.net/manual/en/mysql-xdevapi-collectionfind.bind.php |
|
240 | - * @param array $placeholder_values |
|
241 | - * @return \mysql_xdevapi\CollectionFind |
|
242 | - */ |
|
243 | - public function bind(array $placeholder_values): CollectionFind {} |
|
244 | - |
|
245 | - /** |
|
246 | - * Execute the find operation; this functionality allows for method chaining. |
|
247 | - * @link https://www.php.net/manual/en/mysql-xdevapi-collectionfind.execute.php |
|
248 | - * @return \mysql_xdevapi\DocResult |
|
249 | - */ |
|
250 | - public function execute(): DocResult {} |
|
251 | - |
|
252 | - /** |
|
253 | - * Defined the columns for the query to return. If not defined then all columns are used. |
|
254 | - * @link https://www.php.net/manual/en/mysql-xdevapi-collectionfind.fields.php |
|
255 | - * @param string $projection |
|
256 | - * @return \mysql_xdevapi\CollectionFind |
|
257 | - */ |
|
258 | - public function fields(string $projection): CollectionFind {} |
|
259 | - |
|
260 | - /** |
|
261 | - * This function can be used to group the result-set by one more columns, frequently this is used with aggregate functions like COUNT,MAX,MIN,SUM etc. |
|
262 | - * @link https://www.php.net/manual/en/mysql-xdevapi-collectionfind.groupby.php |
|
263 | - * @param string $sort_expr |
|
264 | - * @return \mysql_xdevapi\CollectionFind |
|
265 | - */ |
|
266 | - public function groupBy(string $sort_expr): CollectionFind {} |
|
267 | - |
|
268 | - /** |
|
269 | - * This function can be used after the 'field' operation in order to make a selection on the documents to extract. |
|
270 | - * @link https://www.php.net/manual/en/mysql-xdevapi-collectionfind.having.php |
|
271 | - * @param string $sort_expr |
|
272 | - * @return \mysql_xdevapi\CollectionFind |
|
273 | - */ |
|
274 | - public function having(string $sort_expr): CollectionFind {} |
|
275 | - |
|
276 | - /** |
|
277 | - * Set the maximum number of documents to return. |
|
278 | - * @link https://www.php.net/manual/en/mysql-xdevapi-collectionfind.limit.php |
|
279 | - * @param int $rows |
|
280 | - * @return \mysql_xdevapi\CollectionFind |
|
281 | - */ |
|
282 | - public function limit(int $rows): CollectionFind {} |
|
283 | - |
|
284 | - /** |
|
285 | - * Execute operation with EXCLUSIVE LOCK |
|
286 | - * |
|
287 | - * Lock exclusively the document, other transactions are blocked from updating the document until the document is locked While the document is locked, other transactions are blocked from updating those docs, from doing SELECT ... LOCK IN SHARE MODE, or from reading the data in certain transaction isolation levels. Consistent reads ignore any locks set on the records that exist in the read view. |
|
288 | - * This feature is directly useful with the modify() command, to avoid concurrency problems. Basically, it serializes access to a row through row locking |
|
289 | - * |
|
290 | - * @link https://www.php.net/manual/en/mysql-xdevapi-collectionfind.lockexclusive.php |
|
291 | - * |
|
292 | - * @param int $lock_waiting_option |
|
293 | - * @return \mysql_xdevapi\CollectionFind |
|
294 | - */ |
|
295 | - public function lockExclusive(int $lock_waiting_option): CollectionFind {} |
|
296 | - |
|
297 | - /** |
|
298 | - * Execute operation with SHARED LOCK |
|
299 | - * |
|
300 | - * Allows to share the documents between multiple transactions which are locking in shared mode. |
|
301 | - * Other sessions can read the rows, but cannot modify them until your transaction commits. |
|
302 | - * If any of these rows were changed by another transaction that has not yet committed, |
|
303 | - * your query waits until that transaction ends and then uses the latest values. |
|
304 | - * |
|
305 | - * @link https://www.php.net/manual/en/mysql-xdevapi-collectionfind.lockshared.php |
|
306 | - * |
|
307 | - * @param int $lock_waiting_option |
|
308 | - * @return \mysql_xdevapi\CollectionFind |
|
309 | - */ |
|
310 | - public function lockShared(int $lock_waiting_option): CollectionFind {} |
|
311 | - |
|
312 | - /** |
|
313 | - * Skip given number of elements to be returned |
|
314 | - * |
|
315 | - * Skip (offset) these number of elements that otherwise would be returned by the find operation. Use with the limit() method. |
|
316 | - * Defining an offset larger than the result set size results in an empty set. |
|
317 | - * |
|
318 | - * @link https://www.php.net/manual/en/mysql-xdevapi-collectionfind.offset.php |
|
319 | - * |
|
320 | - * @param int $position |
|
321 | - * @return \mysql_xdevapi\CollectionFind |
|
322 | - */ |
|
323 | - public function offset(int $position): CollectionFind {} |
|
324 | - |
|
325 | - /** |
|
326 | - * Set the sorting criteria |
|
327 | - * |
|
328 | - * Sort the result set by the field selected in the sort_expr argument. The allowed orders are ASC (Ascending) or DESC (Descending). This operation is equivalent to the 'ORDER BY' SQL operation and it follows the same set of rules. |
|
329 | - * |
|
330 | - * @link https://www.php.net/manual/en/mysql-xdevapi-collectionfind.sort.php |
|
331 | - * |
|
332 | - * @param string $sort_expr |
|
333 | - * @return CollectionFind |
|
334 | - */ |
|
335 | - public function sort(string $sort_expr): CollectionFind {} |
|
236 | + /** |
|
237 | + * Bind value to query placeholder |
|
238 | + * It allows the user to bind a parameter to the placeholder in the search condition of the find operation. The placeholder has the form of :NAME where ':' is a common prefix that must always exists before any NAME, NAME is the actual name of the placeholder. The bind function accepts a list of placeholders if multiple entities have to be substituted in the search condition. |
|
239 | + * @link https://www.php.net/manual/en/mysql-xdevapi-collectionfind.bind.php |
|
240 | + * @param array $placeholder_values |
|
241 | + * @return \mysql_xdevapi\CollectionFind |
|
242 | + */ |
|
243 | + public function bind(array $placeholder_values): CollectionFind {} |
|
244 | + |
|
245 | + /** |
|
246 | + * Execute the find operation; this functionality allows for method chaining. |
|
247 | + * @link https://www.php.net/manual/en/mysql-xdevapi-collectionfind.execute.php |
|
248 | + * @return \mysql_xdevapi\DocResult |
|
249 | + */ |
|
250 | + public function execute(): DocResult {} |
|
251 | + |
|
252 | + /** |
|
253 | + * Defined the columns for the query to return. If not defined then all columns are used. |
|
254 | + * @link https://www.php.net/manual/en/mysql-xdevapi-collectionfind.fields.php |
|
255 | + * @param string $projection |
|
256 | + * @return \mysql_xdevapi\CollectionFind |
|
257 | + */ |
|
258 | + public function fields(string $projection): CollectionFind {} |
|
259 | + |
|
260 | + /** |
|
261 | + * This function can be used to group the result-set by one more columns, frequently this is used with aggregate functions like COUNT,MAX,MIN,SUM etc. |
|
262 | + * @link https://www.php.net/manual/en/mysql-xdevapi-collectionfind.groupby.php |
|
263 | + * @param string $sort_expr |
|
264 | + * @return \mysql_xdevapi\CollectionFind |
|
265 | + */ |
|
266 | + public function groupBy(string $sort_expr): CollectionFind {} |
|
267 | + |
|
268 | + /** |
|
269 | + * This function can be used after the 'field' operation in order to make a selection on the documents to extract. |
|
270 | + * @link https://www.php.net/manual/en/mysql-xdevapi-collectionfind.having.php |
|
271 | + * @param string $sort_expr |
|
272 | + * @return \mysql_xdevapi\CollectionFind |
|
273 | + */ |
|
274 | + public function having(string $sort_expr): CollectionFind {} |
|
275 | + |
|
276 | + /** |
|
277 | + * Set the maximum number of documents to return. |
|
278 | + * @link https://www.php.net/manual/en/mysql-xdevapi-collectionfind.limit.php |
|
279 | + * @param int $rows |
|
280 | + * @return \mysql_xdevapi\CollectionFind |
|
281 | + */ |
|
282 | + public function limit(int $rows): CollectionFind {} |
|
283 | + |
|
284 | + /** |
|
285 | + * Execute operation with EXCLUSIVE LOCK |
|
286 | + * |
|
287 | + * Lock exclusively the document, other transactions are blocked from updating the document until the document is locked While the document is locked, other transactions are blocked from updating those docs, from doing SELECT ... LOCK IN SHARE MODE, or from reading the data in certain transaction isolation levels. Consistent reads ignore any locks set on the records that exist in the read view. |
|
288 | + * This feature is directly useful with the modify() command, to avoid concurrency problems. Basically, it serializes access to a row through row locking |
|
289 | + * |
|
290 | + * @link https://www.php.net/manual/en/mysql-xdevapi-collectionfind.lockexclusive.php |
|
291 | + * |
|
292 | + * @param int $lock_waiting_option |
|
293 | + * @return \mysql_xdevapi\CollectionFind |
|
294 | + */ |
|
295 | + public function lockExclusive(int $lock_waiting_option): CollectionFind {} |
|
296 | + |
|
297 | + /** |
|
298 | + * Execute operation with SHARED LOCK |
|
299 | + * |
|
300 | + * Allows to share the documents between multiple transactions which are locking in shared mode. |
|
301 | + * Other sessions can read the rows, but cannot modify them until your transaction commits. |
|
302 | + * If any of these rows were changed by another transaction that has not yet committed, |
|
303 | + * your query waits until that transaction ends and then uses the latest values. |
|
304 | + * |
|
305 | + * @link https://www.php.net/manual/en/mysql-xdevapi-collectionfind.lockshared.php |
|
306 | + * |
|
307 | + * @param int $lock_waiting_option |
|
308 | + * @return \mysql_xdevapi\CollectionFind |
|
309 | + */ |
|
310 | + public function lockShared(int $lock_waiting_option): CollectionFind {} |
|
311 | + |
|
312 | + /** |
|
313 | + * Skip given number of elements to be returned |
|
314 | + * |
|
315 | + * Skip (offset) these number of elements that otherwise would be returned by the find operation. Use with the limit() method. |
|
316 | + * Defining an offset larger than the result set size results in an empty set. |
|
317 | + * |
|
318 | + * @link https://www.php.net/manual/en/mysql-xdevapi-collectionfind.offset.php |
|
319 | + * |
|
320 | + * @param int $position |
|
321 | + * @return \mysql_xdevapi\CollectionFind |
|
322 | + */ |
|
323 | + public function offset(int $position): CollectionFind {} |
|
324 | + |
|
325 | + /** |
|
326 | + * Set the sorting criteria |
|
327 | + * |
|
328 | + * Sort the result set by the field selected in the sort_expr argument. The allowed orders are ASC (Ascending) or DESC (Descending). This operation is equivalent to the 'ORDER BY' SQL operation and it follows the same set of rules. |
|
329 | + * |
|
330 | + * @link https://www.php.net/manual/en/mysql-xdevapi-collectionfind.sort.php |
|
331 | + * |
|
332 | + * @param string $sort_expr |
|
333 | + * @return CollectionFind |
|
334 | + */ |
|
335 | + public function sort(string $sort_expr): CollectionFind {} |
|
336 | 336 | } |
337 | 337 | |
338 | 338 | /** |
@@ -341,132 +341,132 @@ discard block |
||
341 | 341 | */ |
342 | 342 | class CollectionModify implements \mysql_xdevapi\Executable, \mysql_xdevapi\CrudOperationBindable, \mysql_xdevapi\CrudOperationLimitable, \mysql_xdevapi\CrudOperationSkippable, \mysql_xdevapi\CrudOperationSortable |
343 | 343 | { |
344 | - /** |
|
345 | - * Add an element to a document's field, as multiple elements of a field are represented as an array. Unlike arrayInsert(), arrayAppend() always appends the new element at the end of the array, whereas arrayInsert() can define the location. |
|
346 | - * @link https://www.php.net/manual/en/mysql-xdevapi-collectionmodify.arrayappend.php |
|
347 | - * @param string $collection_field |
|
348 | - * @param string $expression_or_literal |
|
349 | - * @return \mysql_xdevapi\CollectionModify |
|
350 | - */ |
|
351 | - public function arrayAppend(string $collection_field, string $expression_or_literal): CollectionModify {} |
|
352 | - |
|
353 | - /** |
|
354 | - * Add an element to a document's field, as multiple elements of a field are represented as an array. Unlike arrayAppend(), arrayInsert() allows you to specify where the new element is inserted by defining which item it is after, whereas arrayAppend() always appends the new element at the end of the array. |
|
355 | - * @link https://www.php.net/manual/en/mysql-xdevapi-collectionmodify.arrayinsert.php |
|
356 | - * @param string $collection_field |
|
357 | - * @param string $expression_or_literal |
|
358 | - * @return \mysql_xdevapi\CollectionModify |
|
359 | - */ |
|
360 | - public function arrayInsert(string $collection_field, string $expression_or_literal): CollectionModify {} |
|
361 | - |
|
362 | - /** |
|
363 | - * Bind a parameter to the placeholder in the search condition of the modify operation. |
|
364 | - * The placeholder has the form of :NAME where ':' is a common prefix that must always exists before any NAME where NAME is the name of the placeholder. The bind method accepts a list of placeholders if multiple entities have to be substituted in the search condition of the modify operation. |
|
365 | - * @link https://www.php.net/manual/en/mysql-xdevapi-collectionmodify.bind.php |
|
366 | - * @param array $placeholder_values |
|
367 | - * @return \mysql_xdevapi\CollectionModify |
|
368 | - */ |
|
369 | - public function bind(array $placeholder_values): CollectionModify {} |
|
370 | - |
|
371 | - /** |
|
372 | - * The execute method is required to send the CRUD operation request to the MySQL server. |
|
373 | - * @link https://www.php.net/manual/en/mysql-xdevapi-collectionmodify.execute.php |
|
374 | - * @return \mysql_xdevapi\Result |
|
375 | - */ |
|
376 | - public function execute(): Result {} |
|
377 | - |
|
378 | - /** |
|
379 | - * Limit the number of documents modified by this operation. Optionally combine with skip() to define an offset value. |
|
380 | - * @link https://www.php.net/manual/en/mysql-xdevapi-collectionmodify.limit.php |
|
381 | - * @param int $rows |
|
382 | - * @return \mysql_xdevapi\CollectionModify |
|
383 | - */ |
|
384 | - public function limit(int $rows): CollectionModify {} |
|
385 | - |
|
386 | - /** |
|
387 | - * Takes a patch object and applies it on one or more documents, and can update multiple document properties. |
|
388 | - * @link https://www.php.net/manual/en/mysql-xdevapi-collectionmodify.patch.php |
|
389 | - * @param string $document |
|
390 | - * @return \mysql_xdevapi\CollectionModify |
|
391 | - */ |
|
392 | - public function patch(string $document): CollectionModify {} |
|
393 | - |
|
394 | - /** |
|
395 | - * Replace (update) a given field value with a new one. |
|
396 | - * @link https://www.php.net/manual/en/mysql-xdevapi-collectionmodify.replace.php |
|
397 | - * @param string $collection_field |
|
398 | - * @param string $expression_or_literal |
|
399 | - * @return \mysql_xdevapi\CollectionModify |
|
400 | - */ |
|
401 | - public function replace(string $collection_field, string $expression_or_literal): CollectionModify {} |
|
402 | - |
|
403 | - /** |
|
404 | - * Sets or updates attributes on documents in a collection. |
|
405 | - * @link https://www.php.net/manual/en/mysql-xdevapi-collectionmodify.set.php |
|
406 | - * @param string $collection_field |
|
407 | - * @param string $expression_or_literal |
|
408 | - * @return \mysql_xdevapi\CollectionModify |
|
409 | - */ |
|
410 | - public function set(string $collection_field, string $expression_or_literal): CollectionModify {} |
|
411 | - |
|
412 | - /** |
|
413 | - * Skip the first N elements that would otherwise be returned by a find operation. If the number of elements skipped is larger than the size of the result set, then the find operation returns an empty set. |
|
414 | - * @link https://www.php.net/manual/en/mysql-xdevapi-collectionmodify.skip.php |
|
415 | - * @param int $position |
|
416 | - * @return \mysql_xdevapi\CollectionModify |
|
417 | - */ |
|
418 | - public function skip(int $position): CollectionModify {} |
|
419 | - |
|
420 | - /** |
|
421 | - * Sort the result set by the field selected in the sort_expr argument. The allowed orders are ASC (Ascending) or DESC (Descending). This operation is equivalent to the 'ORDER BY' SQL operation and it follows the same set of rules. |
|
422 | - * @link https://www.php.net/manual/en/mysql-xdevapi-collectionmodify.sort.php |
|
423 | - * @param string $sort_expr |
|
424 | - * @return \mysql_xdevapi\CollectionModify |
|
425 | - */ |
|
426 | - public function sort(string $sort_expr): CollectionModify {} |
|
427 | - |
|
428 | - /** |
|
429 | - * Removes attributes from documents in a collection. |
|
430 | - * @link https://www.php.net/manual/en/mysql-xdevapi-collectionmodify.unset.php |
|
431 | - * @param array $fields |
|
432 | - * @return \mysql_xdevapi\CollectionModify |
|
433 | - */ |
|
434 | - public function unset(array $fields): CollectionModify {} |
|
344 | + /** |
|
345 | + * Add an element to a document's field, as multiple elements of a field are represented as an array. Unlike arrayInsert(), arrayAppend() always appends the new element at the end of the array, whereas arrayInsert() can define the location. |
|
346 | + * @link https://www.php.net/manual/en/mysql-xdevapi-collectionmodify.arrayappend.php |
|
347 | + * @param string $collection_field |
|
348 | + * @param string $expression_or_literal |
|
349 | + * @return \mysql_xdevapi\CollectionModify |
|
350 | + */ |
|
351 | + public function arrayAppend(string $collection_field, string $expression_or_literal): CollectionModify {} |
|
352 | + |
|
353 | + /** |
|
354 | + * Add an element to a document's field, as multiple elements of a field are represented as an array. Unlike arrayAppend(), arrayInsert() allows you to specify where the new element is inserted by defining which item it is after, whereas arrayAppend() always appends the new element at the end of the array. |
|
355 | + * @link https://www.php.net/manual/en/mysql-xdevapi-collectionmodify.arrayinsert.php |
|
356 | + * @param string $collection_field |
|
357 | + * @param string $expression_or_literal |
|
358 | + * @return \mysql_xdevapi\CollectionModify |
|
359 | + */ |
|
360 | + public function arrayInsert(string $collection_field, string $expression_or_literal): CollectionModify {} |
|
361 | + |
|
362 | + /** |
|
363 | + * Bind a parameter to the placeholder in the search condition of the modify operation. |
|
364 | + * The placeholder has the form of :NAME where ':' is a common prefix that must always exists before any NAME where NAME is the name of the placeholder. The bind method accepts a list of placeholders if multiple entities have to be substituted in the search condition of the modify operation. |
|
365 | + * @link https://www.php.net/manual/en/mysql-xdevapi-collectionmodify.bind.php |
|
366 | + * @param array $placeholder_values |
|
367 | + * @return \mysql_xdevapi\CollectionModify |
|
368 | + */ |
|
369 | + public function bind(array $placeholder_values): CollectionModify {} |
|
370 | + |
|
371 | + /** |
|
372 | + * The execute method is required to send the CRUD operation request to the MySQL server. |
|
373 | + * @link https://www.php.net/manual/en/mysql-xdevapi-collectionmodify.execute.php |
|
374 | + * @return \mysql_xdevapi\Result |
|
375 | + */ |
|
376 | + public function execute(): Result {} |
|
377 | + |
|
378 | + /** |
|
379 | + * Limit the number of documents modified by this operation. Optionally combine with skip() to define an offset value. |
|
380 | + * @link https://www.php.net/manual/en/mysql-xdevapi-collectionmodify.limit.php |
|
381 | + * @param int $rows |
|
382 | + * @return \mysql_xdevapi\CollectionModify |
|
383 | + */ |
|
384 | + public function limit(int $rows): CollectionModify {} |
|
385 | + |
|
386 | + /** |
|
387 | + * Takes a patch object and applies it on one or more documents, and can update multiple document properties. |
|
388 | + * @link https://www.php.net/manual/en/mysql-xdevapi-collectionmodify.patch.php |
|
389 | + * @param string $document |
|
390 | + * @return \mysql_xdevapi\CollectionModify |
|
391 | + */ |
|
392 | + public function patch(string $document): CollectionModify {} |
|
393 | + |
|
394 | + /** |
|
395 | + * Replace (update) a given field value with a new one. |
|
396 | + * @link https://www.php.net/manual/en/mysql-xdevapi-collectionmodify.replace.php |
|
397 | + * @param string $collection_field |
|
398 | + * @param string $expression_or_literal |
|
399 | + * @return \mysql_xdevapi\CollectionModify |
|
400 | + */ |
|
401 | + public function replace(string $collection_field, string $expression_or_literal): CollectionModify {} |
|
402 | + |
|
403 | + /** |
|
404 | + * Sets or updates attributes on documents in a collection. |
|
405 | + * @link https://www.php.net/manual/en/mysql-xdevapi-collectionmodify.set.php |
|
406 | + * @param string $collection_field |
|
407 | + * @param string $expression_or_literal |
|
408 | + * @return \mysql_xdevapi\CollectionModify |
|
409 | + */ |
|
410 | + public function set(string $collection_field, string $expression_or_literal): CollectionModify {} |
|
411 | + |
|
412 | + /** |
|
413 | + * Skip the first N elements that would otherwise be returned by a find operation. If the number of elements skipped is larger than the size of the result set, then the find operation returns an empty set. |
|
414 | + * @link https://www.php.net/manual/en/mysql-xdevapi-collectionmodify.skip.php |
|
415 | + * @param int $position |
|
416 | + * @return \mysql_xdevapi\CollectionModify |
|
417 | + */ |
|
418 | + public function skip(int $position): CollectionModify {} |
|
419 | + |
|
420 | + /** |
|
421 | + * Sort the result set by the field selected in the sort_expr argument. The allowed orders are ASC (Ascending) or DESC (Descending). This operation is equivalent to the 'ORDER BY' SQL operation and it follows the same set of rules. |
|
422 | + * @link https://www.php.net/manual/en/mysql-xdevapi-collectionmodify.sort.php |
|
423 | + * @param string $sort_expr |
|
424 | + * @return \mysql_xdevapi\CollectionModify |
|
425 | + */ |
|
426 | + public function sort(string $sort_expr): CollectionModify {} |
|
427 | + |
|
428 | + /** |
|
429 | + * Removes attributes from documents in a collection. |
|
430 | + * @link https://www.php.net/manual/en/mysql-xdevapi-collectionmodify.unset.php |
|
431 | + * @param array $fields |
|
432 | + * @return \mysql_xdevapi\CollectionModify |
|
433 | + */ |
|
434 | + public function unset(array $fields): CollectionModify {} |
|
435 | 435 | } |
436 | 436 | |
437 | 437 | class CollectionRemove implements \mysql_xdevapi\Executable, \mysql_xdevapi\CrudOperationBindable, \mysql_xdevapi\CrudOperationLimitable, \mysql_xdevapi\CrudOperationSortable |
438 | 438 | { |
439 | - /** |
|
440 | - * Bind a parameter to the placeholder in the search condition of the remove operation. |
|
441 | - * The placeholder has the form of :NAME where ':' is a common prefix that must always exists before any NAME where NAME is the name of the placeholder. The bind method accepts a list of placeholders if multiple entities have to be substituted in the search condition of the remove operation. |
|
442 | - * @link https://www.php.net/manual/en/mysql-xdevapi-collectionremove.bind.php |
|
443 | - * @param array $placeholder_values |
|
444 | - * @return \mysql_xdevapi\CollectionRemove |
|
445 | - */ |
|
446 | - public function bind(array $placeholder_values): CollectionRemove {} |
|
447 | - |
|
448 | - /** |
|
449 | - * The execute function needs to be invoked in order to trigger the client to send the CRUD operation request to the server. |
|
450 | - * @link https://www.php.net/manual/en/mysql-xdevapi-collectionremove.execute.php |
|
451 | - * @return \mysql_xdevapi\Result |
|
452 | - */ |
|
453 | - public function execute(): Result {} |
|
454 | - |
|
455 | - /** |
|
456 | - * Sets the maximum number of documents to remove. |
|
457 | - * @link https://www.php.net/manual/en/mysql-xdevapi-collectionremove.limit.php |
|
458 | - * @param int $rows |
|
459 | - * @return \mysql_xdevapi\CollectionRemove |
|
460 | - */ |
|
461 | - public function limit(int $rows): CollectionRemove {} |
|
462 | - |
|
463 | - /** |
|
464 | - * Sort the result set by the field selected in the sort_expr argument. The allowed orders are ASC (Ascending) or DESC (Descending). This operation is equivalent to the 'ORDER BY' SQL operation and it follows the same set of rules. |
|
465 | - * @link https://www.php.net/manual/en/mysql-xdevapi-collectionremove.sort.php |
|
466 | - * @param string $sort_expr |
|
467 | - * @return \mysql_xdevapi\CollectionRemove |
|
468 | - */ |
|
469 | - public function sort(string $sort_expr): CollectionRemove {} |
|
439 | + /** |
|
440 | + * Bind a parameter to the placeholder in the search condition of the remove operation. |
|
441 | + * The placeholder has the form of :NAME where ':' is a common prefix that must always exists before any NAME where NAME is the name of the placeholder. The bind method accepts a list of placeholders if multiple entities have to be substituted in the search condition of the remove operation. |
|
442 | + * @link https://www.php.net/manual/en/mysql-xdevapi-collectionremove.bind.php |
|
443 | + * @param array $placeholder_values |
|
444 | + * @return \mysql_xdevapi\CollectionRemove |
|
445 | + */ |
|
446 | + public function bind(array $placeholder_values): CollectionRemove {} |
|
447 | + |
|
448 | + /** |
|
449 | + * The execute function needs to be invoked in order to trigger the client to send the CRUD operation request to the server. |
|
450 | + * @link https://www.php.net/manual/en/mysql-xdevapi-collectionremove.execute.php |
|
451 | + * @return \mysql_xdevapi\Result |
|
452 | + */ |
|
453 | + public function execute(): Result {} |
|
454 | + |
|
455 | + /** |
|
456 | + * Sets the maximum number of documents to remove. |
|
457 | + * @link https://www.php.net/manual/en/mysql-xdevapi-collectionremove.limit.php |
|
458 | + * @param int $rows |
|
459 | + * @return \mysql_xdevapi\CollectionRemove |
|
460 | + */ |
|
461 | + public function limit(int $rows): CollectionRemove {} |
|
462 | + |
|
463 | + /** |
|
464 | + * Sort the result set by the field selected in the sort_expr argument. The allowed orders are ASC (Ascending) or DESC (Descending). This operation is equivalent to the 'ORDER BY' SQL operation and it follows the same set of rules. |
|
465 | + * @link https://www.php.net/manual/en/mysql-xdevapi-collectionremove.sort.php |
|
466 | + * @param string $sort_expr |
|
467 | + * @return \mysql_xdevapi\CollectionRemove |
|
468 | + */ |
|
469 | + public function sort(string $sort_expr): CollectionRemove {} |
|
470 | 470 | } |
471 | 471 | |
472 | 472 | /** |
@@ -475,89 +475,89 @@ discard block |
||
475 | 475 | */ |
476 | 476 | class ColumnResult |
477 | 477 | { |
478 | - /** |
|
479 | - * Get character set |
|
480 | - * @link https://www.php.net/manual/en/mysql-xdevapi-columnresult.getcharactersetname.php |
|
481 | - * @return string |
|
482 | - */ |
|
483 | - public function getCharacterSetName(): string {} |
|
484 | - |
|
485 | - /** |
|
486 | - * Get collation name |
|
487 | - * @link https://www.php.net/manual/en/mysql-xdevapi-columnresult.getcollationname.php |
|
488 | - * @return string |
|
489 | - */ |
|
490 | - public function getCollationName(): string {} |
|
491 | - |
|
492 | - /** |
|
493 | - * Get column label |
|
494 | - * @link https://www.php.net/manual/en/mysql-xdevapi-columnresult.getcolumnlabel.php |
|
495 | - * @return string |
|
496 | - */ |
|
497 | - public function getColumnLabel(): string {} |
|
498 | - |
|
499 | - /** |
|
500 | - * Get column name |
|
501 | - * @link https://www.php.net/manual/en/mysql-xdevapi-columnresult.getcolumnname.php |
|
502 | - * @return string |
|
503 | - */ |
|
504 | - public function getColumnName(): string {} |
|
505 | - |
|
506 | - /** |
|
507 | - * Get fractional digit length |
|
508 | - * @link https://www.php.net/manual/en/mysql-xdevapi-columnresult.getfractionaldigits.php |
|
509 | - * @return int |
|
510 | - */ |
|
511 | - public function getFractionalDigits(): int {} |
|
512 | - |
|
513 | - /** |
|
514 | - * Get column field length |
|
515 | - * @link https://www.php.net/manual/en/mysql-xdevapi-columnresult.getlength.php |
|
516 | - * @return int |
|
517 | - */ |
|
518 | - public function getLength(): int {} |
|
519 | - |
|
520 | - /** |
|
521 | - * Get schema name |
|
522 | - * @link https://www.php.net/manual/en/mysql-xdevapi-columnresult.getschemaname.php |
|
523 | - * @return string |
|
524 | - */ |
|
525 | - public function getSchemaName(): string {} |
|
526 | - |
|
527 | - /** |
|
528 | - * Get table label |
|
529 | - * @link https://www.php.net/manual/en/mysql-xdevapi-columnresult.gettablelabel.php |
|
530 | - * @return string |
|
531 | - */ |
|
532 | - public function getTableLabel(): string {} |
|
533 | - |
|
534 | - /** |
|
535 | - * Get table name |
|
536 | - * @link https://www.php.net/manual/en/mysql-xdevapi-columnresult.gettablename.php |
|
537 | - * @return string |
|
538 | - */ |
|
539 | - public function getTableName(): string {} |
|
540 | - |
|
541 | - /** |
|
542 | - * Get column type |
|
543 | - * @link https://www.php.net/manual/en/mysql-xdevapi-columnresult.gettype.php |
|
544 | - * @return int |
|
545 | - */ |
|
546 | - public function getType(): int {} |
|
547 | - |
|
548 | - /** |
|
549 | - * Check if signed type |
|
550 | - * @link https://www.php.net/manual/en/mysql-xdevapi-columnresult.isnumbersigned.php |
|
551 | - * @return int |
|
552 | - */ |
|
553 | - public function isNumberSigned(): int {} |
|
554 | - |
|
555 | - /** |
|
556 | - * Check if padded |
|
557 | - * @link https://www.php.net/manual/en/mysql-xdevapi-columnresult.ispadded.php |
|
558 | - * @return int |
|
559 | - */ |
|
560 | - public function isPadded(): int {} |
|
478 | + /** |
|
479 | + * Get character set |
|
480 | + * @link https://www.php.net/manual/en/mysql-xdevapi-columnresult.getcharactersetname.php |
|
481 | + * @return string |
|
482 | + */ |
|
483 | + public function getCharacterSetName(): string {} |
|
484 | + |
|
485 | + /** |
|
486 | + * Get collation name |
|
487 | + * @link https://www.php.net/manual/en/mysql-xdevapi-columnresult.getcollationname.php |
|
488 | + * @return string |
|
489 | + */ |
|
490 | + public function getCollationName(): string {} |
|
491 | + |
|
492 | + /** |
|
493 | + * Get column label |
|
494 | + * @link https://www.php.net/manual/en/mysql-xdevapi-columnresult.getcolumnlabel.php |
|
495 | + * @return string |
|
496 | + */ |
|
497 | + public function getColumnLabel(): string {} |
|
498 | + |
|
499 | + /** |
|
500 | + * Get column name |
|
501 | + * @link https://www.php.net/manual/en/mysql-xdevapi-columnresult.getcolumnname.php |
|
502 | + * @return string |
|
503 | + */ |
|
504 | + public function getColumnName(): string {} |
|
505 | + |
|
506 | + /** |
|
507 | + * Get fractional digit length |
|
508 | + * @link https://www.php.net/manual/en/mysql-xdevapi-columnresult.getfractionaldigits.php |
|
509 | + * @return int |
|
510 | + */ |
|
511 | + public function getFractionalDigits(): int {} |
|
512 | + |
|
513 | + /** |
|
514 | + * Get column field length |
|
515 | + * @link https://www.php.net/manual/en/mysql-xdevapi-columnresult.getlength.php |
|
516 | + * @return int |
|
517 | + */ |
|
518 | + public function getLength(): int {} |
|
519 | + |
|
520 | + /** |
|
521 | + * Get schema name |
|
522 | + * @link https://www.php.net/manual/en/mysql-xdevapi-columnresult.getschemaname.php |
|
523 | + * @return string |
|
524 | + */ |
|
525 | + public function getSchemaName(): string {} |
|
526 | + |
|
527 | + /** |
|
528 | + * Get table label |
|
529 | + * @link https://www.php.net/manual/en/mysql-xdevapi-columnresult.gettablelabel.php |
|
530 | + * @return string |
|
531 | + */ |
|
532 | + public function getTableLabel(): string {} |
|
533 | + |
|
534 | + /** |
|
535 | + * Get table name |
|
536 | + * @link https://www.php.net/manual/en/mysql-xdevapi-columnresult.gettablename.php |
|
537 | + * @return string |
|
538 | + */ |
|
539 | + public function getTableName(): string {} |
|
540 | + |
|
541 | + /** |
|
542 | + * Get column type |
|
543 | + * @link https://www.php.net/manual/en/mysql-xdevapi-columnresult.gettype.php |
|
544 | + * @return int |
|
545 | + */ |
|
546 | + public function getType(): int {} |
|
547 | + |
|
548 | + /** |
|
549 | + * Check if signed type |
|
550 | + * @link https://www.php.net/manual/en/mysql-xdevapi-columnresult.isnumbersigned.php |
|
551 | + * @return int |
|
552 | + */ |
|
553 | + public function isNumberSigned(): int {} |
|
554 | + |
|
555 | + /** |
|
556 | + * Check if padded |
|
557 | + * @link https://www.php.net/manual/en/mysql-xdevapi-columnresult.ispadded.php |
|
558 | + * @return int |
|
559 | + */ |
|
560 | + public function isPadded(): int {} |
|
561 | 561 | } |
562 | 562 | |
563 | 563 | /** |
@@ -567,13 +567,13 @@ discard block |
||
567 | 567 | */ |
568 | 568 | interface CrudOperationBindable |
569 | 569 | { |
570 | - /** |
|
571 | - * Binds a value to a specific placeholder. |
|
572 | - * @link https://www.php.net/manual/en/mysql-xdevapi-crudoperationbindable.bind.php |
|
573 | - * @param array $placeholder_values |
|
574 | - * @return CrudOperationBindable |
|
575 | - */ |
|
576 | - public function bind(array $placeholder_values): CrudOperationBindable; |
|
570 | + /** |
|
571 | + * Binds a value to a specific placeholder. |
|
572 | + * @link https://www.php.net/manual/en/mysql-xdevapi-crudoperationbindable.bind.php |
|
573 | + * @param array $placeholder_values |
|
574 | + * @return CrudOperationBindable |
|
575 | + */ |
|
576 | + public function bind(array $placeholder_values): CrudOperationBindable; |
|
577 | 577 | } |
578 | 578 | |
579 | 579 | /** |
@@ -583,13 +583,13 @@ discard block |
||
583 | 583 | */ |
584 | 584 | interface CrudOperationLimitable |
585 | 585 | { |
586 | - /** |
|
587 | - * Set result limit |
|
588 | - * @link https://www.php.net/manual/en/mysql-xdevapi-crudoperationlimitable.limit.php |
|
589 | - * @param int $rows |
|
590 | - * @return CrudOperationLimitable |
|
591 | - */ |
|
592 | - public function limit(int $rows): CrudOperationLimitable; |
|
586 | + /** |
|
587 | + * Set result limit |
|
588 | + * @link https://www.php.net/manual/en/mysql-xdevapi-crudoperationlimitable.limit.php |
|
589 | + * @param int $rows |
|
590 | + * @return CrudOperationLimitable |
|
591 | + */ |
|
592 | + public function limit(int $rows): CrudOperationLimitable; |
|
593 | 593 | } |
594 | 594 | |
595 | 595 | /** |
@@ -599,13 +599,13 @@ discard block |
||
599 | 599 | */ |
600 | 600 | interface CrudOperationSkippable |
601 | 601 | { |
602 | - /** |
|
603 | - * Number of operations to skip |
|
604 | - * @link https://www.php.net/manual/en/mysql-xdevapi-crudoperationskippable.skip.php |
|
605 | - * @param int $skip |
|
606 | - * @return CrudOperationSkippable |
|
607 | - */ |
|
608 | - public function skip(int $skip): CrudOperationSkippable; |
|
602 | + /** |
|
603 | + * Number of operations to skip |
|
604 | + * @link https://www.php.net/manual/en/mysql-xdevapi-crudoperationskippable.skip.php |
|
605 | + * @param int $skip |
|
606 | + * @return CrudOperationSkippable |
|
607 | + */ |
|
608 | + public function skip(int $skip): CrudOperationSkippable; |
|
609 | 609 | } |
610 | 610 | |
611 | 611 | /** |
@@ -615,13 +615,13 @@ discard block |
||
615 | 615 | */ |
616 | 616 | interface CrudOperationSortable |
617 | 617 | { |
618 | - /** |
|
619 | - * Sort results |
|
620 | - * @link https://www.php.net/manual/en/mysql-xdevapi-crudoperationsortable.sort.php |
|
621 | - * @param string $sort_expr |
|
622 | - * @return CrudOperationSortable |
|
623 | - */ |
|
624 | - public function sort(string $sort_expr): CrudOperationSortable; |
|
618 | + /** |
|
619 | + * Sort results |
|
620 | + * @link https://www.php.net/manual/en/mysql-xdevapi-crudoperationsortable.sort.php |
|
621 | + * @param string $sort_expr |
|
622 | + * @return CrudOperationSortable |
|
623 | + */ |
|
624 | + public function sort(string $sort_expr): CrudOperationSortable; |
|
625 | 625 | } |
626 | 626 | |
627 | 627 | /** |
@@ -631,26 +631,26 @@ discard block |
||
631 | 631 | */ |
632 | 632 | interface DatabaseObject |
633 | 633 | { |
634 | - /** |
|
635 | - * Check if object exists in database |
|
636 | - * @link https://www.php.net/manual/en/mysql-xdevapi-databaseobject.existsindatabase.php |
|
637 | - * @return bool |
|
638 | - */ |
|
639 | - public function existsInDatabase(): bool; |
|
640 | - |
|
641 | - /** |
|
642 | - * Get object name |
|
643 | - * @link https://www.php.net/manual/en/mysql-xdevapi-databaseobject.getname.php |
|
644 | - * @return string |
|
645 | - */ |
|
646 | - public function getName(): string; |
|
647 | - |
|
648 | - /** |
|
649 | - * Get session name |
|
650 | - * @link https://www.php.net/manual/en/mysql-xdevapi-databaseobject.getsession.php |
|
651 | - * @return \mysql_xdevapi\Session |
|
652 | - */ |
|
653 | - public function getSession(): Session; |
|
634 | + /** |
|
635 | + * Check if object exists in database |
|
636 | + * @link https://www.php.net/manual/en/mysql-xdevapi-databaseobject.existsindatabase.php |
|
637 | + * @return bool |
|
638 | + */ |
|
639 | + public function existsInDatabase(): bool; |
|
640 | + |
|
641 | + /** |
|
642 | + * Get object name |
|
643 | + * @link https://www.php.net/manual/en/mysql-xdevapi-databaseobject.getname.php |
|
644 | + * @return string |
|
645 | + */ |
|
646 | + public function getName(): string; |
|
647 | + |
|
648 | + /** |
|
649 | + * Get session name |
|
650 | + * @link https://www.php.net/manual/en/mysql-xdevapi-databaseobject.getsession.php |
|
651 | + * @return \mysql_xdevapi\Session |
|
652 | + */ |
|
653 | + public function getSession(): Session; |
|
654 | 654 | } |
655 | 655 | |
656 | 656 | /** |
@@ -660,33 +660,33 @@ discard block |
||
660 | 660 | */ |
661 | 661 | class DocResult implements \mysql_xdevapi\BaseResult, \Traversable |
662 | 662 | { |
663 | - /** |
|
664 | - * Get all rows |
|
665 | - * @link https://www.php.net/manual/en/mysql-xdevapi-docresult.fetchall.php |
|
666 | - * @return array |
|
667 | - */ |
|
668 | - public function fetchAll(): array {} |
|
669 | - |
|
670 | - /** |
|
671 | - * Fetch one result from a result set. |
|
672 | - * @link https://www.php.net/manual/en/mysql-xdevapi-docresult.fetchone.php |
|
673 | - * @return array |
|
674 | - */ |
|
675 | - public function fetchOne(): array {} |
|
676 | - |
|
677 | - /** |
|
678 | - * Fetches warnings generated by MySQL server's last operation. |
|
679 | - * @link https://www.php.net/manual/en/mysql-xdevapi-docresult.getwarnings.php |
|
680 | - * @return \mysql_xdevapi\Warning[] |
|
681 | - */ |
|
682 | - public function getWarnings(): array {} |
|
683 | - |
|
684 | - /** |
|
685 | - * Returns the number of warnings raised by the last operation. Specifically, these warnings are raised by the MySQL server. |
|
686 | - * @link https://www.php.net/manual/en/mysql-xdevapi-docresult.getwarningscount.php |
|
687 | - * @return int |
|
688 | - */ |
|
689 | - public function getWarningsCount(): int {} |
|
663 | + /** |
|
664 | + * Get all rows |
|
665 | + * @link https://www.php.net/manual/en/mysql-xdevapi-docresult.fetchall.php |
|
666 | + * @return array |
|
667 | + */ |
|
668 | + public function fetchAll(): array {} |
|
669 | + |
|
670 | + /** |
|
671 | + * Fetch one result from a result set. |
|
672 | + * @link https://www.php.net/manual/en/mysql-xdevapi-docresult.fetchone.php |
|
673 | + * @return array |
|
674 | + */ |
|
675 | + public function fetchOne(): array {} |
|
676 | + |
|
677 | + /** |
|
678 | + * Fetches warnings generated by MySQL server's last operation. |
|
679 | + * @link https://www.php.net/manual/en/mysql-xdevapi-docresult.getwarnings.php |
|
680 | + * @return \mysql_xdevapi\Warning[] |
|
681 | + */ |
|
682 | + public function getWarnings(): array {} |
|
683 | + |
|
684 | + /** |
|
685 | + * Returns the number of warnings raised by the last operation. Specifically, these warnings are raised by the MySQL server. |
|
686 | + * @link https://www.php.net/manual/en/mysql-xdevapi-docresult.getwarningscount.php |
|
687 | + * @return int |
|
688 | + */ |
|
689 | + public function getWarningsCount(): int {} |
|
690 | 690 | } |
691 | 691 | |
692 | 692 | /** |
@@ -702,12 +702,12 @@ discard block |
||
702 | 702 | */ |
703 | 703 | interface Executable |
704 | 704 | { |
705 | - /** |
|
706 | - * Execute statement |
|
707 | - * @link https://www.php.net/manual/en/class.mysql-xdevapi-executable.php |
|
708 | - * @return Result |
|
709 | - */ |
|
710 | - public function execute(): Result; |
|
705 | + /** |
|
706 | + * Execute statement |
|
707 | + * @link https://www.php.net/manual/en/class.mysql-xdevapi-executable.php |
|
708 | + * @return Result |
|
709 | + */ |
|
710 | + public function execute(): Result; |
|
711 | 711 | } |
712 | 712 | |
713 | 713 | /** |
@@ -717,11 +717,11 @@ discard block |
||
717 | 717 | */ |
718 | 718 | class ExecutionStatus |
719 | 719 | { |
720 | - public $affectedItems; |
|
721 | - public $matchedItems; |
|
722 | - public $foundItems; |
|
723 | - public $lastInsertId; |
|
724 | - public $lastDocumentId; |
|
720 | + public $affectedItems; |
|
721 | + public $matchedItems; |
|
722 | + public $foundItems; |
|
723 | + public $lastInsertId; |
|
724 | + public $lastDocumentId; |
|
725 | 725 | } |
726 | 726 | |
727 | 727 | /** |
@@ -731,11 +731,11 @@ discard block |
||
731 | 731 | */ |
732 | 732 | class Expression |
733 | 733 | { |
734 | - /* Properties */ |
|
735 | - public $name; |
|
734 | + /* Properties */ |
|
735 | + public $name; |
|
736 | 736 | |
737 | - /* Constructor */ |
|
738 | - public function __construct(string $expression) {} |
|
737 | + /* Constructor */ |
|
738 | + public function __construct(string $expression) {} |
|
739 | 739 | } |
740 | 740 | |
741 | 741 | /** |
@@ -745,33 +745,33 @@ discard block |
||
745 | 745 | */ |
746 | 746 | class Result implements \mysql_xdevapi\BaseResult, \Traversable |
747 | 747 | { |
748 | - /** |
|
749 | - * Get the last AUTO_INCREMENT value (last insert id). |
|
750 | - * @link https://www.php.net/manual/en/mysql-xdevapi-result.getautoincrementvalue.php |
|
751 | - * @return int |
|
752 | - */ |
|
753 | - public function getAutoIncrementValue(): int {} |
|
754 | - |
|
755 | - /** |
|
756 | - * Fetch the generated _id values from the last operation. The unique _id field is generated by the MySQL server. |
|
757 | - * @link https://www.php.net/manual/en/mysql-xdevapi-result.getgeneratedids.php |
|
758 | - * @return string[] |
|
759 | - */ |
|
760 | - public function getGeneratedIds(): array {} |
|
761 | - |
|
762 | - /** |
|
763 | - * Retrieve warnings from the last Result operation. |
|
764 | - * @link https://www.php.net/manual/en/mysql-xdevapi-result.getwarnings.php |
|
765 | - * @return \mysql_xdevapi\Warning[] |
|
766 | - */ |
|
767 | - public function getWarnings(): array {} |
|
768 | - |
|
769 | - /** |
|
770 | - * Retrieve the number of warnings from the last Result operation. |
|
771 | - * @link https://www.php.net/manual/en/mysql-xdevapi-result.getwarningscount.php |
|
772 | - * @return int |
|
773 | - */ |
|
774 | - public function getWarningsCount(): int {} |
|
748 | + /** |
|
749 | + * Get the last AUTO_INCREMENT value (last insert id). |
|
750 | + * @link https://www.php.net/manual/en/mysql-xdevapi-result.getautoincrementvalue.php |
|
751 | + * @return int |
|
752 | + */ |
|
753 | + public function getAutoIncrementValue(): int {} |
|
754 | + |
|
755 | + /** |
|
756 | + * Fetch the generated _id values from the last operation. The unique _id field is generated by the MySQL server. |
|
757 | + * @link https://www.php.net/manual/en/mysql-xdevapi-result.getgeneratedids.php |
|
758 | + * @return string[] |
|
759 | + */ |
|
760 | + public function getGeneratedIds(): array {} |
|
761 | + |
|
762 | + /** |
|
763 | + * Retrieve warnings from the last Result operation. |
|
764 | + * @link https://www.php.net/manual/en/mysql-xdevapi-result.getwarnings.php |
|
765 | + * @return \mysql_xdevapi\Warning[] |
|
766 | + */ |
|
767 | + public function getWarnings(): array {} |
|
768 | + |
|
769 | + /** |
|
770 | + * Retrieve the number of warnings from the last Result operation. |
|
771 | + * @link https://www.php.net/manual/en/mysql-xdevapi-result.getwarningscount.php |
|
772 | + * @return int |
|
773 | + */ |
|
774 | + public function getWarningsCount(): int {} |
|
775 | 775 | } |
776 | 776 | |
777 | 777 | /** |
@@ -781,54 +781,54 @@ discard block |
||
781 | 781 | */ |
782 | 782 | class RowResult implements \mysql_xdevapi\BaseResult, \Traversable |
783 | 783 | { |
784 | - /** |
|
785 | - * Fetch all the rows from the result set. |
|
786 | - * @link https://www.php.net/manual/en/mysql-xdevapi-rowresult.fetchall.php |
|
787 | - * @return array A numerical array with all results from the query; each result is an associative array. An empty array is returned if no rows are present. |
|
788 | - */ |
|
789 | - public function fetchAll(): array {} |
|
790 | - |
|
791 | - /** |
|
792 | - * Fetch one result from the result set. |
|
793 | - * @link https://www.php.net/manual/en/mysql-xdevapi-rowresult.fetchone.php |
|
794 | - * @return array The result, as an associative array or NULL if no results are present. |
|
795 | - */ |
|
796 | - public function fetchOne(): array {} |
|
797 | - |
|
798 | - /** |
|
799 | - * Retrieve the column count for columns present in the result set. |
|
800 | - * @link https://www.php.net/manual/en/mysql-xdevapi-rowresult.getcolumncount.php |
|
801 | - * @return int |
|
802 | - */ |
|
803 | - public function getColumnsCount(): int {} |
|
804 | - |
|
805 | - /** |
|
806 | - * Retrieve column names for columns present in the result set. |
|
807 | - * @link https://www.php.net/manual/en/mysql-xdevapi-rowresult.getcolumnnames.php |
|
808 | - * @return array |
|
809 | - */ |
|
810 | - public function getColumnNames(): array {} |
|
811 | - |
|
812 | - /** |
|
813 | - * Retrieve column metadata for columns present in the result set. |
|
814 | - * @link https://www.php.net/manual/en/mysql-xdevapi-rowresult.getcolumns.php |
|
815 | - * @return \mysql_xdevapi\FieldMetadata[] |
|
816 | - */ |
|
817 | - public function getColumns(): array {} |
|
818 | - |
|
819 | - /** |
|
820 | - * Retrieve warnings from the last RowResult operation. |
|
821 | - * @link https://www.php.net/manual/en/mysql-xdevapi-rowresult.getwarnings.php |
|
822 | - * @return \mysql_xdevapi\Warning[] |
|
823 | - */ |
|
824 | - public function getWarnings(): array {} |
|
825 | - |
|
826 | - /** |
|
827 | - * Retrieve the number of warnings from the last RowResult operation. |
|
828 | - * @link https://www.php.net/manual/en/mysql-xdevapi-rowresult.getwarningscount.php |
|
829 | - * @return int |
|
830 | - */ |
|
831 | - public function getWarningsCount(): int {} |
|
784 | + /** |
|
785 | + * Fetch all the rows from the result set. |
|
786 | + * @link https://www.php.net/manual/en/mysql-xdevapi-rowresult.fetchall.php |
|
787 | + * @return array A numerical array with all results from the query; each result is an associative array. An empty array is returned if no rows are present. |
|
788 | + */ |
|
789 | + public function fetchAll(): array {} |
|
790 | + |
|
791 | + /** |
|
792 | + * Fetch one result from the result set. |
|
793 | + * @link https://www.php.net/manual/en/mysql-xdevapi-rowresult.fetchone.php |
|
794 | + * @return array The result, as an associative array or NULL if no results are present. |
|
795 | + */ |
|
796 | + public function fetchOne(): array {} |
|
797 | + |
|
798 | + /** |
|
799 | + * Retrieve the column count for columns present in the result set. |
|
800 | + * @link https://www.php.net/manual/en/mysql-xdevapi-rowresult.getcolumncount.php |
|
801 | + * @return int |
|
802 | + */ |
|
803 | + public function getColumnsCount(): int {} |
|
804 | + |
|
805 | + /** |
|
806 | + * Retrieve column names for columns present in the result set. |
|
807 | + * @link https://www.php.net/manual/en/mysql-xdevapi-rowresult.getcolumnnames.php |
|
808 | + * @return array |
|
809 | + */ |
|
810 | + public function getColumnNames(): array {} |
|
811 | + |
|
812 | + /** |
|
813 | + * Retrieve column metadata for columns present in the result set. |
|
814 | + * @link https://www.php.net/manual/en/mysql-xdevapi-rowresult.getcolumns.php |
|
815 | + * @return \mysql_xdevapi\FieldMetadata[] |
|
816 | + */ |
|
817 | + public function getColumns(): array {} |
|
818 | + |
|
819 | + /** |
|
820 | + * Retrieve warnings from the last RowResult operation. |
|
821 | + * @link https://www.php.net/manual/en/mysql-xdevapi-rowresult.getwarnings.php |
|
822 | + * @return \mysql_xdevapi\Warning[] |
|
823 | + */ |
|
824 | + public function getWarnings(): array {} |
|
825 | + |
|
826 | + /** |
|
827 | + * Retrieve the number of warnings from the last RowResult operation. |
|
828 | + * @link https://www.php.net/manual/en/mysql-xdevapi-rowresult.getwarningscount.php |
|
829 | + * @return int |
|
830 | + */ |
|
831 | + public function getWarningsCount(): int {} |
|
832 | 832 | } |
833 | 833 | |
834 | 834 | /** |
@@ -838,85 +838,85 @@ discard block |
||
838 | 838 | */ |
839 | 839 | class Schema implements \mysql_xdevapi\DatabaseObject |
840 | 840 | { |
841 | - /* Properties */ |
|
842 | - public $name; |
|
843 | - |
|
844 | - /* Methods */ |
|
845 | - /** |
|
846 | - * Create a collection within the schema. |
|
847 | - * @link https://www.php.net/manual/en/mysql-xdevapi-schema.createcollection.php |
|
848 | - * @param string $name |
|
849 | - * @return \mysql_xdevapi\Collection |
|
850 | - */ |
|
851 | - public function createCollection(string $name): Collection {} |
|
852 | - |
|
853 | - /** |
|
854 | - * Drop collection from schema |
|
855 | - * @link https://www.php.net/manual/en/mysql-xdevapi-schema.dropcollection.php |
|
856 | - * @param string $collection_name |
|
857 | - * @return bool |
|
858 | - */ |
|
859 | - public function dropCollection(string $collection_name): bool {} |
|
860 | - |
|
861 | - /** |
|
862 | - * Check if exists in database |
|
863 | - * Checks if the current object (schema, table, collection, or view) exists in the schema object. |
|
864 | - * @link https://www.php.net/manual/en/mysql-xdevapi-schema.existsindatabase.php |
|
865 | - * @return bool |
|
866 | - */ |
|
867 | - public function existsInDatabase(): bool {} |
|
868 | - |
|
869 | - /** |
|
870 | - * Get a collection from the schema. |
|
871 | - * @link https://www.php.net/manual/en/mysql-xdevapi-schema.getcollection.php |
|
872 | - * @param string $name |
|
873 | - * @return \mysql_xdevapi\Collection |
|
874 | - */ |
|
875 | - public function getCollection(string $name): Collection {} |
|
876 | - |
|
877 | - /** |
|
878 | - * Get a collection, but as a Table object instead of a Collection object. |
|
879 | - * @link https://www.php.net/manual/en/mysql-xdevapi-schema.getcollectionastable.php |
|
880 | - * @param string $name |
|
881 | - * @return \mysql_xdevapi\Table |
|
882 | - */ |
|
883 | - public function getCollectionAsTable(string $name): Table {} |
|
884 | - |
|
885 | - /** |
|
886 | - * Fetch a list of collections for this schema. |
|
887 | - * @link https://www.php.net/manual/en/mysql-xdevapi-schema.getcollections.php |
|
888 | - * @return \mysql_xdevapi\Collection[] Array of all collections in this schema, where each array element value is a Collection object with the collection name as the key. |
|
889 | - */ |
|
890 | - public function getCollections(): array {} |
|
891 | - |
|
892 | - /** |
|
893 | - * Get the name of the schema. |
|
894 | - * @link https://www.php.net/manual/en/mysql-xdevapi-schema.getname.php |
|
895 | - * @return string |
|
896 | - */ |
|
897 | - public function getName(): string {} |
|
898 | - |
|
899 | - /** |
|
900 | - * Get a new Session object from the Schema object. |
|
901 | - * @link https://www.php.net/manual/en/mysql-xdevapi-schema.getsession.php |
|
902 | - * @return \mysql_xdevapi\Session |
|
903 | - */ |
|
904 | - public function getSession(): Session {} |
|
905 | - |
|
906 | - /** |
|
907 | - * Fetch a Table object for the provided table in the schema. |
|
908 | - * @link https://www.php.net/manual/en/mysql-xdevapi-schema.gettable.php |
|
909 | - * @param string $name |
|
910 | - * @return \mysql_xdevapi\Table |
|
911 | - */ |
|
912 | - public function getTable(string $name): Table {} |
|
913 | - |
|
914 | - /** |
|
915 | - * Get schema tables |
|
916 | - * @link https://www.php.net/manual/en/mysql-xdevapi-schema.gettables.php |
|
917 | - * @return \mysql_xdevapi\Table[] Array of all tables in this schema, where each array element value is a Table object with the table name as the key. |
|
918 | - */ |
|
919 | - public function getTables(): array {} |
|
841 | + /* Properties */ |
|
842 | + public $name; |
|
843 | + |
|
844 | + /* Methods */ |
|
845 | + /** |
|
846 | + * Create a collection within the schema. |
|
847 | + * @link https://www.php.net/manual/en/mysql-xdevapi-schema.createcollection.php |
|
848 | + * @param string $name |
|
849 | + * @return \mysql_xdevapi\Collection |
|
850 | + */ |
|
851 | + public function createCollection(string $name): Collection {} |
|
852 | + |
|
853 | + /** |
|
854 | + * Drop collection from schema |
|
855 | + * @link https://www.php.net/manual/en/mysql-xdevapi-schema.dropcollection.php |
|
856 | + * @param string $collection_name |
|
857 | + * @return bool |
|
858 | + */ |
|
859 | + public function dropCollection(string $collection_name): bool {} |
|
860 | + |
|
861 | + /** |
|
862 | + * Check if exists in database |
|
863 | + * Checks if the current object (schema, table, collection, or view) exists in the schema object. |
|
864 | + * @link https://www.php.net/manual/en/mysql-xdevapi-schema.existsindatabase.php |
|
865 | + * @return bool |
|
866 | + */ |
|
867 | + public function existsInDatabase(): bool {} |
|
868 | + |
|
869 | + /** |
|
870 | + * Get a collection from the schema. |
|
871 | + * @link https://www.php.net/manual/en/mysql-xdevapi-schema.getcollection.php |
|
872 | + * @param string $name |
|
873 | + * @return \mysql_xdevapi\Collection |
|
874 | + */ |
|
875 | + public function getCollection(string $name): Collection {} |
|
876 | + |
|
877 | + /** |
|
878 | + * Get a collection, but as a Table object instead of a Collection object. |
|
879 | + * @link https://www.php.net/manual/en/mysql-xdevapi-schema.getcollectionastable.php |
|
880 | + * @param string $name |
|
881 | + * @return \mysql_xdevapi\Table |
|
882 | + */ |
|
883 | + public function getCollectionAsTable(string $name): Table {} |
|
884 | + |
|
885 | + /** |
|
886 | + * Fetch a list of collections for this schema. |
|
887 | + * @link https://www.php.net/manual/en/mysql-xdevapi-schema.getcollections.php |
|
888 | + * @return \mysql_xdevapi\Collection[] Array of all collections in this schema, where each array element value is a Collection object with the collection name as the key. |
|
889 | + */ |
|
890 | + public function getCollections(): array {} |
|
891 | + |
|
892 | + /** |
|
893 | + * Get the name of the schema. |
|
894 | + * @link https://www.php.net/manual/en/mysql-xdevapi-schema.getname.php |
|
895 | + * @return string |
|
896 | + */ |
|
897 | + public function getName(): string {} |
|
898 | + |
|
899 | + /** |
|
900 | + * Get a new Session object from the Schema object. |
|
901 | + * @link https://www.php.net/manual/en/mysql-xdevapi-schema.getsession.php |
|
902 | + * @return \mysql_xdevapi\Session |
|
903 | + */ |
|
904 | + public function getSession(): Session {} |
|
905 | + |
|
906 | + /** |
|
907 | + * Fetch a Table object for the provided table in the schema. |
|
908 | + * @link https://www.php.net/manual/en/mysql-xdevapi-schema.gettable.php |
|
909 | + * @param string $name |
|
910 | + * @return \mysql_xdevapi\Table |
|
911 | + */ |
|
912 | + public function getTable(string $name): Table {} |
|
913 | + |
|
914 | + /** |
|
915 | + * Get schema tables |
|
916 | + * @link https://www.php.net/manual/en/mysql-xdevapi-schema.gettables.php |
|
917 | + * @return \mysql_xdevapi\Table[] Array of all tables in this schema, where each array element value is a Table object with the table name as the key. |
|
918 | + */ |
|
919 | + public function getTables(): array {} |
|
920 | 920 | } |
921 | 921 | |
922 | 922 | /** |
@@ -926,8 +926,8 @@ discard block |
||
926 | 926 | */ |
927 | 927 | interface SchemaObject extends \mysql_xdevapi\DatabaseObject |
928 | 928 | { |
929 | - /* Methods */ |
|
930 | - public function getSchema(): Schema; |
|
929 | + /* Methods */ |
|
930 | + public function getSchema(): Schema; |
|
931 | 931 | } |
932 | 932 | |
933 | 933 | /** |
@@ -937,122 +937,122 @@ discard block |
||
937 | 937 | */ |
938 | 938 | class Session |
939 | 939 | { |
940 | - /** |
|
941 | - * Close the session with the server. |
|
942 | - * @link https://www.php.net/manual/en/mysql-xdevapi-session.close.php |
|
943 | - * @return bool |
|
944 | - */ |
|
945 | - public function close(): bool {} |
|
946 | - |
|
947 | - /** |
|
948 | - * Commit the transaction. |
|
949 | - * @link https://www.php.net/manual/en/mysql-xdevapi-session.commit.php |
|
950 | - * @return object |
|
951 | - */ |
|
952 | - public function commit(): object {} |
|
953 | - |
|
954 | - /** |
|
955 | - * Creates a new schema. |
|
956 | - * @link https://www.php.net/manual/en/mysql-xdevapi-session.createschema.php |
|
957 | - * @param string $schema_name |
|
958 | - * @return \mysql_xdevapi\Schema |
|
959 | - */ |
|
960 | - public function createSchema(string $schema_name): Schema {} |
|
961 | - |
|
962 | - /** |
|
963 | - * Drop a schema (database). |
|
964 | - * @link https://www.php.net/manual/en/mysql-xdevapi-session.dropschema.php |
|
965 | - * @param string $schema_name |
|
966 | - * @return bool |
|
967 | - */ |
|
968 | - public function dropSchema(string $schema_name): bool {} |
|
969 | - |
|
970 | - /** |
|
971 | - * Generate a Universal Unique IDentifier (UUID) generated according to » RFC 4122. |
|
972 | - * @link https://www.php.net/manual/en/mysql-xdevapi-session.generateuuid.php |
|
973 | - * @return string |
|
974 | - */ |
|
975 | - public function generateUUID(): string {} |
|
976 | - |
|
977 | - /** |
|
978 | - * Get a new schema object |
|
979 | - * @link https://www.php.net/manual/en/mysql-xdevapi-session.getschema.php |
|
980 | - * @param string $schema_name |
|
981 | - * @return \mysql_xdevapi\Schema |
|
982 | - */ |
|
983 | - public function getSchema(string $schema_name): Schema {} |
|
984 | - |
|
985 | - /** |
|
986 | - * Get schema objects for all schemas available to the session. |
|
987 | - * @link https://www.php.net/manual/en/mysql-xdevapi-session.getschemas.php |
|
988 | - * @return \mysql_xdevapi\Schema[] |
|
989 | - */ |
|
990 | - public function getSchemas(): array {} |
|
991 | - |
|
992 | - /** |
|
993 | - * Retrieve the MySQL server version for the session. |
|
994 | - * @link https://www.php.net/manual/en/mysql-xdevapi-session.getserverversion.php |
|
995 | - * @return int |
|
996 | - */ |
|
997 | - public function getServerVersion(): int {} |
|
998 | - |
|
999 | - /** |
|
1000 | - * Get a list of client connections to the session's MySQL server. |
|
1001 | - * @link https://www.php.net/manual/en/mysql-xdevapi-session.listclients.php |
|
1002 | - * @return array |
|
1003 | - */ |
|
1004 | - public function listClients(): array {} |
|
1005 | - |
|
1006 | - /** |
|
1007 | - * Add quotes |
|
1008 | - * A quoting function to escape SQL names and identifiers. It escapes the identifier given in accordance to the settings of the current connection. This escape function should not be used to escape values. |
|
1009 | - * @link https://www.php.net/manual/en/mysql-xdevapi-session.quotename.php |
|
1010 | - * @param string $name |
|
1011 | - * @return string |
|
1012 | - */ |
|
1013 | - public function quoteName(string $name): string {} |
|
1014 | - |
|
1015 | - /** |
|
1016 | - * Release a previously set savepoint. |
|
1017 | - * @link https://www.php.net/manual/en/mysql-xdevapi-session.releasesavepoint.php |
|
1018 | - * @param string $name |
|
1019 | - */ |
|
1020 | - public function releaseSavepoint(string $name): void {} |
|
1021 | - |
|
1022 | - /** |
|
1023 | - * Rollback the transaction. |
|
1024 | - * @link https://www.php.net/manual/en/mysql-xdevapi-session.rollback.php |
|
1025 | - */ |
|
1026 | - public function rollback(): void {} |
|
1027 | - |
|
1028 | - /** |
|
1029 | - * Rollback transaction to savepoint |
|
1030 | - * @link https://www.php.net/manual/en/mysql-xdevapi-session.rollbackto.php |
|
1031 | - * @param string $name |
|
1032 | - */ |
|
1033 | - public function rollbackTo(string $name): void {} |
|
1034 | - |
|
1035 | - /** |
|
1036 | - * Create a new savepoint for the transaction. |
|
1037 | - * @link https://www.php.net/manual/en/mysql-xdevapi-session.setsavepoint.php |
|
1038 | - * @param string $name |
|
1039 | - * @return string |
|
1040 | - */ |
|
1041 | - public function setSavepoint(string $name): string {} |
|
1042 | - |
|
1043 | - /** |
|
1044 | - * Create a native SQL statement. Placeholders are supported using the native "?" syntax. Use the execute method to execute the SQL statement. |
|
1045 | - * @link https://www.php.net/manual/en/mysql-xdevapi-session.sql.php |
|
1046 | - * @param string $query |
|
1047 | - * @return SqlStatement |
|
1048 | - */ |
|
1049 | - public function sql(string $query): SqlStatement {} |
|
1050 | - |
|
1051 | - /** |
|
1052 | - * Start a new transaction. |
|
1053 | - * @link https://www.php.net/manual/en/mysql-xdevapi-session.starttransaction.php |
|
1054 | - */ |
|
1055 | - public function startTransaction(): void {} |
|
940 | + /** |
|
941 | + * Close the session with the server. |
|
942 | + * @link https://www.php.net/manual/en/mysql-xdevapi-session.close.php |
|
943 | + * @return bool |
|
944 | + */ |
|
945 | + public function close(): bool {} |
|
946 | + |
|
947 | + /** |
|
948 | + * Commit the transaction. |
|
949 | + * @link https://www.php.net/manual/en/mysql-xdevapi-session.commit.php |
|
950 | + * @return object |
|
951 | + */ |
|
952 | + public function commit(): object {} |
|
953 | + |
|
954 | + /** |
|
955 | + * Creates a new schema. |
|
956 | + * @link https://www.php.net/manual/en/mysql-xdevapi-session.createschema.php |
|
957 | + * @param string $schema_name |
|
958 | + * @return \mysql_xdevapi\Schema |
|
959 | + */ |
|
960 | + public function createSchema(string $schema_name): Schema {} |
|
961 | + |
|
962 | + /** |
|
963 | + * Drop a schema (database). |
|
964 | + * @link https://www.php.net/manual/en/mysql-xdevapi-session.dropschema.php |
|
965 | + * @param string $schema_name |
|
966 | + * @return bool |
|
967 | + */ |
|
968 | + public function dropSchema(string $schema_name): bool {} |
|
969 | + |
|
970 | + /** |
|
971 | + * Generate a Universal Unique IDentifier (UUID) generated according to » RFC 4122. |
|
972 | + * @link https://www.php.net/manual/en/mysql-xdevapi-session.generateuuid.php |
|
973 | + * @return string |
|
974 | + */ |
|
975 | + public function generateUUID(): string {} |
|
976 | + |
|
977 | + /** |
|
978 | + * Get a new schema object |
|
979 | + * @link https://www.php.net/manual/en/mysql-xdevapi-session.getschema.php |
|
980 | + * @param string $schema_name |
|
981 | + * @return \mysql_xdevapi\Schema |
|
982 | + */ |
|
983 | + public function getSchema(string $schema_name): Schema {} |
|
984 | + |
|
985 | + /** |
|
986 | + * Get schema objects for all schemas available to the session. |
|
987 | + * @link https://www.php.net/manual/en/mysql-xdevapi-session.getschemas.php |
|
988 | + * @return \mysql_xdevapi\Schema[] |
|
989 | + */ |
|
990 | + public function getSchemas(): array {} |
|
991 | + |
|
992 | + /** |
|
993 | + * Retrieve the MySQL server version for the session. |
|
994 | + * @link https://www.php.net/manual/en/mysql-xdevapi-session.getserverversion.php |
|
995 | + * @return int |
|
996 | + */ |
|
997 | + public function getServerVersion(): int {} |
|
998 | + |
|
999 | + /** |
|
1000 | + * Get a list of client connections to the session's MySQL server. |
|
1001 | + * @link https://www.php.net/manual/en/mysql-xdevapi-session.listclients.php |
|
1002 | + * @return array |
|
1003 | + */ |
|
1004 | + public function listClients(): array {} |
|
1005 | + |
|
1006 | + /** |
|
1007 | + * Add quotes |
|
1008 | + * A quoting function to escape SQL names and identifiers. It escapes the identifier given in accordance to the settings of the current connection. This escape function should not be used to escape values. |
|
1009 | + * @link https://www.php.net/manual/en/mysql-xdevapi-session.quotename.php |
|
1010 | + * @param string $name |
|
1011 | + * @return string |
|
1012 | + */ |
|
1013 | + public function quoteName(string $name): string {} |
|
1014 | + |
|
1015 | + /** |
|
1016 | + * Release a previously set savepoint. |
|
1017 | + * @link https://www.php.net/manual/en/mysql-xdevapi-session.releasesavepoint.php |
|
1018 | + * @param string $name |
|
1019 | + */ |
|
1020 | + public function releaseSavepoint(string $name): void {} |
|
1021 | + |
|
1022 | + /** |
|
1023 | + * Rollback the transaction. |
|
1024 | + * @link https://www.php.net/manual/en/mysql-xdevapi-session.rollback.php |
|
1025 | + */ |
|
1026 | + public function rollback(): void {} |
|
1027 | + |
|
1028 | + /** |
|
1029 | + * Rollback transaction to savepoint |
|
1030 | + * @link https://www.php.net/manual/en/mysql-xdevapi-session.rollbackto.php |
|
1031 | + * @param string $name |
|
1032 | + */ |
|
1033 | + public function rollbackTo(string $name): void {} |
|
1034 | + |
|
1035 | + /** |
|
1036 | + * Create a new savepoint for the transaction. |
|
1037 | + * @link https://www.php.net/manual/en/mysql-xdevapi-session.setsavepoint.php |
|
1038 | + * @param string $name |
|
1039 | + * @return string |
|
1040 | + */ |
|
1041 | + public function setSavepoint(string $name): string {} |
|
1042 | + |
|
1043 | + /** |
|
1044 | + * Create a native SQL statement. Placeholders are supported using the native "?" syntax. Use the execute method to execute the SQL statement. |
|
1045 | + * @link https://www.php.net/manual/en/mysql-xdevapi-session.sql.php |
|
1046 | + * @param string $query |
|
1047 | + * @return SqlStatement |
|
1048 | + */ |
|
1049 | + public function sql(string $query): SqlStatement {} |
|
1050 | + |
|
1051 | + /** |
|
1052 | + * Start a new transaction. |
|
1053 | + * @link https://www.php.net/manual/en/mysql-xdevapi-session.starttransaction.php |
|
1054 | + */ |
|
1055 | + public function startTransaction(): void {} |
|
1056 | 1056 | } |
1057 | 1057 | |
1058 | 1058 | /** |
@@ -1062,49 +1062,49 @@ discard block |
||
1062 | 1062 | */ |
1063 | 1063 | class SqlStatement |
1064 | 1064 | { |
1065 | - /* Constants */ |
|
1066 | - public const EXECUTE_ASYNC = 1; |
|
1067 | - public const BUFFERED = 2; |
|
1068 | - |
|
1069 | - /* Properties */ |
|
1070 | - public $statement; |
|
1071 | - |
|
1072 | - /* Methods */ |
|
1073 | - /** |
|
1074 | - * Bind statement parameters |
|
1075 | - * @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatement.bind.php |
|
1076 | - * @param string $param |
|
1077 | - * @return \mysql_xdevapi\SqlStatement |
|
1078 | - */ |
|
1079 | - public function bind(string $param): SqlStatement {} |
|
1080 | - |
|
1081 | - /** |
|
1082 | - * Execute the operation |
|
1083 | - * @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatement.execute.php |
|
1084 | - * @return \mysql_xdevapi\Result |
|
1085 | - */ |
|
1086 | - public function execute(): Result {} |
|
1087 | - |
|
1088 | - /** |
|
1089 | - * Get next result |
|
1090 | - * @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatement.getnextresult.php |
|
1091 | - * @return \mysql_xdevapi\Result |
|
1092 | - */ |
|
1093 | - public function getNextResult(): Result {} |
|
1094 | - |
|
1095 | - /** |
|
1096 | - * Get result |
|
1097 | - * @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatement.getresult.php |
|
1098 | - * @return \mysql_xdevapi\Result |
|
1099 | - */ |
|
1100 | - public function getResult(): Result {} |
|
1101 | - |
|
1102 | - /** |
|
1103 | - * Check for more results |
|
1104 | - * @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatement.hasmoreresults.php |
|
1105 | - * @return bool |
|
1106 | - */ |
|
1107 | - public function hasMoreResults(): bool {} |
|
1065 | + /* Constants */ |
|
1066 | + public const EXECUTE_ASYNC = 1; |
|
1067 | + public const BUFFERED = 2; |
|
1068 | + |
|
1069 | + /* Properties */ |
|
1070 | + public $statement; |
|
1071 | + |
|
1072 | + /* Methods */ |
|
1073 | + /** |
|
1074 | + * Bind statement parameters |
|
1075 | + * @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatement.bind.php |
|
1076 | + * @param string $param |
|
1077 | + * @return \mysql_xdevapi\SqlStatement |
|
1078 | + */ |
|
1079 | + public function bind(string $param): SqlStatement {} |
|
1080 | + |
|
1081 | + /** |
|
1082 | + * Execute the operation |
|
1083 | + * @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatement.execute.php |
|
1084 | + * @return \mysql_xdevapi\Result |
|
1085 | + */ |
|
1086 | + public function execute(): Result {} |
|
1087 | + |
|
1088 | + /** |
|
1089 | + * Get next result |
|
1090 | + * @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatement.getnextresult.php |
|
1091 | + * @return \mysql_xdevapi\Result |
|
1092 | + */ |
|
1093 | + public function getNextResult(): Result {} |
|
1094 | + |
|
1095 | + /** |
|
1096 | + * Get result |
|
1097 | + * @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatement.getresult.php |
|
1098 | + * @return \mysql_xdevapi\Result |
|
1099 | + */ |
|
1100 | + public function getResult(): Result {} |
|
1101 | + |
|
1102 | + /** |
|
1103 | + * Check for more results |
|
1104 | + * @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatement.hasmoreresults.php |
|
1105 | + * @return bool |
|
1106 | + */ |
|
1107 | + public function hasMoreResults(): bool {} |
|
1108 | 1108 | } |
1109 | 1109 | |
1110 | 1110 | /** |
@@ -1114,90 +1114,90 @@ discard block |
||
1114 | 1114 | */ |
1115 | 1115 | class SqlStatementResult implements \mysql_xdevapi\BaseResult, \Traversable |
1116 | 1116 | { |
1117 | - /* Methods */ |
|
1118 | - /** |
|
1119 | - * Fetch all the rows from the result set. |
|
1120 | - * @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatementresult.fetchall.php |
|
1121 | - * @return array |
|
1122 | - */ |
|
1123 | - public function fetchAll(): array {} |
|
1124 | - |
|
1125 | - /** |
|
1126 | - * Fetch one row from the result set. |
|
1127 | - * @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatementresult.fetchone.php |
|
1128 | - * @return array |
|
1129 | - */ |
|
1130 | - public function fetchOne(): array {} |
|
1131 | - |
|
1132 | - /** |
|
1133 | - * Get affected row count |
|
1134 | - * @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatementresult.getaffecteditemscount.php |
|
1135 | - * @return int |
|
1136 | - */ |
|
1137 | - public function getAffectedItemsCount(): int {} |
|
1138 | - |
|
1139 | - /** |
|
1140 | - * Get column count |
|
1141 | - * @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatementresult.getcolumncount.php |
|
1142 | - * @return int |
|
1143 | - */ |
|
1144 | - public function getColumnsCount(): int {} |
|
1145 | - |
|
1146 | - /** |
|
1147 | - * Get column names |
|
1148 | - * @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatementresult.getcolumnnames.php |
|
1149 | - * @return array |
|
1150 | - */ |
|
1151 | - public function getColumnNames(): array {} |
|
1152 | - |
|
1153 | - /** |
|
1154 | - * Get columns |
|
1155 | - * @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatementresult.getcolumns.php |
|
1156 | - * @return array |
|
1157 | - */ |
|
1158 | - public function getColumns(): array {} |
|
1159 | - |
|
1160 | - /** |
|
1161 | - * Get generated ids |
|
1162 | - * @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatementresult.getgeneratedids.php |
|
1163 | - * @return array |
|
1164 | - */ |
|
1165 | - public function getGeneratedIds(): array {} |
|
1166 | - |
|
1167 | - /** |
|
1168 | - * Get last insert id |
|
1169 | - * @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatementresult.getlastinsertid.php |
|
1170 | - * @return string |
|
1171 | - */ |
|
1172 | - public function getLastInsertId(): string {} |
|
1173 | - |
|
1174 | - /** |
|
1175 | - * Get warnings from last operation |
|
1176 | - * @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatementresult.getwarnings.php |
|
1177 | - * @return \mysql_xdevapi\Warning[] |
|
1178 | - */ |
|
1179 | - public function getWarnings(): array {} |
|
1180 | - |
|
1181 | - /** |
|
1182 | - * Get warning count from last operation |
|
1183 | - * @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatementresult.getwarningcount.php |
|
1184 | - * @return int |
|
1185 | - */ |
|
1186 | - public function getWarningCounts(): int {} |
|
1187 | - |
|
1188 | - /** |
|
1189 | - * Check if result has data |
|
1190 | - * @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatementresult.hasdata.php |
|
1191 | - * @return bool |
|
1192 | - */ |
|
1193 | - public function hasData(): bool {} |
|
1194 | - |
|
1195 | - /** |
|
1196 | - * Get next result |
|
1197 | - * @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatementresult.nextresult.php |
|
1198 | - * @return \mysql_xdevapi\Result |
|
1199 | - */ |
|
1200 | - public function nextResult(): Result {} |
|
1117 | + /* Methods */ |
|
1118 | + /** |
|
1119 | + * Fetch all the rows from the result set. |
|
1120 | + * @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatementresult.fetchall.php |
|
1121 | + * @return array |
|
1122 | + */ |
|
1123 | + public function fetchAll(): array {} |
|
1124 | + |
|
1125 | + /** |
|
1126 | + * Fetch one row from the result set. |
|
1127 | + * @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatementresult.fetchone.php |
|
1128 | + * @return array |
|
1129 | + */ |
|
1130 | + public function fetchOne(): array {} |
|
1131 | + |
|
1132 | + /** |
|
1133 | + * Get affected row count |
|
1134 | + * @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatementresult.getaffecteditemscount.php |
|
1135 | + * @return int |
|
1136 | + */ |
|
1137 | + public function getAffectedItemsCount(): int {} |
|
1138 | + |
|
1139 | + /** |
|
1140 | + * Get column count |
|
1141 | + * @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatementresult.getcolumncount.php |
|
1142 | + * @return int |
|
1143 | + */ |
|
1144 | + public function getColumnsCount(): int {} |
|
1145 | + |
|
1146 | + /** |
|
1147 | + * Get column names |
|
1148 | + * @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatementresult.getcolumnnames.php |
|
1149 | + * @return array |
|
1150 | + */ |
|
1151 | + public function getColumnNames(): array {} |
|
1152 | + |
|
1153 | + /** |
|
1154 | + * Get columns |
|
1155 | + * @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatementresult.getcolumns.php |
|
1156 | + * @return array |
|
1157 | + */ |
|
1158 | + public function getColumns(): array {} |
|
1159 | + |
|
1160 | + /** |
|
1161 | + * Get generated ids |
|
1162 | + * @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatementresult.getgeneratedids.php |
|
1163 | + * @return array |
|
1164 | + */ |
|
1165 | + public function getGeneratedIds(): array {} |
|
1166 | + |
|
1167 | + /** |
|
1168 | + * Get last insert id |
|
1169 | + * @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatementresult.getlastinsertid.php |
|
1170 | + * @return string |
|
1171 | + */ |
|
1172 | + public function getLastInsertId(): string {} |
|
1173 | + |
|
1174 | + /** |
|
1175 | + * Get warnings from last operation |
|
1176 | + * @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatementresult.getwarnings.php |
|
1177 | + * @return \mysql_xdevapi\Warning[] |
|
1178 | + */ |
|
1179 | + public function getWarnings(): array {} |
|
1180 | + |
|
1181 | + /** |
|
1182 | + * Get warning count from last operation |
|
1183 | + * @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatementresult.getwarningcount.php |
|
1184 | + * @return int |
|
1185 | + */ |
|
1186 | + public function getWarningCounts(): int {} |
|
1187 | + |
|
1188 | + /** |
|
1189 | + * Check if result has data |
|
1190 | + * @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatementresult.hasdata.php |
|
1191 | + * @return bool |
|
1192 | + */ |
|
1193 | + public function hasData(): bool {} |
|
1194 | + |
|
1195 | + /** |
|
1196 | + * Get next result |
|
1197 | + * @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatementresult.nextresult.php |
|
1198 | + * @return \mysql_xdevapi\Result |
|
1199 | + */ |
|
1200 | + public function nextResult(): Result {} |
|
1201 | 1201 | } |
1202 | 1202 | |
1203 | 1203 | /** |
@@ -1207,31 +1207,31 @@ discard block |
||
1207 | 1207 | */ |
1208 | 1208 | class Statement |
1209 | 1209 | { |
1210 | - /* Constants */ |
|
1211 | - public const EXECUTE_ASYNC = 1; |
|
1212 | - public const BUFFERED = 2; |
|
1213 | - |
|
1214 | - /* Methods */ |
|
1215 | - /** |
|
1216 | - * Get next result |
|
1217 | - * @link https://www.php.net/manual/en/mysql-xdevapi-statement.getnextresult.php |
|
1218 | - * @return \mysql_xdevapi\Result |
|
1219 | - */ |
|
1220 | - public function getNextResult(): Result {} |
|
1221 | - |
|
1222 | - /** |
|
1223 | - * Get result |
|
1224 | - * @link https://www.php.net/manual/en/mysql-xdevapi-statement.getresult.php |
|
1225 | - * @return Result |
|
1226 | - */ |
|
1227 | - public function getResult(): Result {} |
|
1228 | - |
|
1229 | - /** |
|
1230 | - * Check if more results |
|
1231 | - * @link https://www.php.net/manual/en/mysql-xdevapi-statement.hasmoreresults.php |
|
1232 | - * @return bool |
|
1233 | - */ |
|
1234 | - public function hasMoreResults(): bool {} |
|
1210 | + /* Constants */ |
|
1211 | + public const EXECUTE_ASYNC = 1; |
|
1212 | + public const BUFFERED = 2; |
|
1213 | + |
|
1214 | + /* Methods */ |
|
1215 | + /** |
|
1216 | + * Get next result |
|
1217 | + * @link https://www.php.net/manual/en/mysql-xdevapi-statement.getnextresult.php |
|
1218 | + * @return \mysql_xdevapi\Result |
|
1219 | + */ |
|
1220 | + public function getNextResult(): Result {} |
|
1221 | + |
|
1222 | + /** |
|
1223 | + * Get result |
|
1224 | + * @link https://www.php.net/manual/en/mysql-xdevapi-statement.getresult.php |
|
1225 | + * @return Result |
|
1226 | + */ |
|
1227 | + public function getResult(): Result {} |
|
1228 | + |
|
1229 | + /** |
|
1230 | + * Check if more results |
|
1231 | + * @link https://www.php.net/manual/en/mysql-xdevapi-statement.hasmoreresults.php |
|
1232 | + * @return bool |
|
1233 | + */ |
|
1234 | + public function hasMoreResults(): bool {} |
|
1235 | 1235 | } |
1236 | 1236 | |
1237 | 1237 | /** |
@@ -1241,83 +1241,83 @@ discard block |
||
1241 | 1241 | */ |
1242 | 1242 | class Table implements \mysql_xdevapi\SchemaObject |
1243 | 1243 | { |
1244 | - /* Properties */ |
|
1245 | - public $name; |
|
1246 | - |
|
1247 | - /* Methods */ |
|
1248 | - /** |
|
1249 | - * Fetch the number of rows in the table. |
|
1250 | - * @link https://www.php.net/manual/en/mysql-xdevapi-table.count.php |
|
1251 | - * @return int |
|
1252 | - */ |
|
1253 | - public function count(): int {} |
|
1254 | - |
|
1255 | - /** |
|
1256 | - * Deletes rows from a table. |
|
1257 | - * @link https://www.php.net/manual/en/mysql-xdevapi-table.delete.php |
|
1258 | - * @return \mysql_xdevapi\TableDelete |
|
1259 | - */ |
|
1260 | - public function delete(): TableDelete {} |
|
1261 | - |
|
1262 | - /** |
|
1263 | - * Verifies if this table exists in the database. |
|
1264 | - * @link https://www.php.net/manual/en/mysql-xdevapi-table.existsindatabase.php |
|
1265 | - * @return bool |
|
1266 | - */ |
|
1267 | - public function existsInDatabase(): bool {} |
|
1268 | - |
|
1269 | - /** |
|
1270 | - * Returns the name of this database object. |
|
1271 | - * @link https://www.php.net/manual/en/mysql-xdevapi-table.getname.php |
|
1272 | - * @return string |
|
1273 | - */ |
|
1274 | - public function getName(): string {} |
|
1275 | - |
|
1276 | - /** |
|
1277 | - * Fetch the schema associated with the table. |
|
1278 | - * @link https://www.php.net/manual/en/mysql-xdevapi-table.getschema.php |
|
1279 | - * @return \mysql_xdevapi\Schema |
|
1280 | - */ |
|
1281 | - public function getSchema(): Schema {} |
|
1282 | - |
|
1283 | - /** |
|
1284 | - * Get session associated with the table. |
|
1285 | - * @link https://www.php.net/manual/en/mysql-xdevapi-table.getsession.php |
|
1286 | - * @return \mysql_xdevapi\Session |
|
1287 | - */ |
|
1288 | - public function getSession(): Session {} |
|
1289 | - |
|
1290 | - /** |
|
1291 | - * Inserts rows into a table. |
|
1292 | - * @link https://www.php.net/manual/en/mysql-xdevapi-table.insert.php |
|
1293 | - * @param string|string[] $columns The columns to insert data into. Can be an array with one or more values, or a string. |
|
1294 | - * @param string|string[] ...$additionalColumns Additional columns definitions. |
|
1295 | - * @return \mysql_xdevapi\TableInsert |
|
1296 | - */ |
|
1297 | - public function insert($columns, ...$additionalColumns): TableInsert {} |
|
1298 | - |
|
1299 | - /** |
|
1300 | - * Determine if the underlying object is a view or not. |
|
1301 | - * @link https://www.php.net/manual/en/mysql-xdevapi-table.isview.php |
|
1302 | - * @return bool |
|
1303 | - */ |
|
1304 | - public function isView(): bool {} |
|
1305 | - |
|
1306 | - /** |
|
1307 | - * Fetches data from a table. |
|
1308 | - * @link https://www.php.net/manual/en/mysql-xdevapi-table.select.php |
|
1309 | - * @param string|string[] $columns The columns to select data from. Can be an array with one or more values, or a string. |
|
1310 | - * @param string|string[] ...$additionalColumns Additional columns parameter definitions. |
|
1311 | - * @return \mysql_xdevapi\TableSelect |
|
1312 | - */ |
|
1313 | - public function select($columns, ...$additionalColumns): TableSelect {} |
|
1314 | - |
|
1315 | - /** |
|
1316 | - * Updates columns in a table. |
|
1317 | - * @link https://www.php.net/manual/en/mysql-xdevapi-table.update.php |
|
1318 | - * @return \mysql_xdevapi\TableUpdate |
|
1319 | - */ |
|
1320 | - public function update(): TableUpdate {} |
|
1244 | + /* Properties */ |
|
1245 | + public $name; |
|
1246 | + |
|
1247 | + /* Methods */ |
|
1248 | + /** |
|
1249 | + * Fetch the number of rows in the table. |
|
1250 | + * @link https://www.php.net/manual/en/mysql-xdevapi-table.count.php |
|
1251 | + * @return int |
|
1252 | + */ |
|
1253 | + public function count(): int {} |
|
1254 | + |
|
1255 | + /** |
|
1256 | + * Deletes rows from a table. |
|
1257 | + * @link https://www.php.net/manual/en/mysql-xdevapi-table.delete.php |
|
1258 | + * @return \mysql_xdevapi\TableDelete |
|
1259 | + */ |
|
1260 | + public function delete(): TableDelete {} |
|
1261 | + |
|
1262 | + /** |
|
1263 | + * Verifies if this table exists in the database. |
|
1264 | + * @link https://www.php.net/manual/en/mysql-xdevapi-table.existsindatabase.php |
|
1265 | + * @return bool |
|
1266 | + */ |
|
1267 | + public function existsInDatabase(): bool {} |
|
1268 | + |
|
1269 | + /** |
|
1270 | + * Returns the name of this database object. |
|
1271 | + * @link https://www.php.net/manual/en/mysql-xdevapi-table.getname.php |
|
1272 | + * @return string |
|
1273 | + */ |
|
1274 | + public function getName(): string {} |
|
1275 | + |
|
1276 | + /** |
|
1277 | + * Fetch the schema associated with the table. |
|
1278 | + * @link https://www.php.net/manual/en/mysql-xdevapi-table.getschema.php |
|
1279 | + * @return \mysql_xdevapi\Schema |
|
1280 | + */ |
|
1281 | + public function getSchema(): Schema {} |
|
1282 | + |
|
1283 | + /** |
|
1284 | + * Get session associated with the table. |
|
1285 | + * @link https://www.php.net/manual/en/mysql-xdevapi-table.getsession.php |
|
1286 | + * @return \mysql_xdevapi\Session |
|
1287 | + */ |
|
1288 | + public function getSession(): Session {} |
|
1289 | + |
|
1290 | + /** |
|
1291 | + * Inserts rows into a table. |
|
1292 | + * @link https://www.php.net/manual/en/mysql-xdevapi-table.insert.php |
|
1293 | + * @param string|string[] $columns The columns to insert data into. Can be an array with one or more values, or a string. |
|
1294 | + * @param string|string[] ...$additionalColumns Additional columns definitions. |
|
1295 | + * @return \mysql_xdevapi\TableInsert |
|
1296 | + */ |
|
1297 | + public function insert($columns, ...$additionalColumns): TableInsert {} |
|
1298 | + |
|
1299 | + /** |
|
1300 | + * Determine if the underlying object is a view or not. |
|
1301 | + * @link https://www.php.net/manual/en/mysql-xdevapi-table.isview.php |
|
1302 | + * @return bool |
|
1303 | + */ |
|
1304 | + public function isView(): bool {} |
|
1305 | + |
|
1306 | + /** |
|
1307 | + * Fetches data from a table. |
|
1308 | + * @link https://www.php.net/manual/en/mysql-xdevapi-table.select.php |
|
1309 | + * @param string|string[] $columns The columns to select data from. Can be an array with one or more values, or a string. |
|
1310 | + * @param string|string[] ...$additionalColumns Additional columns parameter definitions. |
|
1311 | + * @return \mysql_xdevapi\TableSelect |
|
1312 | + */ |
|
1313 | + public function select($columns, ...$additionalColumns): TableSelect {} |
|
1314 | + |
|
1315 | + /** |
|
1316 | + * Updates columns in a table. |
|
1317 | + * @link https://www.php.net/manual/en/mysql-xdevapi-table.update.php |
|
1318 | + * @return \mysql_xdevapi\TableUpdate |
|
1319 | + */ |
|
1320 | + public function update(): TableUpdate {} |
|
1321 | 1321 | } |
1322 | 1322 | |
1323 | 1323 | /** |
@@ -1327,45 +1327,45 @@ discard block |
||
1327 | 1327 | */ |
1328 | 1328 | class TableDelete implements \mysql_xdevapi\Executable |
1329 | 1329 | { |
1330 | - /* Methods */ |
|
1331 | - /** |
|
1332 | - * Binds a value to a specific placeholder. |
|
1333 | - * @link https://www.php.net/manual/en/mysql-xdevapi-tabledelete.bind.php |
|
1334 | - * @param array $placeholder_values |
|
1335 | - * @return \mysql_xdevapi\TableDelete |
|
1336 | - */ |
|
1337 | - public function bind(array $placeholder_values): TableDelete {} |
|
1338 | - |
|
1339 | - /** |
|
1340 | - * Execute the delete query. |
|
1341 | - * @link https://www.php.net/manual/en/mysql-xdevapi-tabledelete.execute.php |
|
1342 | - * @return \mysql_xdevapi\Result |
|
1343 | - */ |
|
1344 | - public function execute(): Result {} |
|
1345 | - |
|
1346 | - /** |
|
1347 | - * Sets the maximum number of records or documents to delete. |
|
1348 | - * @link https://www.php.net/manual/en/mysql-xdevapi-tabledelete.limit.php |
|
1349 | - * @param int $rows |
|
1350 | - * @return \mysql_xdevapi\TableDelete |
|
1351 | - */ |
|
1352 | - public function limit(int $rows): TableDelete {} |
|
1353 | - |
|
1354 | - /** |
|
1355 | - * Set the order options for a result set. |
|
1356 | - * @link https://www.php.net/manual/en/mysql-xdevapi-tabledelete.orderby.php |
|
1357 | - * @param string $orderby_expr |
|
1358 | - * @return \mysql_xdevapi\TableDelete |
|
1359 | - */ |
|
1360 | - public function orderby(string $orderby_expr): TableDelete {} |
|
1361 | - |
|
1362 | - /** |
|
1363 | - * Sets the search condition to filter. |
|
1364 | - * @link https://www.php.net/manual/en/mysql-xdevapi-tabledelete.where.php |
|
1365 | - * @param string $where_expr |
|
1366 | - * @return \mysql_xdevapi\TableDelete |
|
1367 | - */ |
|
1368 | - public function where(string $where_expr): TableDelete {} |
|
1330 | + /* Methods */ |
|
1331 | + /** |
|
1332 | + * Binds a value to a specific placeholder. |
|
1333 | + * @link https://www.php.net/manual/en/mysql-xdevapi-tabledelete.bind.php |
|
1334 | + * @param array $placeholder_values |
|
1335 | + * @return \mysql_xdevapi\TableDelete |
|
1336 | + */ |
|
1337 | + public function bind(array $placeholder_values): TableDelete {} |
|
1338 | + |
|
1339 | + /** |
|
1340 | + * Execute the delete query. |
|
1341 | + * @link https://www.php.net/manual/en/mysql-xdevapi-tabledelete.execute.php |
|
1342 | + * @return \mysql_xdevapi\Result |
|
1343 | + */ |
|
1344 | + public function execute(): Result {} |
|
1345 | + |
|
1346 | + /** |
|
1347 | + * Sets the maximum number of records or documents to delete. |
|
1348 | + * @link https://www.php.net/manual/en/mysql-xdevapi-tabledelete.limit.php |
|
1349 | + * @param int $rows |
|
1350 | + * @return \mysql_xdevapi\TableDelete |
|
1351 | + */ |
|
1352 | + public function limit(int $rows): TableDelete {} |
|
1353 | + |
|
1354 | + /** |
|
1355 | + * Set the order options for a result set. |
|
1356 | + * @link https://www.php.net/manual/en/mysql-xdevapi-tabledelete.orderby.php |
|
1357 | + * @param string $orderby_expr |
|
1358 | + * @return \mysql_xdevapi\TableDelete |
|
1359 | + */ |
|
1360 | + public function orderby(string $orderby_expr): TableDelete {} |
|
1361 | + |
|
1362 | + /** |
|
1363 | + * Sets the search condition to filter. |
|
1364 | + * @link https://www.php.net/manual/en/mysql-xdevapi-tabledelete.where.php |
|
1365 | + * @param string $where_expr |
|
1366 | + * @return \mysql_xdevapi\TableDelete |
|
1367 | + */ |
|
1368 | + public function where(string $where_expr): TableDelete {} |
|
1369 | 1369 | } |
1370 | 1370 | |
1371 | 1371 | /** |
@@ -1375,20 +1375,20 @@ discard block |
||
1375 | 1375 | */ |
1376 | 1376 | class TableInsert implements \mysql_xdevapi\Executable |
1377 | 1377 | { |
1378 | - /** |
|
1379 | - * Execute the statement. |
|
1380 | - * @link https://www.php.net/manual/en/mysql-xdevapi-tableinsert.execute.php |
|
1381 | - * @return \mysql_xdevapi\Result |
|
1382 | - */ |
|
1383 | - public function execute(): Result {} |
|
1384 | - |
|
1385 | - /** |
|
1386 | - * Set the values to be inserted. |
|
1387 | - * @link https://www.php.net/manual/en/mysql-xdevapi-tableinsert.values.php |
|
1388 | - * @param array $row_values |
|
1389 | - * @return \mysql_xdevapi\TableInsert |
|
1390 | - */ |
|
1391 | - public function values(array $row_values): TableInsert {} |
|
1378 | + /** |
|
1379 | + * Execute the statement. |
|
1380 | + * @link https://www.php.net/manual/en/mysql-xdevapi-tableinsert.execute.php |
|
1381 | + * @return \mysql_xdevapi\Result |
|
1382 | + */ |
|
1383 | + public function execute(): Result {} |
|
1384 | + |
|
1385 | + /** |
|
1386 | + * Set the values to be inserted. |
|
1387 | + * @link https://www.php.net/manual/en/mysql-xdevapi-tableinsert.values.php |
|
1388 | + * @param array $row_values |
|
1389 | + * @return \mysql_xdevapi\TableInsert |
|
1390 | + */ |
|
1391 | + public function values(array $row_values): TableInsert {} |
|
1392 | 1392 | } |
1393 | 1393 | |
1394 | 1394 | /** |
@@ -1398,84 +1398,84 @@ discard block |
||
1398 | 1398 | */ |
1399 | 1399 | class TableSelect implements \mysql_xdevapi\Executable |
1400 | 1400 | { |
1401 | - /** |
|
1402 | - * Binds a value to a specific placeholder. |
|
1403 | - * @link https://www.php.net/manual/en/mysql-xdevapi-tableselect.bind.php |
|
1404 | - * @param array $placeholder_values |
|
1405 | - * @return \mysql_xdevapi\TableSelect |
|
1406 | - */ |
|
1407 | - public function bind(array $placeholder_values): TableSelect {} |
|
1408 | - |
|
1409 | - /** |
|
1410 | - * Execute the select statement by chaining it with the execute() method. |
|
1411 | - * @link https://www.php.net/manual/en/mysql-xdevapi-tableselect.execute.php |
|
1412 | - * @return \mysql_xdevapi\RowResult |
|
1413 | - */ |
|
1414 | - public function execute(): RowResult {} |
|
1415 | - |
|
1416 | - /** |
|
1417 | - * Sets a grouping criteria for the result set. |
|
1418 | - * @link https://www.php.net/manual/en/mysql-xdevapi-tableselect.groupby.php |
|
1419 | - * @param mixed $sort_expr |
|
1420 | - * @return \mysql_xdevapi\TableSelect |
|
1421 | - */ |
|
1422 | - public function groupBy($sort_expr): TableSelect {} |
|
1423 | - |
|
1424 | - /** |
|
1425 | - * Sets a condition for records to consider in aggregate function operations. |
|
1426 | - * @link https://www.php.net/manual/en/mysql-xdevapi-tableselect.having.php |
|
1427 | - * @param string $sort_expr |
|
1428 | - * @return \mysql_xdevapi\TableSelect |
|
1429 | - */ |
|
1430 | - public function having(string $sort_expr): TableSelect {} |
|
1431 | - |
|
1432 | - /** |
|
1433 | - * Sets the maximum number of records or documents to return. |
|
1434 | - * @link https://www.php.net/manual/en/mysql-xdevapi-tableselect.limit.php |
|
1435 | - * @param int $rows |
|
1436 | - * @return \mysql_xdevapi\TableSelect |
|
1437 | - */ |
|
1438 | - public function limit(int $rows): TableSelect {} |
|
1439 | - |
|
1440 | - /** |
|
1441 | - * Execute a read operation with EXCLUSIVE LOCK. Only one lock can be active at a time. |
|
1442 | - * @link https://www.php.net/manual/en/mysql-xdevapi-tableselect.lockexclusive.php |
|
1443 | - * @param int|null $lock_waiting_option |
|
1444 | - * @return \mysql_xdevapi\TableSelect |
|
1445 | - */ |
|
1446 | - public function lockExclusive(?int $lock_waiting_option): TableSelect {} |
|
1447 | - |
|
1448 | - /** |
|
1449 | - * Execute a read operation with SHARED LOCK. Only one lock can be active at a time. |
|
1450 | - * @link https://www.php.net/manual/en/mysql-xdevapi-tableselect.lockshared.php |
|
1451 | - * @param int|null $lock_waiting_option |
|
1452 | - * @return \mysql_xdevapi\TableSelect |
|
1453 | - */ |
|
1454 | - public function lockShared(?int $lock_waiting_option): TableSelect {} |
|
1455 | - |
|
1456 | - /** |
|
1457 | - * Skip given number of rows in result. |
|
1458 | - * @link https://www.php.net/manual/en/mysql-xdevapi-tableselect.offset.php |
|
1459 | - * @param int $position |
|
1460 | - * @return \mysql_xdevapi\TableSelect |
|
1461 | - */ |
|
1462 | - public function offset(int $position): TableSelect {} |
|
1463 | - |
|
1464 | - /** |
|
1465 | - * Sets the order by criteria. |
|
1466 | - * @link https://www.php.net/manual/en/mysql-xdevapi-tableselect.orderby.php |
|
1467 | - * @param string|string[] ...$sort_expr |
|
1468 | - * @return \mysql_xdevapi\TableSelect |
|
1469 | - */ |
|
1470 | - public function orderby(...$sort_expr): TableSelect {} |
|
1471 | - |
|
1472 | - /** |
|
1473 | - * Sets the search condition to filter. |
|
1474 | - * @link https://www.php.net/manual/en/mysql-xdevapi-tableselect.where.php |
|
1475 | - * @param string $where_expr |
|
1476 | - * @return \mysql_xdevapi\TableSelect |
|
1477 | - */ |
|
1478 | - public function where(string $where_expr): TableSelect {} |
|
1401 | + /** |
|
1402 | + * Binds a value to a specific placeholder. |
|
1403 | + * @link https://www.php.net/manual/en/mysql-xdevapi-tableselect.bind.php |
|
1404 | + * @param array $placeholder_values |
|
1405 | + * @return \mysql_xdevapi\TableSelect |
|
1406 | + */ |
|
1407 | + public function bind(array $placeholder_values): TableSelect {} |
|
1408 | + |
|
1409 | + /** |
|
1410 | + * Execute the select statement by chaining it with the execute() method. |
|
1411 | + * @link https://www.php.net/manual/en/mysql-xdevapi-tableselect.execute.php |
|
1412 | + * @return \mysql_xdevapi\RowResult |
|
1413 | + */ |
|
1414 | + public function execute(): RowResult {} |
|
1415 | + |
|
1416 | + /** |
|
1417 | + * Sets a grouping criteria for the result set. |
|
1418 | + * @link https://www.php.net/manual/en/mysql-xdevapi-tableselect.groupby.php |
|
1419 | + * @param mixed $sort_expr |
|
1420 | + * @return \mysql_xdevapi\TableSelect |
|
1421 | + */ |
|
1422 | + public function groupBy($sort_expr): TableSelect {} |
|
1423 | + |
|
1424 | + /** |
|
1425 | + * Sets a condition for records to consider in aggregate function operations. |
|
1426 | + * @link https://www.php.net/manual/en/mysql-xdevapi-tableselect.having.php |
|
1427 | + * @param string $sort_expr |
|
1428 | + * @return \mysql_xdevapi\TableSelect |
|
1429 | + */ |
|
1430 | + public function having(string $sort_expr): TableSelect {} |
|
1431 | + |
|
1432 | + /** |
|
1433 | + * Sets the maximum number of records or documents to return. |
|
1434 | + * @link https://www.php.net/manual/en/mysql-xdevapi-tableselect.limit.php |
|
1435 | + * @param int $rows |
|
1436 | + * @return \mysql_xdevapi\TableSelect |
|
1437 | + */ |
|
1438 | + public function limit(int $rows): TableSelect {} |
|
1439 | + |
|
1440 | + /** |
|
1441 | + * Execute a read operation with EXCLUSIVE LOCK. Only one lock can be active at a time. |
|
1442 | + * @link https://www.php.net/manual/en/mysql-xdevapi-tableselect.lockexclusive.php |
|
1443 | + * @param int|null $lock_waiting_option |
|
1444 | + * @return \mysql_xdevapi\TableSelect |
|
1445 | + */ |
|
1446 | + public function lockExclusive(?int $lock_waiting_option): TableSelect {} |
|
1447 | + |
|
1448 | + /** |
|
1449 | + * Execute a read operation with SHARED LOCK. Only one lock can be active at a time. |
|
1450 | + * @link https://www.php.net/manual/en/mysql-xdevapi-tableselect.lockshared.php |
|
1451 | + * @param int|null $lock_waiting_option |
|
1452 | + * @return \mysql_xdevapi\TableSelect |
|
1453 | + */ |
|
1454 | + public function lockShared(?int $lock_waiting_option): TableSelect {} |
|
1455 | + |
|
1456 | + /** |
|
1457 | + * Skip given number of rows in result. |
|
1458 | + * @link https://www.php.net/manual/en/mysql-xdevapi-tableselect.offset.php |
|
1459 | + * @param int $position |
|
1460 | + * @return \mysql_xdevapi\TableSelect |
|
1461 | + */ |
|
1462 | + public function offset(int $position): TableSelect {} |
|
1463 | + |
|
1464 | + /** |
|
1465 | + * Sets the order by criteria. |
|
1466 | + * @link https://www.php.net/manual/en/mysql-xdevapi-tableselect.orderby.php |
|
1467 | + * @param string|string[] ...$sort_expr |
|
1468 | + * @return \mysql_xdevapi\TableSelect |
|
1469 | + */ |
|
1470 | + public function orderby(...$sort_expr): TableSelect {} |
|
1471 | + |
|
1472 | + /** |
|
1473 | + * Sets the search condition to filter. |
|
1474 | + * @link https://www.php.net/manual/en/mysql-xdevapi-tableselect.where.php |
|
1475 | + * @param string $where_expr |
|
1476 | + * @return \mysql_xdevapi\TableSelect |
|
1477 | + */ |
|
1478 | + public function where(string $where_expr): TableSelect {} |
|
1479 | 1479 | } |
1480 | 1480 | |
1481 | 1481 | /** |
@@ -1485,53 +1485,53 @@ discard block |
||
1485 | 1485 | */ |
1486 | 1486 | class TableUpdate implements \mysql_xdevapi\Executable |
1487 | 1487 | { |
1488 | - /** |
|
1489 | - * Bind update query parameters |
|
1490 | - * @link https://www.php.net/manual/en/mysql-xdevapi-tableupdate.bind.php |
|
1491 | - * @param array $placeholder_values The name of the placeholder, and the value to bind, defined as a JSON array. |
|
1492 | - * @return \mysql_xdevapi\TableUpdate |
|
1493 | - */ |
|
1494 | - public function bind(array $placeholder_values): TableUpdate {} |
|
1495 | - |
|
1496 | - /** |
|
1497 | - * Executes the update statement. |
|
1498 | - * @link https://www.php.net/manual/en/mysql-xdevapi-tableupdate.execute.php |
|
1499 | - * @return \mysql_xdevapi\TableUpdate |
|
1500 | - */ |
|
1501 | - public function execute(): TableUpdate {} |
|
1502 | - |
|
1503 | - /** |
|
1504 | - * Set the maximum number of records or documents update. |
|
1505 | - * @link https://www.php.net/manual/en/mysql-xdevapi-tableupdate.limit.php |
|
1506 | - * @param int $rows |
|
1507 | - * @return \mysql_xdevapi\TableUpdate |
|
1508 | - */ |
|
1509 | - public function limit(int $rows): TableUpdate {} |
|
1510 | - |
|
1511 | - /** |
|
1512 | - * Sets the sorting criteria. |
|
1513 | - * @link https://www.php.net/manual/en/mysql-xdevapi-tableupdate.orderby.php |
|
1514 | - * @param ?string|?string[] ...$orderby_expr The expressions that define the order by criteria. Can be an array with one or more expressions, or a string. |
|
1515 | - * @return \mysql_xdevapi\TableUpdate |
|
1516 | - */ |
|
1517 | - public function orderby(...$orderby_expr): TableUpdate {} |
|
1518 | - |
|
1519 | - /** |
|
1520 | - * Updates the column value on records in a table. |
|
1521 | - * @link https://www.php.net/manual/en/mysql-xdevapi-tableupdate.set.php |
|
1522 | - * @param string $table_field |
|
1523 | - * @param string $expression_or_literal |
|
1524 | - * @return \mysql_xdevapi\TableUpdate |
|
1525 | - */ |
|
1526 | - public function set(string $table_field, string $expression_or_literal): TableUpdate {} |
|
1527 | - |
|
1528 | - /** |
|
1529 | - * Set the search condition to filter. |
|
1530 | - * @link https://www.php.net/manual/en/mysql-xdevapi-tableupdate.where.php |
|
1531 | - * @param string $where_expr |
|
1532 | - * @return \mysql_xdevapi\TableUpdate |
|
1533 | - */ |
|
1534 | - public function where(string $where_expr): TableUpdate {} |
|
1488 | + /** |
|
1489 | + * Bind update query parameters |
|
1490 | + * @link https://www.php.net/manual/en/mysql-xdevapi-tableupdate.bind.php |
|
1491 | + * @param array $placeholder_values The name of the placeholder, and the value to bind, defined as a JSON array. |
|
1492 | + * @return \mysql_xdevapi\TableUpdate |
|
1493 | + */ |
|
1494 | + public function bind(array $placeholder_values): TableUpdate {} |
|
1495 | + |
|
1496 | + /** |
|
1497 | + * Executes the update statement. |
|
1498 | + * @link https://www.php.net/manual/en/mysql-xdevapi-tableupdate.execute.php |
|
1499 | + * @return \mysql_xdevapi\TableUpdate |
|
1500 | + */ |
|
1501 | + public function execute(): TableUpdate {} |
|
1502 | + |
|
1503 | + /** |
|
1504 | + * Set the maximum number of records or documents update. |
|
1505 | + * @link https://www.php.net/manual/en/mysql-xdevapi-tableupdate.limit.php |
|
1506 | + * @param int $rows |
|
1507 | + * @return \mysql_xdevapi\TableUpdate |
|
1508 | + */ |
|
1509 | + public function limit(int $rows): TableUpdate {} |
|
1510 | + |
|
1511 | + /** |
|
1512 | + * Sets the sorting criteria. |
|
1513 | + * @link https://www.php.net/manual/en/mysql-xdevapi-tableupdate.orderby.php |
|
1514 | + * @param ?string|?string[] ...$orderby_expr The expressions that define the order by criteria. Can be an array with one or more expressions, or a string. |
|
1515 | + * @return \mysql_xdevapi\TableUpdate |
|
1516 | + */ |
|
1517 | + public function orderby(...$orderby_expr): TableUpdate {} |
|
1518 | + |
|
1519 | + /** |
|
1520 | + * Updates the column value on records in a table. |
|
1521 | + * @link https://www.php.net/manual/en/mysql-xdevapi-tableupdate.set.php |
|
1522 | + * @param string $table_field |
|
1523 | + * @param string $expression_or_literal |
|
1524 | + * @return \mysql_xdevapi\TableUpdate |
|
1525 | + */ |
|
1526 | + public function set(string $table_field, string $expression_or_literal): TableUpdate {} |
|
1527 | + |
|
1528 | + /** |
|
1529 | + * Set the search condition to filter. |
|
1530 | + * @link https://www.php.net/manual/en/mysql-xdevapi-tableupdate.where.php |
|
1531 | + * @param string $where_expr |
|
1532 | + * @return \mysql_xdevapi\TableUpdate |
|
1533 | + */ |
|
1534 | + public function where(string $where_expr): TableUpdate {} |
|
1535 | 1535 | } |
1536 | 1536 | |
1537 | 1537 | /** |
@@ -1541,13 +1541,13 @@ discard block |
||
1541 | 1541 | */ |
1542 | 1542 | class Warning |
1543 | 1543 | { |
1544 | - /* Properties */ |
|
1545 | - public $message; |
|
1546 | - public $level; |
|
1547 | - public $code; |
|
1544 | + /* Properties */ |
|
1545 | + public $message; |
|
1546 | + public $level; |
|
1547 | + public $code; |
|
1548 | 1548 | |
1549 | - /* Constructor */ |
|
1550 | - private function __construct() {} |
|
1549 | + /* Constructor */ |
|
1550 | + private function __construct() {} |
|
1551 | 1551 | } |
1552 | 1552 | |
1553 | 1553 | /** |
@@ -65,8 +65,7 @@ discard block |
||
65 | 65 | * Interface BaseResult |
66 | 66 | * @package mysql_xdevapi |
67 | 67 | */ |
68 | -interface BaseResult |
|
69 | -{ |
|
68 | +interface BaseResult { |
|
70 | 69 | /** |
71 | 70 | * Fetch warnings from last operation |
72 | 71 | * @link https://www.php.net/manual/en/mysql-xdevapi-baseresult.getwarnings.php |
@@ -87,8 +86,7 @@ discard block |
||
87 | 86 | * @link https://www.php.net/manual/en/class.mysql-xdevapi-collection.php |
88 | 87 | * @package mysql_xdevapi |
89 | 88 | */ |
90 | -class Collection |
|
91 | -{ |
|
89 | +class Collection { |
|
92 | 90 | /** |
93 | 91 | * Collection constructor |
94 | 92 | * @link https://www.php.net/manual/en/mysql-xdevapi-collection.construct.php |
@@ -473,8 +471,7 @@ discard block |
||
473 | 471 | * Class ColumnResult |
474 | 472 | * @package mysql_xdevapi |
475 | 473 | */ |
476 | -class ColumnResult |
|
477 | -{ |
|
474 | +class ColumnResult { |
|
478 | 475 | /** |
479 | 476 | * Get character set |
480 | 477 | * @link https://www.php.net/manual/en/mysql-xdevapi-columnresult.getcharactersetname.php |
@@ -565,8 +562,7 @@ discard block |
||
565 | 562 | * @link https://www.php.net/manual/en/class.mysql-xdevapi-crudoperationbindable.php |
566 | 563 | * @package mysql_xdevapi |
567 | 564 | */ |
568 | -interface CrudOperationBindable |
|
569 | -{ |
|
565 | +interface CrudOperationBindable { |
|
570 | 566 | /** |
571 | 567 | * Binds a value to a specific placeholder. |
572 | 568 | * @link https://www.php.net/manual/en/mysql-xdevapi-crudoperationbindable.bind.php |
@@ -581,8 +577,7 @@ discard block |
||
581 | 577 | * @link https://www.php.net/manual/en/class.mysql-xdevapi-crudoperationlimitable.php |
582 | 578 | * @package mysql_xdevapi |
583 | 579 | */ |
584 | -interface CrudOperationLimitable |
|
585 | -{ |
|
580 | +interface CrudOperationLimitable { |
|
586 | 581 | /** |
587 | 582 | * Set result limit |
588 | 583 | * @link https://www.php.net/manual/en/mysql-xdevapi-crudoperationlimitable.limit.php |
@@ -597,8 +592,7 @@ discard block |
||
597 | 592 | * @link https://www.php.net/manual/en/class.mysql-xdevapi-crudoperationskippable.php |
598 | 593 | * @package mysql_xdevapi |
599 | 594 | */ |
600 | -interface CrudOperationSkippable |
|
601 | -{ |
|
595 | +interface CrudOperationSkippable { |
|
602 | 596 | /** |
603 | 597 | * Number of operations to skip |
604 | 598 | * @link https://www.php.net/manual/en/mysql-xdevapi-crudoperationskippable.skip.php |
@@ -613,8 +607,7 @@ discard block |
||
613 | 607 | * @link https://www.php.net/manual/en/class.mysql-xdevapi-crudoperationsortable.php |
614 | 608 | * @package mysql_xdevapi |
615 | 609 | */ |
616 | -interface CrudOperationSortable |
|
617 | -{ |
|
610 | +interface CrudOperationSortable { |
|
618 | 611 | /** |
619 | 612 | * Sort results |
620 | 613 | * @link https://www.php.net/manual/en/mysql-xdevapi-crudoperationsortable.sort.php |
@@ -629,8 +622,7 @@ discard block |
||
629 | 622 | * @link https://www.php.net/manual/en/class.mysql-xdevapi-databaseobject.php |
630 | 623 | * @package mysql_xdevapi |
631 | 624 | */ |
632 | -interface DatabaseObject |
|
633 | -{ |
|
625 | +interface DatabaseObject { |
|
634 | 626 | /** |
635 | 627 | * Check if object exists in database |
636 | 628 | * @link https://www.php.net/manual/en/mysql-xdevapi-databaseobject.existsindatabase.php |
@@ -700,8 +692,7 @@ discard block |
||
700 | 692 | * @link https://www.php.net/manual/en/class.mysql-xdevapi-exception.php |
701 | 693 | * @package mysql_xdevapi |
702 | 694 | */ |
703 | -interface Executable |
|
704 | -{ |
|
695 | +interface Executable { |
|
705 | 696 | /** |
706 | 697 | * Execute statement |
707 | 698 | * @link https://www.php.net/manual/en/class.mysql-xdevapi-executable.php |
@@ -715,8 +706,7 @@ discard block |
||
715 | 706 | * @link https://www.php.net/manual/en/class.mysql-xdevapi-executionstatus.php |
716 | 707 | * @package mysql_xdevapi |
717 | 708 | */ |
718 | -class ExecutionStatus |
|
719 | -{ |
|
709 | +class ExecutionStatus { |
|
720 | 710 | public $affectedItems; |
721 | 711 | public $matchedItems; |
722 | 712 | public $foundItems; |
@@ -729,8 +719,7 @@ discard block |
||
729 | 719 | * @link https://www.php.net/manual/en/class.mysql-xdevapi-expression.php |
730 | 720 | * @package mysql_xdevapi |
731 | 721 | */ |
732 | -class Expression |
|
733 | -{ |
|
722 | +class Expression { |
|
734 | 723 | /* Properties */ |
735 | 724 | public $name; |
736 | 725 | |
@@ -935,8 +924,7 @@ discard block |
||
935 | 924 | * @link https://www.php.net/manual/en/class.mysql-xdevapi-session.php |
936 | 925 | * @package mysql_xdevapi |
937 | 926 | */ |
938 | -class Session |
|
939 | -{ |
|
927 | +class Session { |
|
940 | 928 | /** |
941 | 929 | * Close the session with the server. |
942 | 930 | * @link https://www.php.net/manual/en/mysql-xdevapi-session.close.php |
@@ -1060,8 +1048,7 @@ discard block |
||
1060 | 1048 | * @link https://www.php.net/manual/en/class.mysql-xdevapi-sqlstatement.php |
1061 | 1049 | * @package mysql_xdevapi |
1062 | 1050 | */ |
1063 | -class SqlStatement |
|
1064 | -{ |
|
1051 | +class SqlStatement { |
|
1065 | 1052 | /* Constants */ |
1066 | 1053 | public const EXECUTE_ASYNC = 1; |
1067 | 1054 | public const BUFFERED = 2; |
@@ -1205,8 +1192,7 @@ discard block |
||
1205 | 1192 | * @link https://www.php.net/manual/en/class.mysql-xdevapi-statement.php |
1206 | 1193 | * @package mysql_xdevapi |
1207 | 1194 | */ |
1208 | -class Statement |
|
1209 | -{ |
|
1195 | +class Statement { |
|
1210 | 1196 | /* Constants */ |
1211 | 1197 | public const EXECUTE_ASYNC = 1; |
1212 | 1198 | public const BUFFERED = 2; |
@@ -1539,8 +1525,7 @@ discard block |
||
1539 | 1525 | * @link https://www.php.net/manual/en/class.mysql-xdevapi-warning.php |
1540 | 1526 | * @package mysql_xdevapi |
1541 | 1527 | */ |
1542 | -class Warning |
|
1543 | -{ |
|
1528 | +class Warning { |
|
1544 | 1529 | /* Properties */ |
1545 | 1530 | public $message; |
1546 | 1531 | public $level; |
@@ -8,226 +8,226 @@ discard block |
||
8 | 8 | */ |
9 | 9 | class SQLiteDatabase |
10 | 10 | { |
11 | - /** |
|
12 | - * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) |
|
13 | - * @link https://php.net/manual/en/function.sqlite-open.php |
|
14 | - * @param string $filename <p>The filename of the SQLite database. If the file does not exist, SQLite will attempt to create it. PHP must have write permissions to the file if data is inserted, the database schema is modified or to create the database if it does not exist.</p> |
|
15 | - * @param int $mode [optional] <p>The mode of the file. Intended to be used to open the database in read-only mode. Presently, this parameter is ignored by the sqlite library. The default value for mode is the octal value 0666 and this is the recommended value.</p> |
|
16 | - * @param string &$error_message [optional] <p>Passed by reference and is set to hold a descriptive error message explaining why the database could not be opened if there was an error.</p> |
|
17 | - */ |
|
18 | - final public function __construct($filename, $mode = 0666, &$error_message) {} |
|
19 | - |
|
20 | - /** |
|
21 | - * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) |
|
22 | - * @link https://php.net/manual/en/function.sqlite-query.php |
|
23 | - * @param string $query <p> |
|
24 | - * The query to be executed. |
|
25 | - * </p> |
|
26 | - * <p> |
|
27 | - * Data inside the query should be {@link https://php.net/manual/en/function.sqlite-escape-string.php properly escaped}. |
|
28 | - * </p> |
|
29 | - * @param int $result_type [optional] |
|
30 | - * <p>The optional <i>result_type</i> parameter accepts a constant and determines how the returned array will be indexed. Using <b>SQLITE_ASSOC</b> will return only associative indices (named fields) while <b>SQLITE_NUM</b> will return only numerical indices (ordinal field numbers). <b>SQLITE_BOTH</b> will return both associative and numerical indices. <b>SQLITE_BOTH</b> is the default for this function.</p> |
|
31 | - * @param string &$error_message [optional] <p>The specified variable will be filled if an error occurs. This is specially important because SQL syntax errors can't be fetched using the {@see sqlite_last_error()} function.</p> |
|
32 | - * @return resource|false <p> |
|
33 | - * This function will return a result handle or <b>FALSE</b> on failure. |
|
34 | - * For queries that return rows, the result handle can then be used with |
|
35 | - * functions such as {@see sqlite_fetch_array()} and |
|
36 | - * {@see sqlite_seek()}. |
|
37 | - * </p> |
|
38 | - * <p> |
|
39 | - * Regardless of the query type, this function will return <b>FALSE</b> if the |
|
40 | - * query failed. |
|
41 | - * </p> |
|
42 | - * <p> |
|
43 | - * {@see sqlite_query()} returns a buffered, seekable result |
|
44 | - * handle. This is useful for reasonably small queries where you need to |
|
45 | - * be able to randomly access the rows. Buffered result handles will |
|
46 | - * allocate memory to hold the entire result and will not return until it |
|
47 | - * has been fetched. If you only need sequential access to the data, it is |
|
48 | - * recommended that you use the much higher performance |
|
49 | - * {@see sqlite_unbuffered_query()} instead. |
|
50 | - * </p> |
|
51 | - */ |
|
52 | - public function query($query, $result_type, &$error_message) {} |
|
53 | - |
|
54 | - /** |
|
55 | - * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) |
|
56 | - * @link https://php.net/manual/en/function.sqlite-exec.php |
|
57 | - * @param string $query <p> |
|
58 | - * The query to be executed. |
|
59 | - * </p> |
|
60 | - * <p> |
|
61 | - * Data inside the query should be {@link https://php.net/manual/en/function.sqlite-escape-string.php properly escaped}. |
|
62 | - * </p> |
|
63 | - * @param string &$error_message [optional] <p>The specified variable will be filled if an error occurs. This is specially important because SQL syntax errors can't be fetched using the |
|
64 | - * {@see sqlite_last_error()} function.</p> |
|
65 | - * @return bool <p> |
|
66 | - * This function will return a boolean result; <b>TRUE</b> for success or <b>FALSE</b> for failure. |
|
67 | - * If you need to run a query that returns rows, see {@see sqlite_query()}. |
|
68 | - * </p> |
|
69 | - * <p>The column names returned by |
|
70 | - * <b>SQLITE_ASSOC</b> and <b>SQLITE_BOTH</b> will be |
|
71 | - * case-folded according to the value of the |
|
72 | - * {@link https://php.net/manual/en/sqlite.configuration.php#ini.sqlite.assoc-case sqlite.assoc_case} configuration |
|
73 | - * option.</p> |
|
74 | - */ |
|
75 | - public function queryExec($query, &$error_message) {} |
|
76 | - |
|
77 | - /** |
|
78 | - * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) |
|
79 | - * Execute a query against a given database and returns an array |
|
80 | - * @link https://php.net/manual/en/function.sqlite-array-query.php |
|
81 | - * @param string $query <p> |
|
82 | - * The query to be executed. |
|
83 | - * </p> |
|
84 | - * <p> |
|
85 | - * Data inside the query should be {@link https://php.net/manual/en/function.sqlite-escape-string.php properly escaped}. |
|
86 | - * </p> |
|
87 | - * @param int $result_type [optional] <p>The optional <i>result_type</i> |
|
88 | - * parameter accepts a constant and determines how the returned array will be |
|
89 | - * indexed. Using <b>SQLITE_ASSOC</b> will return only associative |
|
90 | - * indices (named fields) while <b>SQLITE_NUM</b> will return |
|
91 | - * only numerical indices (ordinal field numbers). <b>SQLITE_BOTH</b> |
|
92 | - * will return both associative and numerical indices. |
|
93 | - * <b>SQLITE_BOTH</b> is the default for this function.</p> |
|
94 | - * @param bool $decode_binary [optional] <p>When the <i>decode_binary</i> |
|
95 | - * parameter is set to <b>TRUE</b> (the default), PHP will decode the binary encoding |
|
96 | - * it applied to the data if it was encoded using the |
|
97 | - * {@see sqlite_escape_string()}. You should normally leave this |
|
98 | - * value at its default, unless you are interoperating with databases created by |
|
99 | - * other sqlite capable applications.</p> |
|
100 | - * <p> |
|
101 | - * @return array|false |
|
102 | - * Returns an array of the entire result set; <b>FALSE</b> otherwise. |
|
103 | - * </p> |
|
104 | - * <p>The column names returned by |
|
105 | - * <b>SQLITE_ASSOC</b> and <b>SQLITE_BOTH</b> will be |
|
106 | - * case-folded according to the value of the |
|
107 | - * {@link https://php.net/manual/en/sqlite.configuration.php#ini.sqlite.assoc-case sqlite.assoc_case} configuration |
|
108 | - * option.</p> |
|
109 | - */ |
|
110 | - public function arrayQuery($query, $result_type, $decode_binary) {} |
|
111 | - |
|
112 | - /** |
|
113 | - * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.1) |
|
114 | - * Executes a query and returns either an array for one single column or the value of the first row |
|
115 | - * @link https://php.net/manual/en/function.sqlite-single-query.php |
|
116 | - * @param string $query |
|
117 | - * @param bool $first_row_only [optional] |
|
118 | - * @param bool $decode_binary [optional] |
|
119 | - * @return array |
|
120 | - */ |
|
121 | - public function singleQuery($query, $first_row_only, $decode_binary) {} |
|
122 | - |
|
123 | - /** |
|
124 | - * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) |
|
125 | - * Execute a query that does not prefetch and buffer all data |
|
126 | - * @link https://php.net/manual/en/function.sqlite-unbuffered-query.php |
|
127 | - * @param string $query <p> |
|
128 | - * The query to be executed. |
|
129 | - * </p> |
|
130 | - * <p> |
|
131 | - * Data inside the query should be {@link https://php.net/manual/en/function.sqlite-escape-string.php properly escaped}. |
|
132 | - * </p> |
|
133 | - * @param int $result_type [optional] <p>The optional <i>result_type</i> parameter accepts a constant and determines how the returned array will be indexed. |
|
134 | - * Using <b>SQLITE_ASSOC</b> will return only associative indices (named fields) while <b>SQLITE_NUM</b> will return only numerical indices (ordinal field numbers). |
|
135 | - * <b>SQLITE_BOTH</b> will return both associative and numerical indices. <b>SQLITE_BOTH</b> is the default for this function. |
|
136 | - * </p> |
|
137 | - * @param string &$error_message [optional] |
|
138 | - * @return resource Returns a result handle or <b>FALSE</b> on failure. |
|
139 | - * {@see sqlite_unbuffered_query()} returns a sequential forward-only result set that can only be used to read each row, one after the other. |
|
140 | - */ |
|
141 | - public function unbufferedQuery($query, $result_type = SQLITE_BOTH, &$error_message = null) {} |
|
142 | - |
|
143 | - /** |
|
144 | - * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) |
|
145 | - * Returns the rowid of the most recently inserted row |
|
146 | - * @link https://php.net/manual/en/function.sqlite-last-insert-rowid.php |
|
147 | - * @return int Returns the row id, as an integer. |
|
148 | - */ |
|
149 | - public function lastInsertRowid() {} |
|
150 | - |
|
151 | - /** |
|
152 | - * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) |
|
153 | - * Returns the number of rows that were changed by the most recent SQL statement |
|
154 | - * @link https://php.net/manual/en/function.sqlite-changes.php |
|
155 | - * @return int Returns the number of changed rows. |
|
156 | - */ |
|
157 | - public function changes() {} |
|
158 | - |
|
159 | - /** |
|
160 | - * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) |
|
161 | - * Register an aggregating UDF for use in SQL statements |
|
162 | - * @link https://php.net/manual/en/function.sqlite-create-aggregate.php |
|
163 | - * @param string $function_name <p>The name of the function used in SQL statements.</p> |
|
164 | - * @param callable $step_func <p>Callback function called for each row of the result set. Function parameters are &$context, $value, ....</p> |
|
165 | - * @param callable $finalize_func <p>Callback function to aggregate the "stepped" data from each row. Function parameter is &$context and the function should return the final result of aggregation.</p> |
|
166 | - * @param int $num_args [optional] <p>Hint to the SQLite parser if the callback function accepts a predetermined number of arguments.</p> |
|
167 | - */ |
|
168 | - public function createAggregate($function_name, $step_func, $finalize_func, $num_args = -1) {} |
|
169 | - |
|
170 | - /** |
|
171 | - * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) |
|
172 | - * Registers a "regular" User Defined Function for use in SQL statements |
|
173 | - * @link https://php.net/manual/en/function.sqlite-create-function.php |
|
174 | - * @param string $function_name <p>The name of the function used in SQL statements.</p> |
|
175 | - * @param callable $callback <p> |
|
176 | - * Callback function to handle the defined SQL function. |
|
177 | - * </p> |
|
178 | - * <blockquote><p><b>Note</b>: |
|
179 | - * Callback functions should return a type understood by SQLite (i.e. |
|
180 | - * {@link https://php.net/manual/en/language.types.intro.php scalar type}). |
|
181 | - * </p></blockquote> |
|
182 | - * @param int $num_args [optional] <blockquote><p><b>Note</b>: Two alternative syntaxes are |
|
183 | - * supported for compatibility with other database extensions (such as MySQL). |
|
184 | - * The preferred form is the first, where the <i>dbhandle</i> |
|
185 | - * parameter is the first parameter to the function.</p></blockquote> |
|
186 | - */ |
|
187 | - public function createFunction($function_name, $callback, $num_args = -1) {} |
|
188 | - |
|
189 | - /** |
|
190 | - * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) |
|
191 | - * Set busy timeout duration, or disable busy handlers |
|
192 | - * @link https://php.net/manual/en/function.sqlite-busy-timeout.php |
|
193 | - * @param int $milliseconds <p> The number of milliseconds. When set to 0, busy handlers will be disabled and SQLite will return immediately with a <b>SQLITE_BUSY</b> status code if another process/thread has the database locked for an update. |
|
194 | - * PHP sets the default busy timeout to be 60 seconds when the database is opened.</p> |
|
195 | - * @return int <p>Returns an error code, or 0 if no error occurred.</p> |
|
196 | - */ |
|
197 | - public function busyTimeout($milliseconds) {} |
|
198 | - |
|
199 | - /** |
|
200 | - * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) |
|
201 | - * Returns the error code of the last error for a database |
|
202 | - * @link https://php.net/manual/en/function.sqlite-last-error.php |
|
203 | - * @return int Returns an error code, or 0 if no error occurred. |
|
204 | - */ |
|
205 | - public function lastError() {} |
|
206 | - |
|
207 | - /** |
|
208 | - * (PHP 5 < 5.4.0) |
|
209 | - * Return an array of column types from a particular table |
|
210 | - * @link https://php.net/manual/en/function.sqlite-fetch-column-types.php |
|
211 | - * @param string $table_name <p>The table name to query.</p> |
|
212 | - * @param int $result_type [optional] <p> |
|
213 | - * The optional <i>result_type</i> parameter accepts a |
|
214 | - * constant and determines how the returned array will be indexed. Using |
|
215 | - * <b>SQLITE_ASSOC</b> will return only associative indices |
|
216 | - * (named fields) while <b>SQLITE_NUM</b> will return only |
|
217 | - * numerical indices (ordinal field numbers). |
|
218 | - * <b>SQLITE_ASSOC</b> is the default for |
|
219 | - * this function. |
|
220 | - * </p> |
|
221 | - * @return array <p> |
|
222 | - * Returns an array of column data types; <b>FALSE</b> on error. |
|
223 | - * </p> |
|
224 | - * <p>The column names returned by |
|
225 | - * <b>SQLITE_ASSOC</b> and <b>SQLITE_BOTH</b> will be |
|
226 | - * case-folded according to the value of the |
|
227 | - * {@link https://php.net/manual/en/sqlite.configuration.php#ini.sqlite.assoc-case sqlite.assoc_case} configuration |
|
228 | - * option.</p> |
|
229 | - */ |
|
230 | - public function fetchColumnTypes($table_name, $result_type = SQLITE_ASSOC) {} |
|
11 | + /** |
|
12 | + * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) |
|
13 | + * @link https://php.net/manual/en/function.sqlite-open.php |
|
14 | + * @param string $filename <p>The filename of the SQLite database. If the file does not exist, SQLite will attempt to create it. PHP must have write permissions to the file if data is inserted, the database schema is modified or to create the database if it does not exist.</p> |
|
15 | + * @param int $mode [optional] <p>The mode of the file. Intended to be used to open the database in read-only mode. Presently, this parameter is ignored by the sqlite library. The default value for mode is the octal value 0666 and this is the recommended value.</p> |
|
16 | + * @param string &$error_message [optional] <p>Passed by reference and is set to hold a descriptive error message explaining why the database could not be opened if there was an error.</p> |
|
17 | + */ |
|
18 | + final public function __construct($filename, $mode = 0666, &$error_message) {} |
|
19 | + |
|
20 | + /** |
|
21 | + * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) |
|
22 | + * @link https://php.net/manual/en/function.sqlite-query.php |
|
23 | + * @param string $query <p> |
|
24 | + * The query to be executed. |
|
25 | + * </p> |
|
26 | + * <p> |
|
27 | + * Data inside the query should be {@link https://php.net/manual/en/function.sqlite-escape-string.php properly escaped}. |
|
28 | + * </p> |
|
29 | + * @param int $result_type [optional] |
|
30 | + * <p>The optional <i>result_type</i> parameter accepts a constant and determines how the returned array will be indexed. Using <b>SQLITE_ASSOC</b> will return only associative indices (named fields) while <b>SQLITE_NUM</b> will return only numerical indices (ordinal field numbers). <b>SQLITE_BOTH</b> will return both associative and numerical indices. <b>SQLITE_BOTH</b> is the default for this function.</p> |
|
31 | + * @param string &$error_message [optional] <p>The specified variable will be filled if an error occurs. This is specially important because SQL syntax errors can't be fetched using the {@see sqlite_last_error()} function.</p> |
|
32 | + * @return resource|false <p> |
|
33 | + * This function will return a result handle or <b>FALSE</b> on failure. |
|
34 | + * For queries that return rows, the result handle can then be used with |
|
35 | + * functions such as {@see sqlite_fetch_array()} and |
|
36 | + * {@see sqlite_seek()}. |
|
37 | + * </p> |
|
38 | + * <p> |
|
39 | + * Regardless of the query type, this function will return <b>FALSE</b> if the |
|
40 | + * query failed. |
|
41 | + * </p> |
|
42 | + * <p> |
|
43 | + * {@see sqlite_query()} returns a buffered, seekable result |
|
44 | + * handle. This is useful for reasonably small queries where you need to |
|
45 | + * be able to randomly access the rows. Buffered result handles will |
|
46 | + * allocate memory to hold the entire result and will not return until it |
|
47 | + * has been fetched. If you only need sequential access to the data, it is |
|
48 | + * recommended that you use the much higher performance |
|
49 | + * {@see sqlite_unbuffered_query()} instead. |
|
50 | + * </p> |
|
51 | + */ |
|
52 | + public function query($query, $result_type, &$error_message) {} |
|
53 | + |
|
54 | + /** |
|
55 | + * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) |
|
56 | + * @link https://php.net/manual/en/function.sqlite-exec.php |
|
57 | + * @param string $query <p> |
|
58 | + * The query to be executed. |
|
59 | + * </p> |
|
60 | + * <p> |
|
61 | + * Data inside the query should be {@link https://php.net/manual/en/function.sqlite-escape-string.php properly escaped}. |
|
62 | + * </p> |
|
63 | + * @param string &$error_message [optional] <p>The specified variable will be filled if an error occurs. This is specially important because SQL syntax errors can't be fetched using the |
|
64 | + * {@see sqlite_last_error()} function.</p> |
|
65 | + * @return bool <p> |
|
66 | + * This function will return a boolean result; <b>TRUE</b> for success or <b>FALSE</b> for failure. |
|
67 | + * If you need to run a query that returns rows, see {@see sqlite_query()}. |
|
68 | + * </p> |
|
69 | + * <p>The column names returned by |
|
70 | + * <b>SQLITE_ASSOC</b> and <b>SQLITE_BOTH</b> will be |
|
71 | + * case-folded according to the value of the |
|
72 | + * {@link https://php.net/manual/en/sqlite.configuration.php#ini.sqlite.assoc-case sqlite.assoc_case} configuration |
|
73 | + * option.</p> |
|
74 | + */ |
|
75 | + public function queryExec($query, &$error_message) {} |
|
76 | + |
|
77 | + /** |
|
78 | + * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) |
|
79 | + * Execute a query against a given database and returns an array |
|
80 | + * @link https://php.net/manual/en/function.sqlite-array-query.php |
|
81 | + * @param string $query <p> |
|
82 | + * The query to be executed. |
|
83 | + * </p> |
|
84 | + * <p> |
|
85 | + * Data inside the query should be {@link https://php.net/manual/en/function.sqlite-escape-string.php properly escaped}. |
|
86 | + * </p> |
|
87 | + * @param int $result_type [optional] <p>The optional <i>result_type</i> |
|
88 | + * parameter accepts a constant and determines how the returned array will be |
|
89 | + * indexed. Using <b>SQLITE_ASSOC</b> will return only associative |
|
90 | + * indices (named fields) while <b>SQLITE_NUM</b> will return |
|
91 | + * only numerical indices (ordinal field numbers). <b>SQLITE_BOTH</b> |
|
92 | + * will return both associative and numerical indices. |
|
93 | + * <b>SQLITE_BOTH</b> is the default for this function.</p> |
|
94 | + * @param bool $decode_binary [optional] <p>When the <i>decode_binary</i> |
|
95 | + * parameter is set to <b>TRUE</b> (the default), PHP will decode the binary encoding |
|
96 | + * it applied to the data if it was encoded using the |
|
97 | + * {@see sqlite_escape_string()}. You should normally leave this |
|
98 | + * value at its default, unless you are interoperating with databases created by |
|
99 | + * other sqlite capable applications.</p> |
|
100 | + * <p> |
|
101 | + * @return array|false |
|
102 | + * Returns an array of the entire result set; <b>FALSE</b> otherwise. |
|
103 | + * </p> |
|
104 | + * <p>The column names returned by |
|
105 | + * <b>SQLITE_ASSOC</b> and <b>SQLITE_BOTH</b> will be |
|
106 | + * case-folded according to the value of the |
|
107 | + * {@link https://php.net/manual/en/sqlite.configuration.php#ini.sqlite.assoc-case sqlite.assoc_case} configuration |
|
108 | + * option.</p> |
|
109 | + */ |
|
110 | + public function arrayQuery($query, $result_type, $decode_binary) {} |
|
111 | + |
|
112 | + /** |
|
113 | + * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.1) |
|
114 | + * Executes a query and returns either an array for one single column or the value of the first row |
|
115 | + * @link https://php.net/manual/en/function.sqlite-single-query.php |
|
116 | + * @param string $query |
|
117 | + * @param bool $first_row_only [optional] |
|
118 | + * @param bool $decode_binary [optional] |
|
119 | + * @return array |
|
120 | + */ |
|
121 | + public function singleQuery($query, $first_row_only, $decode_binary) {} |
|
122 | + |
|
123 | + /** |
|
124 | + * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) |
|
125 | + * Execute a query that does not prefetch and buffer all data |
|
126 | + * @link https://php.net/manual/en/function.sqlite-unbuffered-query.php |
|
127 | + * @param string $query <p> |
|
128 | + * The query to be executed. |
|
129 | + * </p> |
|
130 | + * <p> |
|
131 | + * Data inside the query should be {@link https://php.net/manual/en/function.sqlite-escape-string.php properly escaped}. |
|
132 | + * </p> |
|
133 | + * @param int $result_type [optional] <p>The optional <i>result_type</i> parameter accepts a constant and determines how the returned array will be indexed. |
|
134 | + * Using <b>SQLITE_ASSOC</b> will return only associative indices (named fields) while <b>SQLITE_NUM</b> will return only numerical indices (ordinal field numbers). |
|
135 | + * <b>SQLITE_BOTH</b> will return both associative and numerical indices. <b>SQLITE_BOTH</b> is the default for this function. |
|
136 | + * </p> |
|
137 | + * @param string &$error_message [optional] |
|
138 | + * @return resource Returns a result handle or <b>FALSE</b> on failure. |
|
139 | + * {@see sqlite_unbuffered_query()} returns a sequential forward-only result set that can only be used to read each row, one after the other. |
|
140 | + */ |
|
141 | + public function unbufferedQuery($query, $result_type = SQLITE_BOTH, &$error_message = null) {} |
|
142 | + |
|
143 | + /** |
|
144 | + * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) |
|
145 | + * Returns the rowid of the most recently inserted row |
|
146 | + * @link https://php.net/manual/en/function.sqlite-last-insert-rowid.php |
|
147 | + * @return int Returns the row id, as an integer. |
|
148 | + */ |
|
149 | + public function lastInsertRowid() {} |
|
150 | + |
|
151 | + /** |
|
152 | + * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) |
|
153 | + * Returns the number of rows that were changed by the most recent SQL statement |
|
154 | + * @link https://php.net/manual/en/function.sqlite-changes.php |
|
155 | + * @return int Returns the number of changed rows. |
|
156 | + */ |
|
157 | + public function changes() {} |
|
158 | + |
|
159 | + /** |
|
160 | + * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) |
|
161 | + * Register an aggregating UDF for use in SQL statements |
|
162 | + * @link https://php.net/manual/en/function.sqlite-create-aggregate.php |
|
163 | + * @param string $function_name <p>The name of the function used in SQL statements.</p> |
|
164 | + * @param callable $step_func <p>Callback function called for each row of the result set. Function parameters are &$context, $value, ....</p> |
|
165 | + * @param callable $finalize_func <p>Callback function to aggregate the "stepped" data from each row. Function parameter is &$context and the function should return the final result of aggregation.</p> |
|
166 | + * @param int $num_args [optional] <p>Hint to the SQLite parser if the callback function accepts a predetermined number of arguments.</p> |
|
167 | + */ |
|
168 | + public function createAggregate($function_name, $step_func, $finalize_func, $num_args = -1) {} |
|
169 | + |
|
170 | + /** |
|
171 | + * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) |
|
172 | + * Registers a "regular" User Defined Function for use in SQL statements |
|
173 | + * @link https://php.net/manual/en/function.sqlite-create-function.php |
|
174 | + * @param string $function_name <p>The name of the function used in SQL statements.</p> |
|
175 | + * @param callable $callback <p> |
|
176 | + * Callback function to handle the defined SQL function. |
|
177 | + * </p> |
|
178 | + * <blockquote><p><b>Note</b>: |
|
179 | + * Callback functions should return a type understood by SQLite (i.e. |
|
180 | + * {@link https://php.net/manual/en/language.types.intro.php scalar type}). |
|
181 | + * </p></blockquote> |
|
182 | + * @param int $num_args [optional] <blockquote><p><b>Note</b>: Two alternative syntaxes are |
|
183 | + * supported for compatibility with other database extensions (such as MySQL). |
|
184 | + * The preferred form is the first, where the <i>dbhandle</i> |
|
185 | + * parameter is the first parameter to the function.</p></blockquote> |
|
186 | + */ |
|
187 | + public function createFunction($function_name, $callback, $num_args = -1) {} |
|
188 | + |
|
189 | + /** |
|
190 | + * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) |
|
191 | + * Set busy timeout duration, or disable busy handlers |
|
192 | + * @link https://php.net/manual/en/function.sqlite-busy-timeout.php |
|
193 | + * @param int $milliseconds <p> The number of milliseconds. When set to 0, busy handlers will be disabled and SQLite will return immediately with a <b>SQLITE_BUSY</b> status code if another process/thread has the database locked for an update. |
|
194 | + * PHP sets the default busy timeout to be 60 seconds when the database is opened.</p> |
|
195 | + * @return int <p>Returns an error code, or 0 if no error occurred.</p> |
|
196 | + */ |
|
197 | + public function busyTimeout($milliseconds) {} |
|
198 | + |
|
199 | + /** |
|
200 | + * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) |
|
201 | + * Returns the error code of the last error for a database |
|
202 | + * @link https://php.net/manual/en/function.sqlite-last-error.php |
|
203 | + * @return int Returns an error code, or 0 if no error occurred. |
|
204 | + */ |
|
205 | + public function lastError() {} |
|
206 | + |
|
207 | + /** |
|
208 | + * (PHP 5 < 5.4.0) |
|
209 | + * Return an array of column types from a particular table |
|
210 | + * @link https://php.net/manual/en/function.sqlite-fetch-column-types.php |
|
211 | + * @param string $table_name <p>The table name to query.</p> |
|
212 | + * @param int $result_type [optional] <p> |
|
213 | + * The optional <i>result_type</i> parameter accepts a |
|
214 | + * constant and determines how the returned array will be indexed. Using |
|
215 | + * <b>SQLITE_ASSOC</b> will return only associative indices |
|
216 | + * (named fields) while <b>SQLITE_NUM</b> will return only |
|
217 | + * numerical indices (ordinal field numbers). |
|
218 | + * <b>SQLITE_ASSOC</b> is the default for |
|
219 | + * this function. |
|
220 | + * </p> |
|
221 | + * @return array <p> |
|
222 | + * Returns an array of column data types; <b>FALSE</b> on error. |
|
223 | + * </p> |
|
224 | + * <p>The column names returned by |
|
225 | + * <b>SQLITE_ASSOC</b> and <b>SQLITE_BOTH</b> will be |
|
226 | + * case-folded according to the value of the |
|
227 | + * {@link https://php.net/manual/en/sqlite.configuration.php#ini.sqlite.assoc-case sqlite.assoc_case} configuration |
|
228 | + * option.</p> |
|
229 | + */ |
|
230 | + public function fetchColumnTypes($table_name, $result_type = SQLITE_ASSOC) {} |
|
231 | 231 | } |
232 | 232 | |
233 | 233 | /** |
@@ -235,227 +235,227 @@ discard block |
||
235 | 235 | */ |
236 | 236 | final class SQLiteResult implements Iterator, Countable |
237 | 237 | { |
238 | - /** |
|
239 | - * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) |
|
240 | - * Fetches the next row from a result set as an array |
|
241 | - * @link https://php.net/manual/en/function.sqlite-fetch-array.php |
|
242 | - * @param int $result_type [optional] |
|
243 | - * <p> |
|
244 | - * The optional <i>result_type</i> |
|
245 | - * parameter accepts a constant and determines how the returned array will be |
|
246 | - * indexed. Using <b>SQLITE_ASSOC</b> will return only associative |
|
247 | - * indices (named fields) while <b>SQLITE_NUM</b> will return |
|
248 | - * only numerical indices (ordinal field numbers). <b>SQLITE_BOTH</b> |
|
249 | - * will return both associative and numerical indices. |
|
250 | - * <b>SQLITE_BOTH</b> is the default for this function. |
|
251 | - * </p> |
|
252 | - * @param bool $decode_binary [optional] <p>When the <i>decode_binary</i> |
|
253 | - * parameter is set to <b>TRUE</b> (the default), PHP will decode the binary encoding |
|
254 | - * it applied to the data if it was encoded using the |
|
255 | - * {@link https://php.net/manual/en/sqlite.configuration.php#ini.sqlite.assoc-case sqlite.assoc_case}. You should normally leave this |
|
256 | - * value at its default, unless you are interoperating with databases created by |
|
257 | - * other sqlite capable applications.</p> |
|
258 | - * @return array |
|
259 | - * <p> |
|
260 | - * Returns an array of the next row from a result set; <b>FALSE</b> if the |
|
261 | - * next position is beyond the final row. |
|
262 | - * </p> |
|
263 | - * <p>The column names returned by |
|
264 | - * <b>SQLITE_ASSOC</b> and <b>SQLITE_BOTH</b> will be |
|
265 | - * case-folded according to the value of the |
|
266 | - * {@link https://php.net/manual/en/sqlite.configuration.php#ini.sqlite.assoc-case sqlite.assoc_case} configuration |
|
267 | - * option.</p> |
|
268 | - */ |
|
269 | - public function fetch($result_type = SQLITE_BOTH, $decode_binary = true) {} |
|
270 | - |
|
271 | - /** |
|
272 | - * (PHP 5 < 5.4.0) |
|
273 | - * Fetches the next row from a result set as an object |
|
274 | - * @link https://php.net/manual/en/function.sqlite-fetch-object.php |
|
275 | - * @param string $class_name [optional] |
|
276 | - * @param array $ctor_params [optional] |
|
277 | - * @param bool $decode_binary [optional] |
|
278 | - * @return object |
|
279 | - */ |
|
280 | - public function fetchObject($class_name, $ctor_params, $decode_binary = true) {} |
|
281 | - |
|
282 | - /** |
|
283 | - * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.1) |
|
284 | - * Fetches the first column of a result set as a string |
|
285 | - * @link https://php.net/manual/en/function.sqlite-fetch-single.php |
|
286 | - * @param bool $decode_binary [optional] |
|
287 | - * @return string <p>Returns the first column value, as a string.</p> |
|
288 | - */ |
|
289 | - public function fetchSingle($decode_binary = true) {} |
|
290 | - |
|
291 | - /** |
|
292 | - * (PHP 5 < 5.4.0) |
|
293 | - * Fetches the next row from a result set as an object |
|
294 | - * @link https://www.php.net/manual/en/function.sqlite-fetch-all.php |
|
295 | - * @param int $result_type [optional] <p> |
|
296 | - * The optional result_type parameter accepts a constant and determines how the returned array will be indexed. |
|
297 | - * Using SQLITE_ASSOC will return only associative indices (named fields) while SQLITE_NUM will return only numerical indices (ordinal field numbers). |
|
298 | - * {@see SQLITE_BOTH} will return both associative and numerical indices. {@see SQLITE_BOTH} is the default for this function.</p> |
|
299 | - * @param bool $decode_binary [optional] <p> When the decode_binary parameter is set to TRUE (the default), |
|
300 | - * PHP will decode the binary encoding it applied to the data if it was encoded using the {@see sqlite_escape_string()}. |
|
301 | - * You should normally leave this value at its default, unless you are interoperating with databases created by other sqlite capable applications.</p> |
|
302 | - * @return object |
|
303 | - */ |
|
304 | - public function fetchAll($result_type, $decode_binary = true) {} |
|
305 | - |
|
306 | - /** |
|
307 | - * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) |
|
308 | - * Fetches a column from the current row of a result set |
|
309 | - * @link https://php.net/manual/en/function.sqlite-column.php |
|
310 | - * @param $index_or_name |
|
311 | - * @param $decode_binary [optional] <p>When the <i>decode_binary</i> |
|
312 | - * parameter is set to <b>TRUE</b> (the default), PHP will decode the binary encoding |
|
313 | - * it applied to the data if it was encoded using the |
|
314 | - * {@see sqlite_escape_string()}. You should normally leave this |
|
315 | - * value at its default, unless you are interoperating with databases created by |
|
316 | - * other sqlite capable applications.</p> |
|
317 | - * @return mixed <p>Returns the column value</p> |
|
318 | - */ |
|
319 | - public function column($index_or_name, $decode_binary = true) {} |
|
320 | - |
|
321 | - /** |
|
322 | - * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) |
|
323 | - * Returns the number of fields in a result set |
|
324 | - * @link https://php.net/manual/en/function.sqlite-num-fields.php |
|
325 | - * @return int <p>Returns the number of fields, as an integer.</p> |
|
326 | - */ |
|
327 | - public function numFields() {} |
|
328 | - |
|
329 | - /** |
|
330 | - * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) |
|
331 | - * Returns the name of a particular field |
|
332 | - * @link https://php.net/manual/en/function.sqlite-field-name.php |
|
333 | - * @param int $field_index <p>The ordinal column number in the result set.</p> |
|
334 | - * @return string <p> |
|
335 | - * Returns the name of a field in an SQLite result set, given the ordinal |
|
336 | - * column number; <b>FALSE</b> on error. |
|
337 | - * </p> |
|
338 | - * <p>The column names returned by |
|
339 | - * <b>SQLITE_ASSOC</b> and <b>SQLITE_BOTH</b> will be |
|
340 | - * case-folded according to the value of the |
|
341 | - * {@link https://php.net/manual/en/sqlite.configuration.php#ini.sqlite.assoc-case sqlite.assoc_case}configuration |
|
342 | - * option.</p> |
|
343 | - */ |
|
344 | - public function fieldName($field_index) {} |
|
345 | - |
|
346 | - /** |
|
347 | - * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) |
|
348 | - * Fetches the current row from a result set as an array |
|
349 | - * @link https://php.net/manual/en/function.sqlite-current.php |
|
350 | - * @param int $result_type [optional] <p>The optional <i>result_type</i> |
|
351 | - * parameter accepts a constant and determines how the returned array will be |
|
352 | - * indexed. Using {@see SQLITE_ASSOC} will return only associative |
|
353 | - * indices (named fields) while {@see SQLITE_NUM} will return |
|
354 | - * only numerical indices (ordinal field numbers). <b>SQLITE_BOTH</b> |
|
355 | - * will return both associative and numerical indices. |
|
356 | - * {@see SQLITE_BOTH} is the default for this function.</p> |
|
357 | - * @param bool $decode_binary [optional] <p>When the <i>decode_binary</i> |
|
358 | - * parameter is set to <b>TRUE</b> (the default), PHP will decode the binary encoding |
|
359 | - * it applied to the data if it was encoded using the |
|
360 | - * {@see sqlite_escape_string()}. You should normally leave this |
|
361 | - * value at its default, unless you are interoperating with databases created by |
|
362 | - * other sqlite capable applications.</p> |
|
363 | - * @return array <p> |
|
364 | - * Returns an array of the current row from a result set; <b>FALSE</b> if the |
|
365 | - * current position is beyond the final row. |
|
366 | - * </p> |
|
367 | - * <p>The column names returned by |
|
368 | - * <b>SQLITE_ASSOC</b> and <b>SQLITE_BOTH</b> will be |
|
369 | - * case-folded according to the value of the |
|
370 | - * {@link https://php.net/manual/en/sqlite.configuration.php#ini.sqlite.assoc-case sqlite.assoc_case} configuration |
|
371 | - * option.</p> |
|
372 | - */ |
|
373 | - public function current($result_type = SQLITE_BOTH, $decode_binary = true) {} |
|
374 | - /** |
|
375 | - * Return the key of the current element |
|
376 | - * @link https://php.net/manual/en/iterator.key.php |
|
377 | - * @return mixed scalar on success, or null on failure. |
|
378 | - * @since 5.0.0 |
|
379 | - */ |
|
380 | - public function key() {} |
|
381 | - /** |
|
382 | - * Seek to the next row number |
|
383 | - * @link https://php.net/manual/en/function.sqlite-next.php |
|
384 | - * @return bool Returns <b>TRUE</b> on success, or <b>FALSE</b> if there are no more rows. |
|
385 | - * @since 5.0.0 |
|
386 | - */ |
|
387 | - public function next() {} |
|
388 | - /** |
|
389 | - * Checks if current position is valid |
|
390 | - * @link https://php.net/manual/en/iterator.valid.php |
|
391 | - * @return bool <p> |
|
392 | - * Returns <b>TRUE</b> if there are more rows available from the |
|
393 | - * <i>result</i> handle, or <b>FALSE</b> otherwise. |
|
394 | - * </p> |
|
395 | - * @since 5.0.0 |
|
396 | - */ |
|
397 | - public function valid() {} |
|
398 | - /** |
|
399 | - * Rewind the Iterator to the first element |
|
400 | - * @link https://php.net/manual/en/iterator.rewind.php |
|
401 | - * @return void Any returned value is ignored. |
|
402 | - * @since 5.0.0 |
|
403 | - */ |
|
404 | - public function rewind() {} |
|
405 | - |
|
406 | - /** |
|
407 | - * Count elements of an object |
|
408 | - * @link https://php.net/manual/en/countable.count.php |
|
409 | - * @return int <p>The custom count as an integer. |
|
410 | - * </p> |
|
411 | - * <p> |
|
412 | - * The return value is cast to an integer. |
|
413 | - * </p> |
|
414 | - * @since 5.1.0 |
|
415 | - */ |
|
416 | - public function count() {} |
|
417 | - |
|
418 | - /** |
|
419 | - * Seek to the previous row number of a result set |
|
420 | - * @link https://php.net/manual/en/function.sqlite-prev.php |
|
421 | - * @return bool <p> Returns <b>TRUE</b> on success, or <b>FALSE</b> if there are no more previous rows. |
|
422 | - * </p> |
|
423 | - * @since 5.4.0 |
|
424 | - */ |
|
425 | - public function prev() {} |
|
426 | - |
|
427 | - /** |
|
428 | - *@since 5.4.0 |
|
429 | - * Returns whether or not a previous row is available |
|
430 | - * @link https://php.net/manual/en/function.sqlite-has-prev.php |
|
431 | - * @return bool <p> |
|
432 | - * Returns <b>TRUE</b> if there are more previous rows available from the |
|
433 | - * <i>result</i> handle, or <b>FALSE</b> otherwise. |
|
434 | - * </p> |
|
435 | - */ |
|
436 | - public function hasPrev() {} |
|
437 | - |
|
438 | - /** |
|
439 | - * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) |
|
440 | - * Returns the number of rows in a buffered result set |
|
441 | - * @link https://php.net/manual/en/function.sqlite-num-rows.php |
|
442 | - * @return int Returns the number of rows, as an integer. |
|
443 | - */ |
|
444 | - public function numRows() {} |
|
445 | - |
|
446 | - /** |
|
447 | - * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) |
|
448 | - * Seek to a particular row number of a buffered result set |
|
449 | - * @link https://php.net/manual/en/function.sqlite-seek.php |
|
450 | - * @param $row |
|
451 | - * <p> |
|
452 | - * The ordinal row number to seek to. The row number is zero-based (0 is |
|
453 | - * the first row). |
|
454 | - * </p> |
|
455 | - * <blockquote><p><b>Note</b>: </p><p>This function cannot be used with |
|
456 | - * unbuffered result handles.</p></blockquote> |
|
457 | - */ |
|
458 | - public function seek($row) {} |
|
238 | + /** |
|
239 | + * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) |
|
240 | + * Fetches the next row from a result set as an array |
|
241 | + * @link https://php.net/manual/en/function.sqlite-fetch-array.php |
|
242 | + * @param int $result_type [optional] |
|
243 | + * <p> |
|
244 | + * The optional <i>result_type</i> |
|
245 | + * parameter accepts a constant and determines how the returned array will be |
|
246 | + * indexed. Using <b>SQLITE_ASSOC</b> will return only associative |
|
247 | + * indices (named fields) while <b>SQLITE_NUM</b> will return |
|
248 | + * only numerical indices (ordinal field numbers). <b>SQLITE_BOTH</b> |
|
249 | + * will return both associative and numerical indices. |
|
250 | + * <b>SQLITE_BOTH</b> is the default for this function. |
|
251 | + * </p> |
|
252 | + * @param bool $decode_binary [optional] <p>When the <i>decode_binary</i> |
|
253 | + * parameter is set to <b>TRUE</b> (the default), PHP will decode the binary encoding |
|
254 | + * it applied to the data if it was encoded using the |
|
255 | + * {@link https://php.net/manual/en/sqlite.configuration.php#ini.sqlite.assoc-case sqlite.assoc_case}. You should normally leave this |
|
256 | + * value at its default, unless you are interoperating with databases created by |
|
257 | + * other sqlite capable applications.</p> |
|
258 | + * @return array |
|
259 | + * <p> |
|
260 | + * Returns an array of the next row from a result set; <b>FALSE</b> if the |
|
261 | + * next position is beyond the final row. |
|
262 | + * </p> |
|
263 | + * <p>The column names returned by |
|
264 | + * <b>SQLITE_ASSOC</b> and <b>SQLITE_BOTH</b> will be |
|
265 | + * case-folded according to the value of the |
|
266 | + * {@link https://php.net/manual/en/sqlite.configuration.php#ini.sqlite.assoc-case sqlite.assoc_case} configuration |
|
267 | + * option.</p> |
|
268 | + */ |
|
269 | + public function fetch($result_type = SQLITE_BOTH, $decode_binary = true) {} |
|
270 | + |
|
271 | + /** |
|
272 | + * (PHP 5 < 5.4.0) |
|
273 | + * Fetches the next row from a result set as an object |
|
274 | + * @link https://php.net/manual/en/function.sqlite-fetch-object.php |
|
275 | + * @param string $class_name [optional] |
|
276 | + * @param array $ctor_params [optional] |
|
277 | + * @param bool $decode_binary [optional] |
|
278 | + * @return object |
|
279 | + */ |
|
280 | + public function fetchObject($class_name, $ctor_params, $decode_binary = true) {} |
|
281 | + |
|
282 | + /** |
|
283 | + * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.1) |
|
284 | + * Fetches the first column of a result set as a string |
|
285 | + * @link https://php.net/manual/en/function.sqlite-fetch-single.php |
|
286 | + * @param bool $decode_binary [optional] |
|
287 | + * @return string <p>Returns the first column value, as a string.</p> |
|
288 | + */ |
|
289 | + public function fetchSingle($decode_binary = true) {} |
|
290 | + |
|
291 | + /** |
|
292 | + * (PHP 5 < 5.4.0) |
|
293 | + * Fetches the next row from a result set as an object |
|
294 | + * @link https://www.php.net/manual/en/function.sqlite-fetch-all.php |
|
295 | + * @param int $result_type [optional] <p> |
|
296 | + * The optional result_type parameter accepts a constant and determines how the returned array will be indexed. |
|
297 | + * Using SQLITE_ASSOC will return only associative indices (named fields) while SQLITE_NUM will return only numerical indices (ordinal field numbers). |
|
298 | + * {@see SQLITE_BOTH} will return both associative and numerical indices. {@see SQLITE_BOTH} is the default for this function.</p> |
|
299 | + * @param bool $decode_binary [optional] <p> When the decode_binary parameter is set to TRUE (the default), |
|
300 | + * PHP will decode the binary encoding it applied to the data if it was encoded using the {@see sqlite_escape_string()}. |
|
301 | + * You should normally leave this value at its default, unless you are interoperating with databases created by other sqlite capable applications.</p> |
|
302 | + * @return object |
|
303 | + */ |
|
304 | + public function fetchAll($result_type, $decode_binary = true) {} |
|
305 | + |
|
306 | + /** |
|
307 | + * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) |
|
308 | + * Fetches a column from the current row of a result set |
|
309 | + * @link https://php.net/manual/en/function.sqlite-column.php |
|
310 | + * @param $index_or_name |
|
311 | + * @param $decode_binary [optional] <p>When the <i>decode_binary</i> |
|
312 | + * parameter is set to <b>TRUE</b> (the default), PHP will decode the binary encoding |
|
313 | + * it applied to the data if it was encoded using the |
|
314 | + * {@see sqlite_escape_string()}. You should normally leave this |
|
315 | + * value at its default, unless you are interoperating with databases created by |
|
316 | + * other sqlite capable applications.</p> |
|
317 | + * @return mixed <p>Returns the column value</p> |
|
318 | + */ |
|
319 | + public function column($index_or_name, $decode_binary = true) {} |
|
320 | + |
|
321 | + /** |
|
322 | + * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) |
|
323 | + * Returns the number of fields in a result set |
|
324 | + * @link https://php.net/manual/en/function.sqlite-num-fields.php |
|
325 | + * @return int <p>Returns the number of fields, as an integer.</p> |
|
326 | + */ |
|
327 | + public function numFields() {} |
|
328 | + |
|
329 | + /** |
|
330 | + * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) |
|
331 | + * Returns the name of a particular field |
|
332 | + * @link https://php.net/manual/en/function.sqlite-field-name.php |
|
333 | + * @param int $field_index <p>The ordinal column number in the result set.</p> |
|
334 | + * @return string <p> |
|
335 | + * Returns the name of a field in an SQLite result set, given the ordinal |
|
336 | + * column number; <b>FALSE</b> on error. |
|
337 | + * </p> |
|
338 | + * <p>The column names returned by |
|
339 | + * <b>SQLITE_ASSOC</b> and <b>SQLITE_BOTH</b> will be |
|
340 | + * case-folded according to the value of the |
|
341 | + * {@link https://php.net/manual/en/sqlite.configuration.php#ini.sqlite.assoc-case sqlite.assoc_case}configuration |
|
342 | + * option.</p> |
|
343 | + */ |
|
344 | + public function fieldName($field_index) {} |
|
345 | + |
|
346 | + /** |
|
347 | + * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) |
|
348 | + * Fetches the current row from a result set as an array |
|
349 | + * @link https://php.net/manual/en/function.sqlite-current.php |
|
350 | + * @param int $result_type [optional] <p>The optional <i>result_type</i> |
|
351 | + * parameter accepts a constant and determines how the returned array will be |
|
352 | + * indexed. Using {@see SQLITE_ASSOC} will return only associative |
|
353 | + * indices (named fields) while {@see SQLITE_NUM} will return |
|
354 | + * only numerical indices (ordinal field numbers). <b>SQLITE_BOTH</b> |
|
355 | + * will return both associative and numerical indices. |
|
356 | + * {@see SQLITE_BOTH} is the default for this function.</p> |
|
357 | + * @param bool $decode_binary [optional] <p>When the <i>decode_binary</i> |
|
358 | + * parameter is set to <b>TRUE</b> (the default), PHP will decode the binary encoding |
|
359 | + * it applied to the data if it was encoded using the |
|
360 | + * {@see sqlite_escape_string()}. You should normally leave this |
|
361 | + * value at its default, unless you are interoperating with databases created by |
|
362 | + * other sqlite capable applications.</p> |
|
363 | + * @return array <p> |
|
364 | + * Returns an array of the current row from a result set; <b>FALSE</b> if the |
|
365 | + * current position is beyond the final row. |
|
366 | + * </p> |
|
367 | + * <p>The column names returned by |
|
368 | + * <b>SQLITE_ASSOC</b> and <b>SQLITE_BOTH</b> will be |
|
369 | + * case-folded according to the value of the |
|
370 | + * {@link https://php.net/manual/en/sqlite.configuration.php#ini.sqlite.assoc-case sqlite.assoc_case} configuration |
|
371 | + * option.</p> |
|
372 | + */ |
|
373 | + public function current($result_type = SQLITE_BOTH, $decode_binary = true) {} |
|
374 | + /** |
|
375 | + * Return the key of the current element |
|
376 | + * @link https://php.net/manual/en/iterator.key.php |
|
377 | + * @return mixed scalar on success, or null on failure. |
|
378 | + * @since 5.0.0 |
|
379 | + */ |
|
380 | + public function key() {} |
|
381 | + /** |
|
382 | + * Seek to the next row number |
|
383 | + * @link https://php.net/manual/en/function.sqlite-next.php |
|
384 | + * @return bool Returns <b>TRUE</b> on success, or <b>FALSE</b> if there are no more rows. |
|
385 | + * @since 5.0.0 |
|
386 | + */ |
|
387 | + public function next() {} |
|
388 | + /** |
|
389 | + * Checks if current position is valid |
|
390 | + * @link https://php.net/manual/en/iterator.valid.php |
|
391 | + * @return bool <p> |
|
392 | + * Returns <b>TRUE</b> if there are more rows available from the |
|
393 | + * <i>result</i> handle, or <b>FALSE</b> otherwise. |
|
394 | + * </p> |
|
395 | + * @since 5.0.0 |
|
396 | + */ |
|
397 | + public function valid() {} |
|
398 | + /** |
|
399 | + * Rewind the Iterator to the first element |
|
400 | + * @link https://php.net/manual/en/iterator.rewind.php |
|
401 | + * @return void Any returned value is ignored. |
|
402 | + * @since 5.0.0 |
|
403 | + */ |
|
404 | + public function rewind() {} |
|
405 | + |
|
406 | + /** |
|
407 | + * Count elements of an object |
|
408 | + * @link https://php.net/manual/en/countable.count.php |
|
409 | + * @return int <p>The custom count as an integer. |
|
410 | + * </p> |
|
411 | + * <p> |
|
412 | + * The return value is cast to an integer. |
|
413 | + * </p> |
|
414 | + * @since 5.1.0 |
|
415 | + */ |
|
416 | + public function count() {} |
|
417 | + |
|
418 | + /** |
|
419 | + * Seek to the previous row number of a result set |
|
420 | + * @link https://php.net/manual/en/function.sqlite-prev.php |
|
421 | + * @return bool <p> Returns <b>TRUE</b> on success, or <b>FALSE</b> if there are no more previous rows. |
|
422 | + * </p> |
|
423 | + * @since 5.4.0 |
|
424 | + */ |
|
425 | + public function prev() {} |
|
426 | + |
|
427 | + /** |
|
428 | + *@since 5.4.0 |
|
429 | + * Returns whether or not a previous row is available |
|
430 | + * @link https://php.net/manual/en/function.sqlite-has-prev.php |
|
431 | + * @return bool <p> |
|
432 | + * Returns <b>TRUE</b> if there are more previous rows available from the |
|
433 | + * <i>result</i> handle, or <b>FALSE</b> otherwise. |
|
434 | + * </p> |
|
435 | + */ |
|
436 | + public function hasPrev() {} |
|
437 | + |
|
438 | + /** |
|
439 | + * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) |
|
440 | + * Returns the number of rows in a buffered result set |
|
441 | + * @link https://php.net/manual/en/function.sqlite-num-rows.php |
|
442 | + * @return int Returns the number of rows, as an integer. |
|
443 | + */ |
|
444 | + public function numRows() {} |
|
445 | + |
|
446 | + /** |
|
447 | + * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) |
|
448 | + * Seek to a particular row number of a buffered result set |
|
449 | + * @link https://php.net/manual/en/function.sqlite-seek.php |
|
450 | + * @param $row |
|
451 | + * <p> |
|
452 | + * The ordinal row number to seek to. The row number is zero-based (0 is |
|
453 | + * the first row). |
|
454 | + * </p> |
|
455 | + * <blockquote><p><b>Note</b>: </p><p>This function cannot be used with |
|
456 | + * unbuffered result handles.</p></blockquote> |
|
457 | + */ |
|
458 | + public function seek($row) {} |
|
459 | 459 | } |
460 | 460 | |
461 | 461 | /** |
@@ -464,88 +464,88 @@ discard block |
||
464 | 464 | */ |
465 | 465 | final class SQLiteUnbuffered |
466 | 466 | { |
467 | - /** |
|
468 | - * @param int $result_type [optional] |
|
469 | - * @param bool $decode_binary [optional] |
|
470 | - */ |
|
471 | - public function fetch($result_type, $decode_binary) {} |
|
472 | - |
|
473 | - /** |
|
474 | - * @link https://www.php.net/manual/en/function.sqlite-fetch-object.php |
|
475 | - * @param string $class_name [optional] |
|
476 | - * @param array $ctor_params [optional] |
|
477 | - * @param bool $decode_binary [optional] |
|
478 | - */ |
|
479 | - public function fetchObject($class_name, $ctor_params, $decode_binary) {} |
|
480 | - |
|
481 | - /** |
|
482 | - * @param bool $decode_binary [optional] |
|
483 | - */ |
|
484 | - public function fetchSingle($decode_binary) {} |
|
485 | - |
|
486 | - /** |
|
487 | - * @param int $result_type [optional] |
|
488 | - * @param bool $decode_binary [optional] |
|
489 | - */ |
|
490 | - public function fetchAll($result_type, $decode_binary) {} |
|
491 | - |
|
492 | - /** |
|
493 | - * @param $index_or_name |
|
494 | - * @param $decode_binary [optional] |
|
495 | - */ |
|
496 | - public function column($index_or_name, $decode_binary) {} |
|
497 | - |
|
498 | - public function numFields() {} |
|
499 | - |
|
500 | - /** |
|
501 | - * @param int $field_index |
|
502 | - */ |
|
503 | - public function fieldName($field_index) {} |
|
504 | - |
|
505 | - /** |
|
506 | - * @param int $result_type [optional] |
|
507 | - * @param bool $decode_binary [optional] |
|
508 | - */ |
|
509 | - public function current($result_type, $decode_binary) {} |
|
510 | - |
|
511 | - public function next() {} |
|
512 | - |
|
513 | - public function valid() {} |
|
467 | + /** |
|
468 | + * @param int $result_type [optional] |
|
469 | + * @param bool $decode_binary [optional] |
|
470 | + */ |
|
471 | + public function fetch($result_type, $decode_binary) {} |
|
472 | + |
|
473 | + /** |
|
474 | + * @link https://www.php.net/manual/en/function.sqlite-fetch-object.php |
|
475 | + * @param string $class_name [optional] |
|
476 | + * @param array $ctor_params [optional] |
|
477 | + * @param bool $decode_binary [optional] |
|
478 | + */ |
|
479 | + public function fetchObject($class_name, $ctor_params, $decode_binary) {} |
|
480 | + |
|
481 | + /** |
|
482 | + * @param bool $decode_binary [optional] |
|
483 | + */ |
|
484 | + public function fetchSingle($decode_binary) {} |
|
485 | + |
|
486 | + /** |
|
487 | + * @param int $result_type [optional] |
|
488 | + * @param bool $decode_binary [optional] |
|
489 | + */ |
|
490 | + public function fetchAll($result_type, $decode_binary) {} |
|
491 | + |
|
492 | + /** |
|
493 | + * @param $index_or_name |
|
494 | + * @param $decode_binary [optional] |
|
495 | + */ |
|
496 | + public function column($index_or_name, $decode_binary) {} |
|
497 | + |
|
498 | + public function numFields() {} |
|
499 | + |
|
500 | + /** |
|
501 | + * @param int $field_index |
|
502 | + */ |
|
503 | + public function fieldName($field_index) {} |
|
504 | + |
|
505 | + /** |
|
506 | + * @param int $result_type [optional] |
|
507 | + * @param bool $decode_binary [optional] |
|
508 | + */ |
|
509 | + public function current($result_type, $decode_binary) {} |
|
510 | + |
|
511 | + public function next() {} |
|
512 | + |
|
513 | + public function valid() {} |
|
514 | 514 | } |
515 | 515 | |
516 | 516 | final class SQLiteException extends RuntimeException |
517 | 517 | { |
518 | - protected $message; |
|
519 | - protected $code; |
|
520 | - protected $file; |
|
521 | - protected $line; |
|
522 | - |
|
523 | - /** |
|
524 | - * Clone the exception |
|
525 | - * @link https://php.net/manual/en/exception.clone.php |
|
526 | - * @return void |
|
527 | - * @since 5.1.0 |
|
528 | - */ |
|
529 | - final private function __clone() {} |
|
530 | - |
|
531 | - /** |
|
532 | - * Construct the exception |
|
533 | - * @link https://php.net/manual/en/exception.construct.php |
|
534 | - * @param $message [optional] |
|
535 | - * @param $code [optional] |
|
536 | - * @param $previous [optional] |
|
537 | - * @since 5.1.0 |
|
538 | - */ |
|
539 | - #[Pure] |
|
540 | - public function __construct($message, $code, $previous) {} |
|
541 | - |
|
542 | - /** |
|
543 | - * String representation of the exception |
|
544 | - * @link https://php.net/manual/en/exception.tostring.php |
|
545 | - * @return string the string representation of the exception. |
|
546 | - * @since 5.1.0 |
|
547 | - */ |
|
548 | - public function __toString() {} |
|
518 | + protected $message; |
|
519 | + protected $code; |
|
520 | + protected $file; |
|
521 | + protected $line; |
|
522 | + |
|
523 | + /** |
|
524 | + * Clone the exception |
|
525 | + * @link https://php.net/manual/en/exception.clone.php |
|
526 | + * @return void |
|
527 | + * @since 5.1.0 |
|
528 | + */ |
|
529 | + final private function __clone() {} |
|
530 | + |
|
531 | + /** |
|
532 | + * Construct the exception |
|
533 | + * @link https://php.net/manual/en/exception.construct.php |
|
534 | + * @param $message [optional] |
|
535 | + * @param $code [optional] |
|
536 | + * @param $previous [optional] |
|
537 | + * @since 5.1.0 |
|
538 | + */ |
|
539 | + #[Pure] |
|
540 | + public function __construct($message, $code, $previous) {} |
|
541 | + |
|
542 | + /** |
|
543 | + * String representation of the exception |
|
544 | + * @link https://php.net/manual/en/exception.tostring.php |
|
545 | + * @return string the string representation of the exception. |
|
546 | + * @since 5.1.0 |
|
547 | + */ |
|
548 | + public function __toString() {} |
|
549 | 549 | } |
550 | 550 | |
551 | 551 | /** |
@@ -6,8 +6,7 @@ discard block |
||
6 | 6 | /** |
7 | 7 | * @link https://php.net/manual/en/ref.sqlite.php |
8 | 8 | */ |
9 | -class SQLiteDatabase |
|
10 | -{ |
|
9 | +class SQLiteDatabase { |
|
11 | 10 | /** |
12 | 11 | * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) |
13 | 12 | * @link https://php.net/manual/en/function.sqlite-open.php |
@@ -462,8 +461,7 @@ discard block |
||
462 | 461 | * Represents an unbuffered SQLite result set. Unbuffered results sets are sequential, forward-seeking only. |
463 | 462 | * @link https://php.net/manual/en/ref.sqlite.php |
464 | 463 | */ |
465 | -final class SQLiteUnbuffered |
|
466 | -{ |
|
464 | +final class SQLiteUnbuffered { |
|
467 | 465 | /** |
468 | 466 | * @param int $result_type [optional] |
469 | 467 | * @param bool $decode_binary [optional] |
@@ -513,8 +511,7 @@ discard block |
||
513 | 511 | public function valid() {} |
514 | 512 | } |
515 | 513 | |
516 | -final class SQLiteException extends RuntimeException |
|
517 | -{ |
|
514 | +final class SQLiteException extends RuntimeException { |
|
518 | 515 | protected $message; |
519 | 516 | protected $code; |
520 | 517 | protected $file; |
@@ -813,11 +813,11 @@ |
||
813 | 813 | * or false for failure. |
814 | 814 | */ |
815 | 815 | function mb_convert_variables( |
816 | - string $to_encoding, |
|
817 | - array|string $from_encoding, |
|
818 | - #[PhpStormStubsElementAvailable(from: '5.3', to: '7.4')] &$vars, |
|
819 | - #[PhpStormStubsElementAvailable(from: '8.0')] mixed &$var, |
|
820 | - mixed &...$vars |
|
816 | + string $to_encoding, |
|
817 | + array|string $from_encoding, |
|
818 | + #[PhpStormStubsElementAvailable(from: '5.3', to: '7.4')] &$vars, |
|
819 | + #[PhpStormStubsElementAvailable(from: '8.0')] mixed &$var, |
|
820 | + mixed &...$vars |
|
821 | 821 | ): string|false {} |
822 | 822 | |
823 | 823 | /** |
@@ -72,7 +72,7 @@ discard block |
||
72 | 72 | * name as a string. If no language is set previously, it then returns |
73 | 73 | * false. |
74 | 74 | */ |
75 | -function mb_language(?string $language): string|bool {} |
|
75 | +function mb_language(?string $language): string | bool {} |
|
76 | 76 | |
77 | 77 | /** |
78 | 78 | * Set/Get internal character encoding |
@@ -88,7 +88,7 @@ discard block |
||
88 | 88 | * If encoding is omitted, then |
89 | 89 | * the current character encoding name is returned. |
90 | 90 | */ |
91 | -function mb_internal_encoding(?string $encoding): string|bool {} |
|
91 | +function mb_internal_encoding(?string $encoding): string | bool {} |
|
92 | 92 | |
93 | 93 | /** |
94 | 94 | * Detect HTTP input character encoding |
@@ -104,7 +104,7 @@ discard block |
||
104 | 104 | * HTTP input, it returns false. |
105 | 105 | */ |
106 | 106 | #[Pure] |
107 | -function mb_http_input(?string $type): array|string|false {} |
|
107 | +function mb_http_input(?string $type): array | string | false {} |
|
108 | 108 | |
109 | 109 | /** |
110 | 110 | * Set/Get HTTP output character encoding |
@@ -124,7 +124,7 @@ discard block |
||
124 | 124 | * character encoding. Otherwise, |
125 | 125 | * true on success or false on failure. |
126 | 126 | */ |
127 | -function mb_http_output(?string $encoding): string|bool {} |
|
127 | +function mb_http_output(?string $encoding): string | bool {} |
|
128 | 128 | |
129 | 129 | /** |
130 | 130 | * Set/Get character encoding detection order |
@@ -169,7 +169,7 @@ discard block |
||
169 | 169 | * When getting the encoding detection order, an ordered array |
170 | 170 | * of the encodings is returned. |
171 | 171 | */ |
172 | -function mb_detect_order(array|string|null $encoding = null): array|bool {} |
|
172 | +function mb_detect_order(array | string | null $encoding = null): array | bool {} |
|
173 | 173 | |
174 | 174 | /** |
175 | 175 | * Set/Get substitution character |
@@ -186,7 +186,7 @@ discard block |
||
186 | 186 | * If substchar is not set, it returns the Unicode value, |
187 | 187 | * or "none" or "long". |
188 | 188 | */ |
189 | -function mb_substitute_character(string|int|null $substitute_character = null): string|int|bool {} |
|
189 | +function mb_substitute_character(string | int | null $substitute_character = null): string | int | bool {} |
|
190 | 190 | |
191 | 191 | /** |
192 | 192 | * Parse GET/POST/COOKIE data and set global variable |
@@ -199,7 +199,7 @@ discard block |
||
199 | 199 | * </p> |
200 | 200 | * @return bool true on success or false on failure. |
201 | 201 | */ |
202 | -#[PhpStormStubsElementAvailable(from: '5.3', to: '7.4')] |
|
202 | +#[PhpStormStubsElementAvailable(from : '5.3', to : '7.4')] |
|
203 | 203 | function mb_parse_str(string $string, &$result): bool {} |
204 | 204 | |
205 | 205 | /** |
@@ -213,7 +213,7 @@ discard block |
||
213 | 213 | * </p> |
214 | 214 | * @return bool true on success or false on failure. |
215 | 215 | */ |
216 | -#[PhpStormStubsElementAvailable(from: '8.0')] |
|
216 | +#[PhpStormStubsElementAvailable(from : '8.0')] |
|
217 | 217 | function mb_parse_str(string $string, &$result): bool {} |
218 | 218 | |
219 | 219 | /** |
@@ -240,7 +240,7 @@ discard block |
||
240 | 240 | * encoding. |
241 | 241 | */ |
242 | 242 | #[Pure] |
243 | -function mb_preferred_mime_name(string $encoding): string|false {} |
|
243 | +function mb_preferred_mime_name(string $encoding): string | false {} |
|
244 | 244 | |
245 | 245 | /** |
246 | 246 | * Get string length |
@@ -255,8 +255,8 @@ discard block |
||
255 | 255 | * counted as 1. |
256 | 256 | */ |
257 | 257 | #[Pure] |
258 | -#[LanguageLevelTypeAware(['8.0' => 'int'], default: 'int|false')] |
|
259 | -function mb_strlen(string $string, #[LanguageLevelTypeAware(['8.0' => 'string|null'], default: 'string')] $encoding) {} |
|
258 | +#[LanguageLevelTypeAware(['8.0' => 'int'], default : 'int|false')] |
|
259 | +function mb_strlen(string $string, #[LanguageLevelTypeAware(['8.0' => 'string|null'], default : 'string')] $encoding) {} |
|
260 | 260 | |
261 | 261 | /** |
262 | 262 | * Find position of first occurrence of string in a string |
@@ -277,7 +277,7 @@ discard block |
||
277 | 277 | * needle is not found, it returns false. |
278 | 278 | */ |
279 | 279 | #[Pure] |
280 | -function mb_strpos(string $haystack, string $needle, int $offset = 0, ?string $encoding): int|false {} |
|
280 | +function mb_strpos(string $haystack, string $needle, int $offset = 0, ?string $encoding): int | false {} |
|
281 | 281 | |
282 | 282 | /** |
283 | 283 | * Find position of last occurrence of a string in a string |
@@ -299,7 +299,7 @@ discard block |
||
299 | 299 | * needle is not found, it returns false. |
300 | 300 | */ |
301 | 301 | #[Pure] |
302 | -function mb_strrpos(string $haystack, string $needle, int $offset = 0, ?string $encoding): int|false {} |
|
302 | +function mb_strrpos(string $haystack, string $needle, int $offset = 0, ?string $encoding): int | false {} |
|
303 | 303 | |
304 | 304 | /** |
305 | 305 | * Finds position of first occurrence of a string within another, case insensitive |
@@ -324,7 +324,7 @@ discard block |
||
324 | 324 | * string, or false if needle is not found. |
325 | 325 | */ |
326 | 326 | #[Pure] |
327 | -function mb_stripos(string $haystack, string $needle, int $offset = 0, ?string $encoding): int|false {} |
|
327 | +function mb_stripos(string $haystack, string $needle, int $offset = 0, ?string $encoding): int | false {} |
|
328 | 328 | |
329 | 329 | /** |
330 | 330 | * Finds position of last occurrence of a string within another, case insensitive |
@@ -350,7 +350,7 @@ discard block |
||
350 | 350 | * if needle is not found. |
351 | 351 | */ |
352 | 352 | #[Pure] |
353 | -function mb_strripos(string $haystack, string $needle, int $offset = 0, ?string $encoding): int|false {} |
|
353 | +function mb_strripos(string $haystack, string $needle, int $offset = 0, ?string $encoding): int | false {} |
|
354 | 354 | |
355 | 355 | /** |
356 | 356 | * Finds first occurrence of a string within another |
@@ -378,7 +378,7 @@ discard block |
||
378 | 378 | * or false if needle is not found. |
379 | 379 | */ |
380 | 380 | #[Pure] |
381 | -function mb_strstr(string $haystack, string $needle, bool $before_needle = false, ?string $encoding): string|false {} |
|
381 | +function mb_strstr(string $haystack, string $needle, bool $before_needle = false, ?string $encoding): string | false {} |
|
382 | 382 | |
383 | 383 | /** |
384 | 384 | * Finds the last occurrence of a character in a string within another |
@@ -406,7 +406,7 @@ discard block |
||
406 | 406 | * or false if needle is not found. |
407 | 407 | */ |
408 | 408 | #[Pure] |
409 | -function mb_strrchr(string $haystack, string $needle, bool $before_needle = false, ?string $encoding): string|false {} |
|
409 | +function mb_strrchr(string $haystack, string $needle, bool $before_needle = false, ?string $encoding): string | false {} |
|
410 | 410 | |
411 | 411 | /** |
412 | 412 | * Finds first occurrence of a string within another, case insensitive |
@@ -434,7 +434,7 @@ discard block |
||
434 | 434 | * or false if needle is not found. |
435 | 435 | */ |
436 | 436 | #[Pure] |
437 | -function mb_stristr(string $haystack, string $needle, bool $before_needle = false, ?string $encoding): string|false {} |
|
437 | +function mb_stristr(string $haystack, string $needle, bool $before_needle = false, ?string $encoding): string | false {} |
|
438 | 438 | |
439 | 439 | /** |
440 | 440 | * Finds the last occurrence of a character in a string within another, case insensitive |
@@ -462,7 +462,7 @@ discard block |
||
462 | 462 | * or false if needle is not found. |
463 | 463 | */ |
464 | 464 | #[Pure] |
465 | -function mb_strrichr(string $haystack, string $needle, bool $before_needle = false, ?string $encoding): string|false {} |
|
465 | +function mb_strrichr(string $haystack, string $needle, bool $before_needle = false, ?string $encoding): string | false {} |
|
466 | 466 | |
467 | 467 | /** |
468 | 468 | * Count the number of substring occurrences |
@@ -581,7 +581,7 @@ discard block |
||
581 | 581 | * @return array|string|false The encoded string. |
582 | 582 | */ |
583 | 583 | #[Pure] |
584 | -function mb_convert_encoding(array|string $string, string $to_encoding, array|string|null $from_encoding = null): array|string|false {} |
|
584 | +function mb_convert_encoding(array | string $string, string $to_encoding, array | string | null $from_encoding = null): array | string | false {} |
|
585 | 585 | |
586 | 586 | /** |
587 | 587 | * Detect character encoding |
@@ -607,7 +607,7 @@ discard block |
||
607 | 607 | * detected from the given string. |
608 | 608 | */ |
609 | 609 | #[Pure] |
610 | -function mb_detect_encoding(string $string, array|string|null $encodings = null, bool $strict = false): string|false {} |
|
610 | +function mb_detect_encoding(string $string, array | string | null $encodings = null, bool $strict = false): string | false {} |
|
611 | 611 | |
612 | 612 | /** |
613 | 613 | * Returns an array of all supported encodings |
@@ -624,7 +624,7 @@ discard block |
||
624 | 624 | * @link https://php.net/manual/en/function.mb-encoding-aliases.php |
625 | 625 | */ |
626 | 626 | #[Pure] |
627 | -#[LanguageLevelTypeAware(["8.0" => "array"], default: "array|false")] |
|
627 | +#[LanguageLevelTypeAware(["8.0" => "array"], default : "array|false")] |
|
628 | 628 | function mb_encoding_aliases(string $encoding) {} |
629 | 629 | |
630 | 630 | /** |
@@ -814,11 +814,11 @@ discard block |
||
814 | 814 | */ |
815 | 815 | function mb_convert_variables( |
816 | 816 | string $to_encoding, |
817 | - array|string $from_encoding, |
|
818 | - #[PhpStormStubsElementAvailable(from: '5.3', to: '7.4')] &$vars, |
|
819 | - #[PhpStormStubsElementAvailable(from: '8.0')] mixed &$var, |
|
817 | + array | string $from_encoding, |
|
818 | + #[PhpStormStubsElementAvailable(from : '5.3', to : '7.4')] & $vars, |
|
819 | + #[PhpStormStubsElementAvailable(from : '8.0')] mixed &$var, |
|
820 | 820 | mixed &...$vars |
821 | -): string|false {} |
|
821 | +): string | false {} |
|
822 | 822 | |
823 | 823 | /** |
824 | 824 | * Encode character to HTML numeric string reference |
@@ -854,8 +854,8 @@ discard block |
||
854 | 854 | * @return string|false|null The converted string. |
855 | 855 | */ |
856 | 856 | #[Pure] |
857 | -#[LanguageLevelTypeAware(['8.0' => 'string'], default: 'string|false|null')] |
|
858 | -function mb_decode_numericentity(string $string, array $map, ?string $encoding = null, #[PhpStormStubsElementAvailable(from: '7.2', to: '7.4')] $is_hex = false) {} |
|
857 | +#[LanguageLevelTypeAware(['8.0' => 'string'], default : 'string|false|null')] |
|
858 | +function mb_decode_numericentity(string $string, array $map, ?string $encoding = null, #[PhpStormStubsElementAvailable(from : '7.2', to : '7.4')] $is_hex = false) {} |
|
859 | 859 | |
860 | 860 | /** |
861 | 861 | * Send encoded mail |
@@ -886,7 +886,7 @@ discard block |
||
886 | 886 | * </p> |
887 | 887 | * @return bool true on success or false on failure. |
888 | 888 | */ |
889 | -function mb_send_mail(string $to, string $subject, string $message, array|string $additional_headers, ?string $additional_params): bool {} |
|
889 | +function mb_send_mail(string $to, string $subject, string $message, array | string $additional_headers, ?string $additional_params): bool {} |
|
890 | 890 | |
891 | 891 | /** |
892 | 892 | * Get internal settings of mbstring |
@@ -906,7 +906,7 @@ discard block |
||
906 | 906 | * is not specified, otherwise a specific type. |
907 | 907 | */ |
908 | 908 | #[Pure] |
909 | -function mb_get_info(string $type = 'all'): array|string|int|false {} |
|
909 | +function mb_get_info(string $type = 'all'): array | string | int | false {} |
|
910 | 910 | |
911 | 911 | /** |
912 | 912 | * Check if the string is valid for the specified encoding |
@@ -922,7 +922,7 @@ discard block |
||
922 | 922 | * @since 5.1.3 |
923 | 923 | */ |
924 | 924 | #[Pure] |
925 | -function mb_check_encoding(array|string|null $value = null, ?string $encoding): bool {} |
|
925 | +function mb_check_encoding(array | string | null $value = null, ?string $encoding): bool {} |
|
926 | 926 | |
927 | 927 | /** |
928 | 928 | * Returns current encoding for multibyte regex as string |
@@ -933,7 +933,7 @@ discard block |
||
933 | 933 | * is NOT changed. If encoding is omitted, then the current character |
934 | 934 | * encoding name for a multibyte regex is returned. |
935 | 935 | */ |
936 | -function mb_regex_encoding(?string $encoding): string|bool {} |
|
936 | +function mb_regex_encoding(?string $encoding): string | bool {} |
|
937 | 937 | |
938 | 938 | /** |
939 | 939 | * Set/Get the default options for mbregex functions |
@@ -976,7 +976,7 @@ discard block |
||
976 | 976 | * </p> |
977 | 977 | * @return bool|int |
978 | 978 | */ |
979 | -#[LanguageLevelTypeAware(["8.0" => "bool"], default: "false|int")] |
|
979 | +#[LanguageLevelTypeAware(["8.0" => "bool"], default : "false|int")] |
|
980 | 980 | function mb_eregi(string $pattern, string $string, &$matches): bool {} |
981 | 981 | |
982 | 982 | /** |
@@ -1008,7 +1008,7 @@ discard block |
||
1008 | 1008 | * @return string|false|null The resultant string on success, or false on error. |
1009 | 1009 | */ |
1010 | 1010 | #[Pure] |
1011 | -function mb_ereg_replace(string $pattern, string $replacement, string $string, ?string $options = "msr"): string|false|null {} |
|
1011 | +function mb_ereg_replace(string $pattern, string $replacement, string $string, ?string $options = "msr"): string | false | null {} |
|
1012 | 1012 | |
1013 | 1013 | /** |
1014 | 1014 | * Perform a regular expresssion seach and replace with multibyte support using a callback |
@@ -1053,7 +1053,7 @@ discard block |
||
1053 | 1053 | * </p> |
1054 | 1054 | * @since 5.4.1 |
1055 | 1055 | */ |
1056 | -function mb_ereg_replace_callback(string $pattern, callable $callback, string $string, ?string $options = "msr"): string|false|null {} |
|
1056 | +function mb_ereg_replace_callback(string $pattern, callable $callback, string $string, ?string $options = "msr"): string | false | null {} |
|
1057 | 1057 | |
1058 | 1058 | /** |
1059 | 1059 | * Replace regular expression with multibyte support ignoring case |
@@ -1073,7 +1073,7 @@ discard block |
||
1073 | 1073 | * @return string|false|null The resultant string or false on error. |
1074 | 1074 | */ |
1075 | 1075 | #[Pure] |
1076 | -function mb_eregi_replace(string $pattern, string $replacement, string $string, ?string $options = "msr"): string|false|null {} |
|
1076 | +function mb_eregi_replace(string $pattern, string $replacement, string $string, ?string $options = "msr"): string | false | null {} |
|
1077 | 1077 | |
1078 | 1078 | /** |
1079 | 1079 | * Split multibyte string using regular expression |
@@ -1090,7 +1090,7 @@ discard block |
||
1090 | 1090 | * @return string[]|false The result as an array. |
1091 | 1091 | */ |
1092 | 1092 | #[Pure] |
1093 | -function mb_split(string $pattern, string $string, int $limit = -1): array|false {} |
|
1093 | +function mb_split(string $pattern, string $string, int $limit = -1): array | false {} |
|
1094 | 1094 | |
1095 | 1095 | /** |
1096 | 1096 | * Regular expression match for multibyte string |
@@ -1137,7 +1137,7 @@ discard block |
||
1137 | 1137 | * length in bytes of the match. If an error occurs, FALSE is returned. |
1138 | 1138 | */ |
1139 | 1139 | #[Pure] |
1140 | -function mb_ereg_search_pos(?string $pattern, ?string $options): array|false {} |
|
1140 | +function mb_ereg_search_pos(?string $pattern, ?string $options): array | false {} |
|
1141 | 1141 | |
1142 | 1142 | /** |
1143 | 1143 | * Returns the matched part of a multibyte regular expression |
@@ -1155,7 +1155,7 @@ discard block |
||
1155 | 1155 | * part as third element, and so on. It returns FALSE on error. |
1156 | 1156 | */ |
1157 | 1157 | #[Pure] |
1158 | -function mb_ereg_search_regs(?string $pattern, ?string $options): array|false {} |
|
1158 | +function mb_ereg_search_regs(?string $pattern, ?string $options): array | false {} |
|
1159 | 1159 | |
1160 | 1160 | /** |
1161 | 1161 | * Setup string and regular expression for a multibyte regular expression match |
@@ -1184,7 +1184,7 @@ discard block |
||
1184 | 1184 | * brackets, and so on. It returns FALSE on error; |
1185 | 1185 | */ |
1186 | 1186 | #[Pure] |
1187 | -function mb_ereg_search_getregs(): array|false {} |
|
1187 | +function mb_ereg_search_getregs(): array | false {} |
|
1188 | 1188 | |
1189 | 1189 | /** |
1190 | 1190 | * Returns start point for next regular expression match |
@@ -1192,7 +1192,7 @@ discard block |
||
1192 | 1192 | * @return int |
1193 | 1193 | */ |
1194 | 1194 | #[Pure] |
1195 | -#[Deprecated(since: '7.3')] |
|
1195 | +#[Deprecated(since : '7.3')] |
|
1196 | 1196 | function mb_ereg_search_getpos(): int {} |
1197 | 1197 | |
1198 | 1198 | /** |
@@ -1211,7 +1211,7 @@ discard block |
||
1211 | 1211 | * @see mb_regex_encoding |
1212 | 1212 | * @removed 8.0 |
1213 | 1213 | */ |
1214 | -#[Deprecated(replacement: "mb_regex_encoding(%parametersList%)", since: "7.3")] |
|
1214 | +#[Deprecated(replacement : "mb_regex_encoding(%parametersList%)", since : "7.3")] |
|
1215 | 1215 | function mbregex_encoding($encoding) {} |
1216 | 1216 | |
1217 | 1217 | /** |
@@ -1221,7 +1221,7 @@ discard block |
||
1221 | 1221 | * @see mb_ereg |
1222 | 1222 | * @removed 8.0 |
1223 | 1223 | */ |
1224 | -#[Deprecated(replacement: 'mb_ereg(%parametersList%)', since: '7.3')] |
|
1224 | +#[Deprecated(replacement : 'mb_ereg(%parametersList%)', since : '7.3')] |
|
1225 | 1225 | function mbereg(string $pattern, string $string, array &$registers) {} |
1226 | 1226 | |
1227 | 1227 | /** |
@@ -1231,7 +1231,7 @@ discard block |
||
1231 | 1231 | * @see mb_eregi |
1232 | 1232 | * @removed 8.0 |
1233 | 1233 | */ |
1234 | -#[Deprecated(replacement: "mb_eregi(%parametersList%)", since: "7.3")] |
|
1234 | +#[Deprecated(replacement : "mb_eregi(%parametersList%)", since : "7.3")] |
|
1235 | 1235 | function mberegi(string $pattern, string $string, array &$registers) {} |
1236 | 1236 | |
1237 | 1237 | /** |
@@ -1242,7 +1242,7 @@ discard block |
||
1242 | 1242 | * @see mb_ereg_replace |
1243 | 1243 | * @removed 8.0 |
1244 | 1244 | */ |
1245 | -#[Deprecated(replacement: 'mb_ereg_replace(%parametersList%)', since: '7.3')] |
|
1245 | +#[Deprecated(replacement : 'mb_ereg_replace(%parametersList%)', since : '7.3')] |
|
1246 | 1246 | function mbereg_replace($pattern, $replacement, $string, $option) {} |
1247 | 1247 | |
1248 | 1248 | /** |
@@ -1254,7 +1254,7 @@ discard block |
||
1254 | 1254 | * @see mb_eregi_replace |
1255 | 1255 | * @removed 8.0 |
1256 | 1256 | */ |
1257 | -#[Deprecated(replacement: "mb_eregi_replace(%parametersList%)", since: "7.3")] |
|
1257 | +#[Deprecated(replacement : "mb_eregi_replace(%parametersList%)", since : "7.3")] |
|
1258 | 1258 | function mberegi_replace($pattern, $replacement, $string, string $option = "msri"): string {} |
1259 | 1259 | |
1260 | 1260 | /** |
@@ -1264,7 +1264,7 @@ discard block |
||
1264 | 1264 | * @see mb_split |
1265 | 1265 | * @removed 8.0 |
1266 | 1266 | */ |
1267 | -#[Deprecated(replacement: 'mb_split(%parametersList%)', since: '7.3')] |
|
1267 | +#[Deprecated(replacement : 'mb_split(%parametersList%)', since : '7.3')] |
|
1268 | 1268 | function mbsplit($pattern, $string, $limit) {} |
1269 | 1269 | |
1270 | 1270 | /** |
@@ -1274,7 +1274,7 @@ discard block |
||
1274 | 1274 | * @see mb_ereg_match |
1275 | 1275 | * @removed 8.0 |
1276 | 1276 | */ |
1277 | -#[Deprecated(replacement: "mb_ereg_match(%parametersList%)", since: "7.3")] |
|
1277 | +#[Deprecated(replacement : "mb_ereg_match(%parametersList%)", since : "7.3")] |
|
1278 | 1278 | function mbereg_match($pattern, $string, $option) {} |
1279 | 1279 | |
1280 | 1280 | /** |
@@ -1283,7 +1283,7 @@ discard block |
||
1283 | 1283 | * @see mb_ereg_search |
1284 | 1284 | * @removed 8.0 |
1285 | 1285 | */ |
1286 | -#[Deprecated("use mb_ereg_search instead", replacement: "mb_ereg_search(%parametersList%)", since: "7.3")] |
|
1286 | +#[Deprecated("use mb_ereg_search instead", replacement : "mb_ereg_search(%parametersList%)", since : "7.3")] |
|
1287 | 1287 | function mbereg_search($pattern, $option) {} |
1288 | 1288 | |
1289 | 1289 | /** |
@@ -1292,7 +1292,7 @@ discard block |
||
1292 | 1292 | * @see mb_ereg_search_pos |
1293 | 1293 | * @removed 8.0 |
1294 | 1294 | */ |
1295 | -#[Deprecated(replacement: "mb_ereg_search_pos(%parametersList%)", since: "7.3")] |
|
1295 | +#[Deprecated(replacement : "mb_ereg_search_pos(%parametersList%)", since : "7.3")] |
|
1296 | 1296 | function mbereg_search_pos($pattern, $option) {} |
1297 | 1297 | |
1298 | 1298 | /** |
@@ -1301,7 +1301,7 @@ discard block |
||
1301 | 1301 | * @see mb_ereg_search_regs |
1302 | 1302 | * @removed 8.0 |
1303 | 1303 | */ |
1304 | -#[Deprecated(replacement: 'mb_ereg_search_regs(%parametersList%)', since: '7.3')] |
|
1304 | +#[Deprecated(replacement : 'mb_ereg_search_regs(%parametersList%)', since : '7.3')] |
|
1305 | 1305 | function mbereg_search_regs($pattern, $option) {} |
1306 | 1306 | |
1307 | 1307 | /** |
@@ -1311,21 +1311,21 @@ discard block |
||
1311 | 1311 | * @see mb_ereg_search_init |
1312 | 1312 | * @removed 8.0 |
1313 | 1313 | */ |
1314 | -#[Deprecated(replacement: "mb_ereg_search_init(%parametersList%)", since: "7.3")] |
|
1314 | +#[Deprecated(replacement : "mb_ereg_search_init(%parametersList%)", since : "7.3")] |
|
1315 | 1315 | function mbereg_search_init($string, $pattern, $option) {} |
1316 | 1316 | |
1317 | 1317 | /** |
1318 | 1318 | * @see mb_ereg_search_getregs |
1319 | 1319 | * @removed 8.0 |
1320 | 1320 | */ |
1321 | -#[Deprecated(replacement: 'mb_ereg_search_getregs(%parametersList%)', since: '7.3')] |
|
1321 | +#[Deprecated(replacement : 'mb_ereg_search_getregs(%parametersList%)', since : '7.3')] |
|
1322 | 1322 | function mbereg_search_getregs() {} |
1323 | 1323 | |
1324 | 1324 | /** |
1325 | 1325 | * @see mb_ereg_search_getpos |
1326 | 1326 | * @removed 8.0 |
1327 | 1327 | */ |
1328 | -#[Deprecated(replacement: "mb_ereg_search_getpos()", since: "7.3")] |
|
1328 | +#[Deprecated(replacement : "mb_ereg_search_getpos()", since : "7.3")] |
|
1329 | 1329 | function mbereg_search_getpos() {} |
1330 | 1330 | |
1331 | 1331 | /** |
@@ -1337,7 +1337,7 @@ discard block |
||
1337 | 1337 | * @since 7.2 |
1338 | 1338 | */ |
1339 | 1339 | #[Pure] |
1340 | -function mb_chr(int $codepoint, ?string $encoding): string|false {} |
|
1340 | +function mb_chr(int $codepoint, ?string $encoding): string | false {} |
|
1341 | 1341 | |
1342 | 1342 | /** |
1343 | 1343 | * Get code point of character |
@@ -1348,7 +1348,7 @@ discard block |
||
1348 | 1348 | * @since 7.2 |
1349 | 1349 | */ |
1350 | 1350 | #[Pure] |
1351 | -function mb_ord(string $string, ?string $encoding): int|false {} |
|
1351 | +function mb_ord(string $string, ?string $encoding): int | false {} |
|
1352 | 1352 | |
1353 | 1353 | /** |
1354 | 1354 | * Scrub broken multibyte strings. |
@@ -1359,14 +1359,14 @@ discard block |
||
1359 | 1359 | * @since 7.2 |
1360 | 1360 | */ |
1361 | 1361 | #[Pure] |
1362 | -#[LanguageLevelTypeAware(["8.0" => "string"], default: "string|false")] |
|
1363 | -function mb_scrub(string $string, ?string $encoding): false|string {} |
|
1362 | +#[LanguageLevelTypeAware(["8.0" => "string"], default : "string|false")] |
|
1363 | +function mb_scrub(string $string, ?string $encoding): false | string {} |
|
1364 | 1364 | |
1365 | 1365 | /** |
1366 | 1366 | * @param $position |
1367 | 1367 | * @see mb_ereg_search_setpos |
1368 | 1368 | */ |
1369 | -#[Deprecated(replacement: "mb_ereg_search_setpos(%parametersList%)", since: "7.3")] |
|
1369 | +#[Deprecated(replacement : "mb_ereg_search_setpos(%parametersList%)", since : "7.3")] |
|
1370 | 1370 | #[Pure] |
1371 | 1371 | function mbereg_search_setpos($position) {} |
1372 | 1372 | |
@@ -1386,7 +1386,7 @@ discard block |
||
1386 | 1386 | * @since 7.4 |
1387 | 1387 | */ |
1388 | 1388 | #[Pure] |
1389 | -#[LanguageLevelTypeAware(["8.0" => "array"], default: "array|false")] |
|
1389 | +#[LanguageLevelTypeAware(["8.0" => "array"], default : "array|false")] |
|
1390 | 1390 | function mb_str_split(string $string, int $length = 1, ?string $encoding) {} |
1391 | 1391 | |
1392 | 1392 | /** |
@@ -244,10 +244,10 @@ discard block |
||
244 | 244 | * @since 7.2 |
245 | 245 | */ |
246 | 246 | function sodium_crypto_aead_chacha20poly1305_ietf_encrypt( |
247 | - string $message, |
|
248 | - string $additional_data, |
|
249 | - string $nonce, |
|
250 | - string $key |
|
247 | + string $message, |
|
248 | + string $additional_data, |
|
249 | + string $nonce, |
|
250 | + string $key |
|
251 | 251 | ): string {} |
252 | 252 | |
253 | 253 | /** |
@@ -261,8 +261,8 @@ discard block |
||
261 | 261 | * @since 7.2 |
262 | 262 | */ |
263 | 263 | function sodium_crypto_auth( |
264 | - string $message, |
|
265 | - string $key |
|
264 | + string $message, |
|
265 | + string $key |
|
266 | 266 | ): string {} |
267 | 267 | |
268 | 268 | /** |
@@ -532,10 +532,10 @@ discard block |
||
532 | 532 | * @since 7.2 |
533 | 533 | */ |
534 | 534 | function sodium_crypto_kx( |
535 | - string $secret_key, |
|
536 | - string $public_key, |
|
537 | - string $client_publickey, |
|
538 | - string $server_publickey |
|
535 | + string $secret_key, |
|
536 | + string $public_key, |
|
537 | + string $client_publickey, |
|
538 | + string $server_publickey |
|
539 | 539 | ): string {} |
540 | 540 | |
541 | 541 | /** |
@@ -561,8 +561,8 @@ discard block |
||
561 | 561 | * @since 7.2 |
562 | 562 | */ |
563 | 563 | function sodium_crypto_generichash_init( |
564 | - string $key = '', |
|
565 | - int $length = 32 |
|
564 | + string $key = '', |
|
565 | + int $length = 32 |
|
566 | 566 | ): string {} |
567 | 567 | |
568 | 568 | /** |
@@ -588,8 +588,8 @@ discard block |
||
588 | 588 | * @since 7.2 |
589 | 589 | */ |
590 | 590 | function sodium_crypto_generichash_final( |
591 | - string &$state, |
|
592 | - int $length = 32 |
|
591 | + string &$state, |
|
592 | + int $length = 32 |
|
593 | 593 | ): string {} |
594 | 594 | |
595 | 595 | /** |
@@ -647,12 +647,12 @@ discard block |
||
647 | 647 | * @since 7.2 |
648 | 648 | */ |
649 | 649 | function sodium_crypto_pwhash_scryptsalsa208sha256( |
650 | - int $length, |
|
651 | - string $password, |
|
652 | - string $salt, |
|
653 | - int $opslimit, |
|
654 | - int $memlimit, |
|
655 | - #[PhpStormStubsElementAvailable(from: '7.2', to: '7.4')] $alg = null |
|
650 | + int $length, |
|
651 | + string $password, |
|
652 | + string $salt, |
|
653 | + int $opslimit, |
|
654 | + int $memlimit, |
|
655 | + #[PhpStormStubsElementAvailable(from: '7.2', to: '7.4')] $alg = null |
|
656 | 656 | ): string {} |
657 | 657 | |
658 | 658 | /** |
@@ -792,8 +792,8 @@ discard block |
||
792 | 792 | * @since 7.2 |
793 | 793 | */ |
794 | 794 | function sodium_crypto_sign_keypair_from_secretkey_and_publickey( |
795 | - string $secret_key, |
|
796 | - string $public_key |
|
795 | + string $secret_key, |
|
796 | + string $public_key |
|
797 | 797 | ): string {} |
798 | 798 | |
799 | 799 | /** |
@@ -871,9 +871,9 @@ discard block |
||
871 | 871 | * @since 7.2 |
872 | 872 | */ |
873 | 873 | function sodium_crypto_stream( |
874 | - int $length, |
|
875 | - string $nonce, |
|
876 | - string $key |
|
874 | + int $length, |
|
875 | + string $nonce, |
|
876 | + string $key |
|
877 | 877 | ): string {} |
878 | 878 | |
879 | 879 | /** |
@@ -888,9 +888,9 @@ discard block |
||
888 | 888 | * @since 7.2 |
889 | 889 | */ |
890 | 890 | function sodium_crypto_stream_xor( |
891 | - string $message, |
|
892 | - string $nonce, |
|
893 | - string $key |
|
891 | + string $message, |
|
892 | + string $nonce, |
|
893 | + string $key |
|
894 | 894 | ): string {} |
895 | 895 | |
896 | 896 | /** |
@@ -1025,8 +1025,8 @@ discard block |
||
1025 | 1025 | * @since 7.2 |
1026 | 1026 | */ |
1027 | 1027 | function sodium_crypto_scalarmult_base( |
1028 | - string $secret_key, |
|
1029 | - #[PhpStormStubsElementAvailable(from: '7.2', to: '7.4')] $string_2 |
|
1028 | + string $secret_key, |
|
1029 | + #[PhpStormStubsElementAvailable(from: '7.2', to: '7.4')] $string_2 |
|
1030 | 1030 | ): string {} |
1031 | 1031 | |
1032 | 1032 | /** |
@@ -173,7 +173,7 @@ discard block |
||
173 | 173 | * @throws SodiumException |
174 | 174 | * @since 7.2 |
175 | 175 | */ |
176 | -function sodium_crypto_aead_aes256gcm_decrypt(string $ciphertext, string $additional_data, string $nonce, string $key): string|false {} |
|
176 | +function sodium_crypto_aead_aes256gcm_decrypt(string $ciphertext, string $additional_data, string $nonce, string $key): string | false {} |
|
177 | 177 | |
178 | 178 | /** |
179 | 179 | * Authenticated Encryption with Associated Data (encrypt) |
@@ -201,7 +201,7 @@ discard block |
||
201 | 201 | * @throws SodiumException |
202 | 202 | * @since 7.2 |
203 | 203 | */ |
204 | -function sodium_crypto_aead_chacha20poly1305_decrypt(string $ciphertext, string $additional_data, string $nonce, string $key): string|false {} |
|
204 | +function sodium_crypto_aead_chacha20poly1305_decrypt(string $ciphertext, string $additional_data, string $nonce, string $key): string | false {} |
|
205 | 205 | |
206 | 206 | /** |
207 | 207 | * Authenticated Encryption with Associated Data (encrypt) |
@@ -229,7 +229,7 @@ discard block |
||
229 | 229 | * @throws SodiumException |
230 | 230 | * @since 7.2 |
231 | 231 | */ |
232 | -function sodium_crypto_aead_chacha20poly1305_ietf_decrypt(string $ciphertext, string $additional_data, string $nonce, string $key): string|false {} |
|
232 | +function sodium_crypto_aead_chacha20poly1305_ietf_decrypt(string $ciphertext, string $additional_data, string $nonce, string $key): string | false {} |
|
233 | 233 | |
234 | 234 | /** |
235 | 235 | * Authenticated Encryption with Associated Data (encrypt) |
@@ -465,7 +465,7 @@ discard block |
||
465 | 465 | * @throws SodiumException |
466 | 466 | * @since 7.2 |
467 | 467 | */ |
468 | -function sodium_crypto_box_open(string $ciphertext, string $nonce, string $key_pair): string|false {} |
|
468 | +function sodium_crypto_box_open(string $ciphertext, string $nonce, string $key_pair): string | false {} |
|
469 | 469 | |
470 | 470 | /** |
471 | 471 | * Get an X25519 public key from an X25519 keypair |
@@ -509,7 +509,7 @@ discard block |
||
509 | 509 | * @throws SodiumException |
510 | 510 | * @since 7.2 |
511 | 511 | */ |
512 | -function sodium_crypto_box_seal_open(string $ciphertext, string $key_pair): string|false {} |
|
512 | +function sodium_crypto_box_seal_open(string $ciphertext, string $key_pair): string | false {} |
|
513 | 513 | |
514 | 514 | /** |
515 | 515 | * Extract the X25519 secret key from an X25519 keypair |
@@ -715,7 +715,7 @@ discard block |
||
715 | 715 | * @throws SodiumException |
716 | 716 | * @since 7.2 |
717 | 717 | */ |
718 | -function sodium_crypto_secretbox_open(string $ciphertext, string $nonce, string $key): string|false {} |
|
718 | +function sodium_crypto_secretbox_open(string $ciphertext, string $nonce, string $key): string | false {} |
|
719 | 719 | |
720 | 720 | /** |
721 | 721 | * A short keyed hash suitable for data structures |
@@ -805,7 +805,7 @@ discard block |
||
805 | 805 | * @throws SodiumException |
806 | 806 | * @since 7.2 |
807 | 807 | */ |
808 | -function sodium_crypto_sign_open(string $signed_message, string $public_key): string|false {} |
|
808 | +function sodium_crypto_sign_open(string $signed_message, string $public_key): string | false {} |
|
809 | 809 | |
810 | 810 | /** |
811 | 811 | * Get the public key from an Ed25519 keypair |
@@ -1082,7 +1082,7 @@ discard block |
||
1082 | 1082 | * @since 7.2 |
1083 | 1083 | * @see https://www.php.net/manual/en/function.sodium-crypto-aead-xchacha20poly1305-ietf-decrypt.php |
1084 | 1084 | */ |
1085 | -function sodium_crypto_aead_xchacha20poly1305_ietf_decrypt(string $ciphertext, string $additional_data, string $nonce, string $key): string|false {} |
|
1085 | +function sodium_crypto_aead_xchacha20poly1305_ietf_decrypt(string $ciphertext, string $additional_data, string $nonce, string $key): string | false {} |
|
1086 | 1086 | |
1087 | 1087 | /** |
1088 | 1088 | * @param string $message |
@@ -7,89 +7,89 @@ |
||
7 | 7 | */ |
8 | 8 | class SVMModel |
9 | 9 | { |
10 | - /* Methods */ |
|
11 | - /** |
|
12 | - * Returns true if the model has probability information |
|
13 | - * |
|
14 | - * @return bool Return a boolean value |
|
15 | - * @link https://www.php.net/manual/en/svmmodel.checkprobabilitymodel.php |
|
16 | - */ |
|
17 | - public function checkProbabilityModel(): bool {} |
|
18 | - /** |
|
19 | - * Construct a new SVMModel |
|
20 | - * |
|
21 | - * Build a new SVMModel. Models will usually be created from the SVM::train function, but then saved models may be restored directly. |
|
22 | - * @param string $filename The filename for the saved model file this model should load. |
|
23 | - * @throws Throws SVMException on error |
|
24 | - * @link https://www.php.net/manual/en/svmmodel.construct.php |
|
25 | - */ |
|
26 | - public function __construct(string $filename = '') {} |
|
27 | - /** |
|
28 | - * Get the labels the model was trained on |
|
29 | - * |
|
30 | - * Return an array of labels that the model was trained on. For regression and one class models an empty array is returned. |
|
31 | - * @return array Return an array of labels |
|
32 | - * @link https://www.php.net/manual/en/svmmodel.getlabels.php |
|
33 | - */ |
|
34 | - public function getLabels(): array {} |
|
35 | - /** |
|
36 | - * Returns the number of classes the model was trained with |
|
37 | - * |
|
38 | - * Returns the number of classes the model was trained with, will return 2 for one class and regression models. |
|
39 | - * @return int Return an integer number of classes |
|
40 | - * @link https://www.php.net/manual/en/svmmodel.getnrclass.php |
|
41 | - */ |
|
42 | - public function getNrClass(): int {} |
|
43 | - /** |
|
44 | - * Get the SVM type the model was trained with |
|
45 | - * |
|
46 | - * Returns an integer value representing the type of the SVM model used, e.g SVM::C_SVC. |
|
47 | - * @return int Return an integer SVM type |
|
48 | - * @link https://www.php.net/manual/en/svmmodel.getsvmtype.php |
|
49 | - */ |
|
50 | - public function getSvmType(): int {} |
|
51 | - /** |
|
52 | - * Get the sigma value for regression types |
|
53 | - * |
|
54 | - * For regression models, returns a sigma value. If there is no probability information or the model is not SVR, 0 is returned. |
|
55 | - * @return float Returns a sigma value |
|
56 | - * @link https://www.php.net/manual/en/svmmodel.getsvrprobability.php |
|
57 | - */ |
|
58 | - public function getSvrProbability(): float {} |
|
59 | - /** |
|
60 | - * Load a saved SVM Model |
|
61 | - * @param string $filename The filename of the model. |
|
62 | - * @return bool Returns true on success. |
|
63 | - * @throws SVMException |
|
64 | - * @link https://www.php.net/manual/en/svmmodel.load.php |
|
65 | - */ |
|
66 | - public function load(string $filename): bool {} |
|
67 | - /** |
|
68 | - * Return class probabilities for previous unseen data |
|
69 | - * |
|
70 | - * This function accepts an array of data and attempts to predict the class, as with the predict function. Additionally, however, this function returns an array of probabilities, one per class in the model, which represent the estimated chance of the data supplied being a member of that class. Requires that the model to be used has been trained with the probability parameter set to true. |
|
71 | - * @param array $data The array to be classified. This should be a series of key => value pairs in increasing key order, but not necessarily continuous. |
|
72 | - * @return float the predicted value. This will be a class label in the case of classification, a real value in the case of regression. Throws SVMException on error |
|
73 | - * @throws SVMException Throws SVMException on error |
|
74 | - * @link https://www.php.net/manual/en/svmmodel.predict-probability.php |
|
75 | - */ |
|
76 | - public function predict_probability(array $data): float {} |
|
77 | - /** |
|
78 | - * Predict a value for previously unseen data |
|
79 | - * |
|
80 | - * This function accepts an array of data and attempts to predict the class or regression value based on the model extracted from previously trained data. |
|
81 | - * @param array $data The array to be classified. This should be a series of key => value pairs in increasing key order, but not necessarily continuous. |
|
82 | - * @return float the predicted value. This will be a class label in the case of classification, a real value in the case of regression. Throws SVMException on error |
|
83 | - * @throws SVMException Throws SVMException on error |
|
84 | - * @link https://www.php.net/manual/en/svmmodel.predict.php |
|
85 | - */ |
|
86 | - public function predict(array $data): float {} |
|
87 | - /** |
|
88 | - * Save a model to a file, for later use |
|
89 | - * @param string $filename The file to save the model to. |
|
90 | - * @return bool Throws SVMException on error. Returns true on success. |
|
91 | - * @throws SVMException Throws SVMException on error |
|
92 | - * @link https://www.php.net/manual/en/svmmodel.save.php |
|
93 | - */ |
|
94 | - public function save(string $filename): bool {} |
|
10 | + /* Methods */ |
|
11 | + /** |
|
12 | + * Returns true if the model has probability information |
|
13 | + * |
|
14 | + * @return bool Return a boolean value |
|
15 | + * @link https://www.php.net/manual/en/svmmodel.checkprobabilitymodel.php |
|
16 | + */ |
|
17 | + public function checkProbabilityModel(): bool {} |
|
18 | + /** |
|
19 | + * Construct a new SVMModel |
|
20 | + * |
|
21 | + * Build a new SVMModel. Models will usually be created from the SVM::train function, but then saved models may be restored directly. |
|
22 | + * @param string $filename The filename for the saved model file this model should load. |
|
23 | + * @throws Throws SVMException on error |
|
24 | + * @link https://www.php.net/manual/en/svmmodel.construct.php |
|
25 | + */ |
|
26 | + public function __construct(string $filename = '') {} |
|
27 | + /** |
|
28 | + * Get the labels the model was trained on |
|
29 | + * |
|
30 | + * Return an array of labels that the model was trained on. For regression and one class models an empty array is returned. |
|
31 | + * @return array Return an array of labels |
|
32 | + * @link https://www.php.net/manual/en/svmmodel.getlabels.php |
|
33 | + */ |
|
34 | + public function getLabels(): array {} |
|
35 | + /** |
|
36 | + * Returns the number of classes the model was trained with |
|
37 | + * |
|
38 | + * Returns the number of classes the model was trained with, will return 2 for one class and regression models. |
|
39 | + * @return int Return an integer number of classes |
|
40 | + * @link https://www.php.net/manual/en/svmmodel.getnrclass.php |
|
41 | + */ |
|
42 | + public function getNrClass(): int {} |
|
43 | + /** |
|
44 | + * Get the SVM type the model was trained with |
|
45 | + * |
|
46 | + * Returns an integer value representing the type of the SVM model used, e.g SVM::C_SVC. |
|
47 | + * @return int Return an integer SVM type |
|
48 | + * @link https://www.php.net/manual/en/svmmodel.getsvmtype.php |
|
49 | + */ |
|
50 | + public function getSvmType(): int {} |
|
51 | + /** |
|
52 | + * Get the sigma value for regression types |
|
53 | + * |
|
54 | + * For regression models, returns a sigma value. If there is no probability information or the model is not SVR, 0 is returned. |
|
55 | + * @return float Returns a sigma value |
|
56 | + * @link https://www.php.net/manual/en/svmmodel.getsvrprobability.php |
|
57 | + */ |
|
58 | + public function getSvrProbability(): float {} |
|
59 | + /** |
|
60 | + * Load a saved SVM Model |
|
61 | + * @param string $filename The filename of the model. |
|
62 | + * @return bool Returns true on success. |
|
63 | + * @throws SVMException |
|
64 | + * @link https://www.php.net/manual/en/svmmodel.load.php |
|
65 | + */ |
|
66 | + public function load(string $filename): bool {} |
|
67 | + /** |
|
68 | + * Return class probabilities for previous unseen data |
|
69 | + * |
|
70 | + * This function accepts an array of data and attempts to predict the class, as with the predict function. Additionally, however, this function returns an array of probabilities, one per class in the model, which represent the estimated chance of the data supplied being a member of that class. Requires that the model to be used has been trained with the probability parameter set to true. |
|
71 | + * @param array $data The array to be classified. This should be a series of key => value pairs in increasing key order, but not necessarily continuous. |
|
72 | + * @return float the predicted value. This will be a class label in the case of classification, a real value in the case of regression. Throws SVMException on error |
|
73 | + * @throws SVMException Throws SVMException on error |
|
74 | + * @link https://www.php.net/manual/en/svmmodel.predict-probability.php |
|
75 | + */ |
|
76 | + public function predict_probability(array $data): float {} |
|
77 | + /** |
|
78 | + * Predict a value for previously unseen data |
|
79 | + * |
|
80 | + * This function accepts an array of data and attempts to predict the class or regression value based on the model extracted from previously trained data. |
|
81 | + * @param array $data The array to be classified. This should be a series of key => value pairs in increasing key order, but not necessarily continuous. |
|
82 | + * @return float the predicted value. This will be a class label in the case of classification, a real value in the case of regression. Throws SVMException on error |
|
83 | + * @throws SVMException Throws SVMException on error |
|
84 | + * @link https://www.php.net/manual/en/svmmodel.predict.php |
|
85 | + */ |
|
86 | + public function predict(array $data): float {} |
|
87 | + /** |
|
88 | + * Save a model to a file, for later use |
|
89 | + * @param string $filename The file to save the model to. |
|
90 | + * @return bool Throws SVMException on error. Returns true on success. |
|
91 | + * @throws SVMException Throws SVMException on error |
|
92 | + * @link https://www.php.net/manual/en/svmmodel.save.php |
|
93 | + */ |
|
94 | + public function save(string $filename): bool {} |
|
95 | 95 | } |
@@ -5,8 +5,7 @@ |
||
5 | 5 | * @since 7.0 |
6 | 6 | * @link https://www.php.net/manual/en/class.svmmodel.php |
7 | 7 | */ |
8 | -class SVMModel |
|
9 | -{ |
|
8 | +class SVMModel { |
|
10 | 9 | /* Methods */ |
11 | 10 | /** |
12 | 11 | * Returns true if the model has probability information |
@@ -1,153 +1,152 @@ |
||
1 | 1 | <?php |
2 | 2 | /** |
3 | 3 | * Support Vector Machine Library |
4 | - |
|
5 | 4 | * LibSVM is an efficient solver for SVM classification and regression problems. The svm extension wraps this in a PHP interface for easy use in PHP scripts. |
6 | 5 | * @since 7.0 |
7 | 6 | * @link https://www.php.net/manual/en/class.svm.php |
8 | 7 | */ |
9 | 8 | class SVM |
10 | 9 | { |
11 | - /* Constants */ |
|
12 | - /** |
|
13 | - * @const The basic C_SVC SVM type. The default, and a good starting point |
|
14 | - */ |
|
15 | - public const C_SVC = 0; |
|
16 | - /** |
|
17 | - * @const NU_SVC type uses a different, more flexible, error weighting |
|
18 | - */ |
|
19 | - public const NU_SVC = 1; |
|
20 | - /** |
|
21 | - * @const One class SVM type. Train just on a single class, using outliers as negative examples |
|
22 | - */ |
|
23 | - public const ONE_CLASS = 2; |
|
24 | - /** |
|
25 | - * @const A SVM type for regression (predicting a value rather than just a class) |
|
26 | - */ |
|
27 | - public const EPSILON_SVR = 3; |
|
28 | - /** |
|
29 | - * @const A NU style SVM regression type |
|
30 | - */ |
|
31 | - public const NU_SVR = 4; |
|
32 | - /** |
|
33 | - * @const A very simple kernel, can work well on large document classification problems |
|
34 | - */ |
|
35 | - public const KERNEL_LINEAR = 0; |
|
36 | - /** |
|
37 | - * @const A polynomial kernel |
|
38 | - */ |
|
39 | - public const KERNEL_POLY = 1; |
|
40 | - /** |
|
41 | - * @const The common Gaussian RBD kernel. Handles non-linear problems well and is a good default for classification |
|
42 | - */ |
|
43 | - public const KERNEL_RBF = 2; |
|
44 | - /** |
|
45 | - * @const A kernel based on the sigmoid function. Using this makes the SVM very similar to a two layer sigmoid based neural network |
|
46 | - */ |
|
47 | - public const KERNEL_SIGMOID = 3; |
|
48 | - /** |
|
49 | - * @const A precomputed kernel - currently unsupported. |
|
50 | - */ |
|
51 | - public const KERNEL_PRECOMPUTED = 4; |
|
52 | - /** |
|
53 | - * @const The options key for the SVM type |
|
54 | - */ |
|
55 | - public const OPT_TYPE = 101; |
|
56 | - /** |
|
57 | - * @const The options key for the kernel type |
|
58 | - */ |
|
59 | - public const OPT_KERNEL_TYPE = 102; |
|
60 | - /** |
|
61 | - * @const OPT_DEGREE |
|
62 | - */ |
|
63 | - public const OPT_DEGREE = 103; |
|
64 | - /** |
|
65 | - * @const Training parameter, boolean, for whether to use the shrinking heuristics |
|
66 | - */ |
|
67 | - public const OPT_SHRINKING = 104; |
|
68 | - /** |
|
69 | - * @const Training parameter, boolean, for whether to collect and use probability estimates |
|
70 | - */ |
|
71 | - public const OPT_PROPABILITY = 105; |
|
72 | - /** |
|
73 | - * @const Algorithm parameter for Poly, RBF and Sigmoid kernel types. |
|
74 | - */ |
|
75 | - public const OPT_GAMMA = 201; |
|
76 | - /** |
|
77 | - * @const The option key for the nu parameter, only used in the NU_ SVM types |
|
78 | - */ |
|
79 | - public const OPT_NU = 202; |
|
80 | - /** |
|
81 | - * @const The option key for the Epsilon parameter, used in epsilon regression |
|
82 | - */ |
|
83 | - public const OPT_EPS = 203; |
|
84 | - /** |
|
85 | - * @const Training parameter used by Episilon SVR regression |
|
86 | - */ |
|
87 | - public const OPT_P = 204; |
|
88 | - /** |
|
89 | - * @const Algorithm parameter for poly and sigmoid kernels |
|
90 | - */ |
|
91 | - public const OPT_COEF_ZERO = 205; |
|
92 | - /** |
|
93 | - * @const The option for the cost parameter that controls tradeoff between errors and generality - effectively the penalty for misclassifying training examples. |
|
94 | - */ |
|
95 | - public const OPT_C = 206; |
|
96 | - /** |
|
97 | - * @const Memory cache size, in MB |
|
98 | - */ |
|
99 | - public const OPT_CACHE_SIZE = 207; |
|
10 | + /* Constants */ |
|
11 | + /** |
|
12 | + * @const The basic C_SVC SVM type. The default, and a good starting point |
|
13 | + */ |
|
14 | + public const C_SVC = 0; |
|
15 | + /** |
|
16 | + * @const NU_SVC type uses a different, more flexible, error weighting |
|
17 | + */ |
|
18 | + public const NU_SVC = 1; |
|
19 | + /** |
|
20 | + * @const One class SVM type. Train just on a single class, using outliers as negative examples |
|
21 | + */ |
|
22 | + public const ONE_CLASS = 2; |
|
23 | + /** |
|
24 | + * @const A SVM type for regression (predicting a value rather than just a class) |
|
25 | + */ |
|
26 | + public const EPSILON_SVR = 3; |
|
27 | + /** |
|
28 | + * @const A NU style SVM regression type |
|
29 | + */ |
|
30 | + public const NU_SVR = 4; |
|
31 | + /** |
|
32 | + * @const A very simple kernel, can work well on large document classification problems |
|
33 | + */ |
|
34 | + public const KERNEL_LINEAR = 0; |
|
35 | + /** |
|
36 | + * @const A polynomial kernel |
|
37 | + */ |
|
38 | + public const KERNEL_POLY = 1; |
|
39 | + /** |
|
40 | + * @const The common Gaussian RBD kernel. Handles non-linear problems well and is a good default for classification |
|
41 | + */ |
|
42 | + public const KERNEL_RBF = 2; |
|
43 | + /** |
|
44 | + * @const A kernel based on the sigmoid function. Using this makes the SVM very similar to a two layer sigmoid based neural network |
|
45 | + */ |
|
46 | + public const KERNEL_SIGMOID = 3; |
|
47 | + /** |
|
48 | + * @const A precomputed kernel - currently unsupported. |
|
49 | + */ |
|
50 | + public const KERNEL_PRECOMPUTED = 4; |
|
51 | + /** |
|
52 | + * @const The options key for the SVM type |
|
53 | + */ |
|
54 | + public const OPT_TYPE = 101; |
|
55 | + /** |
|
56 | + * @const The options key for the kernel type |
|
57 | + */ |
|
58 | + public const OPT_KERNEL_TYPE = 102; |
|
59 | + /** |
|
60 | + * @const OPT_DEGREE |
|
61 | + */ |
|
62 | + public const OPT_DEGREE = 103; |
|
63 | + /** |
|
64 | + * @const Training parameter, boolean, for whether to use the shrinking heuristics |
|
65 | + */ |
|
66 | + public const OPT_SHRINKING = 104; |
|
67 | + /** |
|
68 | + * @const Training parameter, boolean, for whether to collect and use probability estimates |
|
69 | + */ |
|
70 | + public const OPT_PROPABILITY = 105; |
|
71 | + /** |
|
72 | + * @const Algorithm parameter for Poly, RBF and Sigmoid kernel types. |
|
73 | + */ |
|
74 | + public const OPT_GAMMA = 201; |
|
75 | + /** |
|
76 | + * @const The option key for the nu parameter, only used in the NU_ SVM types |
|
77 | + */ |
|
78 | + public const OPT_NU = 202; |
|
79 | + /** |
|
80 | + * @const The option key for the Epsilon parameter, used in epsilon regression |
|
81 | + */ |
|
82 | + public const OPT_EPS = 203; |
|
83 | + /** |
|
84 | + * @const Training parameter used by Episilon SVR regression |
|
85 | + */ |
|
86 | + public const OPT_P = 204; |
|
87 | + /** |
|
88 | + * @const Algorithm parameter for poly and sigmoid kernels |
|
89 | + */ |
|
90 | + public const OPT_COEF_ZERO = 205; |
|
91 | + /** |
|
92 | + * @const The option for the cost parameter that controls tradeoff between errors and generality - effectively the penalty for misclassifying training examples. |
|
93 | + */ |
|
94 | + public const OPT_C = 206; |
|
95 | + /** |
|
96 | + * @const Memory cache size, in MB |
|
97 | + */ |
|
98 | + public const OPT_CACHE_SIZE = 207; |
|
100 | 99 | |
101 | - /* Methods */ |
|
102 | - /** |
|
103 | - * Construct a new SVM object |
|
104 | - * |
|
105 | - * Constructs a new SVM object ready to accept training data. |
|
106 | - * @throws SVMException Throws SVMException if the libsvm library could not be loaded |
|
107 | - * @link https://www.php.net/manual/en/svm.construct.php |
|
108 | - */ |
|
109 | - public function __construct() {} |
|
100 | + /* Methods */ |
|
101 | + /** |
|
102 | + * Construct a new SVM object |
|
103 | + * |
|
104 | + * Constructs a new SVM object ready to accept training data. |
|
105 | + * @throws SVMException Throws SVMException if the libsvm library could not be loaded |
|
106 | + * @link https://www.php.net/manual/en/svm.construct.php |
|
107 | + */ |
|
108 | + public function __construct() {} |
|
110 | 109 | |
111 | - /** |
|
112 | - * Test training params on subsets of the training data |
|
113 | - * |
|
114 | - * Crossvalidate can be used to test the effectiveness of the current parameter set on a subset of the training data. Given a problem set and a n "folds", it separates the problem set into n subsets, and the repeatedly trains on one subset and tests on another. While the accuracy will generally be lower than a SVM trained on the enter data set, the accuracy score returned should be relatively useful, so it can be used to test different training parameters. |
|
115 | - * @param array $problem The problem data. This can either be in the form of an array, the URL of an SVMLight formatted file, or a stream to an opened SVMLight formatted datasource. |
|
116 | - * @param int $number_of_folds The number of sets the data should be divided into and cross tested. A higher number means smaller training sets and less reliability. 5 is a good number to start with. |
|
117 | - * @return float The correct percentage, expressed as a floating point number from 0-1. In the case of NU_SVC or EPSILON_SVR kernels the mean squared error will returned instead. |
|
118 | - * @link https://www.php.net/manual/en/svm.crossvalidate.php |
|
119 | - */ |
|
120 | - public function crossvalidate(array $problem, int $number_of_folds): float {} |
|
110 | + /** |
|
111 | + * Test training params on subsets of the training data |
|
112 | + * |
|
113 | + * Crossvalidate can be used to test the effectiveness of the current parameter set on a subset of the training data. Given a problem set and a n "folds", it separates the problem set into n subsets, and the repeatedly trains on one subset and tests on another. While the accuracy will generally be lower than a SVM trained on the enter data set, the accuracy score returned should be relatively useful, so it can be used to test different training parameters. |
|
114 | + * @param array $problem The problem data. This can either be in the form of an array, the URL of an SVMLight formatted file, or a stream to an opened SVMLight formatted datasource. |
|
115 | + * @param int $number_of_folds The number of sets the data should be divided into and cross tested. A higher number means smaller training sets and less reliability. 5 is a good number to start with. |
|
116 | + * @return float The correct percentage, expressed as a floating point number from 0-1. In the case of NU_SVC or EPSILON_SVR kernels the mean squared error will returned instead. |
|
117 | + * @link https://www.php.net/manual/en/svm.crossvalidate.php |
|
118 | + */ |
|
119 | + public function crossvalidate(array $problem, int $number_of_folds): float {} |
|
121 | 120 | |
122 | - /** |
|
123 | - * Return the current training parameters |
|
124 | - * |
|
125 | - * Retrieve an array containing the training parameters. The parameters will be keyed on the predefined SVM constants. |
|
126 | - * @return array Returns an array of configuration settings. |
|
127 | - * @link https://www.php.net/manual/en/svm.getoptions.php |
|
128 | - */ |
|
129 | - public function getOptions(): array {} |
|
121 | + /** |
|
122 | + * Return the current training parameters |
|
123 | + * |
|
124 | + * Retrieve an array containing the training parameters. The parameters will be keyed on the predefined SVM constants. |
|
125 | + * @return array Returns an array of configuration settings. |
|
126 | + * @link https://www.php.net/manual/en/svm.getoptions.php |
|
127 | + */ |
|
128 | + public function getOptions(): array {} |
|
130 | 129 | |
131 | - /** |
|
132 | - * Set training parameters |
|
133 | - * |
|
134 | - * Set one or more training parameters. |
|
135 | - * @param array $params An array of training parameters, keyed on the SVM constants. |
|
136 | - * @return bool Return true on success, throws SVMException on error. |
|
137 | - * @throws SVMException |
|
138 | - * @link https://www.php.net/manual/en/svm.setoptions.php |
|
139 | - */ |
|
140 | - public function setOptions(array $params): bool {} |
|
130 | + /** |
|
131 | + * Set training parameters |
|
132 | + * |
|
133 | + * Set one or more training parameters. |
|
134 | + * @param array $params An array of training parameters, keyed on the SVM constants. |
|
135 | + * @return bool Return true on success, throws SVMException on error. |
|
136 | + * @throws SVMException |
|
137 | + * @link https://www.php.net/manual/en/svm.setoptions.php |
|
138 | + */ |
|
139 | + public function setOptions(array $params): bool {} |
|
141 | 140 | |
142 | - /** |
|
143 | - * Create a SVMModel based on training data |
|
144 | - * |
|
145 | - * Train a support vector machine based on the supplied training data. |
|
146 | - * @param array $problem The problem can be provided in three different ways. An array, where the data should start with the class label (usually 1 or -1) then followed by a sparse data set of dimension => data pairs. A URL to a file containing a SVM Light formatted problem, with the each line being a new training example, the start of each line containing the class (1, -1) then a series of tab separated data values shows as key:value. A opened stream pointing to a data source formatted as in the file above. |
|
147 | - * @param array|null $weights Weights are an optional set of weighting parameters for the different classes, to help account for unbalanced training sets. For example, if the classes were 1 and -1, and -1 had significantly more example than one, the weight for -1 could be 0.5. Weights should be in the range 0-1. |
|
148 | - * @return SVMModel Returns an SVMModel that can be used to classify previously unseen data. Throws SVMException on error |
|
149 | - * @throws SMVException |
|
150 | - * @link https://www.php.net/manual/en/svm.train.php |
|
151 | - */ |
|
152 | - public function train(array $problem, array $weights = null): SVMModel {} |
|
141 | + /** |
|
142 | + * Create a SVMModel based on training data |
|
143 | + * |
|
144 | + * Train a support vector machine based on the supplied training data. |
|
145 | + * @param array $problem The problem can be provided in three different ways. An array, where the data should start with the class label (usually 1 or -1) then followed by a sparse data set of dimension => data pairs. A URL to a file containing a SVM Light formatted problem, with the each line being a new training example, the start of each line containing the class (1, -1) then a series of tab separated data values shows as key:value. A opened stream pointing to a data source formatted as in the file above. |
|
146 | + * @param array|null $weights Weights are an optional set of weighting parameters for the different classes, to help account for unbalanced training sets. For example, if the classes were 1 and -1, and -1 had significantly more example than one, the weight for -1 could be 0.5. Weights should be in the range 0-1. |
|
147 | + * @return SVMModel Returns an SVMModel that can be used to classify previously unseen data. Throws SVMException on error |
|
148 | + * @throws SMVException |
|
149 | + * @link https://www.php.net/manual/en/svm.train.php |
|
150 | + */ |
|
151 | + public function train(array $problem, array $weights = null): SVMModel {} |
|
153 | 152 | } |
@@ -6,8 +6,7 @@ |
||
6 | 6 | * @since 7.0 |
7 | 7 | * @link https://www.php.net/manual/en/class.svm.php |
8 | 8 | */ |
9 | -class SVM |
|
10 | -{ |
|
9 | +class SVM { |
|
11 | 10 | /* Constants */ |
12 | 11 | /** |
13 | 12 | * @const The basic C_SVC SVM type. The default, and a good starting point |
@@ -28,7 +28,7 @@ discard block |
||
28 | 28 | * returns <b>FALSE</b> if the variable is not set and <b>NULL</b> if the filter fails. |
29 | 29 | */ |
30 | 30 | #[Pure] |
31 | -function filter_input(int $type, string $var_name, int $filter = FILTER_DEFAULT, array|int $options): mixed {} |
|
31 | +function filter_input(int $type, string $var_name, int $filter = FILTER_DEFAULT, array | int $options): mixed {} |
|
32 | 32 | |
33 | 33 | /** |
34 | 34 | * Filters a variable with a specified filter |
@@ -84,7 +84,7 @@ discard block |
||
84 | 84 | * @return mixed the filtered data, or <b>FALSE</b> if the filter fails. |
85 | 85 | */ |
86 | 86 | #[Pure] |
87 | -function filter_var(mixed $value, int $filter = FILTER_DEFAULT, array|int $options): mixed {} |
|
87 | +function filter_var(mixed $value, int $filter = FILTER_DEFAULT, array | int $options): mixed {} |
|
88 | 88 | |
89 | 89 | /** |
90 | 90 | * Gets external variables and optionally filters them |
@@ -118,7 +118,7 @@ discard block |
||
118 | 118 | * fails. |
119 | 119 | */ |
120 | 120 | #[Pure] |
121 | -function filter_input_array(int $type, array|int $options = FILTER_DEFAULT, bool $add_empty = true): array|false|null {} |
|
121 | +function filter_input_array(int $type, array | int $options = FILTER_DEFAULT, bool $add_empty = true): array | false | null {} |
|
122 | 122 | |
123 | 123 | /** |
124 | 124 | * Gets multiple variables and optionally filters them |
@@ -149,7 +149,7 @@ discard block |
||
149 | 149 | * the variable is not set. |
150 | 150 | */ |
151 | 151 | #[Pure] |
152 | -function filter_var_array(array $array, array|int $options = FILTER_DEFAULT, bool $add_empty = true): array|false|null {} |
|
152 | +function filter_var_array(array $array, array | int $options = FILTER_DEFAULT, bool $add_empty = true): array | false | null {} |
|
153 | 153 | |
154 | 154 | /** |
155 | 155 | * Returns a list of all supported filters |
@@ -186,7 +186,7 @@ discard block |
||
186 | 186 | * @return int|false ID of a filter on success or <b>FALSE</b> if filter doesn't exist. |
187 | 187 | */ |
188 | 188 | #[Pure] |
189 | -function filter_id(string $name): int|false {} |
|
189 | +function filter_id(string $name): int | false {} |
|
190 | 190 | |
191 | 191 | /** |
192 | 192 | * POST variables. |
@@ -135,7 +135,7 @@ |
||
135 | 135 | */ |
136 | 136 | function mqseries_strerror($reason) |
137 | 137 | { |
138 | - return (string)$reason; |
|
138 | + return (string)$reason; |
|
139 | 139 | } |
140 | 140 | |
141 | 141 | /* |
@@ -41,8 +41,8 @@ discard block |
||
41 | 41 | */ |
42 | 42 | function expect_popen(string $command) |
43 | 43 | { |
44 | - unset($command); |
|
45 | - return false; |
|
44 | + unset($command); |
|
45 | + return false; |
|
46 | 46 | } |
47 | 47 | |
48 | 48 | /** |
@@ -94,6 +94,6 @@ discard block |
||
94 | 94 | */ |
95 | 95 | function expect_expectl($expect, array $cases, array &$match = []): int |
96 | 96 | { |
97 | - unset($expect, $cases, $match); |
|
98 | - return 0; |
|
97 | + unset($expect, $cases, $match); |
|
98 | + return 0; |
|
99 | 99 | } |