forked from HvyIndustries/crane-php-stubs
-
Notifications
You must be signed in to change notification settings - Fork 1
/
PDO.php
1474 lines (1334 loc) · 47.2 KB
/
PDO.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
// Start of PDO v.7.0.4-7ubuntu2
/**
* Represents an error raised by PDO. You should not throw a
* <b>PDOException</b> from your own code.
* See Exceptions for more
* information about Exceptions in PHP.
* @link http://php.net/manual/en/class.pdoexception.php
*/
class PDOException extends RuntimeException implements Throwable {
protected $message;
protected $code;
protected $file;
protected $line;
public $errorInfo;
/**
* (PHP 5 >= 5.1.0, PHP 7)<br/>
* Clone the exception
* @link http://php.net/manual/en/exception.clone.php
* @return void No value is returned.
*/
final private function __clone() {}
/**
* (PHP 5 >= 5.1.0, PHP 7)<br/>
* Construct the exception
* @link http://php.net/manual/en/exception.construct.php
* @param string $message [optional] <p>
* The Exception message to throw.
* </p>
* @param int $code [optional] <p>
* The Exception code.
* </p>
* @param Throwable $previous [optional] <p>
* The previous exception used for the exception chaining.
* </p>
*/
public function __construct(string $message = "", int $code = 0, Throwable $previous = null) {}
public function __wakeup() {}
/**
* (PHP 5 >= 5.1.0, PHP 7)<br/>
* Gets the Exception message
* @link http://php.net/manual/en/exception.getmessage.php
* @return string the Exception message as a string.
*/
final public function getMessage(): string {}
/**
* (PHP 5 >= 5.1.0, PHP 7)<br/>
* Gets the Exception code
* @link http://php.net/manual/en/exception.getcode.php
* @return mixed the exception code as integer in
* <b>Exception</b> but possibly as other type in
* <b>Exception</b> descendants (for example as
* string in <b>PDOException</b>).
*/
final public function getCode() {}
/**
* (PHP 5 >= 5.1.0, PHP 7)<br/>
* Gets the file in which the exception occurred
* @link http://php.net/manual/en/exception.getfile.php
* @return string the filename in which the exception was created.
*/
final public function getFile(): string {}
/**
* (PHP 5 >= 5.1.0, PHP 7)<br/>
* Gets the line in which the exception occurred
* @link http://php.net/manual/en/exception.getline.php
* @return int the line number where the exception was created.
*/
final public function getLine(): int {}
/**
* (PHP 5 >= 5.1.0, PHP 7)<br/>
* Gets the stack trace
* @link http://php.net/manual/en/exception.gettrace.php
* @return array the Exception stack trace as an array.
*/
final public function getTrace(): array {}
/**
* (PHP 5 >= 5.3.0, PHP 7)<br/>
* Returns previous Exception
* @link http://php.net/manual/en/exception.getprevious.php
* @return Exception the previous <b>Exception</b> if available
* or <b>NULL</b> otherwise.
*/
final public function getPrevious(): Exception {}
/**
* (PHP 5 >= 5.1.0, PHP 7)<br/>
* Gets the stack trace as a string
* @link http://php.net/manual/en/exception.gettraceasstring.php
* @return string the Exception stack trace as a string.
*/
final public function getTraceAsString(): string {}
/**
* (PHP 5 >= 5.1.0, PHP 7)<br/>
* String representation of the exception
* @link http://php.net/manual/en/exception.tostring.php
* @return string the string representation of the exception.
*/
public function __toString(): string {}
}
/**
* Represents a connection between PHP and a database server.
* @link http://php.net/manual/en/class.pdo.php
*/
class PDO {
/**
* Represents a boolean data type.
* @link http://php.net/manual/en/pdo.constants.php
*/
const PARAM_BOOL = 5;
/**
* Represents the SQL NULL data type.
* @link http://php.net/manual/en/pdo.constants.php
*/
const PARAM_NULL = 0;
/**
* Represents the SQL INTEGER data type.
* @link http://php.net/manual/en/pdo.constants.php
*/
const PARAM_INT = 1;
/**
* Represents the SQL CHAR, VARCHAR, or other string data type.
* @link http://php.net/manual/en/pdo.constants.php
*/
const PARAM_STR = 2;
/**
* Represents the SQL large object data type.
* @link http://php.net/manual/en/pdo.constants.php
*/
const PARAM_LOB = 3;
/**
* Represents a recordset type. Not currently supported by any drivers.
* @link http://php.net/manual/en/pdo.constants.php
*/
const PARAM_STMT = 4;
/**
* Specifies that the parameter is an INOUT parameter for a stored
* procedure. You must bitwise-OR this value with an explicit
* PDO::PARAM_* data type.
* @link http://php.net/manual/en/pdo.constants.php
*/
const PARAM_INPUT_OUTPUT = 2147483648;
/**
* Allocation event
* @link http://php.net/manual/en/pdo.constants.php
*/
const PARAM_EVT_ALLOC = 0;
/**
* Deallocation event
* @link http://php.net/manual/en/pdo.constants.php
*/
const PARAM_EVT_FREE = 1;
/**
* Event triggered prior to execution of a prepared statement.
* @link http://php.net/manual/en/pdo.constants.php
*/
const PARAM_EVT_EXEC_PRE = 2;
/**
* Event triggered subsequent to execution of a prepared statement.
* @link http://php.net/manual/en/pdo.constants.php
*/
const PARAM_EVT_EXEC_POST = 3;
/**
* Event triggered prior to fetching a result from a resultset.
* @link http://php.net/manual/en/pdo.constants.php
*/
const PARAM_EVT_FETCH_PRE = 4;
/**
* Event triggered subsequent to fetching a result from a resultset.
* @link http://php.net/manual/en/pdo.constants.php
*/
const PARAM_EVT_FETCH_POST = 5;
/**
* Event triggered during bound parameter registration
* allowing the driver to normalize the parameter name.
* @link http://php.net/manual/en/pdo.constants.php
*/
const PARAM_EVT_NORMALIZE = 6;
/**
* Specifies that the fetch method shall return each row as an object with
* variable names that correspond to the column names returned in the result
* set. <b>PDO::FETCH_LAZY</b> creates the object variable names as they are accessed.
* Not valid inside <b>PDOStatement::fetchAll</b>.
* @link http://php.net/manual/en/pdo.constants.php
*/
const FETCH_LAZY = 1;
/**
* Specifies that the fetch method shall return each row as an array indexed
* by column name as returned in the corresponding result set. If the result
* set contains multiple columns with the same name,
* <b>PDO::FETCH_ASSOC</b> returns
* only a single value per column name.
* @link http://php.net/manual/en/pdo.constants.php
*/
const FETCH_ASSOC = 2;
/**
* Specifies that the fetch method shall return each row as an array indexed
* by column number as returned in the corresponding result set, starting at
* column 0.
* @link http://php.net/manual/en/pdo.constants.php
*/
const FETCH_NUM = 3;
/**
* Specifies that the fetch method shall return each row as an array indexed
* by both column name and number as returned in the corresponding result set,
* starting at column 0.
* @link http://php.net/manual/en/pdo.constants.php
*/
const FETCH_BOTH = 4;
/**
* Specifies that the fetch method shall return each row as an object with
* property names that correspond to the column names returned in the result
* set.
* @link http://php.net/manual/en/pdo.constants.php
*/
const FETCH_OBJ = 5;
/**
* Specifies that the fetch method shall return TRUE and assign the values of
* the columns in the result set to the PHP variables to which they were
* bound with the <b>PDOStatement::bindParam</b> or
* <b>PDOStatement::bindColumn</b> methods.
* @link http://php.net/manual/en/pdo.constants.php
*/
const FETCH_BOUND = 6;
/**
* Specifies that the fetch method shall return only a single requested
* column from the next row in the result set.
* @link http://php.net/manual/en/pdo.constants.php
*/
const FETCH_COLUMN = 7;
/**
* Specifies that the fetch method shall return a new instance of the
* requested class, mapping the columns to named properties in the class.
* The magic
* <b>__set</b>
* method is called if the property doesn't exist in the requested class
* @link http://php.net/manual/en/pdo.constants.php
*/
const FETCH_CLASS = 8;
/**
* Specifies that the fetch method shall update an existing instance of the
* requested class, mapping the columns to named properties in the class.
* @link http://php.net/manual/en/pdo.constants.php
*/
const FETCH_INTO = 9;
/**
* Allows completely customize the way data is treated on the fly (only
* valid inside <b>PDOStatement::fetchAll</b>).
* @link http://php.net/manual/en/pdo.constants.php
*/
const FETCH_FUNC = 10;
/**
* Group return by values. Usually combined with
* <b>PDO::FETCH_COLUMN</b> or
* <b>PDO::FETCH_KEY_PAIR</b>.
* @link http://php.net/manual/en/pdo.constants.php
*/
const FETCH_GROUP = 65536;
/**
* Fetch only the unique values.
* @link http://php.net/manual/en/pdo.constants.php
*/
const FETCH_UNIQUE = 196608;
/**
* Fetch a two-column result into an array where the first column is a key and the second column
* is the value. Available since PHP 5.2.3.
* @link http://php.net/manual/en/pdo.constants.php
*/
const FETCH_KEY_PAIR = 12;
/**
* Determine the class name from the value of first column.
* @link http://php.net/manual/en/pdo.constants.php
*/
const FETCH_CLASSTYPE = 262144;
/**
* As <b>PDO::FETCH_INTO</b> but object is provided as a serialized string.
* Available since PHP 5.1.0. Since PHP 5.3.0 the class constructor is never called if this
* flag is set.
* @link http://php.net/manual/en/pdo.constants.php
*/
const FETCH_SERIALIZE = 524288;
/**
* Call the constructor before setting properties. Available since PHP 5.2.0.
* @link http://php.net/manual/en/pdo.constants.php
*/
const FETCH_PROPS_LATE = 1048576;
/**
* Specifies that the fetch method shall return each row as an array indexed
* by column name as returned in the corresponding result set. If the result
* set contains multiple columns with the same name,
* <b>PDO::FETCH_NAMED</b> returns
* an array of values per column name.
* @link http://php.net/manual/en/pdo.constants.php
*/
const FETCH_NAMED = 11;
/**
* If this value is <b>FALSE</b>, PDO attempts to disable autocommit so that the
* connection begins a transaction.
* @link http://php.net/manual/en/pdo.constants.php
*/
const ATTR_AUTOCOMMIT = 0;
/**
* Setting the prefetch size allows you to balance speed against memory
* usage for your application. Not all database/driver combinations support
* setting of the prefetch size. A larger prefetch size results in
* increased performance at the cost of higher memory usage.
* @link http://php.net/manual/en/pdo.constants.php
*/
const ATTR_PREFETCH = 1;
/**
* Sets the timeout value in seconds for communications with the database.
* @link http://php.net/manual/en/pdo.constants.php
*/
const ATTR_TIMEOUT = 2;
/**
* See the Errors and error
* handling section for more information about this attribute.
* @link http://php.net/manual/en/pdo.constants.php
*/
const ATTR_ERRMODE = 3;
/**
* This is a read only attribute; it will return information about the
* version of the database server to which PDO is connected.
* @link http://php.net/manual/en/pdo.constants.php
*/
const ATTR_SERVER_VERSION = 4;
/**
* This is a read only attribute; it will return information about the
* version of the client libraries that the PDO driver is using.
* @link http://php.net/manual/en/pdo.constants.php
*/
const ATTR_CLIENT_VERSION = 5;
/**
* This is a read only attribute; it will return some meta information about the
* database server to which PDO is connected.
* @link http://php.net/manual/en/pdo.constants.php
*/
const ATTR_SERVER_INFO = 6;
const ATTR_CONNECTION_STATUS = 7;
/**
* Force column names to a specific case specified by the PDO::CASE_*
* constants.
* @link http://php.net/manual/en/pdo.constants.php
*/
const ATTR_CASE = 8;
/**
* Get or set the name to use for a cursor. Most useful when using
* scrollable cursors and positioned updates.
* @link http://php.net/manual/en/pdo.constants.php
*/
const ATTR_CURSOR_NAME = 9;
/**
* Selects the cursor type. PDO currently supports either
* <b>PDO::CURSOR_FWDONLY</b> and
* <b>PDO::CURSOR_SCROLL</b>. Stick with
* <b>PDO::CURSOR_FWDONLY</b> unless you know that you need a
* scrollable cursor.
* @link http://php.net/manual/en/pdo.constants.php
*/
const ATTR_CURSOR = 10;
/**
* Convert empty strings to SQL NULL values on data fetches.
* @link http://php.net/manual/en/pdo.constants.php
*/
const ATTR_ORACLE_NULLS = 11;
/**
* Request a persistent connection, rather than creating a new connection.
* See Connections and Connection
* management for more information on this attribute.
* @link http://php.net/manual/en/pdo.constants.php
*/
const ATTR_PERSISTENT = 12;
const ATTR_STATEMENT_CLASS = 13;
/**
* Prepend the containing table name to each column name returned in the
* result set. The table name and column name are separated by a decimal (.)
* character. Support of this attribute is at the driver level; it may not
* be supported by your driver.
* @link http://php.net/manual/en/pdo.constants.php
*/
const ATTR_FETCH_TABLE_NAMES = 14;
/**
* Prepend the containing catalog name to each column name returned in the
* result set. The catalog name and column name are separated by a decimal
* (.) character. Support of this attribute is at the driver level; it may
* not be supported by your driver.
* @link http://php.net/manual/en/pdo.constants.php
*/
const ATTR_FETCH_CATALOG_NAMES = 15;
/**
* Returns the name of the driver.
* <p>
* using <b>PDO::ATTR_DRIVER_NAME</b>
* <code>
* if ($db->getAttribute(PDO::ATTR_DRIVER_NAME) == 'mysql') {
* echo "Running on mysql; doing something mysql specific here\n";
* }
* </code>
* </p>
* @link http://php.net/manual/en/pdo.constants.php
*/
const ATTR_DRIVER_NAME = 16;
const ATTR_STRINGIFY_FETCHES = 17;
const ATTR_MAX_COLUMN_LEN = 18;
/**
* Available since PHP 5.1.3.
* @link http://php.net/manual/en/pdo.constants.php
*/
const ATTR_EMULATE_PREPARES = 20;
/**
* Available since PHP 5.2.0
* @link http://php.net/manual/en/pdo.constants.php
*/
const ATTR_DEFAULT_FETCH_MODE = 19;
/**
* Do not raise an error or exception if an error occurs. The developer is
* expected to explicitly check for errors. This is the default mode.
* See Errors and error handling
* for more information about this attribute.
* @link http://php.net/manual/en/pdo.constants.php
*/
const ERRMODE_SILENT = 0;
/**
* Issue a PHP <b>E_WARNING</b> message if an error occurs.
* See Errors and error handling
* for more information about this attribute.
* @link http://php.net/manual/en/pdo.constants.php
*/
const ERRMODE_WARNING = 1;
/**
* Throw a <b>PDOException</b> if an error occurs.
* See Errors and error handling
* for more information about this attribute.
* @link http://php.net/manual/en/pdo.constants.php
*/
const ERRMODE_EXCEPTION = 2;
/**
* Leave column names as returned by the database driver.
* @link http://php.net/manual/en/pdo.constants.php
*/
const CASE_NATURAL = 0;
/**
* Force column names to lower case.
* @link http://php.net/manual/en/pdo.constants.php
*/
const CASE_LOWER = 2;
/**
* Force column names to upper case.
* @link http://php.net/manual/en/pdo.constants.php
*/
const CASE_UPPER = 1;
const NULL_NATURAL = 0;
const NULL_EMPTY_STRING = 1;
const NULL_TO_STRING = 2;
/**
* Corresponds to SQLSTATE '00000', meaning that the SQL statement was
* successfully issued with no errors or warnings. This constant is for
* your convenience when checking <b>PDO::errorCode</b> or
* <b>PDOStatement::errorCode</b> to determine if an error
* occurred. You will usually know if this is the case by examining the
* return code from the method that raised the error condition anyway.
* @link http://php.net/manual/en/pdo.constants.php
*/
const ERR_NONE = 00000;
/**
* Fetch the next row in the result set. Valid only for scrollable cursors.
* @link http://php.net/manual/en/pdo.constants.php
*/
const FETCH_ORI_NEXT = 0;
/**
* Fetch the previous row in the result set. Valid only for scrollable
* cursors.
* @link http://php.net/manual/en/pdo.constants.php
*/
const FETCH_ORI_PRIOR = 1;
/**
* Fetch the first row in the result set. Valid only for scrollable cursors.
* @link http://php.net/manual/en/pdo.constants.php
*/
const FETCH_ORI_FIRST = 2;
/**
* Fetch the last row in the result set. Valid only for scrollable cursors.
* @link http://php.net/manual/en/pdo.constants.php
*/
const FETCH_ORI_LAST = 3;
/**
* Fetch the requested row by row number from the result set. Valid only
* for scrollable cursors.
* @link http://php.net/manual/en/pdo.constants.php
*/
const FETCH_ORI_ABS = 4;
/**
* Fetch the requested row by relative position from the current position
* of the cursor in the result set. Valid only for scrollable cursors.
* @link http://php.net/manual/en/pdo.constants.php
*/
const FETCH_ORI_REL = 5;
/**
* Create a <b>PDOStatement</b> object with a forward-only cursor. This is the
* default cursor choice, as it is the fastest and most common data access
* pattern in PHP.
* @link http://php.net/manual/en/pdo.constants.php
*/
const CURSOR_FWDONLY = 0;
/**
* Create a <b>PDOStatement</b> object with a scrollable cursor. Pass the
* PDO::FETCH_ORI_* constants to control the rows fetched from the result set.
* @link http://php.net/manual/en/pdo.constants.php
*/
const CURSOR_SCROLL = 1;
/**
* <p>
* Available since PHP 5.3.0.
* </p>
* <p>
* Sets the date format.
* </p>
* @link http://php.net/manual/en/pdo-firebird.constants.php
*/
const FB_ATTR_DATE_FORMAT = 1000;
/**
* <p>
* Sets the time format.
* </p>
* <p>
* Available since PHP 5.3.0.
* </p>
* @link http://php.net/manual/en/pdo-firebird.constants.php
*/
const FB_ATTR_TIME_FORMAT = 1001;
/**
* <p>
* Sets the timestamp format.
* </p>
* <p>
* Available since PHP 5.3.0.
* </p>
* @link http://php.net/manual/en/pdo-firebird.constants.php
*/
const FB_ATTR_TIMESTAMP_FORMAT = 1002;
/**
* If this attribute is set to <b>TRUE</b> on a
* <b>PDOStatement</b>, the MySQL driver will use the
* buffered versions of the MySQL API. If you're writing portable code, you
* should use <b>PDOStatement::fetchAll</b> instead.
* <p>
* Forcing queries to be buffered in mysql
* <code>
* if ($db->getAttribute(PDO::ATTR_DRIVER_NAME) == 'mysql') {
* $stmt = $db->prepare('select * from foo',
* array(PDO::MYSQL_ATTR_USE_BUFFERED_QUERY => true));
* } else {
* die("my application only works with mysql; I should use \$stmt->fetchAll() instead");
* }
* </code>
* </p>
* @link http://php.net/manual/en/pdo-mysql.constants.php
*/
const MYSQL_ATTR_USE_BUFFERED_QUERY = 1000;
/**
* <p>
* Enable LOAD LOCAL INFILE.
* </p>
* <p>
* Note, this constant can only be used in the <i>driver_options</i>
* array when constructing a new database handle.
* </p>
* @link http://php.net/manual/en/pdo-mysql.constants.php
*/
const MYSQL_ATTR_LOCAL_INFILE = 1001;
/**
* <p>
* Command to execute when connecting to the MySQL server. Will
* automatically be re-executed when reconnecting.
* </p>
* <p>
* Note, this constant can only be used in the <i>driver_options</i>
* array when constructing a new database handle.
* </p>
* @link http://php.net/manual/en/pdo-mysql.constants.php
*/
const MYSQL_ATTR_INIT_COMMAND = 1002;
/**
* <p>
* Enable network communication compression. This is also supported when
* compiled against mysqlnd as of PHP 5.3.11.
* </p>
* @link http://php.net/manual/en/pdo-mysql.constants.php
*/
const MYSQL_ATTR_COMPRESS = 1003;
/**
* <p>
* Perform direct queries, don't use prepared statements.
* </p>
* @link http://php.net/manual/en/pdo-mysql.constants.php
*/
const MYSQL_ATTR_DIRECT_QUERY = 1004;
/**
* <p>
* Return the number of found (matched) rows, not the
* number of changed rows.
* </p>
* @link http://php.net/manual/en/pdo-mysql.constants.php
*/
const MYSQL_ATTR_FOUND_ROWS = 1005;
/**
* <p>
* Permit spaces after function names. Makes all functions
* names reserved words.
* </p>
* @link http://php.net/manual/en/pdo-mysql.constants.php
*/
const MYSQL_ATTR_IGNORE_SPACE = 1006;
/**
* <p>
* The file path to the SSL key.
* </p>
* <p>
* This exists as of PHP 5.3.7.
* </p>
* @link http://php.net/manual/en/pdo-mysql.constants.php
*/
const MYSQL_ATTR_SSL_KEY = 1007;
/**
* <p>
* The file path to the SSL certificate.
* </p>
* <p>
* This exists as of PHP 5.3.7.
* </p>
* @link http://php.net/manual/en/pdo-mysql.constants.php
*/
const MYSQL_ATTR_SSL_CERT = 1008;
/**
* <p>
* The file path to the SSL certificate authority.
* </p>
* <p>
* This exists as of PHP 5.3.7.
* </p>
* @link http://php.net/manual/en/pdo-mysql.constants.php
*/
const MYSQL_ATTR_SSL_CA = 1009;
/**
* <p>
* The file path to the directory that contains the trusted SSL
* CA certificates, which are stored in PEM format.
* </p>
* <p>
* This exists as of PHP 5.3.7.
* </p>
* @link http://php.net/manual/en/pdo-mysql.constants.php
*/
const MYSQL_ATTR_SSL_CAPATH = 1010;
/**
* <p>
* A list of one or more permissible ciphers to use for SSL encryption, in a format
* understood by OpenSSL. For example: DHE-RSA-AES256-SHA:AES128-SHA
* </p>
* <p>
* This exists as of PHP 5.3.7.
* </p>
* @link http://php.net/manual/en/pdo-mysql.constants.php
*/
const MYSQL_ATTR_SSL_CIPHER = 1011;
const MYSQL_ATTR_SERVER_PUBLIC_KEY = 1012;
const MYSQL_ATTR_MULTI_STATEMENTS = 1013;
const ODBC_ATTR_USE_CURSOR_LIBRARY = 1000;
const ODBC_ATTR_ASSUME_UTF8 = 1001;
const ODBC_SQL_USE_IF_NEEDED = 0;
const ODBC_SQL_USE_DRIVER = 2;
const ODBC_SQL_USE_ODBC = 1;
const PGSQL_ATTR_DISABLE_PREPARES = 1000;
const PGSQL_TRANSACTION_IDLE = 0;
const PGSQL_TRANSACTION_ACTIVE = 1;
const PGSQL_TRANSACTION_INTRANS = 2;
const PGSQL_TRANSACTION_INERROR = 3;
const PGSQL_TRANSACTION_UNKNOWN = 4;
/**
* (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0)<br/>
* Creates a PDO instance representing a connection to a database
* @link http://php.net/manual/en/pdo.construct.php
* @param string $dsn <p>
* <i>dsn</i> consists of a name
* <i>name</i> that maps to
* pdo.dsn.<i>name</i> in <i>php.ini</i>
* defining the DSN string.
* </p>
* <p>
* The alias must be defined in <i>php.ini</i>, and not .htaccess or httpd.conf
* </p>
* @param string $username [optional]
* @param string $password [optional]
* @param array $options [optional]
*/
public function __construct(string $dsn, string $username = null, string $password = null, array $options = null) {}
/**
* (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0)<br/>
* Prepares a statement for execution and returns a statement object
* @link http://php.net/manual/en/pdo.prepare.php
* @param string $statement <p>
* This must be a valid SQL statement template for the target database server.
* </p>
* @param array $driver_options [optional] <p>
* This array holds one or more key=>value pairs to set
* attribute values for the PDOStatement object that this method
* returns. You would most commonly use this to set the
* PDO::ATTR_CURSOR value to
* PDO::CURSOR_SCROLL to request a scrollable cursor.
* Some drivers have driver specific options that may be set at
* prepare-time.
* </p>
* @return PDOStatement If the database server successfully prepares the statement,
* <b>PDO::prepare</b> returns a
* <b>PDOStatement</b> object.
* If the database server cannot successfully prepare the statement,
* <b>PDO::prepare</b> returns <b>FALSE</b> or emits
* <b>PDOException</b> (depending on error handling).
* </p>
* <p>
* Emulated prepared statements does not communicate with the database server
* so <b>PDO::prepare</b> does not check the statement.
*/
public function prepare(string $statement, array $driver_options = array()): PDOStatement {}
/**
* (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0)<br/>
* Initiates a transaction
* @link http://php.net/manual/en/pdo.begintransaction.php
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
*/
public function beginTransaction(): bool {}
/**
* (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0)<br/>
* Commits a transaction
* @link http://php.net/manual/en/pdo.commit.php
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
*/
public function commit(): bool {}
/**
* (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0)<br/>
* Rolls back a transaction
* @link http://php.net/manual/en/pdo.rollback.php
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
*/
public function rollBack(): bool {}
/**
* (PHP 5 >= 5.3.3, Bundled pdo_pgsql, PHP 7)<br/>
* Checks if inside a transaction
* @link http://php.net/manual/en/pdo.intransaction.php
* @return bool <b>TRUE</b> if a transaction is currently active, and <b>FALSE</b> if not.
*/
public function inTransaction(): bool {}
/**
* (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0)<br/>
* Set an attribute
* @link http://php.net/manual/en/pdo.setattribute.php
* @param int $attribute
* @param mixed $value
* @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure.
*/
public function setAttribute(int $attribute, $value): bool {}
/**
* (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0)<br/>
* Execute an SQL statement and return the number of affected rows
* @link http://php.net/manual/en/pdo.exec.php
* @param string $statement <p>
* The SQL statement to prepare and execute.
* </p>
* <p>
* Data inside the query should be properly escaped.
* </p>
* @return int <b>PDO::exec</b> returns the number of rows that were modified
* or deleted by the SQL statement you issued. If no rows were affected,
* <b>PDO::exec</b> returns 0.
* </p>
* This function may
* return Boolean <b>FALSE</b>, but may also return a non-Boolean value which
* evaluates to <b>FALSE</b>. Please read the section on Booleans for more
* information. Use the ===
* operator for testing the return value of this
* function.
* <p>
* The following example incorrectly relies on the return value of
* <b>PDO::exec</b>, wherein a statement that affected 0 rows
* results in a call to <b>die</b>:
* <code>
* $db->exec() or die(print_r($db->errorInfo(), true));
* </code>
*/
public function exec(string $statement): int {}
/**
* (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.2.0)<br/>
* Executes an SQL statement, returning a result set as a PDOStatement object
* @link http://php.net/manual/en/pdo.query.php
* @param string $statement <p>
* The SQL statement to prepare and execute.
* </p>
* <p>
* Data inside the query should be properly escaped.
* </p>
* @return PDOStatement <b>PDO::query</b> returns a PDOStatement object, or <b>FALSE</b>
* on failure.
*/
public function query(string $statement): PDOStatement {}
/**
* (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0)<br/>
* Returns the ID of the last inserted row or sequence value
* @link http://php.net/manual/en/pdo.lastinsertid.php
* @param string $name [optional] <p>
* Name of the sequence object from which the ID should be returned.
* </p>
* @return string If a sequence name was not specified for the <i>name</i>
* parameter, <b>PDO::lastInsertId</b> returns a
* string representing the row ID of the last row that was inserted into
* the database.
* </p>
* <p>
* If a sequence name was specified for the <i>name</i>
* parameter, <b>PDO::lastInsertId</b> returns a
* string representing the last value retrieved from the specified sequence
* object.
* </p>
* <p>
* If the PDO driver does not support this capability,
* <b>PDO::lastInsertId</b> triggers an
* IM001 SQLSTATE.
*/
public function lastInsertId(string $name = null): string {}
/**
* (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0)<br/>
* Fetch the SQLSTATE associated with the last operation on the database handle
* @link http://php.net/manual/en/pdo.errorcode.php
* @return mixed an SQLSTATE, a five characters alphanumeric identifier defined in
* the ANSI SQL-92 standard. Briefly, an SQLSTATE consists of a
* two characters class value followed by a three characters subclass value. A
* class value of 01 indicates a warning and is accompanied by a return code
* of SQL_SUCCESS_WITH_INFO. Class values other than '01', except for the
* class 'IM', indicate an error. The class 'IM' is specific to warnings
* and errors that derive from the implementation of PDO (or perhaps ODBC,
* if you're using the ODBC driver) itself. The subclass value '000' in any
* class indicates that there is no subclass for that SQLSTATE.
* </p>
* <p>
* <b>PDO::errorCode</b> only retrieves error codes for operations
* performed directly on the database handle. If you create a PDOStatement
* object through <b>PDO::prepare</b> or
* <b>PDO::query</b> and invoke an error on the statement
* handle, <b>PDO::errorCode</b> will not reflect that error.
* You must call <b>PDOStatement::errorCode</b> to return the error
* code for an operation performed on a particular statement handle.
* </p>
* <p>
* Returns <b>NULL</b> if no operation has been run on the database handle.
*/
public function errorCode() {}
/**
* (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0)<br/>
* Fetch extended error information associated with the last operation on the database handle
* @link http://php.net/manual/en/pdo.errorinfo.php
* @return array <b>PDO::errorInfo</b> returns an array of error information
* about the last operation performed by this database handle. The array
* consists of the following fields:
* <tr valign="top">
* <td>Element</td>
* <td>Information</td>
* </tr>
* <tr valign="top">
* <td>0</td>
* <td>SQLSTATE error code (a five characters alphanumeric identifier defined
* in the ANSI SQL standard).</td>
* </tr>
* <tr valign="top">
* <td>1</td>
* <td>Driver-specific error code.</td>
* </tr>
* <tr valign="top">
* <td>2</td>
* <td>Driver-specific error message.</td>
* </tr>
* </p>
* <p>
* If the SQLSTATE error code is not set or there is no driver-specific
* error, the elements following element 0 will be set to <b>NULL</b>.
* </p>
* <p>
* <b>PDO::errorInfo</b> only retrieves error information for
* operations performed directly on the database handle. If you create a
* PDOStatement object through <b>PDO::prepare</b> or
* <b>PDO::query</b> and invoke an error on the statement
* handle, <b>PDO::errorInfo</b> will not reflect the error
* from the statement handle. You must call
* <b>PDOStatement::errorInfo</b> to return the error
* information for an operation performed on a particular statement handle.
*/