@@ -12,54 +12,54 @@ |
||
12 | 12 | */ |
13 | 13 | class LibXMLError |
14 | 14 | { |
15 | - /** |
|
16 | - * <p style="margin-top:0;"> |
|
17 | - * the severity of the error (one of the following constants: |
|
18 | - * <b><code>LIBXML_ERR_WARNING</code></b>, |
|
19 | - * <b><code>LIBXML_ERR_ERROR</code></b> or |
|
20 | - * <b><code>LIBXML_ERR_FATAL</code></b>) |
|
21 | - * </p> |
|
22 | - * @var int |
|
23 | - */ |
|
24 | - public int $level; |
|
25 | - /** |
|
26 | - * <p style="margin-top:0;"> |
|
27 | - * The error's code. |
|
28 | - * </p> |
|
29 | - * @var int |
|
30 | - */ |
|
31 | - public int $code; |
|
32 | - /** |
|
33 | - * <p style="margin-top:0;"> |
|
34 | - * The column where the error occurred. |
|
35 | - * </p> |
|
36 | - * <p><b>Note</b>: |
|
37 | - * </p><p> |
|
38 | - * This property isn't entirely implemented in libxml and therefore |
|
39 | - * 0 is often returned. |
|
40 | - * </p> |
|
41 | - * @var int |
|
42 | - */ |
|
43 | - public int $column; |
|
44 | - /** |
|
45 | - * <p style="margin-top:0;"> |
|
46 | - * The error message, if any. |
|
47 | - * </p> |
|
48 | - * @var string |
|
49 | - */ |
|
50 | - public string $message; |
|
51 | - /** |
|
52 | - * <p style="margin-top:0;">The filename, or empty if the XML was loaded from a string.</p> |
|
53 | - * @var string |
|
54 | - */ |
|
55 | - public string $file; |
|
56 | - /** |
|
57 | - * <p style="margin-top:0;"> |
|
58 | - * The line where the error occurred. |
|
59 | - * </p> |
|
60 | - * @var int |
|
61 | - */ |
|
62 | - public int $line; |
|
15 | + /** |
|
16 | + * <p style="margin-top:0;"> |
|
17 | + * the severity of the error (one of the following constants: |
|
18 | + * <b><code>LIBXML_ERR_WARNING</code></b>, |
|
19 | + * <b><code>LIBXML_ERR_ERROR</code></b> or |
|
20 | + * <b><code>LIBXML_ERR_FATAL</code></b>) |
|
21 | + * </p> |
|
22 | + * @var int |
|
23 | + */ |
|
24 | + public int $level; |
|
25 | + /** |
|
26 | + * <p style="margin-top:0;"> |
|
27 | + * The error's code. |
|
28 | + * </p> |
|
29 | + * @var int |
|
30 | + */ |
|
31 | + public int $code; |
|
32 | + /** |
|
33 | + * <p style="margin-top:0;"> |
|
34 | + * The column where the error occurred. |
|
35 | + * </p> |
|
36 | + * <p><b>Note</b>: |
|
37 | + * </p><p> |
|
38 | + * This property isn't entirely implemented in libxml and therefore |
|
39 | + * 0 is often returned. |
|
40 | + * </p> |
|
41 | + * @var int |
|
42 | + */ |
|
43 | + public int $column; |
|
44 | + /** |
|
45 | + * <p style="margin-top:0;"> |
|
46 | + * The error message, if any. |
|
47 | + * </p> |
|
48 | + * @var string |
|
49 | + */ |
|
50 | + public string $message; |
|
51 | + /** |
|
52 | + * <p style="margin-top:0;">The filename, or empty if the XML was loaded from a string.</p> |
|
53 | + * @var string |
|
54 | + */ |
|
55 | + public string $file; |
|
56 | + /** |
|
57 | + * <p style="margin-top:0;"> |
|
58 | + * The line where the error occurred. |
|
59 | + * </p> |
|
60 | + * @var int |
|
61 | + */ |
|
62 | + public int $line; |
|
63 | 63 | } |
64 | 64 | |
65 | 65 | /** |
@@ -91,7 +91,7 @@ discard block |
||
91 | 91 | * buffer, <b>FALSE</b> otherwise. |
92 | 92 | */ |
93 | 93 | #[Pure(true)] |
94 | -function libxml_get_last_error(): LibXMLError|false {} |
|
94 | +function libxml_get_last_error(): LibXMLError | false {} |
|
95 | 95 | |
96 | 96 | /** |
97 | 97 | * Clear libxml error buffer |
@@ -120,7 +120,7 @@ discard block |
||
120 | 120 | * @return bool the previous value. |
121 | 121 | * @since 5.2.11 |
122 | 122 | */ |
123 | -#[Deprecated(since: "8.0")] |
|
123 | +#[Deprecated(since : "8.0")] |
|
124 | 124 | function libxml_disable_entity_loader(bool $disable = true): bool {} |
125 | 125 | |
126 | 126 | /** |
@@ -10,8 +10,7 @@ |
||
10 | 10 | * xmlError API documentation. |
11 | 11 | * @link https://php.net/manual/en/class.libxmlerror.php |
12 | 12 | */ |
13 | -class LibXMLError |
|
14 | -{ |
|
13 | +class LibXMLError { |
|
15 | 14 | /** |
16 | 15 | * <p style="margin-top:0;"> |
17 | 16 | * the severity of the error (one of the following constants: |
@@ -9,81 +9,81 @@ |
||
9 | 9 | |
10 | 10 | class finfo |
11 | 11 | { |
12 | - /** |
|
13 | - * @param int $flags [optional] |
|
14 | - * @param string $magic_database [optional] |
|
15 | - */ |
|
16 | - public function __construct( |
|
17 | - #[LanguageLevelTypeAware(['8.0' => 'int'], default: '')] $flags, |
|
18 | - #[LanguageLevelTypeAware(['8.0' => 'string|null'], default: '')] $magic_database |
|
19 | - ) {} |
|
20 | - |
|
21 | - /** |
|
22 | - * @param $options [optional] |
|
23 | - * @param $arg [optional] |
|
24 | - */ |
|
25 | - #[PhpStormStubsElementAvailable(from: '5.3', to: '7.4')] |
|
26 | - public function finfo($options, $arg) {} |
|
27 | - |
|
28 | - /** |
|
29 | - * (PHP >= 5.3.0, PECL fileinfo >= 0.1.0)<br/> |
|
30 | - * Set libmagic configuration options |
|
31 | - * @link https://php.net/manual/en/function.finfo-set-flags.php |
|
32 | - * @param int $flags <p> |
|
33 | - * One or disjunction of more Fileinfo |
|
34 | - * constants. |
|
35 | - * </p> |
|
36 | - * @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure. |
|
37 | - */ |
|
38 | - public function set_flags(#[LanguageLevelTypeAware(['8.0' => 'int'], default: '')] $flags) {} |
|
39 | - |
|
40 | - /** |
|
41 | - * (PHP >= 5.3.0, PECL fileinfo >= 0.1.0)<br/> |
|
42 | - * Return information about a file |
|
43 | - * @link https://php.net/manual/en/function.finfo-file.php |
|
44 | - * @param string $filename [optional] <p> |
|
45 | - * Name of a file to be checked. |
|
46 | - * </p> |
|
47 | - * @param int $flags [optional] <p> |
|
48 | - * One or disjunction of more Fileinfo |
|
49 | - * constants. |
|
50 | - * </p> |
|
51 | - * @param resource $context [optional] <p> |
|
52 | - * For a description of contexts, refer to . |
|
53 | - * </p> |
|
54 | - * @return string a textual description of the contents of the |
|
55 | - * <i>filename</i> argument, or <b>FALSE</b> if an error occurred. |
|
56 | - */ |
|
57 | - #[Pure] |
|
58 | - #[TentativeType] |
|
59 | - public function file( |
|
60 | - #[LanguageLevelTypeAware(['8.0' => 'string'], default: '')] $filename = null, |
|
61 | - #[LanguageLevelTypeAware(['8.0' => 'int'], default: '')] $flags = FILEINFO_NONE, |
|
62 | - $context = null |
|
63 | - ): string|false {} |
|
64 | - |
|
65 | - /** |
|
66 | - * (PHP 5 >= 5.3.0, PECL fileinfo >= 0.1.0)<br/> |
|
67 | - * Return information about a string buffer |
|
68 | - * @link https://php.net/manual/en/function.finfo-buffer.php |
|
69 | - * @param string $string [optional] <p> |
|
70 | - * Content of a file to be checked. |
|
71 | - * </p> |
|
72 | - * @param int $flags [optional] <p> |
|
73 | - * One or disjunction of more Fileinfo |
|
74 | - * constants. |
|
75 | - * </p> |
|
76 | - * @param resource $context [optional] |
|
77 | - * @return string a textual description of the <i>string</i> |
|
78 | - * argument, or <b>FALSE</b> if an error occurred. |
|
79 | - */ |
|
80 | - #[Pure] |
|
81 | - #[TentativeType] |
|
82 | - public function buffer( |
|
83 | - #[LanguageLevelTypeAware(['8.0' => 'string'], default: '')] $string = null, |
|
84 | - #[LanguageLevelTypeAware(['8.0' => 'int'], default: '')] $flags = FILEINFO_NONE, |
|
85 | - $context = null |
|
86 | - ): string|false {} |
|
12 | + /** |
|
13 | + * @param int $flags [optional] |
|
14 | + * @param string $magic_database [optional] |
|
15 | + */ |
|
16 | + public function __construct( |
|
17 | + #[LanguageLevelTypeAware(['8.0' => 'int'], default: '')] $flags, |
|
18 | + #[LanguageLevelTypeAware(['8.0' => 'string|null'], default: '')] $magic_database |
|
19 | + ) {} |
|
20 | + |
|
21 | + /** |
|
22 | + * @param $options [optional] |
|
23 | + * @param $arg [optional] |
|
24 | + */ |
|
25 | + #[PhpStormStubsElementAvailable(from: '5.3', to: '7.4')] |
|
26 | + public function finfo($options, $arg) {} |
|
27 | + |
|
28 | + /** |
|
29 | + * (PHP >= 5.3.0, PECL fileinfo >= 0.1.0)<br/> |
|
30 | + * Set libmagic configuration options |
|
31 | + * @link https://php.net/manual/en/function.finfo-set-flags.php |
|
32 | + * @param int $flags <p> |
|
33 | + * One or disjunction of more Fileinfo |
|
34 | + * constants. |
|
35 | + * </p> |
|
36 | + * @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure. |
|
37 | + */ |
|
38 | + public function set_flags(#[LanguageLevelTypeAware(['8.0' => 'int'], default: '')] $flags) {} |
|
39 | + |
|
40 | + /** |
|
41 | + * (PHP >= 5.3.0, PECL fileinfo >= 0.1.0)<br/> |
|
42 | + * Return information about a file |
|
43 | + * @link https://php.net/manual/en/function.finfo-file.php |
|
44 | + * @param string $filename [optional] <p> |
|
45 | + * Name of a file to be checked. |
|
46 | + * </p> |
|
47 | + * @param int $flags [optional] <p> |
|
48 | + * One or disjunction of more Fileinfo |
|
49 | + * constants. |
|
50 | + * </p> |
|
51 | + * @param resource $context [optional] <p> |
|
52 | + * For a description of contexts, refer to . |
|
53 | + * </p> |
|
54 | + * @return string a textual description of the contents of the |
|
55 | + * <i>filename</i> argument, or <b>FALSE</b> if an error occurred. |
|
56 | + */ |
|
57 | + #[Pure] |
|
58 | + #[TentativeType] |
|
59 | + public function file( |
|
60 | + #[LanguageLevelTypeAware(['8.0' => 'string'], default: '')] $filename = null, |
|
61 | + #[LanguageLevelTypeAware(['8.0' => 'int'], default: '')] $flags = FILEINFO_NONE, |
|
62 | + $context = null |
|
63 | + ): string|false {} |
|
64 | + |
|
65 | + /** |
|
66 | + * (PHP 5 >= 5.3.0, PECL fileinfo >= 0.1.0)<br/> |
|
67 | + * Return information about a string buffer |
|
68 | + * @link https://php.net/manual/en/function.finfo-buffer.php |
|
69 | + * @param string $string [optional] <p> |
|
70 | + * Content of a file to be checked. |
|
71 | + * </p> |
|
72 | + * @param int $flags [optional] <p> |
|
73 | + * One or disjunction of more Fileinfo |
|
74 | + * constants. |
|
75 | + * </p> |
|
76 | + * @param resource $context [optional] |
|
77 | + * @return string a textual description of the <i>string</i> |
|
78 | + * argument, or <b>FALSE</b> if an error occurred. |
|
79 | + */ |
|
80 | + #[Pure] |
|
81 | + #[TentativeType] |
|
82 | + public function buffer( |
|
83 | + #[LanguageLevelTypeAware(['8.0' => 'string'], default: '')] $string = null, |
|
84 | + #[LanguageLevelTypeAware(['8.0' => 'int'], default: '')] $flags = FILEINFO_NONE, |
|
85 | + $context = null |
|
86 | + ): string|false {} |
|
87 | 87 | } |
88 | 88 | |
89 | 89 | /** |
@@ -60,7 +60,7 @@ discard block |
||
60 | 60 | #[LanguageLevelTypeAware(['8.0' => 'string'], default: '')] $filename = null, |
61 | 61 | #[LanguageLevelTypeAware(['8.0' => 'int'], default: '')] $flags = FILEINFO_NONE, |
62 | 62 | $context = null |
63 | - ): string|false {} |
|
63 | + ): string | false {} |
|
64 | 64 | |
65 | 65 | /** |
66 | 66 | * (PHP 5 >= 5.3.0, PECL fileinfo >= 0.1.0)<br/> |
@@ -83,7 +83,7 @@ discard block |
||
83 | 83 | #[LanguageLevelTypeAware(['8.0' => 'string'], default: '')] $string = null, |
84 | 84 | #[LanguageLevelTypeAware(['8.0' => 'int'], default: '')] $flags = FILEINFO_NONE, |
85 | 85 | $context = null |
86 | - ): string|false {} |
|
86 | + ): string | false {} |
|
87 | 87 | } |
88 | 88 | |
89 | 89 | /** |
@@ -116,7 +116,7 @@ discard block |
||
116 | 116 | * </p> |
117 | 117 | * @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure. |
118 | 118 | */ |
119 | -function finfo_close(#[LanguageLevelTypeAware(['8.1' => 'finfo'], default: 'resource')] $finfo): bool {} |
|
119 | +function finfo_close(#[LanguageLevelTypeAware(['8.1' => 'finfo'], default : 'resource')] $finfo): bool {} |
|
120 | 120 | |
121 | 121 | /** |
122 | 122 | * (PHP >= 5.3.0, PECL fileinfo >= 0.1.0)<br/> |
@@ -131,7 +131,7 @@ discard block |
||
131 | 131 | * </p> |
132 | 132 | * @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure. |
133 | 133 | */ |
134 | -function finfo_set_flags(#[LanguageLevelTypeAware(['8.1' => 'finfo'], default: 'resource')] $finfo, int $flags): bool {} |
|
134 | +function finfo_set_flags(#[LanguageLevelTypeAware(['8.1' => 'finfo'], default : 'resource')] $finfo, int $flags): bool {} |
|
135 | 135 | |
136 | 136 | /** |
137 | 137 | * (PHP >= 5.3.0, PECL fileinfo >= 0.1.0)<br/> |
@@ -153,7 +153,7 @@ discard block |
||
153 | 153 | * @return string|false a textual description of the contents of the |
154 | 154 | * <i>filename</i> argument, or <b>FALSE</b> if an error occurred. |
155 | 155 | */ |
156 | -function finfo_file(#[LanguageLevelTypeAware(['8.1' => 'finfo'], default: 'resource')] $finfo, string $filename, int $flags, $context): string|false {} |
|
156 | +function finfo_file(#[LanguageLevelTypeAware(['8.1' => 'finfo'], default : 'resource')] $finfo, string $filename, int $flags, $context): string | false {} |
|
157 | 157 | |
158 | 158 | /** |
159 | 159 | * (PHP 5 >= 5.3.0, PECL fileinfo >= 0.1.0)<br/> |
@@ -171,7 +171,7 @@ discard block |
||
171 | 171 | * @return string|false a textual description of the <i>string</i> |
172 | 172 | * argument, or <b>FALSE</b> if an error occurred. |
173 | 173 | */ |
174 | -function finfo_buffer(#[LanguageLevelTypeAware(['8.1' => 'finfo'], default: 'resource')] $finfo, string $string, int $flags = FILEINFO_NONE, $context): string|false {} |
|
174 | +function finfo_buffer(#[LanguageLevelTypeAware(['8.1' => 'finfo'], default : 'resource')] $finfo, string $string, int $flags = FILEINFO_NONE, $context): string | false {} |
|
175 | 175 | |
176 | 176 | /** |
177 | 177 | * Detect MIME Content-type for a file |
@@ -182,7 +182,7 @@ discard block |
||
182 | 182 | * @return string|false the content type in MIME format, like |
183 | 183 | * text/plain or application/octet-stream. |
184 | 184 | */ |
185 | -function mime_content_type($filename): string|false {} |
|
185 | +function mime_content_type($filename): string | false {} |
|
186 | 186 | |
187 | 187 | /** |
188 | 188 | * No special handling. |
@@ -7,8 +7,7 @@ |
||
7 | 7 | use JetBrains\PhpStorm\Internal\TentativeType; |
8 | 8 | use JetBrains\PhpStorm\Pure; |
9 | 9 | |
10 | -class finfo |
|
11 | -{ |
|
10 | +class finfo { |
|
12 | 11 | /** |
13 | 12 | * @param int $flags [optional] |
14 | 13 | * @param string $magic_database [optional] |
@@ -10,273 +10,273 @@ discard block |
||
10 | 10 | */ |
11 | 11 | class ZMQ |
12 | 12 | { |
13 | - /** |
|
14 | - * Exclusive pair pattern |
|
15 | - */ |
|
16 | - public const SOCKET_PAIR = 0; |
|
17 | - /** |
|
18 | - * Publisher socket |
|
19 | - */ |
|
20 | - public const SOCKET_PUB = 1; |
|
21 | - /** |
|
22 | - * Subscriber socket |
|
23 | - */ |
|
24 | - public const SOCKET_SUB = 2; |
|
25 | - /** |
|
26 | - * Request socket |
|
27 | - */ |
|
28 | - public const SOCKET_REQ = 3; |
|
29 | - /** |
|
30 | - * Reply socket |
|
31 | - */ |
|
32 | - public const SOCKET_REP = 4; |
|
33 | - /** |
|
34 | - * Alias for SOCKET_DEALER |
|
35 | - */ |
|
36 | - public const SOCKET_XREQ = 5; |
|
37 | - /** |
|
38 | - * Alias for SOCKET_ROUTER |
|
39 | - */ |
|
40 | - public const SOCKET_XREP = 6; |
|
41 | - /** |
|
42 | - * Pipeline upstream push socket |
|
43 | - */ |
|
44 | - public const SOCKET_PUSH = 8; |
|
45 | - /** |
|
46 | - * Pipeline downstream pull socket |
|
47 | - */ |
|
48 | - public const SOCKET_PULL = 7; |
|
49 | - /** |
|
50 | - * Extended REP socket that can route replies to requesters |
|
51 | - */ |
|
52 | - public const SOCKET_ROUTER = 6; |
|
53 | - /** |
|
54 | - * Extended REQ socket that load balances to all connected peers |
|
55 | - */ |
|
56 | - public const SOCKET_DEALER = 5; |
|
57 | - /** |
|
58 | - * Similar to SOCKET_PUB, except you can receive subscriptions as messages. |
|
59 | - * The subscription message is 0 (unsubscribe) or 1 (subscribe) followed by the topic. |
|
60 | - */ |
|
61 | - public const SOCKET_XPUB = 9; |
|
62 | - /** |
|
63 | - * Similar to SOCKET_SUB, except you can send subscriptions as messages. See SOCKET_XPUB for format. |
|
64 | - */ |
|
65 | - public const SOCKET_XSUB = 10; |
|
66 | - /** |
|
67 | - * Used to send and receive TCP data from a non-ØMQ peer. |
|
68 | - * Available if compiled against ZeroMQ 4.x or higher. |
|
69 | - */ |
|
70 | - public const SOCKET_STREAM = 11; |
|
71 | - /** |
|
72 | - * The high water mark for inbound and outbound messages is a hard |
|
73 | - * limit on the maximum number of outstanding messages ØMQ shall queue in memory |
|
74 | - * for any single peer that the specified socket is communicating with. |
|
75 | - * Setting this option on a socket will only affect connections made after the option has been set. |
|
76 | - * On ZeroMQ 3.x this is a wrapper for setting both SNDHWM and RCVHWM. |
|
77 | - */ |
|
78 | - public const SOCKOPT_HWM = 1; |
|
79 | - /** |
|
80 | - * The ZMQ_SNDHWM option shall set the high water mark for outbound messages on the specified socket. |
|
81 | - * Available if compiled against ZeroMQ 3.x or higher. |
|
82 | - */ |
|
83 | - public const SOCKOPT_SNDHWM = 23; |
|
84 | - /** |
|
85 | - * The ZMQ_SNDHWM option shall set the high water mark for inbound messages on the specified socket. |
|
86 | - * Available if compiled against ZeroMQ 3.x or higher. |
|
87 | - */ |
|
88 | - public const SOCKOPT_RCVHWM = 24; |
|
89 | - /** |
|
90 | - * Set I/O thread affinity |
|
91 | - */ |
|
92 | - public const SOCKOPT_AFFINITY = 4; |
|
93 | - /** |
|
94 | - * Set socket identity |
|
95 | - */ |
|
96 | - public const SOCKOPT_IDENTITY = 5; |
|
97 | - /** |
|
98 | - * Establish message filter. Valid for subscriber socket |
|
99 | - */ |
|
100 | - public const SOCKOPT_SUBSCRIBE = 6; |
|
101 | - /** |
|
102 | - * Remove message filter. Valid for subscriber socket |
|
103 | - */ |
|
104 | - public const SOCKOPT_UNSUBSCRIBE = 7; |
|
105 | - /** |
|
106 | - * Set rate for multicast sockets (pgm) (Value: int >= 0) |
|
107 | - */ |
|
108 | - public const SOCKOPT_RATE = 8; |
|
109 | - /** |
|
110 | - * Set multicast recovery interval (Value: int >= 0) |
|
111 | - */ |
|
112 | - public const SOCKOPT_RECOVERY_IVL = 9; |
|
113 | - /** |
|
114 | - * Set the initial reconnection interval (Value: int >= 0) |
|
115 | - */ |
|
116 | - public const SOCKOPT_RECONNECT_IVL = 18; |
|
117 | - /** |
|
118 | - * Set the max reconnection interval (Value: int >= 0) |
|
119 | - */ |
|
120 | - public const SOCKOPT_RECONNECT_IVL_MAX = 21; |
|
121 | - /** |
|
122 | - * Control multicast loopback (Value: int >= 0) |
|
123 | - */ |
|
124 | - public const SOCKOPT_MCAST_LOOP = 10; |
|
125 | - /** |
|
126 | - * Set kernel transmit buffer size (Value: int >= 0) |
|
127 | - */ |
|
128 | - public const SOCKOPT_SNDBUF = 11; |
|
129 | - /** |
|
130 | - * Set kernel receive buffer size (Value: int >= 0) |
|
131 | - */ |
|
132 | - public const SOCKOPT_RCVBUF = 12; |
|
133 | - /** |
|
134 | - * Receive multi-part messages |
|
135 | - */ |
|
136 | - public const SOCKOPT_RCVMORE = 13; |
|
137 | - /** |
|
138 | - * Get the socket type. Valid for getSockOpt |
|
139 | - */ |
|
140 | - public const SOCKOPT_TYPE = 16; |
|
141 | - /** |
|
142 | - * The linger value of the socket. |
|
143 | - * Specifies how long the socket blocks trying flush messages after it has been closed |
|
144 | - */ |
|
145 | - public const SOCKOPT_LINGER = 17; |
|
146 | - /** |
|
147 | - * The SOCKOPT_BACKLOG option shall set the maximum length of the queue of outstanding peer connections |
|
148 | - * for the specified socket; this only applies to connection-oriented transports. |
|
149 | - */ |
|
150 | - public const SOCKOPT_BACKLOG = 19; |
|
151 | - /** |
|
152 | - * Limits the maximum size of the inbound message. Value -1 means no limit. |
|
153 | - * Available if compiled against ZeroMQ 3.x or higher |
|
154 | - */ |
|
155 | - public const SOCKOPT_MAXMSGSIZE = 22; |
|
156 | - /** |
|
157 | - * Sets the timeout for send operation on the socket. Value -1 means no limit. |
|
158 | - * Available if compiled against ZeroMQ 3.x or higher |
|
159 | - */ |
|
160 | - public const SOCKOPT_SNDTIMEO = 28; |
|
161 | - /** |
|
162 | - * Sets the timeout for receive operation on the socket. Value -1 means no limit. |
|
163 | - * Available if compiled against ZeroMQ 3.x or higher |
|
164 | - */ |
|
165 | - public const SOCKOPT_RCVTIMEO = 27; |
|
166 | - /** |
|
167 | - * Disable IPV6 support if 1. |
|
168 | - * Available if compiled against ZeroMQ 3.x |
|
169 | - */ |
|
170 | - public const SOCKOPT_IPV4ONLY = 31; |
|
171 | - /** |
|
172 | - * Retrieve the last connected endpoint - for use with * wildcard ports. |
|
173 | - * Available if compiled against ZeroMQ 3.x or higher |
|
174 | - */ |
|
175 | - public const SOCKOPT_LAST_ENDPOINT = 32; |
|
176 | - /** |
|
177 | - * Idle time for TCP keepalive. |
|
178 | - * Available if compiled against ZeroMQ 3.x or higher |
|
179 | - */ |
|
180 | - public const SOCKOPT_TCP_KEEPALIVE_IDLE = 36; |
|
181 | - /** |
|
182 | - * Count time for TCP keepalive. |
|
183 | - * Available if compiled against ZeroMQ 3.x or higher |
|
184 | - */ |
|
185 | - public const SOCKOPT_TCP_KEEPALIVE_CNT = 35; |
|
186 | - /** |
|
187 | - * Interval for TCP keepalive. |
|
188 | - * Available if compiled against ZeroMQ 3.x or higher |
|
189 | - */ |
|
190 | - public const SOCKOPT_TCP_KEEPALIVE_INTVL = 37; |
|
191 | - /** |
|
192 | - * Set a CIDR string to match against incoming TCP connections. |
|
193 | - * Available if compiled against ZeroMQ 3.x or higher |
|
194 | - */ |
|
195 | - public const SOCKOPT_DELAY_ATTACH_ON_CONNECT = 39; |
|
196 | - /** |
|
197 | - * Set a CIDR string to match against incoming TCP connections. |
|
198 | - * Available if compiled against ZeroMQ 3.x or higher |
|
199 | - */ |
|
200 | - public const SOCKOPT_TCP_ACCEPT_FILTER = 38; |
|
201 | - /** |
|
202 | - * Set the XPUB to receive an application message on each instance of a subscription. |
|
203 | - * Available if compiled against ZeroMQ 3.x or higher |
|
204 | - */ |
|
205 | - public const SOCKOPT_XPUB_VERBOSE = 40; |
|
206 | - /** |
|
207 | - * Sets the raw mode on the ROUTER, when set to 1. |
|
208 | - * In raw mode when using tcp:// transport the socket will read and write without ZeroMQ framing. |
|
209 | - * Available if compiled against ZeroMQ 4.0 or higher |
|
210 | - */ |
|
211 | - public const SOCKOPT_ROUTER_RAW = 41; |
|
212 | - /** |
|
213 | - * Enable IPV6. |
|
214 | - * Available if compiled against ZeroMQ 4.0 or higher |
|
215 | - */ |
|
216 | - public const SOCKOPT_IPV6 = 42; |
|
217 | - /** |
|
218 | - * The socket limit for this context. |
|
219 | - * Available if compiled against ZeroMQ 3.x or higher |
|
220 | - */ |
|
221 | - public const CTXOPT_MAX_SOCKETS = 2; |
|
222 | - /** |
|
223 | - * Poll for incoming data |
|
224 | - */ |
|
225 | - public const POLL_IN = 1; |
|
226 | - /** |
|
227 | - * Poll for outgoing data |
|
228 | - */ |
|
229 | - public const POLL_OUT = 2; |
|
230 | - /** |
|
231 | - * Non-blocking operation. |
|
232 | - * @deprecated use ZMQ::MODE_DONTWAIT instead |
|
233 | - */ |
|
234 | - public const MODE_NOBLOCK = 1; |
|
235 | - /** |
|
236 | - * Non-blocking operation |
|
237 | - */ |
|
238 | - public const MODE_DONTWAIT = 1; |
|
239 | - /** |
|
240 | - * Send multi-part message |
|
241 | - */ |
|
242 | - public const MODE_SNDMORE = 2; |
|
243 | - /** |
|
244 | - * Forwarder device |
|
245 | - */ |
|
246 | - public const DEVICE_FORWARDER = 2; |
|
247 | - /** |
|
248 | - * Queue device |
|
249 | - */ |
|
250 | - public const DEVICE_QUEUE = 3; |
|
251 | - /** |
|
252 | - * Streamer device |
|
253 | - */ |
|
254 | - public const DEVICE_STREAMER = 1; |
|
255 | - /** |
|
256 | - * ZMQ extension internal error |
|
257 | - */ |
|
258 | - public const ERR_INTERNAL = -99; |
|
259 | - /** |
|
260 | - * Implies that the operation would block when ZMQ::MODE_DONTWAIT is used |
|
261 | - */ |
|
262 | - public const ERR_EAGAIN = 11; |
|
263 | - /** |
|
264 | - * The operation is not supported by the socket type |
|
265 | - */ |
|
266 | - public const ERR_ENOTSUP = 156384713; |
|
267 | - /** |
|
268 | - * The operation can not be executed because the socket is not in correct state |
|
269 | - */ |
|
270 | - public const ERR_EFSM = 156384763; |
|
271 | - /** |
|
272 | - * The context has been terminated |
|
273 | - */ |
|
274 | - public const ERR_ETERM = 156384765; |
|
275 | - /** |
|
276 | - * Private constructor to prevent direct initialization. This class holds the constants for ZMQ extension. |
|
277 | - * @link https://secure.php.net/manual/en/zmq.construct.php |
|
278 | - */ |
|
279 | - private function __construct() {} |
|
13 | + /** |
|
14 | + * Exclusive pair pattern |
|
15 | + */ |
|
16 | + public const SOCKET_PAIR = 0; |
|
17 | + /** |
|
18 | + * Publisher socket |
|
19 | + */ |
|
20 | + public const SOCKET_PUB = 1; |
|
21 | + /** |
|
22 | + * Subscriber socket |
|
23 | + */ |
|
24 | + public const SOCKET_SUB = 2; |
|
25 | + /** |
|
26 | + * Request socket |
|
27 | + */ |
|
28 | + public const SOCKET_REQ = 3; |
|
29 | + /** |
|
30 | + * Reply socket |
|
31 | + */ |
|
32 | + public const SOCKET_REP = 4; |
|
33 | + /** |
|
34 | + * Alias for SOCKET_DEALER |
|
35 | + */ |
|
36 | + public const SOCKET_XREQ = 5; |
|
37 | + /** |
|
38 | + * Alias for SOCKET_ROUTER |
|
39 | + */ |
|
40 | + public const SOCKET_XREP = 6; |
|
41 | + /** |
|
42 | + * Pipeline upstream push socket |
|
43 | + */ |
|
44 | + public const SOCKET_PUSH = 8; |
|
45 | + /** |
|
46 | + * Pipeline downstream pull socket |
|
47 | + */ |
|
48 | + public const SOCKET_PULL = 7; |
|
49 | + /** |
|
50 | + * Extended REP socket that can route replies to requesters |
|
51 | + */ |
|
52 | + public const SOCKET_ROUTER = 6; |
|
53 | + /** |
|
54 | + * Extended REQ socket that load balances to all connected peers |
|
55 | + */ |
|
56 | + public const SOCKET_DEALER = 5; |
|
57 | + /** |
|
58 | + * Similar to SOCKET_PUB, except you can receive subscriptions as messages. |
|
59 | + * The subscription message is 0 (unsubscribe) or 1 (subscribe) followed by the topic. |
|
60 | + */ |
|
61 | + public const SOCKET_XPUB = 9; |
|
62 | + /** |
|
63 | + * Similar to SOCKET_SUB, except you can send subscriptions as messages. See SOCKET_XPUB for format. |
|
64 | + */ |
|
65 | + public const SOCKET_XSUB = 10; |
|
66 | + /** |
|
67 | + * Used to send and receive TCP data from a non-ØMQ peer. |
|
68 | + * Available if compiled against ZeroMQ 4.x or higher. |
|
69 | + */ |
|
70 | + public const SOCKET_STREAM = 11; |
|
71 | + /** |
|
72 | + * The high water mark for inbound and outbound messages is a hard |
|
73 | + * limit on the maximum number of outstanding messages ØMQ shall queue in memory |
|
74 | + * for any single peer that the specified socket is communicating with. |
|
75 | + * Setting this option on a socket will only affect connections made after the option has been set. |
|
76 | + * On ZeroMQ 3.x this is a wrapper for setting both SNDHWM and RCVHWM. |
|
77 | + */ |
|
78 | + public const SOCKOPT_HWM = 1; |
|
79 | + /** |
|
80 | + * The ZMQ_SNDHWM option shall set the high water mark for outbound messages on the specified socket. |
|
81 | + * Available if compiled against ZeroMQ 3.x or higher. |
|
82 | + */ |
|
83 | + public const SOCKOPT_SNDHWM = 23; |
|
84 | + /** |
|
85 | + * The ZMQ_SNDHWM option shall set the high water mark for inbound messages on the specified socket. |
|
86 | + * Available if compiled against ZeroMQ 3.x or higher. |
|
87 | + */ |
|
88 | + public const SOCKOPT_RCVHWM = 24; |
|
89 | + /** |
|
90 | + * Set I/O thread affinity |
|
91 | + */ |
|
92 | + public const SOCKOPT_AFFINITY = 4; |
|
93 | + /** |
|
94 | + * Set socket identity |
|
95 | + */ |
|
96 | + public const SOCKOPT_IDENTITY = 5; |
|
97 | + /** |
|
98 | + * Establish message filter. Valid for subscriber socket |
|
99 | + */ |
|
100 | + public const SOCKOPT_SUBSCRIBE = 6; |
|
101 | + /** |
|
102 | + * Remove message filter. Valid for subscriber socket |
|
103 | + */ |
|
104 | + public const SOCKOPT_UNSUBSCRIBE = 7; |
|
105 | + /** |
|
106 | + * Set rate for multicast sockets (pgm) (Value: int >= 0) |
|
107 | + */ |
|
108 | + public const SOCKOPT_RATE = 8; |
|
109 | + /** |
|
110 | + * Set multicast recovery interval (Value: int >= 0) |
|
111 | + */ |
|
112 | + public const SOCKOPT_RECOVERY_IVL = 9; |
|
113 | + /** |
|
114 | + * Set the initial reconnection interval (Value: int >= 0) |
|
115 | + */ |
|
116 | + public const SOCKOPT_RECONNECT_IVL = 18; |
|
117 | + /** |
|
118 | + * Set the max reconnection interval (Value: int >= 0) |
|
119 | + */ |
|
120 | + public const SOCKOPT_RECONNECT_IVL_MAX = 21; |
|
121 | + /** |
|
122 | + * Control multicast loopback (Value: int >= 0) |
|
123 | + */ |
|
124 | + public const SOCKOPT_MCAST_LOOP = 10; |
|
125 | + /** |
|
126 | + * Set kernel transmit buffer size (Value: int >= 0) |
|
127 | + */ |
|
128 | + public const SOCKOPT_SNDBUF = 11; |
|
129 | + /** |
|
130 | + * Set kernel receive buffer size (Value: int >= 0) |
|
131 | + */ |
|
132 | + public const SOCKOPT_RCVBUF = 12; |
|
133 | + /** |
|
134 | + * Receive multi-part messages |
|
135 | + */ |
|
136 | + public const SOCKOPT_RCVMORE = 13; |
|
137 | + /** |
|
138 | + * Get the socket type. Valid for getSockOpt |
|
139 | + */ |
|
140 | + public const SOCKOPT_TYPE = 16; |
|
141 | + /** |
|
142 | + * The linger value of the socket. |
|
143 | + * Specifies how long the socket blocks trying flush messages after it has been closed |
|
144 | + */ |
|
145 | + public const SOCKOPT_LINGER = 17; |
|
146 | + /** |
|
147 | + * The SOCKOPT_BACKLOG option shall set the maximum length of the queue of outstanding peer connections |
|
148 | + * for the specified socket; this only applies to connection-oriented transports. |
|
149 | + */ |
|
150 | + public const SOCKOPT_BACKLOG = 19; |
|
151 | + /** |
|
152 | + * Limits the maximum size of the inbound message. Value -1 means no limit. |
|
153 | + * Available if compiled against ZeroMQ 3.x or higher |
|
154 | + */ |
|
155 | + public const SOCKOPT_MAXMSGSIZE = 22; |
|
156 | + /** |
|
157 | + * Sets the timeout for send operation on the socket. Value -1 means no limit. |
|
158 | + * Available if compiled against ZeroMQ 3.x or higher |
|
159 | + */ |
|
160 | + public const SOCKOPT_SNDTIMEO = 28; |
|
161 | + /** |
|
162 | + * Sets the timeout for receive operation on the socket. Value -1 means no limit. |
|
163 | + * Available if compiled against ZeroMQ 3.x or higher |
|
164 | + */ |
|
165 | + public const SOCKOPT_RCVTIMEO = 27; |
|
166 | + /** |
|
167 | + * Disable IPV6 support if 1. |
|
168 | + * Available if compiled against ZeroMQ 3.x |
|
169 | + */ |
|
170 | + public const SOCKOPT_IPV4ONLY = 31; |
|
171 | + /** |
|
172 | + * Retrieve the last connected endpoint - for use with * wildcard ports. |
|
173 | + * Available if compiled against ZeroMQ 3.x or higher |
|
174 | + */ |
|
175 | + public const SOCKOPT_LAST_ENDPOINT = 32; |
|
176 | + /** |
|
177 | + * Idle time for TCP keepalive. |
|
178 | + * Available if compiled against ZeroMQ 3.x or higher |
|
179 | + */ |
|
180 | + public const SOCKOPT_TCP_KEEPALIVE_IDLE = 36; |
|
181 | + /** |
|
182 | + * Count time for TCP keepalive. |
|
183 | + * Available if compiled against ZeroMQ 3.x or higher |
|
184 | + */ |
|
185 | + public const SOCKOPT_TCP_KEEPALIVE_CNT = 35; |
|
186 | + /** |
|
187 | + * Interval for TCP keepalive. |
|
188 | + * Available if compiled against ZeroMQ 3.x or higher |
|
189 | + */ |
|
190 | + public const SOCKOPT_TCP_KEEPALIVE_INTVL = 37; |
|
191 | + /** |
|
192 | + * Set a CIDR string to match against incoming TCP connections. |
|
193 | + * Available if compiled against ZeroMQ 3.x or higher |
|
194 | + */ |
|
195 | + public const SOCKOPT_DELAY_ATTACH_ON_CONNECT = 39; |
|
196 | + /** |
|
197 | + * Set a CIDR string to match against incoming TCP connections. |
|
198 | + * Available if compiled against ZeroMQ 3.x or higher |
|
199 | + */ |
|
200 | + public const SOCKOPT_TCP_ACCEPT_FILTER = 38; |
|
201 | + /** |
|
202 | + * Set the XPUB to receive an application message on each instance of a subscription. |
|
203 | + * Available if compiled against ZeroMQ 3.x or higher |
|
204 | + */ |
|
205 | + public const SOCKOPT_XPUB_VERBOSE = 40; |
|
206 | + /** |
|
207 | + * Sets the raw mode on the ROUTER, when set to 1. |
|
208 | + * In raw mode when using tcp:// transport the socket will read and write without ZeroMQ framing. |
|
209 | + * Available if compiled against ZeroMQ 4.0 or higher |
|
210 | + */ |
|
211 | + public const SOCKOPT_ROUTER_RAW = 41; |
|
212 | + /** |
|
213 | + * Enable IPV6. |
|
214 | + * Available if compiled against ZeroMQ 4.0 or higher |
|
215 | + */ |
|
216 | + public const SOCKOPT_IPV6 = 42; |
|
217 | + /** |
|
218 | + * The socket limit for this context. |
|
219 | + * Available if compiled against ZeroMQ 3.x or higher |
|
220 | + */ |
|
221 | + public const CTXOPT_MAX_SOCKETS = 2; |
|
222 | + /** |
|
223 | + * Poll for incoming data |
|
224 | + */ |
|
225 | + public const POLL_IN = 1; |
|
226 | + /** |
|
227 | + * Poll for outgoing data |
|
228 | + */ |
|
229 | + public const POLL_OUT = 2; |
|
230 | + /** |
|
231 | + * Non-blocking operation. |
|
232 | + * @deprecated use ZMQ::MODE_DONTWAIT instead |
|
233 | + */ |
|
234 | + public const MODE_NOBLOCK = 1; |
|
235 | + /** |
|
236 | + * Non-blocking operation |
|
237 | + */ |
|
238 | + public const MODE_DONTWAIT = 1; |
|
239 | + /** |
|
240 | + * Send multi-part message |
|
241 | + */ |
|
242 | + public const MODE_SNDMORE = 2; |
|
243 | + /** |
|
244 | + * Forwarder device |
|
245 | + */ |
|
246 | + public const DEVICE_FORWARDER = 2; |
|
247 | + /** |
|
248 | + * Queue device |
|
249 | + */ |
|
250 | + public const DEVICE_QUEUE = 3; |
|
251 | + /** |
|
252 | + * Streamer device |
|
253 | + */ |
|
254 | + public const DEVICE_STREAMER = 1; |
|
255 | + /** |
|
256 | + * ZMQ extension internal error |
|
257 | + */ |
|
258 | + public const ERR_INTERNAL = -99; |
|
259 | + /** |
|
260 | + * Implies that the operation would block when ZMQ::MODE_DONTWAIT is used |
|
261 | + */ |
|
262 | + public const ERR_EAGAIN = 11; |
|
263 | + /** |
|
264 | + * The operation is not supported by the socket type |
|
265 | + */ |
|
266 | + public const ERR_ENOTSUP = 156384713; |
|
267 | + /** |
|
268 | + * The operation can not be executed because the socket is not in correct state |
|
269 | + */ |
|
270 | + public const ERR_EFSM = 156384763; |
|
271 | + /** |
|
272 | + * The context has been terminated |
|
273 | + */ |
|
274 | + public const ERR_ETERM = 156384765; |
|
275 | + /** |
|
276 | + * Private constructor to prevent direct initialization. This class holds the constants for ZMQ extension. |
|
277 | + * @link https://secure.php.net/manual/en/zmq.construct.php |
|
278 | + */ |
|
279 | + private function __construct() {} |
|
280 | 280 | } |
281 | 281 | /** |
282 | 282 | * Class ZMQContext |
@@ -284,66 +284,66 @@ discard block |
||
284 | 284 | */ |
285 | 285 | class ZMQContext |
286 | 286 | { |
287 | - /** |
|
288 | - * Constructs a new ZMQ context. The context is used to initialize sockets. |
|
289 | - * A persistent context is required to initialize persistent sockets. |
|
290 | - * |
|
291 | - * @link https://secure.php.net/manual/en/zmqcontext.construct.php |
|
292 | - * |
|
293 | - * @param int $io_threads Number of io-threads in the context |
|
294 | - * @param bool $is_persistent Whether the context is persistent. Persistent context is stored over multiple requests and is a requirement for persistent sockets. |
|
295 | - */ |
|
296 | - public function __construct($io_threads = 1, $is_persistent = true) {} |
|
297 | - /** |
|
298 | - * (PECL zmq >= 1.0.4) |
|
299 | - * Returns the value of a context option. |
|
300 | - * |
|
301 | - * @link https://secure.php.net/manual/en/zmqcontext.getopt.php |
|
302 | - * |
|
303 | - * @param string $key An int representing the option. See the <b>ZMQ::CTXOPT_*</b> constants. |
|
304 | - * @return string|int Returns either a string or an integer depending on key. Throws ZMQContextException on error. |
|
305 | - * @throws ZMQContextException |
|
306 | - */ |
|
307 | - public function getOpt($key) {} |
|
308 | - /** |
|
309 | - * (PECL zmq >= 0.5.0) |
|
310 | - * Shortcut for creating new sockets from the context. |
|
311 | - * If the context is not persistent the persistent_id parameter is ignored |
|
312 | - * and the socket falls back to being non-persistent. |
|
313 | - * The on_new_socket is called only when a new underlying socket structure is created. |
|
314 | - * |
|
315 | - * @link https://secure.php.net/manual/en/zmqcontext.getsocket.php |
|
316 | - * |
|
317 | - * @param int $type <b>ZMQ::SOCKET_*</b> constant to specify socket type. |
|
318 | - * @param string $persistent_id If persistent_id is specified the socket will be persisted over multiple requests. |
|
319 | - * @param callable $on_new_socket Callback function, which is executed when a new socket structure is created. This function does not get invoked if the underlying persistent connection is re-used. The callback takes ZMQSocket and persistent_id as two arguments. |
|
320 | - * @return ZMQSocket |
|
321 | - * @throws ZMQSocketException |
|
322 | - */ |
|
323 | - public function getSocket($type, $persistent_id = null, $on_new_socket = null) {} |
|
324 | - /** |
|
325 | - * (PECL zmq >= 0.5.0) |
|
326 | - * Whether the context is persistent. |
|
327 | - * Persistent context is needed for persistent connections as each socket is allocated from a context. |
|
328 | - * |
|
329 | - * @link https://secure.php.net/manual/en/zmqcontext.ispersistent.php |
|
330 | - * |
|
331 | - * @return bool Returns <b>TRUE</b> if the context is persistent and <b>FALSE</b> if the context is non-persistent. |
|
332 | - */ |
|
333 | - public function isPersistent() {} |
|
334 | - /** |
|
335 | - * (PECL zmq >= 1.0.4) |
|
336 | - * Sets a ZMQ context option. The type of the value depends on the key. |
|
337 | - * See ZMQ Constant Types for more information. |
|
338 | - * |
|
339 | - * @link https://secure.php.net/manual/en/zmqcontext.setopt.php |
|
340 | - * |
|
341 | - * @param int $key One of the <b>ZMQ::CTXOPT_*<b> constants. |
|
342 | - * @param mixed $value The value of the parameter. |
|
343 | - * @return ZMQContext |
|
344 | - * @throws ZMQContextException |
|
345 | - */ |
|
346 | - public function setOpt($key, $value) {} |
|
287 | + /** |
|
288 | + * Constructs a new ZMQ context. The context is used to initialize sockets. |
|
289 | + * A persistent context is required to initialize persistent sockets. |
|
290 | + * |
|
291 | + * @link https://secure.php.net/manual/en/zmqcontext.construct.php |
|
292 | + * |
|
293 | + * @param int $io_threads Number of io-threads in the context |
|
294 | + * @param bool $is_persistent Whether the context is persistent. Persistent context is stored over multiple requests and is a requirement for persistent sockets. |
|
295 | + */ |
|
296 | + public function __construct($io_threads = 1, $is_persistent = true) {} |
|
297 | + /** |
|
298 | + * (PECL zmq >= 1.0.4) |
|
299 | + * Returns the value of a context option. |
|
300 | + * |
|
301 | + * @link https://secure.php.net/manual/en/zmqcontext.getopt.php |
|
302 | + * |
|
303 | + * @param string $key An int representing the option. See the <b>ZMQ::CTXOPT_*</b> constants. |
|
304 | + * @return string|int Returns either a string or an integer depending on key. Throws ZMQContextException on error. |
|
305 | + * @throws ZMQContextException |
|
306 | + */ |
|
307 | + public function getOpt($key) {} |
|
308 | + /** |
|
309 | + * (PECL zmq >= 0.5.0) |
|
310 | + * Shortcut for creating new sockets from the context. |
|
311 | + * If the context is not persistent the persistent_id parameter is ignored |
|
312 | + * and the socket falls back to being non-persistent. |
|
313 | + * The on_new_socket is called only when a new underlying socket structure is created. |
|
314 | + * |
|
315 | + * @link https://secure.php.net/manual/en/zmqcontext.getsocket.php |
|
316 | + * |
|
317 | + * @param int $type <b>ZMQ::SOCKET_*</b> constant to specify socket type. |
|
318 | + * @param string $persistent_id If persistent_id is specified the socket will be persisted over multiple requests. |
|
319 | + * @param callable $on_new_socket Callback function, which is executed when a new socket structure is created. This function does not get invoked if the underlying persistent connection is re-used. The callback takes ZMQSocket and persistent_id as two arguments. |
|
320 | + * @return ZMQSocket |
|
321 | + * @throws ZMQSocketException |
|
322 | + */ |
|
323 | + public function getSocket($type, $persistent_id = null, $on_new_socket = null) {} |
|
324 | + /** |
|
325 | + * (PECL zmq >= 0.5.0) |
|
326 | + * Whether the context is persistent. |
|
327 | + * Persistent context is needed for persistent connections as each socket is allocated from a context. |
|
328 | + * |
|
329 | + * @link https://secure.php.net/manual/en/zmqcontext.ispersistent.php |
|
330 | + * |
|
331 | + * @return bool Returns <b>TRUE</b> if the context is persistent and <b>FALSE</b> if the context is non-persistent. |
|
332 | + */ |
|
333 | + public function isPersistent() {} |
|
334 | + /** |
|
335 | + * (PECL zmq >= 1.0.4) |
|
336 | + * Sets a ZMQ context option. The type of the value depends on the key. |
|
337 | + * See ZMQ Constant Types for more information. |
|
338 | + * |
|
339 | + * @link https://secure.php.net/manual/en/zmqcontext.setopt.php |
|
340 | + * |
|
341 | + * @param int $key One of the <b>ZMQ::CTXOPT_*<b> constants. |
|
342 | + * @param mixed $value The value of the parameter. |
|
343 | + * @return ZMQContext |
|
344 | + * @throws ZMQContextException |
|
345 | + */ |
|
346 | + public function setOpt($key, $value) {} |
|
347 | 347 | } |
348 | 348 | /** |
349 | 349 | * Class ZMQSocket |
@@ -351,205 +351,205 @@ discard block |
||
351 | 351 | */ |
352 | 352 | class ZMQSocket |
353 | 353 | { |
354 | - /** |
|
355 | - * (PECL zmq >= 0.5.0) |
|
356 | - * Constructs a ZMQSocket object. |
|
357 | - * The persistent_id parameter can be used to allocated a persistent socket. |
|
358 | - * A persistent socket has to be allocated from a persistent context and it stays connected over multiple requests. |
|
359 | - * The persistent_id parameter can be used to recall the same socket over multiple requests. |
|
360 | - * The on_new_socket is called only when a new underlying socket structure is created. |
|
361 | - * |
|
362 | - * @link https://secure.php.net/manual/en/zmqsocket.construct.php |
|
363 | - * |
|
364 | - * @param ZMQContext $context <p>ZMQContext to build this object</p> |
|
365 | - * @param int $type <p>The type of the socket. See ZMQ::SOCKET_* constants.</p> |
|
366 | - * @param string $persistent_id [optional] <p>If persistent_id is specified the socket will be persisted over multiple requests. If context is not persistent the socket falls back to non-persistent mode.</p> |
|
367 | - * @param callable $on_new_socket [optional] <p>Callback function, which is executed when a new socket structure is created. This function does not get invoked if the underlying persistent connection is re-used.</p> |
|
368 | - * |
|
369 | - * @throws ZMQSocketException |
|
370 | - */ |
|
371 | - public function __construct(ZMQContext $context, $type, $persistent_id = null, $on_new_socket = null) {} |
|
372 | - /** |
|
373 | - * (PECL zmq >= 0.5.0) |
|
374 | - * Bind the socket to an endpoint. |
|
375 | - * The endpoint is defined in format transport://address |
|
376 | - * where transport is one of the following: inproc, ipc, tcp, pgm or epgm. |
|
377 | - * |
|
378 | - * @link https://secure.php.net/manual/en/zmqsocket.bind.php |
|
379 | - * |
|
380 | - * @param string $dsn The bind dsn, for example transport://address. |
|
381 | - * @param bool $force Tries to bind even if the socket has already been bound to the given endpoint. |
|
382 | - * |
|
383 | - * @return ZMQSocket |
|
384 | - * @throws ZMQSocketException if binding fails |
|
385 | - */ |
|
386 | - public function bind($dsn, $force = false) {} |
|
387 | - /** |
|
388 | - * (PECL zmq >= 0.5.0) |
|
389 | - * Connect the socket to a remote endpoint. |
|
390 | - * The endpoint is defined in format transport://address |
|
391 | - * where transport is one of the following: inproc, ipc, tcp, pgm or epgm. |
|
392 | - * |
|
393 | - * @link https://secure.php.net/manual/en/zmqsocket.connect.php |
|
394 | - * |
|
395 | - * @param string $dsn The bind dsn, for example transport://address. |
|
396 | - * @param bool $force Tries to bind even if the socket has already been bound to the given endpoint. |
|
397 | - * |
|
398 | - * @return ZMQSocket |
|
399 | - * @throws ZMQSocketException If connection fails |
|
400 | - */ |
|
401 | - public function connect($dsn, $force = false) {} |
|
402 | - /** |
|
403 | - * (PECL zmq >= 1.0.4) |
|
404 | - * Disconnect the socket from a previously connected remote endpoint. |
|
405 | - * The endpoint is defined in format transport://address |
|
406 | - * where transport is one of the following: inproc, ipc, tcp, pgm or epgm. |
|
407 | - * |
|
408 | - * @link https://secure.php.net/manual/en/zmqsocket.disconnect.php |
|
409 | - * |
|
410 | - * @param string $dsn The bind dsn, for example transport://address. |
|
411 | - * |
|
412 | - * @return ZMQSocket |
|
413 | - * @throws ZMQSocketException If connection fails |
|
414 | - */ |
|
415 | - public function disconnect($dsn) {} |
|
416 | - /** |
|
417 | - * Returns a list of endpoints where the socket is connected or bound to. |
|
418 | - * |
|
419 | - * @link https://secure.php.net/manual/en/zmqsocket.getendpoints.php |
|
420 | - * |
|
421 | - * @return array contains two sub-arrays: 'connect' and 'bind' |
|
422 | - * @throws ZMQSocketException |
|
423 | - */ |
|
424 | - public function getEndpoints() {} |
|
425 | - /** |
|
426 | - * Returns the persistent id string assigned of the object and NULL if socket is not persistent. |
|
427 | - * |
|
428 | - * @link https://secure.php.net/manual/en/zmqsocket.getpersistentid.php |
|
429 | - * |
|
430 | - * @return string|null <p> |
|
431 | - * Returns the persistent id string assigned of the object and <b>NULL</b> if socket is not persistent. |
|
432 | - * </p> |
|
433 | - */ |
|
434 | - public function getPersistentId() {} |
|
435 | - /** |
|
436 | - * Returns the value of a socket option. |
|
437 | - * This method is available if ZMQ extension has been compiled against ZMQ version 2.0.7 or higher |
|
438 | - * |
|
439 | - * @link https://secure.php.net/manual/en/zmqsocket.getsockopt.php |
|
440 | - * |
|
441 | - * @since 0MQ 2.0.7 |
|
442 | - * @param int $key An int representing the option. See the <b>ZMQ::SOCKOPT_*</b> constants. |
|
443 | - * |
|
444 | - * @return string|int <p> |
|
445 | - * Returns either a string or an integer depending on <b>key</b>. Throws |
|
446 | - * ZMQSocketException on error. |
|
447 | - * </p> |
|
448 | - * @throws ZMQSocketException |
|
449 | - */ |
|
450 | - public function getSockOpt($key) {} |
|
451 | - /** |
|
452 | - * Return the socket type. |
|
453 | - * The socket type can be compared against ZMQ::SOCKET_* constants. |
|
454 | - * |
|
455 | - * @link https://secure.php.net/manual/en/zmqsocket.getsockettype.php |
|
456 | - * |
|
457 | - * @return int <p> |
|
458 | - * Returns an integer representing the socket type. The integer can be compared against |
|
459 | - * <b>ZMQ::SOCKET_*</b> constants. |
|
460 | - * </p> |
|
461 | - */ |
|
462 | - public function getSocketType() {} |
|
463 | - /** |
|
464 | - * Check whether the socket is persistent. |
|
465 | - * |
|
466 | - * @link https://secure.php.net/manual/en/zmqsocket.ispersistent.php |
|
467 | - * |
|
468 | - * @return bool <p>Returns a boolean based on whether the socket is persistent or not.</p> |
|
469 | - */ |
|
470 | - public function isPersistent() {} |
|
471 | - /** |
|
472 | - * Receive a message from a socket. |
|
473 | - * By default receiving will block until a message is available unless <b>ZMQ::MODE_NOBLOCK</b> flag is used. |
|
474 | - * <b>ZMQ::SOCKOPT_RCVMORE</b> socket option can be used for receiving multi-part messages. |
|
475 | - * Returns the message. |
|
476 | - * If <b>ZMQ::MODE_NOBLOCK</b> is used and the operation would block bool false shall be returned. |
|
477 | - * |
|
478 | - * @link https://secure.php.net/manual/en/zmqsocket.recv.php |
|
479 | - * @see ZMQSocket::setSockOpt() |
|
480 | - * |
|
481 | - * @param int $mode Pass mode flags to receive multipart messages or non-blocking operation. See ZMQ::MODE_* constants. |
|
482 | - * |
|
483 | - * @return string|false <p>Returns the message. Throws ZMQSocketException in error. If <b>ZMQ::MODE_NOBLOCK</b> is used and the operation would block boolean false shall be returned.</p> |
|
484 | - * @throws ZMQSocketException if receiving fails. |
|
485 | - */ |
|
486 | - public function recv($mode = 0) {} |
|
487 | - /** |
|
488 | - * Receive an array multipart message from a socket. |
|
489 | - * By default receiving will block until a message is available unless ZMQ::MODE_NOBLOCK flag is used. |
|
490 | - * Returns the array of message parts. |
|
491 | - * If <b>ZMQ::MODE_NOBLOCK</b> is used and the operation would block bool false shall be returned. |
|
492 | - * |
|
493 | - * @link https://secure.php.net/manual/en/zmqsocket.recvmulti.php |
|
494 | - * |
|
495 | - * @param int $mode Pass mode flags to receive multipart messages or non-blocking operation. See ZMQ::MODE_* constants. |
|
496 | - * |
|
497 | - * @return string[] Returns the array of message parts. Throws ZMQSocketException in error. If ZMQ::MODE_NOBLOCK is used and the operation would block boolean false shall be returned. |
|
498 | - * @throws ZMQSocketException if receiving fails. |
|
499 | - */ |
|
500 | - public function recvMulti($mode = 0) {} |
|
501 | - /** |
|
502 | - * Send a message using the socket. The operation can block unless ZMQ::MODE_NOBLOCK is used. |
|
503 | - * If <b>ZMQ::MODE_NOBLOCK</b> is used and the operation would block bool false shall be returned. |
|
504 | - * |
|
505 | - * @link https://secure.php.net/manual/en/zmqsocket.send.php |
|
506 | - * |
|
507 | - * @param string $message The message to send |
|
508 | - * @param int $mode Pass mode flags to receive multipart messages or non-blocking operation. See ZMQ::MODE_* constants. * |
|
509 | - * |
|
510 | - * @return ZMQSocket |
|
511 | - * @throws ZMQSocketException if sending message fails |
|
512 | - */ |
|
513 | - public function send($message, $mode = 0) {} |
|
514 | - /** |
|
515 | - * Send a multipart message using the socket. The operation can block unless ZMQ::MODE_NOBLOCK is used. |
|
516 | - * If <b>ZMQ::MODE_NOBLOCK</b> is used and the operation would block bool false shall be returned. |
|
517 | - * |
|
518 | - * @link https://secure.php.net/manual/en/zmqsocket.sendmulti.php |
|
519 | - * |
|
520 | - * @param array $message The message to send - an array of strings |
|
521 | - * @param int $mode Pass mode flags to receive multipart messages or non-blocking operation. See ZMQ::MODE_* constants. * |
|
522 | - * |
|
523 | - * @return ZMQSocket |
|
524 | - * @throws ZMQSocketException if sending message fails |
|
525 | - */ |
|
526 | - public function sendmulti(array $message, $mode = 0) {} |
|
527 | - /** |
|
528 | - * Sets a ZMQ socket option. The type of the value depends on the key. |
|
529 | - * @see ZMQ Constant Types for more information. |
|
530 | - * |
|
531 | - * @link https://secure.php.net/manual/en/zmqsocket.setsockopt.php |
|
532 | - * |
|
533 | - * @param int $key One of the <b>ZMQ::SOCKOPT_*</b> constants. |
|
534 | - * @param mixed $value The value of the parameter. |
|
535 | - * |
|
536 | - * @return ZMQSocket |
|
537 | - * @throws ZMQSocketException |
|
538 | - */ |
|
539 | - public function setSockOpt($key, $value) {} |
|
540 | - /** |
|
541 | - * Unbind the socket from an endpoint. |
|
542 | - * The endpoint is defined in format transport://address |
|
543 | - * where transport is one of the following: inproc, ipc, tcp, pgm or epgm. |
|
544 | - * |
|
545 | - * @link https://secure.php.net/manual/en/zmqsocket.unbind.php |
|
546 | - * |
|
547 | - * @param string $dsn The previously bound dsn, for example transport://address. |
|
548 | - * |
|
549 | - * @return ZMQSocket |
|
550 | - * @throws ZMQSocketException if binding fails |
|
551 | - */ |
|
552 | - public function unbind($dsn) {} |
|
354 | + /** |
|
355 | + * (PECL zmq >= 0.5.0) |
|
356 | + * Constructs a ZMQSocket object. |
|
357 | + * The persistent_id parameter can be used to allocated a persistent socket. |
|
358 | + * A persistent socket has to be allocated from a persistent context and it stays connected over multiple requests. |
|
359 | + * The persistent_id parameter can be used to recall the same socket over multiple requests. |
|
360 | + * The on_new_socket is called only when a new underlying socket structure is created. |
|
361 | + * |
|
362 | + * @link https://secure.php.net/manual/en/zmqsocket.construct.php |
|
363 | + * |
|
364 | + * @param ZMQContext $context <p>ZMQContext to build this object</p> |
|
365 | + * @param int $type <p>The type of the socket. See ZMQ::SOCKET_* constants.</p> |
|
366 | + * @param string $persistent_id [optional] <p>If persistent_id is specified the socket will be persisted over multiple requests. If context is not persistent the socket falls back to non-persistent mode.</p> |
|
367 | + * @param callable $on_new_socket [optional] <p>Callback function, which is executed when a new socket structure is created. This function does not get invoked if the underlying persistent connection is re-used.</p> |
|
368 | + * |
|
369 | + * @throws ZMQSocketException |
|
370 | + */ |
|
371 | + public function __construct(ZMQContext $context, $type, $persistent_id = null, $on_new_socket = null) {} |
|
372 | + /** |
|
373 | + * (PECL zmq >= 0.5.0) |
|
374 | + * Bind the socket to an endpoint. |
|
375 | + * The endpoint is defined in format transport://address |
|
376 | + * where transport is one of the following: inproc, ipc, tcp, pgm or epgm. |
|
377 | + * |
|
378 | + * @link https://secure.php.net/manual/en/zmqsocket.bind.php |
|
379 | + * |
|
380 | + * @param string $dsn The bind dsn, for example transport://address. |
|
381 | + * @param bool $force Tries to bind even if the socket has already been bound to the given endpoint. |
|
382 | + * |
|
383 | + * @return ZMQSocket |
|
384 | + * @throws ZMQSocketException if binding fails |
|
385 | + */ |
|
386 | + public function bind($dsn, $force = false) {} |
|
387 | + /** |
|
388 | + * (PECL zmq >= 0.5.0) |
|
389 | + * Connect the socket to a remote endpoint. |
|
390 | + * The endpoint is defined in format transport://address |
|
391 | + * where transport is one of the following: inproc, ipc, tcp, pgm or epgm. |
|
392 | + * |
|
393 | + * @link https://secure.php.net/manual/en/zmqsocket.connect.php |
|
394 | + * |
|
395 | + * @param string $dsn The bind dsn, for example transport://address. |
|
396 | + * @param bool $force Tries to bind even if the socket has already been bound to the given endpoint. |
|
397 | + * |
|
398 | + * @return ZMQSocket |
|
399 | + * @throws ZMQSocketException If connection fails |
|
400 | + */ |
|
401 | + public function connect($dsn, $force = false) {} |
|
402 | + /** |
|
403 | + * (PECL zmq >= 1.0.4) |
|
404 | + * Disconnect the socket from a previously connected remote endpoint. |
|
405 | + * The endpoint is defined in format transport://address |
|
406 | + * where transport is one of the following: inproc, ipc, tcp, pgm or epgm. |
|
407 | + * |
|
408 | + * @link https://secure.php.net/manual/en/zmqsocket.disconnect.php |
|
409 | + * |
|
410 | + * @param string $dsn The bind dsn, for example transport://address. |
|
411 | + * |
|
412 | + * @return ZMQSocket |
|
413 | + * @throws ZMQSocketException If connection fails |
|
414 | + */ |
|
415 | + public function disconnect($dsn) {} |
|
416 | + /** |
|
417 | + * Returns a list of endpoints where the socket is connected or bound to. |
|
418 | + * |
|
419 | + * @link https://secure.php.net/manual/en/zmqsocket.getendpoints.php |
|
420 | + * |
|
421 | + * @return array contains two sub-arrays: 'connect' and 'bind' |
|
422 | + * @throws ZMQSocketException |
|
423 | + */ |
|
424 | + public function getEndpoints() {} |
|
425 | + /** |
|
426 | + * Returns the persistent id string assigned of the object and NULL if socket is not persistent. |
|
427 | + * |
|
428 | + * @link https://secure.php.net/manual/en/zmqsocket.getpersistentid.php |
|
429 | + * |
|
430 | + * @return string|null <p> |
|
431 | + * Returns the persistent id string assigned of the object and <b>NULL</b> if socket is not persistent. |
|
432 | + * </p> |
|
433 | + */ |
|
434 | + public function getPersistentId() {} |
|
435 | + /** |
|
436 | + * Returns the value of a socket option. |
|
437 | + * This method is available if ZMQ extension has been compiled against ZMQ version 2.0.7 or higher |
|
438 | + * |
|
439 | + * @link https://secure.php.net/manual/en/zmqsocket.getsockopt.php |
|
440 | + * |
|
441 | + * @since 0MQ 2.0.7 |
|
442 | + * @param int $key An int representing the option. See the <b>ZMQ::SOCKOPT_*</b> constants. |
|
443 | + * |
|
444 | + * @return string|int <p> |
|
445 | + * Returns either a string or an integer depending on <b>key</b>. Throws |
|
446 | + * ZMQSocketException on error. |
|
447 | + * </p> |
|
448 | + * @throws ZMQSocketException |
|
449 | + */ |
|
450 | + public function getSockOpt($key) {} |
|
451 | + /** |
|
452 | + * Return the socket type. |
|
453 | + * The socket type can be compared against ZMQ::SOCKET_* constants. |
|
454 | + * |
|
455 | + * @link https://secure.php.net/manual/en/zmqsocket.getsockettype.php |
|
456 | + * |
|
457 | + * @return int <p> |
|
458 | + * Returns an integer representing the socket type. The integer can be compared against |
|
459 | + * <b>ZMQ::SOCKET_*</b> constants. |
|
460 | + * </p> |
|
461 | + */ |
|
462 | + public function getSocketType() {} |
|
463 | + /** |
|
464 | + * Check whether the socket is persistent. |
|
465 | + * |
|
466 | + * @link https://secure.php.net/manual/en/zmqsocket.ispersistent.php |
|
467 | + * |
|
468 | + * @return bool <p>Returns a boolean based on whether the socket is persistent or not.</p> |
|
469 | + */ |
|
470 | + public function isPersistent() {} |
|
471 | + /** |
|
472 | + * Receive a message from a socket. |
|
473 | + * By default receiving will block until a message is available unless <b>ZMQ::MODE_NOBLOCK</b> flag is used. |
|
474 | + * <b>ZMQ::SOCKOPT_RCVMORE</b> socket option can be used for receiving multi-part messages. |
|
475 | + * Returns the message. |
|
476 | + * If <b>ZMQ::MODE_NOBLOCK</b> is used and the operation would block bool false shall be returned. |
|
477 | + * |
|
478 | + * @link https://secure.php.net/manual/en/zmqsocket.recv.php |
|
479 | + * @see ZMQSocket::setSockOpt() |
|
480 | + * |
|
481 | + * @param int $mode Pass mode flags to receive multipart messages or non-blocking operation. See ZMQ::MODE_* constants. |
|
482 | + * |
|
483 | + * @return string|false <p>Returns the message. Throws ZMQSocketException in error. If <b>ZMQ::MODE_NOBLOCK</b> is used and the operation would block boolean false shall be returned.</p> |
|
484 | + * @throws ZMQSocketException if receiving fails. |
|
485 | + */ |
|
486 | + public function recv($mode = 0) {} |
|
487 | + /** |
|
488 | + * Receive an array multipart message from a socket. |
|
489 | + * By default receiving will block until a message is available unless ZMQ::MODE_NOBLOCK flag is used. |
|
490 | + * Returns the array of message parts. |
|
491 | + * If <b>ZMQ::MODE_NOBLOCK</b> is used and the operation would block bool false shall be returned. |
|
492 | + * |
|
493 | + * @link https://secure.php.net/manual/en/zmqsocket.recvmulti.php |
|
494 | + * |
|
495 | + * @param int $mode Pass mode flags to receive multipart messages or non-blocking operation. See ZMQ::MODE_* constants. |
|
496 | + * |
|
497 | + * @return string[] Returns the array of message parts. Throws ZMQSocketException in error. If ZMQ::MODE_NOBLOCK is used and the operation would block boolean false shall be returned. |
|
498 | + * @throws ZMQSocketException if receiving fails. |
|
499 | + */ |
|
500 | + public function recvMulti($mode = 0) {} |
|
501 | + /** |
|
502 | + * Send a message using the socket. The operation can block unless ZMQ::MODE_NOBLOCK is used. |
|
503 | + * If <b>ZMQ::MODE_NOBLOCK</b> is used and the operation would block bool false shall be returned. |
|
504 | + * |
|
505 | + * @link https://secure.php.net/manual/en/zmqsocket.send.php |
|
506 | + * |
|
507 | + * @param string $message The message to send |
|
508 | + * @param int $mode Pass mode flags to receive multipart messages or non-blocking operation. See ZMQ::MODE_* constants. * |
|
509 | + * |
|
510 | + * @return ZMQSocket |
|
511 | + * @throws ZMQSocketException if sending message fails |
|
512 | + */ |
|
513 | + public function send($message, $mode = 0) {} |
|
514 | + /** |
|
515 | + * Send a multipart message using the socket. The operation can block unless ZMQ::MODE_NOBLOCK is used. |
|
516 | + * If <b>ZMQ::MODE_NOBLOCK</b> is used and the operation would block bool false shall be returned. |
|
517 | + * |
|
518 | + * @link https://secure.php.net/manual/en/zmqsocket.sendmulti.php |
|
519 | + * |
|
520 | + * @param array $message The message to send - an array of strings |
|
521 | + * @param int $mode Pass mode flags to receive multipart messages or non-blocking operation. See ZMQ::MODE_* constants. * |
|
522 | + * |
|
523 | + * @return ZMQSocket |
|
524 | + * @throws ZMQSocketException if sending message fails |
|
525 | + */ |
|
526 | + public function sendmulti(array $message, $mode = 0) {} |
|
527 | + /** |
|
528 | + * Sets a ZMQ socket option. The type of the value depends on the key. |
|
529 | + * @see ZMQ Constant Types for more information. |
|
530 | + * |
|
531 | + * @link https://secure.php.net/manual/en/zmqsocket.setsockopt.php |
|
532 | + * |
|
533 | + * @param int $key One of the <b>ZMQ::SOCKOPT_*</b> constants. |
|
534 | + * @param mixed $value The value of the parameter. |
|
535 | + * |
|
536 | + * @return ZMQSocket |
|
537 | + * @throws ZMQSocketException |
|
538 | + */ |
|
539 | + public function setSockOpt($key, $value) {} |
|
540 | + /** |
|
541 | + * Unbind the socket from an endpoint. |
|
542 | + * The endpoint is defined in format transport://address |
|
543 | + * where transport is one of the following: inproc, ipc, tcp, pgm or epgm. |
|
544 | + * |
|
545 | + * @link https://secure.php.net/manual/en/zmqsocket.unbind.php |
|
546 | + * |
|
547 | + * @param string $dsn The previously bound dsn, for example transport://address. |
|
548 | + * |
|
549 | + * @return ZMQSocket |
|
550 | + * @throws ZMQSocketException if binding fails |
|
551 | + */ |
|
552 | + public function unbind($dsn) {} |
|
553 | 553 | } |
554 | 554 | /** |
555 | 555 | * Class ZMQPoll |
@@ -557,79 +557,79 @@ discard block |
||
557 | 557 | */ |
558 | 558 | class ZMQPoll |
559 | 559 | { |
560 | - /** |
|
561 | - * (PECL zmq >= 0.5.0) |
|
562 | - * Adds a new item to the poll set and returns the internal id of the added item. |
|
563 | - * The item can be removed from the poll set using the returned string id. |
|
564 | - * Returns a string id of the added item which can be later used to remove the item. |
|
565 | - * |
|
566 | - * @link https://secure.php.net/manual/en/zmqpoll.add.php |
|
567 | - * |
|
568 | - * @param ZMQSocket $entry ZMQSocket object or a PHP stream resource |
|
569 | - * @param int $type Defines what activity the socket is polled for. See <b>ZMQ::POLL_IN</b> and <b>ZMQ::POLL_OUT</b> constants. |
|
570 | - * |
|
571 | - * @return int Returns a string id of the added item which can be later used to remove the item. Throws ZMQPollException on error. |
|
572 | - * @throws ZMQPollException if the object has not been initialized with polling |
|
573 | - */ |
|
574 | - public function add(ZMQSocket $entry, $type) {} |
|
575 | - /** |
|
576 | - * (PECL zmq >= 1.0.4) |
|
577 | - * Clears all elements from the poll set. |
|
578 | - * |
|
579 | - * @link https://secure.php.net/manual/en/zmqpoll.clear.php |
|
580 | - * |
|
581 | - * @return ZMQPoll Returns the current object. |
|
582 | - */ |
|
583 | - public function clear() {} |
|
584 | - /** |
|
585 | - * (PECL zmq >= 0.5.0) |
|
586 | - * Count the items in the poll set. |
|
587 | - * |
|
588 | - * @link https://secure.php.net/manual/en/zmqpoll.count.php |
|
589 | - * |
|
590 | - * @return int Returns an integer representing the amount of items in the poll set. |
|
591 | - */ |
|
592 | - public function count() {} |
|
593 | - /** |
|
594 | - * (PECL zmq >= 0.5.0) |
|
595 | - * Returns the ids of the objects that had errors in the last poll. |
|
596 | - * Returns an array containing ids for the items that had errors in the last poll. |
|
597 | - * Empty array is returned if there were no errors. |
|
598 | - * |
|
599 | - * @link https://secure.php.net/manual/en/zmqpoll.getlasterrors.php |
|
600 | - * |
|
601 | - * @return int[] |
|
602 | - */ |
|
603 | - public function getLastErrors() {} |
|
604 | - /** |
|
605 | - * (PECL zmq >= 0.5.0) |
|
606 | - * Polls the items in the current poll set. |
|
607 | - * The readable and writable items are returned in the readable and writable parameters. |
|
608 | - * ZMQPoll::getLastErrors() can be used to check if there were errors. |
|
609 | - * Returns an int representing amount of items with activity. |
|
610 | - * |
|
611 | - * @link https://secure.php.net/manual/en/zmqpoll.poll.php |
|
612 | - * |
|
613 | - * @param array &$readable Array where readable ZMQSockets/PHP streams are returned. The array will be cleared at the beginning of the operation. |
|
614 | - * @param array &$writable Array where writable ZMQSockets/PHP streams are returned. The array will be cleared at the beginning of the operation. |
|
615 | - * @param int $timeout Timeout for the operation. -1 means that poll waits until at least one item has activity. Please note that starting from version 1.0.0 the poll timeout is defined in milliseconds, rather than microseconds. |
|
616 | - * |
|
617 | - * @throws ZMQPollException if polling fails |
|
618 | - * @return int |
|
619 | - */ |
|
620 | - public function poll(array &$readable, array &$writable, $timeout = -1) {} |
|
621 | - /** |
|
622 | - * (PECL zmq >= 0.5.0) |
|
623 | - * Remove item from the poll set. |
|
624 | - * The item parameter can be ZMQSocket object, a stream resource or the id returned from ZMQPoll::add() method. |
|
625 | - * Returns true if the item was removed and false if the object with given id does not exist in the poll set. |
|
626 | - * |
|
627 | - * @link https://secure.php.net/manual/en/zmqpoll.remove.php |
|
628 | - * |
|
629 | - * @param ZMQSocket|string|mixed $item The ZMQSocket object, PHP stream or string id of the item. |
|
630 | - * @return bool Returns true if the item was removed and false if the object with given id does not exist in the poll set. |
|
631 | - */ |
|
632 | - public function remove($item) {} |
|
560 | + /** |
|
561 | + * (PECL zmq >= 0.5.0) |
|
562 | + * Adds a new item to the poll set and returns the internal id of the added item. |
|
563 | + * The item can be removed from the poll set using the returned string id. |
|
564 | + * Returns a string id of the added item which can be later used to remove the item. |
|
565 | + * |
|
566 | + * @link https://secure.php.net/manual/en/zmqpoll.add.php |
|
567 | + * |
|
568 | + * @param ZMQSocket $entry ZMQSocket object or a PHP stream resource |
|
569 | + * @param int $type Defines what activity the socket is polled for. See <b>ZMQ::POLL_IN</b> and <b>ZMQ::POLL_OUT</b> constants. |
|
570 | + * |
|
571 | + * @return int Returns a string id of the added item which can be later used to remove the item. Throws ZMQPollException on error. |
|
572 | + * @throws ZMQPollException if the object has not been initialized with polling |
|
573 | + */ |
|
574 | + public function add(ZMQSocket $entry, $type) {} |
|
575 | + /** |
|
576 | + * (PECL zmq >= 1.0.4) |
|
577 | + * Clears all elements from the poll set. |
|
578 | + * |
|
579 | + * @link https://secure.php.net/manual/en/zmqpoll.clear.php |
|
580 | + * |
|
581 | + * @return ZMQPoll Returns the current object. |
|
582 | + */ |
|
583 | + public function clear() {} |
|
584 | + /** |
|
585 | + * (PECL zmq >= 0.5.0) |
|
586 | + * Count the items in the poll set. |
|
587 | + * |
|
588 | + * @link https://secure.php.net/manual/en/zmqpoll.count.php |
|
589 | + * |
|
590 | + * @return int Returns an integer representing the amount of items in the poll set. |
|
591 | + */ |
|
592 | + public function count() {} |
|
593 | + /** |
|
594 | + * (PECL zmq >= 0.5.0) |
|
595 | + * Returns the ids of the objects that had errors in the last poll. |
|
596 | + * Returns an array containing ids for the items that had errors in the last poll. |
|
597 | + * Empty array is returned if there were no errors. |
|
598 | + * |
|
599 | + * @link https://secure.php.net/manual/en/zmqpoll.getlasterrors.php |
|
600 | + * |
|
601 | + * @return int[] |
|
602 | + */ |
|
603 | + public function getLastErrors() {} |
|
604 | + /** |
|
605 | + * (PECL zmq >= 0.5.0) |
|
606 | + * Polls the items in the current poll set. |
|
607 | + * The readable and writable items are returned in the readable and writable parameters. |
|
608 | + * ZMQPoll::getLastErrors() can be used to check if there were errors. |
|
609 | + * Returns an int representing amount of items with activity. |
|
610 | + * |
|
611 | + * @link https://secure.php.net/manual/en/zmqpoll.poll.php |
|
612 | + * |
|
613 | + * @param array &$readable Array where readable ZMQSockets/PHP streams are returned. The array will be cleared at the beginning of the operation. |
|
614 | + * @param array &$writable Array where writable ZMQSockets/PHP streams are returned. The array will be cleared at the beginning of the operation. |
|
615 | + * @param int $timeout Timeout for the operation. -1 means that poll waits until at least one item has activity. Please note that starting from version 1.0.0 the poll timeout is defined in milliseconds, rather than microseconds. |
|
616 | + * |
|
617 | + * @throws ZMQPollException if polling fails |
|
618 | + * @return int |
|
619 | + */ |
|
620 | + public function poll(array &$readable, array &$writable, $timeout = -1) {} |
|
621 | + /** |
|
622 | + * (PECL zmq >= 0.5.0) |
|
623 | + * Remove item from the poll set. |
|
624 | + * The item parameter can be ZMQSocket object, a stream resource or the id returned from ZMQPoll::add() method. |
|
625 | + * Returns true if the item was removed and false if the object with given id does not exist in the poll set. |
|
626 | + * |
|
627 | + * @link https://secure.php.net/manual/en/zmqpoll.remove.php |
|
628 | + * |
|
629 | + * @param ZMQSocket|string|mixed $item The ZMQSocket object, PHP stream or string id of the item. |
|
630 | + * @return bool Returns true if the item was removed and false if the object with given id does not exist in the poll set. |
|
631 | + */ |
|
632 | + public function remove($item) {} |
|
633 | 633 | } |
634 | 634 | /** |
635 | 635 | * Class ZMQDevice |
@@ -637,101 +637,101 @@ discard block |
||
637 | 637 | */ |
638 | 638 | class ZMQDevice |
639 | 639 | { |
640 | - /** |
|
641 | - * (PECL zmq >= 1.0.4) |
|
642 | - * Construct a new device. |
|
643 | - * "ØMQ devices can do intermediation of addresses, services, queues, or any other abstraction you care |
|
644 | - * to define above the message and socket layers." -- zguide |
|
645 | - * Call to this method will prepare the device. Usually devices are very long running processes so running this method from interactive script is not recommended. This method throw ZMQDeviceException if the device cannot be started. |
|
646 | - * |
|
647 | - * @link https://secure.php.net/manual/en/zmqdevice.construct.php |
|
648 | - * |
|
649 | - * @param ZMQSocket $frontend Frontend parameter for the devices. Usually where there messages are coming. |
|
650 | - * @param ZMQSocket $backend Backend parameter for the devices. Usually where there messages going to. |
|
651 | - * @param null|ZMQSocket $listener Listener socket, which receives a copy of all messages going both directions. The type of this socket should be SUB, PULL or DEALER. |
|
652 | - */ |
|
653 | - public function __construct(ZMQSocket $frontend, ZMQSocket $backend, ZMQSocket $listener = null) {} |
|
654 | - /** |
|
655 | - * Gets the idle callback timeout value. |
|
656 | - * This method returns the idle callback timeout value. |
|
657 | - * Added in ZMQ extension version 1.1.0. |
|
658 | - * |
|
659 | - * @link https://secure.php.net/manual/en/zmqdevice.getidletimeout.php |
|
660 | - * |
|
661 | - * @return int This method returns the idle callback timeout value. |
|
662 | - */ |
|
663 | - public function getIdleTimeout() {} |
|
664 | - /** |
|
665 | - * Gets the timer callback timeout value. |
|
666 | - * Added in ZMQ extension version 1.1.0. |
|
667 | - * |
|
668 | - * @link https://secure.php.net/manual/en/zmqdevice.gettimertimeout.php |
|
669 | - * |
|
670 | - * @return int This method returns the timer timeout value. |
|
671 | - */ |
|
672 | - public function getTimerTimeout() {} |
|
673 | - /** |
|
674 | - * Runs the device. |
|
675 | - * Call to this method will block until the device is running. |
|
676 | - * It is not recommended that devices are used from interactive scripts. |
|
677 | - * |
|
678 | - * @link https://secure.php.net/manual/en/zmqdevice.run.php |
|
679 | - * |
|
680 | - * @throws ZMQDeviceException |
|
681 | - */ |
|
682 | - public function run() {} |
|
683 | - /** |
|
684 | - * Sets the idle callback function. |
|
685 | - * If idle timeout is defined the idle callback function shall be called if the internal poll loop times out |
|
686 | - * without events. If the callback function returns false or a value that evaluates to false the device is stopped. |
|
687 | - * The callback function signature is callback (mixed $user_data). |
|
688 | - * |
|
689 | - * @link https://secure.php.net/manual/en/zmqdevice.setidlecallback.php |
|
690 | - * |
|
691 | - * @param callable $cb_func Callback function to invoke when the device is idle. Returning false or a value that evaluates to false from this function will cause the device to stop. |
|
692 | - * @param int $timeout How often to invoke the idle callback in milliseconds. The idle callback is invoked periodically when there is no activity on the device. The timeout value guarantees that there is at least this amount of milliseconds between invocations of the callback function. |
|
693 | - * @param mixed $user_data Additional data to pass to the callback function. |
|
694 | - * |
|
695 | - * @return ZMQDevice On success this method returns the current object. |
|
696 | - */ |
|
697 | - public function setIdleCallback($cb_func, $timeout, $user_data) {} |
|
698 | - /** |
|
699 | - * Sets the idle callback timeout value. The idle callback is invoked periodically when the device is idle. |
|
700 | - * On success this method returns the current object. |
|
701 | - * |
|
702 | - * @link https://secure.php.net/manual/en/zmqdevice.setidletimeout.php |
|
703 | - * |
|
704 | - * @param int $timeout The idle callback timeout value in milliseconds |
|
705 | - * |
|
706 | - * @return ZMQDevice On success this method returns the current object. |
|
707 | - */ |
|
708 | - public function setIdleTimeout($timeout) {} |
|
709 | - /** |
|
710 | - * Sets the timer callback function. The timer callback will be invoked after timeout has passed. |
|
711 | - * The difference between idle and timer callbacks are that idle callback is invoked only when the device is idle. |
|
712 | - * The callback function signature is callback (mixed $user_data). |
|
713 | - * Added in ZMQ extension version 1.1.0. |
|
714 | - * |
|
715 | - * @link https://secure.php.net/manual/en/zmqdevice.settimercallback.php |
|
716 | - * |
|
717 | - * @param callable $cb_func Callback function to invoke when the device is idle. Returning false or a value that evaluates to false from this function will cause the device to stop. |
|
718 | - * @param int $timeout How often to invoke the idle callback in milliseconds. The idle callback is invoked periodically when there is no activity on the device. The timeout value guarantees that there is at least this amount of milliseconds between invocations of the callback function. |
|
719 | - * @param mixed $user_data Additional data to pass to the callback function. |
|
720 | - * |
|
721 | - * @return ZMQDevice |
|
722 | - */ |
|
723 | - public function setTimerCallback($cb_func, $timeout, $user_data) {} |
|
724 | - /** |
|
725 | - * Sets the timer callback timeout value. The timer callback is invoked periodically if it's set. |
|
726 | - * Added in ZMQ extension version 1.1.0. |
|
727 | - * |
|
728 | - * @link https://secure.php.net/manual/en/zmqdevice.settimertimeout.php |
|
729 | - * |
|
730 | - * @param int $timeout The timer callback timeout value. |
|
731 | - * |
|
732 | - * @return ZMQDevice |
|
733 | - */ |
|
734 | - public function setTimerTimeout($timeout) {} |
|
640 | + /** |
|
641 | + * (PECL zmq >= 1.0.4) |
|
642 | + * Construct a new device. |
|
643 | + * "ØMQ devices can do intermediation of addresses, services, queues, or any other abstraction you care |
|
644 | + * to define above the message and socket layers." -- zguide |
|
645 | + * Call to this method will prepare the device. Usually devices are very long running processes so running this method from interactive script is not recommended. This method throw ZMQDeviceException if the device cannot be started. |
|
646 | + * |
|
647 | + * @link https://secure.php.net/manual/en/zmqdevice.construct.php |
|
648 | + * |
|
649 | + * @param ZMQSocket $frontend Frontend parameter for the devices. Usually where there messages are coming. |
|
650 | + * @param ZMQSocket $backend Backend parameter for the devices. Usually where there messages going to. |
|
651 | + * @param null|ZMQSocket $listener Listener socket, which receives a copy of all messages going both directions. The type of this socket should be SUB, PULL or DEALER. |
|
652 | + */ |
|
653 | + public function __construct(ZMQSocket $frontend, ZMQSocket $backend, ZMQSocket $listener = null) {} |
|
654 | + /** |
|
655 | + * Gets the idle callback timeout value. |
|
656 | + * This method returns the idle callback timeout value. |
|
657 | + * Added in ZMQ extension version 1.1.0. |
|
658 | + * |
|
659 | + * @link https://secure.php.net/manual/en/zmqdevice.getidletimeout.php |
|
660 | + * |
|
661 | + * @return int This method returns the idle callback timeout value. |
|
662 | + */ |
|
663 | + public function getIdleTimeout() {} |
|
664 | + /** |
|
665 | + * Gets the timer callback timeout value. |
|
666 | + * Added in ZMQ extension version 1.1.0. |
|
667 | + * |
|
668 | + * @link https://secure.php.net/manual/en/zmqdevice.gettimertimeout.php |
|
669 | + * |
|
670 | + * @return int This method returns the timer timeout value. |
|
671 | + */ |
|
672 | + public function getTimerTimeout() {} |
|
673 | + /** |
|
674 | + * Runs the device. |
|
675 | + * Call to this method will block until the device is running. |
|
676 | + * It is not recommended that devices are used from interactive scripts. |
|
677 | + * |
|
678 | + * @link https://secure.php.net/manual/en/zmqdevice.run.php |
|
679 | + * |
|
680 | + * @throws ZMQDeviceException |
|
681 | + */ |
|
682 | + public function run() {} |
|
683 | + /** |
|
684 | + * Sets the idle callback function. |
|
685 | + * If idle timeout is defined the idle callback function shall be called if the internal poll loop times out |
|
686 | + * without events. If the callback function returns false or a value that evaluates to false the device is stopped. |
|
687 | + * The callback function signature is callback (mixed $user_data). |
|
688 | + * |
|
689 | + * @link https://secure.php.net/manual/en/zmqdevice.setidlecallback.php |
|
690 | + * |
|
691 | + * @param callable $cb_func Callback function to invoke when the device is idle. Returning false or a value that evaluates to false from this function will cause the device to stop. |
|
692 | + * @param int $timeout How often to invoke the idle callback in milliseconds. The idle callback is invoked periodically when there is no activity on the device. The timeout value guarantees that there is at least this amount of milliseconds between invocations of the callback function. |
|
693 | + * @param mixed $user_data Additional data to pass to the callback function. |
|
694 | + * |
|
695 | + * @return ZMQDevice On success this method returns the current object. |
|
696 | + */ |
|
697 | + public function setIdleCallback($cb_func, $timeout, $user_data) {} |
|
698 | + /** |
|
699 | + * Sets the idle callback timeout value. The idle callback is invoked periodically when the device is idle. |
|
700 | + * On success this method returns the current object. |
|
701 | + * |
|
702 | + * @link https://secure.php.net/manual/en/zmqdevice.setidletimeout.php |
|
703 | + * |
|
704 | + * @param int $timeout The idle callback timeout value in milliseconds |
|
705 | + * |
|
706 | + * @return ZMQDevice On success this method returns the current object. |
|
707 | + */ |
|
708 | + public function setIdleTimeout($timeout) {} |
|
709 | + /** |
|
710 | + * Sets the timer callback function. The timer callback will be invoked after timeout has passed. |
|
711 | + * The difference between idle and timer callbacks are that idle callback is invoked only when the device is idle. |
|
712 | + * The callback function signature is callback (mixed $user_data). |
|
713 | + * Added in ZMQ extension version 1.1.0. |
|
714 | + * |
|
715 | + * @link https://secure.php.net/manual/en/zmqdevice.settimercallback.php |
|
716 | + * |
|
717 | + * @param callable $cb_func Callback function to invoke when the device is idle. Returning false or a value that evaluates to false from this function will cause the device to stop. |
|
718 | + * @param int $timeout How often to invoke the idle callback in milliseconds. The idle callback is invoked periodically when there is no activity on the device. The timeout value guarantees that there is at least this amount of milliseconds between invocations of the callback function. |
|
719 | + * @param mixed $user_data Additional data to pass to the callback function. |
|
720 | + * |
|
721 | + * @return ZMQDevice |
|
722 | + */ |
|
723 | + public function setTimerCallback($cb_func, $timeout, $user_data) {} |
|
724 | + /** |
|
725 | + * Sets the timer callback timeout value. The timer callback is invoked periodically if it's set. |
|
726 | + * Added in ZMQ extension version 1.1.0. |
|
727 | + * |
|
728 | + * @link https://secure.php.net/manual/en/zmqdevice.settimertimeout.php |
|
729 | + * |
|
730 | + * @param int $timeout The timer callback timeout value. |
|
731 | + * |
|
732 | + * @return ZMQDevice |
|
733 | + */ |
|
734 | + public function setTimerTimeout($timeout) {} |
|
735 | 735 | } |
736 | 736 | class ZMQException extends Exception {} |
737 | 737 | class ZMQContextException extends ZMQException {} |
@@ -8,8 +8,7 @@ discard block |
||
8 | 8 | * Class ZMQ |
9 | 9 | * @link https://secure.php.net/manual/en/class.zmq.php |
10 | 10 | */ |
11 | -class ZMQ |
|
12 | -{ |
|
11 | +class ZMQ { |
|
13 | 12 | /** |
14 | 13 | * Exclusive pair pattern |
15 | 14 | */ |
@@ -282,8 +281,7 @@ discard block |
||
282 | 281 | * Class ZMQContext |
283 | 282 | * @link https://secure.php.net/manual/en/class.zmqcontext.php |
284 | 283 | */ |
285 | -class ZMQContext |
|
286 | -{ |
|
284 | +class ZMQContext { |
|
287 | 285 | /** |
288 | 286 | * Constructs a new ZMQ context. The context is used to initialize sockets. |
289 | 287 | * A persistent context is required to initialize persistent sockets. |
@@ -349,8 +347,7 @@ discard block |
||
349 | 347 | * Class ZMQSocket |
350 | 348 | * @link https://secure.php.net/manual/en/class.zmqsocket.php |
351 | 349 | */ |
352 | -class ZMQSocket |
|
353 | -{ |
|
350 | +class ZMQSocket { |
|
354 | 351 | /** |
355 | 352 | * (PECL zmq >= 0.5.0) |
356 | 353 | * Constructs a ZMQSocket object. |
@@ -555,8 +552,7 @@ discard block |
||
555 | 552 | * Class ZMQPoll |
556 | 553 | * @link https://secure.php.net/manual/en/class.zmqpoll.php |
557 | 554 | */ |
558 | -class ZMQPoll |
|
559 | -{ |
|
555 | +class ZMQPoll { |
|
560 | 556 | /** |
561 | 557 | * (PECL zmq >= 0.5.0) |
562 | 558 | * Adds a new item to the poll set and returns the internal id of the added item. |
@@ -635,8 +631,7 @@ discard block |
||
635 | 631 | * Class ZMQDevice |
636 | 632 | * @link https://secure.php.net/manual/en/class.zmqdevice.php |
637 | 633 | */ |
638 | -class ZMQDevice |
|
639 | -{ |
|
634 | +class ZMQDevice { |
|
640 | 635 | /** |
641 | 636 | * (PECL zmq >= 1.0.4) |
642 | 637 | * Construct a new device. |
@@ -15,15 +15,15 @@ discard block |
||
15 | 15 | * @since 7.2 |
16 | 16 | */ |
17 | 17 | function ftp_append( |
18 | - #[LanguageLevelTypeAware(['8.1' => 'FTP\Connection'], default: 'resource')] $ftp, |
|
19 | - string $remote_filename, |
|
20 | - string $local_filename, |
|
21 | - #[EV([FTP_ASCII, FTP_BINARY])] |
|
22 | - #[PhpStormStubsElementAvailable(from: '5.3', to: '7.2')] |
|
23 | - int $mode, |
|
24 | - #[EV([FTP_ASCII, FTP_BINARY])] |
|
25 | - #[PhpStormStubsElementAvailable(from: '7.3')] |
|
26 | - int $mode = FTP_BINARY |
|
18 | + #[LanguageLevelTypeAware(['8.1' => 'FTP\Connection'], default: 'resource')] $ftp, |
|
19 | + string $remote_filename, |
|
20 | + string $local_filename, |
|
21 | + #[EV([FTP_ASCII, FTP_BINARY])] |
|
22 | + #[PhpStormStubsElementAvailable(from: '5.3', to: '7.2')] |
|
23 | + int $mode, |
|
24 | + #[EV([FTP_ASCII, FTP_BINARY])] |
|
25 | + #[PhpStormStubsElementAvailable(from: '7.3')] |
|
26 | + int $mode = FTP_BINARY |
|
27 | 27 | ): bool {} |
28 | 28 | |
29 | 29 | /** |
@@ -303,16 +303,16 @@ discard block |
||
303 | 303 | * @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure. |
304 | 304 | */ |
305 | 305 | function ftp_get( |
306 | - #[LanguageLevelTypeAware(['8.1' => 'FTP\Connection'], default: 'resource')] $ftp, |
|
307 | - string $local_filename, |
|
308 | - string $remote_filename, |
|
309 | - #[EV([FTP_ASCII, FTP_BINARY])] |
|
310 | - #[PhpStormStubsElementAvailable(from: '5.3', to: '7.2')] |
|
311 | - int $mode, |
|
312 | - #[EV([FTP_ASCII, FTP_BINARY])] |
|
313 | - #[PhpStormStubsElementAvailable(from: '7.3')] |
|
314 | - int $mode = FTP_BINARY, |
|
315 | - int $offset = 0 |
|
306 | + #[LanguageLevelTypeAware(['8.1' => 'FTP\Connection'], default: 'resource')] $ftp, |
|
307 | + string $local_filename, |
|
308 | + string $remote_filename, |
|
309 | + #[EV([FTP_ASCII, FTP_BINARY])] |
|
310 | + #[PhpStormStubsElementAvailable(from: '5.3', to: '7.2')] |
|
311 | + int $mode, |
|
312 | + #[EV([FTP_ASCII, FTP_BINARY])] |
|
313 | + #[PhpStormStubsElementAvailable(from: '7.3')] |
|
314 | + int $mode = FTP_BINARY, |
|
315 | + int $offset = 0 |
|
316 | 316 | ): bool {} |
317 | 317 | |
318 | 318 | /** |
@@ -336,16 +336,16 @@ discard block |
||
336 | 336 | * @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure. |
337 | 337 | */ |
338 | 338 | function ftp_fget( |
339 | - #[LanguageLevelTypeAware(['8.1' => 'FTP\Connection'], default: 'resource')] $ftp, |
|
340 | - $stream, |
|
341 | - string $remote_filename, |
|
342 | - #[EV([FTP_ASCII, FTP_BINARY])] |
|
343 | - #[PhpStormStubsElementAvailable(from: '5.3', to: '7.2')] |
|
344 | - int $mode, |
|
345 | - #[EV([FTP_ASCII, FTP_BINARY])] |
|
346 | - #[PhpStormStubsElementAvailable(from: '7.3')] |
|
347 | - int $mode = FTP_BINARY, |
|
348 | - int $offset = 0 |
|
339 | + #[LanguageLevelTypeAware(['8.1' => 'FTP\Connection'], default: 'resource')] $ftp, |
|
340 | + $stream, |
|
341 | + string $remote_filename, |
|
342 | + #[EV([FTP_ASCII, FTP_BINARY])] |
|
343 | + #[PhpStormStubsElementAvailable(from: '5.3', to: '7.2')] |
|
344 | + int $mode, |
|
345 | + #[EV([FTP_ASCII, FTP_BINARY])] |
|
346 | + #[PhpStormStubsElementAvailable(from: '7.3')] |
|
347 | + int $mode = FTP_BINARY, |
|
348 | + int $offset = 0 |
|
349 | 349 | ): bool {} |
350 | 350 | |
351 | 351 | /** |
@@ -367,16 +367,16 @@ discard block |
||
367 | 367 | * @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure. |
368 | 368 | */ |
369 | 369 | function ftp_put( |
370 | - #[LanguageLevelTypeAware(['8.1' => 'FTP\Connection'], default: 'resource')] $ftp, |
|
371 | - string $remote_filename, |
|
372 | - string $local_filename, |
|
373 | - #[EV([FTP_ASCII, FTP_BINARY])] |
|
374 | - #[PhpStormStubsElementAvailable(from: '5.3', to: '7.2')] |
|
375 | - int $mode, |
|
376 | - #[EV([FTP_ASCII, FTP_BINARY])] |
|
377 | - #[PhpStormStubsElementAvailable(from: '7.3')] |
|
378 | - int $mode = FTP_BINARY, |
|
379 | - int $offset = 0 |
|
370 | + #[LanguageLevelTypeAware(['8.1' => 'FTP\Connection'], default: 'resource')] $ftp, |
|
371 | + string $remote_filename, |
|
372 | + string $local_filename, |
|
373 | + #[EV([FTP_ASCII, FTP_BINARY])] |
|
374 | + #[PhpStormStubsElementAvailable(from: '5.3', to: '7.2')] |
|
375 | + int $mode, |
|
376 | + #[EV([FTP_ASCII, FTP_BINARY])] |
|
377 | + #[PhpStormStubsElementAvailable(from: '7.3')] |
|
378 | + int $mode = FTP_BINARY, |
|
379 | + int $offset = 0 |
|
380 | 380 | ): bool {} |
381 | 381 | |
382 | 382 | /** |
@@ -398,16 +398,16 @@ discard block |
||
398 | 398 | * @return bool <b>TRUE</b> on success or <b>FALSE</b> on failure. |
399 | 399 | */ |
400 | 400 | function ftp_fput( |
401 | - #[LanguageLevelTypeAware(['8.1' => 'FTP\Connection'], default: 'resource')] $ftp, |
|
402 | - string $remote_filename, |
|
403 | - $stream, |
|
404 | - #[EV([FTP_ASCII, FTP_BINARY])] |
|
405 | - #[PhpStormStubsElementAvailable(from: '5.3', to: '7.2')] |
|
406 | - int $mode, |
|
407 | - #[EV([FTP_ASCII, FTP_BINARY])] |
|
408 | - #[PhpStormStubsElementAvailable(from: '7.3')] |
|
409 | - int $mode = FTP_BINARY, |
|
410 | - int $offset = 0 |
|
401 | + #[LanguageLevelTypeAware(['8.1' => 'FTP\Connection'], default: 'resource')] $ftp, |
|
402 | + string $remote_filename, |
|
403 | + $stream, |
|
404 | + #[EV([FTP_ASCII, FTP_BINARY])] |
|
405 | + #[PhpStormStubsElementAvailable(from: '5.3', to: '7.2')] |
|
406 | + int $mode, |
|
407 | + #[EV([FTP_ASCII, FTP_BINARY])] |
|
408 | + #[PhpStormStubsElementAvailable(from: '7.3')] |
|
409 | + int $mode = FTP_BINARY, |
|
410 | + int $offset = 0 |
|
411 | 411 | ): bool {} |
412 | 412 | |
413 | 413 | /** |
@@ -581,16 +581,16 @@ discard block |
||
581 | 581 | */ |
582 | 582 | #[EV([FTP_FAILED, FTP_FINISHED, FTP_MOREDATA])] |
583 | 583 | function ftp_nb_fget( |
584 | - #[LanguageLevelTypeAware(['8.1' => 'FTP\Connection'], default: 'resource')] $ftp, |
|
585 | - $stream, |
|
586 | - string $remote_filename, |
|
587 | - #[EV([FTP_ASCII, FTP_BINARY])] |
|
588 | - #[PhpStormStubsElementAvailable(from: '5.3', to: '7.2')] |
|
589 | - int $mode, |
|
590 | - #[EV([FTP_ASCII, FTP_BINARY])] |
|
591 | - #[PhpStormStubsElementAvailable(from: '7.3')] |
|
592 | - int $mode = FTP_BINARY, |
|
593 | - int $offset = 0 |
|
584 | + #[LanguageLevelTypeAware(['8.1' => 'FTP\Connection'], default: 'resource')] $ftp, |
|
585 | + $stream, |
|
586 | + string $remote_filename, |
|
587 | + #[EV([FTP_ASCII, FTP_BINARY])] |
|
588 | + #[PhpStormStubsElementAvailable(from: '5.3', to: '7.2')] |
|
589 | + int $mode, |
|
590 | + #[EV([FTP_ASCII, FTP_BINARY])] |
|
591 | + #[PhpStormStubsElementAvailable(from: '7.3')] |
|
592 | + int $mode = FTP_BINARY, |
|
593 | + int $offset = 0 |
|
594 | 594 | ): int {} |
595 | 595 | |
596 | 596 | /** |
@@ -614,16 +614,16 @@ discard block |
||
614 | 614 | */ |
615 | 615 | #[EV([FTP_FAILED, FTP_FINISHED, FTP_MOREDATA])] |
616 | 616 | function ftp_nb_get( |
617 | - #[LanguageLevelTypeAware(['8.1' => 'FTP\Connection'], default: 'resource')] $ftp, |
|
618 | - string $local_filename, |
|
619 | - string $remote_filename, |
|
620 | - #[EV([FTP_ASCII, FTP_BINARY])] |
|
621 | - #[PhpStormStubsElementAvailable(from: '5.3', to: '7.2')] |
|
622 | - int $mode, |
|
623 | - #[EV([FTP_ASCII, FTP_BINARY])] |
|
624 | - #[PhpStormStubsElementAvailable(from: '7.3')] |
|
625 | - int $mode = FTP_BINARY, |
|
626 | - int $offset = 0 |
|
617 | + #[LanguageLevelTypeAware(['8.1' => 'FTP\Connection'], default: 'resource')] $ftp, |
|
618 | + string $local_filename, |
|
619 | + string $remote_filename, |
|
620 | + #[EV([FTP_ASCII, FTP_BINARY])] |
|
621 | + #[PhpStormStubsElementAvailable(from: '5.3', to: '7.2')] |
|
622 | + int $mode, |
|
623 | + #[EV([FTP_ASCII, FTP_BINARY])] |
|
624 | + #[PhpStormStubsElementAvailable(from: '7.3')] |
|
625 | + int $mode = FTP_BINARY, |
|
626 | + int $offset = 0 |
|
627 | 627 | ): int {} |
628 | 628 | |
629 | 629 | /** |
@@ -659,16 +659,16 @@ discard block |
||
659 | 659 | */ |
660 | 660 | #[EV([FTP_FAILED, FTP_FINISHED, FTP_MOREDATA])] |
661 | 661 | function ftp_nb_put( |
662 | - #[LanguageLevelTypeAware(['8.1' => 'FTP\Connection'], default: 'resource')] $ftp, |
|
663 | - string $remote_filename, |
|
664 | - string $local_filename, |
|
665 | - #[EV([FTP_ASCII, FTP_BINARY])] |
|
666 | - #[PhpStormStubsElementAvailable(from: '5.3', to: '7.2')] |
|
667 | - int $mode, |
|
668 | - #[EV([FTP_ASCII, FTP_BINARY])] |
|
669 | - #[PhpStormStubsElementAvailable(from: '7.3')] |
|
670 | - int $mode = FTP_BINARY, |
|
671 | - int $offset = 0 |
|
662 | + #[LanguageLevelTypeAware(['8.1' => 'FTP\Connection'], default: 'resource')] $ftp, |
|
663 | + string $remote_filename, |
|
664 | + string $local_filename, |
|
665 | + #[EV([FTP_ASCII, FTP_BINARY])] |
|
666 | + #[PhpStormStubsElementAvailable(from: '5.3', to: '7.2')] |
|
667 | + int $mode, |
|
668 | + #[EV([FTP_ASCII, FTP_BINARY])] |
|
669 | + #[PhpStormStubsElementAvailable(from: '7.3')] |
|
670 | + int $mode = FTP_BINARY, |
|
671 | + int $offset = 0 |
|
672 | 672 | ): int|false {} |
673 | 673 | |
674 | 674 | /** |
@@ -692,16 +692,16 @@ discard block |
||
692 | 692 | */ |
693 | 693 | #[EV([FTP_FAILED, FTP_FINISHED, FTP_MOREDATA])] |
694 | 694 | function ftp_nb_fput( |
695 | - #[LanguageLevelTypeAware(['8.1' => 'FTP\Connection'], default: 'resource')] $ftp, |
|
696 | - string $remote_filename, |
|
697 | - $stream, |
|
698 | - #[EV([FTP_ASCII, FTP_BINARY])] |
|
699 | - #[PhpStormStubsElementAvailable(from: '5.3', to: '7.2')] |
|
700 | - int $mode, |
|
701 | - #[EV([FTP_ASCII, FTP_BINARY])] |
|
702 | - #[PhpStormStubsElementAvailable(from: '7.3')] |
|
703 | - int $mode = FTP_BINARY, |
|
704 | - int $offset = 0 |
|
695 | + #[LanguageLevelTypeAware(['8.1' => 'FTP\Connection'], default: 'resource')] $ftp, |
|
696 | + string $remote_filename, |
|
697 | + $stream, |
|
698 | + #[EV([FTP_ASCII, FTP_BINARY])] |
|
699 | + #[PhpStormStubsElementAvailable(from: '5.3', to: '7.2')] |
|
700 | + int $mode, |
|
701 | + #[EV([FTP_ASCII, FTP_BINARY])] |
|
702 | + #[PhpStormStubsElementAvailable(from: '7.3')] |
|
703 | + int $mode = FTP_BINARY, |
|
704 | + int $offset = 0 |
|
705 | 705 | ): int {} |
706 | 706 | |
707 | 707 | /** |
@@ -33,7 +33,7 @@ discard block |
||
33 | 33 | * @return array|false |
34 | 34 | * @since 7.2 |
35 | 35 | */ |
36 | -function ftp_mlsd(#[LanguageLevelTypeAware(['8.1' => 'FTP\Connection'], default: 'resource')] $ftp, string $directory): array|false {} |
|
36 | +function ftp_mlsd(#[LanguageLevelTypeAware(['8.1' => 'FTP\Connection'], default: 'resource')] $ftp, string $directory): array | false {} |
|
37 | 37 | |
38 | 38 | /** |
39 | 39 | * Opens an FTP connection |
@@ -104,7 +104,7 @@ discard block |
||
104 | 104 | * </p> |
105 | 105 | * @return string|false the current directory name or <b>FALSE</b> on error. |
106 | 106 | */ |
107 | -function ftp_pwd(#[LanguageLevelTypeAware(['8.1' => 'FTP\Connection'], default: 'resource')] $ftp): string|false {} |
|
107 | +function ftp_pwd(#[LanguageLevelTypeAware(['8.1' => 'FTP\Connection'], default: 'resource')] $ftp): string | false {} |
|
108 | 108 | |
109 | 109 | /** |
110 | 110 | * Changes to the parent directory |
@@ -171,7 +171,7 @@ discard block |
||
171 | 171 | * </p> |
172 | 172 | * @return string|false the newly created directory name on success or <b>FALSE</b> on error. |
173 | 173 | */ |
174 | -function ftp_mkdir(#[LanguageLevelTypeAware(['8.1' => 'FTP\Connection'], default: 'resource')] $ftp, string $directory): string|false {} |
|
174 | +function ftp_mkdir(#[LanguageLevelTypeAware(['8.1' => 'FTP\Connection'], default: 'resource')] $ftp, string $directory): string | false {} |
|
175 | 175 | |
176 | 176 | /** |
177 | 177 | * Removes a directory |
@@ -201,7 +201,7 @@ discard block |
||
201 | 201 | * </p> |
202 | 202 | * @return int|false the new file permissions on success or <b>FALSE</b> on error. |
203 | 203 | */ |
204 | -function ftp_chmod(#[LanguageLevelTypeAware(['8.1' => 'FTP\Connection'], default: 'resource')] $ftp, int $permissions, string $filename): int|false {} |
|
204 | +function ftp_chmod(#[LanguageLevelTypeAware(['8.1' => 'FTP\Connection'], default: 'resource')] $ftp, int $permissions, string $filename): int | false {} |
|
205 | 205 | |
206 | 206 | /** |
207 | 207 | * Allocates space for a file to be uploaded |
@@ -235,7 +235,7 @@ discard block |
||
235 | 235 | * @return string[]|false an array of filenames from the specified directory on success or |
236 | 236 | * <b>FALSE</b> on error. |
237 | 237 | */ |
238 | -function ftp_nlist(#[LanguageLevelTypeAware(['8.1' => 'FTP\Connection'], default: 'resource')] $ftp, string $directory): array|false {} |
|
238 | +function ftp_nlist(#[LanguageLevelTypeAware(['8.1' => 'FTP\Connection'], default: 'resource')] $ftp, string $directory): array | false {} |
|
239 | 239 | |
240 | 240 | /** |
241 | 241 | * Returns a detailed list of files in the given directory |
@@ -257,7 +257,7 @@ discard block |
||
257 | 257 | * should be interpreted. |
258 | 258 | * </p> |
259 | 259 | */ |
260 | -function ftp_rawlist(#[LanguageLevelTypeAware(['8.1' => 'FTP\Connection'], default: 'resource')] $ftp, string $directory, bool $recursive = false): array|false {} |
|
260 | +function ftp_rawlist(#[LanguageLevelTypeAware(['8.1' => 'FTP\Connection'], default: 'resource')] $ftp, string $directory, bool $recursive = false): array | false {} |
|
261 | 261 | |
262 | 262 | /** |
263 | 263 | * Returns the system type identifier of the remote FTP server |
@@ -267,7 +267,7 @@ discard block |
||
267 | 267 | * </p> |
268 | 268 | * @return string|false the remote system type, or <b>FALSE</b> on error. |
269 | 269 | */ |
270 | -function ftp_systype(#[LanguageLevelTypeAware(['8.1' => 'FTP\Connection'], default: 'resource')] $ftp): string|false {} |
|
270 | +function ftp_systype(#[LanguageLevelTypeAware(['8.1' => 'FTP\Connection'], default: 'resource')] $ftp): string | false {} |
|
271 | 271 | |
272 | 272 | /** |
273 | 273 | * Turns passive mode on or off |
@@ -558,7 +558,7 @@ discard block |
||
558 | 558 | * <i>option</i> is not supported. In the latter case, a |
559 | 559 | * warning message is also thrown. |
560 | 560 | */ |
561 | -function ftp_get_option(#[LanguageLevelTypeAware(['8.1' => 'FTP\Connection'], default: 'resource')] $ftp, #[EV(flags: [FTP_TIMEOUT_SEC, FTP_AUTOSEEK])] int $option): int|bool {} |
|
561 | +function ftp_get_option(#[LanguageLevelTypeAware(['8.1' => 'FTP\Connection'], default: 'resource')] $ftp, #[EV(flags: [FTP_TIMEOUT_SEC, FTP_AUTOSEEK])] int $option): int | bool {} |
|
562 | 562 | |
563 | 563 | /** |
564 | 564 | * Retrieves a file from the FTP server and writes it to an open file (non-blocking) |
@@ -669,7 +669,7 @@ discard block |
||
669 | 669 | #[PhpStormStubsElementAvailable(from: '7.3')] |
670 | 670 | int $mode = FTP_BINARY, |
671 | 671 | int $offset = 0 |
672 | -): int|false {} |
|
672 | +): int | false {} |
|
673 | 673 | |
674 | 674 | /** |
675 | 675 | * Stores a file from an open file to the FTP server (non-blocking) |
@@ -61,7 +61,7 @@ discard block |
||
61 | 61 | * @removed 7.0 |
62 | 62 | * @see preg_replace() |
63 | 63 | */ |
64 | -#[Deprecated(reason: "Use preg_replace() instead", since: "5.3")] |
|
64 | +#[Deprecated(reason : "Use preg_replace() instead", since : "5.3")] |
|
65 | 65 | function ereg_replace($pattern, $replacement, $string) {} |
66 | 66 | |
67 | 67 | /** |
@@ -95,7 +95,7 @@ discard block |
||
95 | 95 | * @removed 7.0 |
96 | 96 | * @see preg_match() |
97 | 97 | */ |
98 | -#[Deprecated(reason: "Use preg_match() instead", since: "5.3")] |
|
98 | +#[Deprecated(reason : "Use preg_match() instead", since : "5.3")] |
|
99 | 99 | function eregi($pattern, $string, array &$regs = null) {} |
100 | 100 | |
101 | 101 | /** |
@@ -121,7 +121,7 @@ discard block |
||
121 | 121 | * @removed 7.0 |
122 | 122 | * @see preg_replace() |
123 | 123 | */ |
124 | -#[Deprecated(reason: "Use preg_replace() instead", since: "5.3")] |
|
124 | +#[Deprecated(reason : "Use preg_replace() instead", since : "5.3")] |
|
125 | 125 | function eregi_replace($pattern, $replacement, $string) {} |
126 | 126 | |
127 | 127 | /** |
@@ -164,7 +164,7 @@ discard block |
||
164 | 164 | * @removed 7.0 |
165 | 165 | * @see preg_split() |
166 | 166 | */ |
167 | -#[Deprecated(reason: "Use preg_split() instead", since: "5.3")] |
|
167 | +#[Deprecated(reason : "Use preg_split() instead", since : "5.3")] |
|
168 | 168 | function split($pattern, $string, $limit = -1) {} |
169 | 169 | |
170 | 170 | /** |
@@ -207,7 +207,7 @@ discard block |
||
207 | 207 | * @removed 7.0 |
208 | 208 | * @see preg_split() |
209 | 209 | */ |
210 | -#[Deprecated(reason: "Use preg_split() instead", since: "5.3")] |
|
210 | +#[Deprecated(reason : "Use preg_split() instead", since : "5.3")] |
|
211 | 211 | function spliti($pattern, $string, $limit = -1) {} |
212 | 212 | |
213 | 213 | /** |
@@ -223,7 +223,7 @@ discard block |
||
223 | 223 | * uppercase and lowercase form. Other characters remain unchanged. |
224 | 224 | * @removed 7.0 |
225 | 225 | */ |
226 | -#[Deprecated(since: '5.3')] |
|
226 | +#[Deprecated(since : '5.3')] |
|
227 | 227 | function sql_regcase($string) {} |
228 | 228 | |
229 | 229 | // End of ereg v. |
@@ -1,216 +1,216 @@ |
||
1 | 1 | <?php |
2 | 2 | class ffmpeg_movie |
3 | 3 | { |
4 | - /** Open a video or audio file and return it as an object. |
|
5 | - * @param string $path_to_media - File path of video or audio file to open. |
|
6 | - * @param bool $persistent - Whether to open this media as a persistent resource. See the PHP documentation for more info about persistent resources |
|
7 | - */ |
|
8 | - public function __construct($path_to_media, $persistent) {} |
|
9 | - |
|
10 | - /** Return the duration of a movie or audio file in seconds. |
|
11 | - * @return int |
|
12 | - */ |
|
13 | - public function getDuration() {} |
|
14 | - |
|
15 | - /** Return the number of frames in a movie or audio file. |
|
16 | - * @return int |
|
17 | - */ |
|
18 | - public function getFrameCount() {} |
|
19 | - |
|
20 | - /** Return the frame rate of a movie in fps. |
|
21 | - * @return int |
|
22 | - */ |
|
23 | - public function getFrameRate() {} |
|
24 | - |
|
25 | - /** Return the path and name of the movie file or audio file. |
|
26 | - * @return string |
|
27 | - */ |
|
28 | - public function getFilename() {} |
|
29 | - |
|
30 | - /** Return the comment field from the movie or audio file. |
|
31 | - * @return string |
|
32 | - */ |
|
33 | - public function getComment() {} |
|
34 | - |
|
35 | - /** Return the title field from the movie or audio file. |
|
36 | - * @return string |
|
37 | - */ |
|
38 | - public function getTitle() {} |
|
39 | - |
|
40 | - /** Return the author field from the movie or the artist ID3 field from an mp3 file. |
|
41 | - * @return string |
|
42 | - */ |
|
43 | - public function getAuthor() {} |
|
44 | - |
|
45 | - /** Return the author field from the movie or the artist ID3 field from an mp3 file. |
|
46 | - * @return string |
|
47 | - */ |
|
48 | - public function getArtist() {} |
|
49 | - |
|
50 | - /** Return the copyright field from the movie or audio file. |
|
51 | - * @return string |
|
52 | - */ |
|
53 | - public function getCopyright() {} |
|
54 | - |
|
55 | - /** Return the genre ID3 field from an mp3 file. |
|
56 | - * @return string |
|
57 | - */ |
|
58 | - public function getGenre() {} |
|
59 | - |
|
60 | - /** Return the track ID3 field from an mp3 file. |
|
61 | - * @return string|int |
|
62 | - */ |
|
63 | - public function getTrackNumber() {} |
|
64 | - |
|
65 | - /** Return the year ID3 field from an mp3 file. |
|
66 | - * @return string|int |
|
67 | - */ |
|
68 | - public function getYear() {} |
|
69 | - |
|
70 | - /** Return the height of the movie in pixels. |
|
71 | - * @return int |
|
72 | - */ |
|
73 | - public function getFrameHeight() {} |
|
74 | - |
|
75 | - /** Return the width of the movie in pixels. |
|
76 | - * @return int |
|
77 | - */ |
|
78 | - public function getFrameWidth() {} |
|
79 | - |
|
80 | - /** Return the pixel format of the movie.*/ |
|
81 | - public function getPixelFormat() {} |
|
82 | - |
|
83 | - /** Return the bit rate of the movie or audio file in bits per second. |
|
84 | - * @return int |
|
85 | - */ |
|
86 | - public function getBitRate() {} |
|
87 | - |
|
88 | - /** Return the bit rate of the video in bits per second. |
|
89 | - * NOTE: This only works for files with constant bit rate. |
|
90 | - * @return int |
|
91 | - */ |
|
92 | - public function getVideoBitRate() {} |
|
93 | - |
|
94 | - /** Return the audio bit rate of the media file in bits per second. |
|
95 | - * @return int |
|
96 | - */ |
|
97 | - public function getAudioBitRate() {} |
|
98 | - |
|
99 | - /** Return the audio sample rate of the media file in bits per second. |
|
100 | - * @return int |
|
101 | - */ |
|
102 | - public function getAudioSampleRate() {} |
|
103 | - |
|
104 | - /** Return the current frame index. |
|
105 | - * @return int |
|
106 | - */ |
|
107 | - public function getFrameNumber() {} |
|
108 | - |
|
109 | - /** Return the name of the video codec used to encode this movie as a string. |
|
110 | - * @return string |
|
111 | - */ |
|
112 | - public function getVideoCodec() {} |
|
113 | - |
|
114 | - /** Return the name of the audio codec used to encode this movie as a string. |
|
115 | - * @return string |
|
116 | - */ |
|
117 | - public function getAudioCodec() {} |
|
118 | - |
|
119 | - /** Return the number of audio channels in this movie as an integer. |
|
120 | - * @return int |
|
121 | - */ |
|
122 | - public function getAudioChannels() {} |
|
123 | - |
|
124 | - /** Return boolean value indicating whether the movie has an audio stream. |
|
125 | - * @return bool |
|
126 | - */ |
|
127 | - public function hasAudio() {} |
|
128 | - |
|
129 | - /** Return boolean value indicating whether the movie has a video stream. |
|
130 | - * @return bool |
|
131 | - */ |
|
132 | - public function hasVideo() {} |
|
133 | - |
|
134 | - /** Returns a frame from the movie as an ffmpeg_frame object. Returns false if the frame was not found. |
|
135 | - * @param int $framenumber - Frame from the movie to return. If no framenumber is specified, returns the next frame of the movie. |
|
136 | - * @return ffmpeg_frame |
|
137 | - */ |
|
138 | - public function getFrame($framenumber) {} |
|
139 | - |
|
140 | - /** Returns the next key frame from the movie as an ffmpeg_frame object. Returns false if the frame was not found. |
|
141 | - * @return ffmpeg_frame |
|
142 | - */ |
|
143 | - public function getNextKeyFrame() {} |
|
4 | + /** Open a video or audio file and return it as an object. |
|
5 | + * @param string $path_to_media - File path of video or audio file to open. |
|
6 | + * @param bool $persistent - Whether to open this media as a persistent resource. See the PHP documentation for more info about persistent resources |
|
7 | + */ |
|
8 | + public function __construct($path_to_media, $persistent) {} |
|
9 | + |
|
10 | + /** Return the duration of a movie or audio file in seconds. |
|
11 | + * @return int |
|
12 | + */ |
|
13 | + public function getDuration() {} |
|
14 | + |
|
15 | + /** Return the number of frames in a movie or audio file. |
|
16 | + * @return int |
|
17 | + */ |
|
18 | + public function getFrameCount() {} |
|
19 | + |
|
20 | + /** Return the frame rate of a movie in fps. |
|
21 | + * @return int |
|
22 | + */ |
|
23 | + public function getFrameRate() {} |
|
24 | + |
|
25 | + /** Return the path and name of the movie file or audio file. |
|
26 | + * @return string |
|
27 | + */ |
|
28 | + public function getFilename() {} |
|
29 | + |
|
30 | + /** Return the comment field from the movie or audio file. |
|
31 | + * @return string |
|
32 | + */ |
|
33 | + public function getComment() {} |
|
34 | + |
|
35 | + /** Return the title field from the movie or audio file. |
|
36 | + * @return string |
|
37 | + */ |
|
38 | + public function getTitle() {} |
|
39 | + |
|
40 | + /** Return the author field from the movie or the artist ID3 field from an mp3 file. |
|
41 | + * @return string |
|
42 | + */ |
|
43 | + public function getAuthor() {} |
|
44 | + |
|
45 | + /** Return the author field from the movie or the artist ID3 field from an mp3 file. |
|
46 | + * @return string |
|
47 | + */ |
|
48 | + public function getArtist() {} |
|
49 | + |
|
50 | + /** Return the copyright field from the movie or audio file. |
|
51 | + * @return string |
|
52 | + */ |
|
53 | + public function getCopyright() {} |
|
54 | + |
|
55 | + /** Return the genre ID3 field from an mp3 file. |
|
56 | + * @return string |
|
57 | + */ |
|
58 | + public function getGenre() {} |
|
59 | + |
|
60 | + /** Return the track ID3 field from an mp3 file. |
|
61 | + * @return string|int |
|
62 | + */ |
|
63 | + public function getTrackNumber() {} |
|
64 | + |
|
65 | + /** Return the year ID3 field from an mp3 file. |
|
66 | + * @return string|int |
|
67 | + */ |
|
68 | + public function getYear() {} |
|
69 | + |
|
70 | + /** Return the height of the movie in pixels. |
|
71 | + * @return int |
|
72 | + */ |
|
73 | + public function getFrameHeight() {} |
|
74 | + |
|
75 | + /** Return the width of the movie in pixels. |
|
76 | + * @return int |
|
77 | + */ |
|
78 | + public function getFrameWidth() {} |
|
79 | + |
|
80 | + /** Return the pixel format of the movie.*/ |
|
81 | + public function getPixelFormat() {} |
|
82 | + |
|
83 | + /** Return the bit rate of the movie or audio file in bits per second. |
|
84 | + * @return int |
|
85 | + */ |
|
86 | + public function getBitRate() {} |
|
87 | + |
|
88 | + /** Return the bit rate of the video in bits per second. |
|
89 | + * NOTE: This only works for files with constant bit rate. |
|
90 | + * @return int |
|
91 | + */ |
|
92 | + public function getVideoBitRate() {} |
|
93 | + |
|
94 | + /** Return the audio bit rate of the media file in bits per second. |
|
95 | + * @return int |
|
96 | + */ |
|
97 | + public function getAudioBitRate() {} |
|
98 | + |
|
99 | + /** Return the audio sample rate of the media file in bits per second. |
|
100 | + * @return int |
|
101 | + */ |
|
102 | + public function getAudioSampleRate() {} |
|
103 | + |
|
104 | + /** Return the current frame index. |
|
105 | + * @return int |
|
106 | + */ |
|
107 | + public function getFrameNumber() {} |
|
108 | + |
|
109 | + /** Return the name of the video codec used to encode this movie as a string. |
|
110 | + * @return string |
|
111 | + */ |
|
112 | + public function getVideoCodec() {} |
|
113 | + |
|
114 | + /** Return the name of the audio codec used to encode this movie as a string. |
|
115 | + * @return string |
|
116 | + */ |
|
117 | + public function getAudioCodec() {} |
|
118 | + |
|
119 | + /** Return the number of audio channels in this movie as an integer. |
|
120 | + * @return int |
|
121 | + */ |
|
122 | + public function getAudioChannels() {} |
|
123 | + |
|
124 | + /** Return boolean value indicating whether the movie has an audio stream. |
|
125 | + * @return bool |
|
126 | + */ |
|
127 | + public function hasAudio() {} |
|
128 | + |
|
129 | + /** Return boolean value indicating whether the movie has a video stream. |
|
130 | + * @return bool |
|
131 | + */ |
|
132 | + public function hasVideo() {} |
|
133 | + |
|
134 | + /** Returns a frame from the movie as an ffmpeg_frame object. Returns false if the frame was not found. |
|
135 | + * @param int $framenumber - Frame from the movie to return. If no framenumber is specified, returns the next frame of the movie. |
|
136 | + * @return ffmpeg_frame |
|
137 | + */ |
|
138 | + public function getFrame($framenumber) {} |
|
139 | + |
|
140 | + /** Returns the next key frame from the movie as an ffmpeg_frame object. Returns false if the frame was not found. |
|
141 | + * @return ffmpeg_frame |
|
142 | + */ |
|
143 | + public function getNextKeyFrame() {} |
|
144 | 144 | } |
145 | 145 | |
146 | 146 | class ffmpeg_frame |
147 | 147 | { |
148 | - /** |
|
149 | - * NOTE: This function will not be available if GD is not enabled. |
|
150 | - * @param resource $gd_image |
|
151 | - */ |
|
152 | - public function __construct($gd_image) {} |
|
153 | - |
|
154 | - /** Return the width of the frame. |
|
155 | - * @return int |
|
156 | - */ |
|
157 | - public function getWidth() {} |
|
158 | - |
|
159 | - /** Return the height of the frame. |
|
160 | - * @return int |
|
161 | - */ |
|
162 | - public function getHeight() {} |
|
163 | - |
|
164 | - /** Return the presentation time stamp of the frame. |
|
165 | - * @return int |
|
166 | - */ |
|
167 | - public function getPTS() {} |
|
168 | - |
|
169 | - /** Return the presentation time stamp of the frame. |
|
170 | - * @return int |
|
171 | - */ |
|
172 | - public function getPresentationTimestamp() {} |
|
173 | - |
|
174 | - /** Resize and optionally crop the frame. (Cropping is built into ffmpeg resizing so I'm providing it here for completeness.) |
|
175 | - * @param int $width - New width of the frame (must be an even number). |
|
176 | - * @param int $height - New height of the frame (must be an even number). |
|
177 | - * @param int $crop_top - Remove [croptop] rows of pixels from the top of the frame. |
|
178 | - * @param int $crop_bottom - Remove [cropbottom] rows of pixels from the bottom of the frame. |
|
179 | - * @param int $crop_left - Remove [cropleft] rows of pixels from the left of the frame. |
|
180 | - * @param int $crop_right - Remove [cropright] rows of pixels from the right of the frame. |
|
181 | - * NOTE: Cropping is always applied to the frame before it is resized. Crop values must be even numbers. |
|
182 | - */ |
|
183 | - public function resize($width, $height, $crop_top = 0, $crop_bottom = 0, $crop_left = 0, $crop_right = 0) {} |
|
184 | - |
|
185 | - /** Crop the frame. |
|
186 | - * @param int $crop_top - Remove [croptop] rows of pixels from the top of the frame. |
|
187 | - * @param int $crop_bottom - Remove [cropbottom] rows of pixels from the bottom of the frame. |
|
188 | - * @param int $crop_left - Remove [cropleft] rows of pixels from the left of the frame. |
|
189 | - * @param int $crop_right - Remove [cropright] rows of pixels from the right of the frame. |
|
190 | - * NOTE: Crop values must be even numbers. |
|
191 | - */ |
|
192 | - public function crop($crop_top, $crop_bottom = 0, $crop_left = 0, $crop_right = 0) {} |
|
193 | - |
|
194 | - /** Returns a truecolor GD image of the frame. |
|
195 | - * NOTE: This function will not be available if GD is not enabled. |
|
196 | - * @return resource |
|
197 | - */ |
|
198 | - public function toGDImage() {} |
|
148 | + /** |
|
149 | + * NOTE: This function will not be available if GD is not enabled. |
|
150 | + * @param resource $gd_image |
|
151 | + */ |
|
152 | + public function __construct($gd_image) {} |
|
153 | + |
|
154 | + /** Return the width of the frame. |
|
155 | + * @return int |
|
156 | + */ |
|
157 | + public function getWidth() {} |
|
158 | + |
|
159 | + /** Return the height of the frame. |
|
160 | + * @return int |
|
161 | + */ |
|
162 | + public function getHeight() {} |
|
163 | + |
|
164 | + /** Return the presentation time stamp of the frame. |
|
165 | + * @return int |
|
166 | + */ |
|
167 | + public function getPTS() {} |
|
168 | + |
|
169 | + /** Return the presentation time stamp of the frame. |
|
170 | + * @return int |
|
171 | + */ |
|
172 | + public function getPresentationTimestamp() {} |
|
173 | + |
|
174 | + /** Resize and optionally crop the frame. (Cropping is built into ffmpeg resizing so I'm providing it here for completeness.) |
|
175 | + * @param int $width - New width of the frame (must be an even number). |
|
176 | + * @param int $height - New height of the frame (must be an even number). |
|
177 | + * @param int $crop_top - Remove [croptop] rows of pixels from the top of the frame. |
|
178 | + * @param int $crop_bottom - Remove [cropbottom] rows of pixels from the bottom of the frame. |
|
179 | + * @param int $crop_left - Remove [cropleft] rows of pixels from the left of the frame. |
|
180 | + * @param int $crop_right - Remove [cropright] rows of pixels from the right of the frame. |
|
181 | + * NOTE: Cropping is always applied to the frame before it is resized. Crop values must be even numbers. |
|
182 | + */ |
|
183 | + public function resize($width, $height, $crop_top = 0, $crop_bottom = 0, $crop_left = 0, $crop_right = 0) {} |
|
184 | + |
|
185 | + /** Crop the frame. |
|
186 | + * @param int $crop_top - Remove [croptop] rows of pixels from the top of the frame. |
|
187 | + * @param int $crop_bottom - Remove [cropbottom] rows of pixels from the bottom of the frame. |
|
188 | + * @param int $crop_left - Remove [cropleft] rows of pixels from the left of the frame. |
|
189 | + * @param int $crop_right - Remove [cropright] rows of pixels from the right of the frame. |
|
190 | + * NOTE: Crop values must be even numbers. |
|
191 | + */ |
|
192 | + public function crop($crop_top, $crop_bottom = 0, $crop_left = 0, $crop_right = 0) {} |
|
193 | + |
|
194 | + /** Returns a truecolor GD image of the frame. |
|
195 | + * NOTE: This function will not be available if GD is not enabled. |
|
196 | + * @return resource |
|
197 | + */ |
|
198 | + public function toGDImage() {} |
|
199 | 199 | } |
200 | 200 | |
201 | 201 | class ffmpeg_animated_gif |
202 | 202 | { |
203 | - /** |
|
204 | - * @param string $output_file_path - Location in the filesystem where the animated gif will be written. |
|
205 | - * @param int $width - Width of the animated gif. |
|
206 | - * @param int $height - Height of the animated gif. |
|
207 | - * @param int $frame_rate - Frame rate of the animated gif in frames per second. |
|
208 | - * @param int $loop_count - Number of times to loop the animation. Put a zero here to loop forever or omit this parameter to disable looping. |
|
209 | - */ |
|
210 | - public function __construct($output_file_path, $width, $height, $frame_rate, $loop_count = 0) {} |
|
211 | - |
|
212 | - /** Add a frame to the end of the animated gif. |
|
213 | - * @param ffmpeg_frame $frame_to_add - The ffmpeg_frame object to add to the end of the animated gif. |
|
214 | - */ |
|
215 | - public function addFrame(ffmpeg_frame $frame_to_add) {} |
|
203 | + /** |
|
204 | + * @param string $output_file_path - Location in the filesystem where the animated gif will be written. |
|
205 | + * @param int $width - Width of the animated gif. |
|
206 | + * @param int $height - Height of the animated gif. |
|
207 | + * @param int $frame_rate - Frame rate of the animated gif in frames per second. |
|
208 | + * @param int $loop_count - Number of times to loop the animation. Put a zero here to loop forever or omit this parameter to disable looping. |
|
209 | + */ |
|
210 | + public function __construct($output_file_path, $width, $height, $frame_rate, $loop_count = 0) {} |
|
211 | + |
|
212 | + /** Add a frame to the end of the animated gif. |
|
213 | + * @param ffmpeg_frame $frame_to_add - The ffmpeg_frame object to add to the end of the animated gif. |
|
214 | + */ |
|
215 | + public function addFrame(ffmpeg_frame $frame_to_add) {} |
|
216 | 216 | } |
@@ -1,6 +1,5 @@ discard block |
||
1 | 1 | <?php |
2 | -class ffmpeg_movie |
|
3 | -{ |
|
2 | +class ffmpeg_movie { |
|
4 | 3 | /** Open a video or audio file and return it as an object. |
5 | 4 | * @param string $path_to_media - File path of video or audio file to open. |
6 | 5 | * @param bool $persistent - Whether to open this media as a persistent resource. See the PHP documentation for more info about persistent resources |
@@ -143,8 +142,7 @@ discard block |
||
143 | 142 | public function getNextKeyFrame() {} |
144 | 143 | } |
145 | 144 | |
146 | -class ffmpeg_frame |
|
147 | -{ |
|
145 | +class ffmpeg_frame { |
|
148 | 146 | /** |
149 | 147 | * NOTE: This function will not be available if GD is not enabled. |
150 | 148 | * @param resource $gd_image |
@@ -198,8 +196,7 @@ discard block |
||
198 | 196 | public function toGDImage() {} |
199 | 197 | } |
200 | 198 | |
201 | -class ffmpeg_animated_gif |
|
202 | -{ |
|
199 | +class ffmpeg_animated_gif { |
|
203 | 200 | /** |
204 | 201 | * @param string $output_file_path - Location in the filesystem where the animated gif will be written. |
205 | 202 | * @param int $width - Width of the animated gif. |
@@ -4,1632 +4,1632 @@ |
||
4 | 4 | |
5 | 5 | class PDFlib |
6 | 6 | { |
7 | - /** |
|
8 | - * Activates a previously created structure element or other content item. |
|
9 | - * @param $id |
|
10 | - * |
|
11 | - * @return bool |
|
12 | - * |
|
13 | - * @link https://secure.php.net/manual/en/function.pdf-activate-item.php |
|
14 | - */ |
|
15 | - public function activate_item($id) {} |
|
16 | - |
|
17 | - /** |
|
18 | - * Adds a link to a web resource. |
|
19 | - * @param float $llx |
|
20 | - * @param float $lly |
|
21 | - * @param float $urx |
|
22 | - * @param float $ury |
|
23 | - * @param string $filename |
|
24 | - * |
|
25 | - * @return bool |
|
26 | - * |
|
27 | - * @link https://secure.php.net/manual/en/function.pdf-add-launchlink.php |
|
28 | - * @see PDF_create_action() |
|
29 | - */ |
|
30 | - #[Deprecated(" This function is deprecated since PDFlib version 6, use PDF_create_action() with type=Launch and PDF_create_annotation() with type=Link instead.")] |
|
31 | - public function add_launchlink($llx, $lly, $urx, $ury, $filename) {} |
|
32 | - |
|
33 | - /** |
|
34 | - * Add a link annotation to a target within the current PDF file. |
|
35 | - * |
|
36 | - * @param float $lowerleftx |
|
37 | - * @param float $lowerlefty |
|
38 | - * @param float $upperrightx |
|
39 | - * @param float $upperrighty |
|
40 | - * @param int $page |
|
41 | - * @param string $dest |
|
42 | - * |
|
43 | - * @return bool |
|
44 | - * |
|
45 | - * @link https://secure.php.net/manual/en/function.pdf-add-locallink.php |
|
46 | - * @see PDF_create_action() |
|
47 | - */ |
|
48 | - #[Deprecated('This function is deprecated since PDFlib version 6, use PDF_create_action() with type=GoTo and PDF_create_annotation() with type=Link instead.')] |
|
49 | - public function add_locallink($lowerleftx, $lowerlefty, $upperrightx, $upperrighty, $page, $dest) {} |
|
50 | - |
|
51 | - /** |
|
52 | - * Creates a named destination on an arbitrary page in the current document. |
|
53 | - * |
|
54 | - * @param string $name |
|
55 | - * @param string $optlist |
|
56 | - * |
|
57 | - * @return bool |
|
58 | - * |
|
59 | - * @link https://secure.php.net/manual/en/function.pdf-add-nameddest.php |
|
60 | - */ |
|
61 | - public function add_nameddest($name, $optlist) {} |
|
62 | - |
|
63 | - /** |
|
64 | - * Sets an annotation for the current page. |
|
65 | - * |
|
66 | - * @param float $llx |
|
67 | - * @param float $lly |
|
68 | - * @param float $urx |
|
69 | - * @param float $ury |
|
70 | - * @param string $contents |
|
71 | - * @param string $title |
|
72 | - * @param string $icon |
|
73 | - * @param int $open |
|
74 | - * |
|
75 | - * @return bool |
|
76 | - * |
|
77 | - * @link https://secure.php.net/manual/en/function.pdf-add-note.php |
|
78 | - * @see PDF_create_annotation() |
|
79 | - */ |
|
80 | - #[Deprecated('This function is deprecated since PDFlib version 6, use PDF_create_annotation() with type=Text instead.')] |
|
81 | - public function add_note($llx, $lly, $urx, $ury, $contents, $title, $icon, $open) {} |
|
82 | - |
|
83 | - /** |
|
84 | - * Add a file link annotation to a PDF target. |
|
85 | - * |
|
86 | - * @param float $bottom_left_x |
|
87 | - * @param float $bottom_left_y |
|
88 | - * @param float $up_right_x |
|
89 | - * @param float $up_right_y |
|
90 | - * @param string $filename |
|
91 | - * @param int $page |
|
92 | - * @param string $dest |
|
93 | - * |
|
94 | - * @return bool |
|
95 | - * |
|
96 | - * @link https://secure.php.net/manual/en/function.pdf-add-pdflink.php |
|
97 | - * @see PDF_create_action |
|
98 | - */ |
|
99 | - #[Deprecated('This function is deprecated since PDFlib version 6, use PDF_create_action() with type=GoToR and PDF_create_annotation() with type=Link instead.')] |
|
100 | - public function add_pdflink($bottom_left_x, $bottom_left_y, $up_right_x, $up_right_y, $filename, $page, $dest) {} |
|
101 | - |
|
102 | - /** |
|
103 | - * Adds a cell to a new or existing table. |
|
104 | - * |
|
105 | - * @param int $table |
|
106 | - * @param int $column |
|
107 | - * @param int $row |
|
108 | - * @param string $text |
|
109 | - * @param string $optlist |
|
110 | - * |
|
111 | - * @return int |
|
112 | - * |
|
113 | - * @link https://secure.php.net/manual/en/function.pdf-add-table-cell.php |
|
114 | - */ |
|
115 | - public function add_table_cell($table, $column, $row, $text, $optlist) {} |
|
116 | - |
|
117 | - /** |
|
118 | - * Creates a Textflow object, or adds text and explicit options to an existing Textflow. |
|
119 | - * |
|
120 | - * @param int $textflow |
|
121 | - * @param string $text |
|
122 | - * @param string $optlist |
|
123 | - * |
|
124 | - * @return int |
|
125 | - * |
|
126 | - * @link https://secure.php.net/manual/en/function.pdf-add-textflow.php |
|
127 | - */ |
|
128 | - public function add_textflow($textflow, $text, $optlist) {} |
|
129 | - |
|
130 | - /** |
|
131 | - * Adds an existing image as thumbnail for the current page. |
|
132 | - * |
|
133 | - * @param int $image |
|
134 | - * |
|
135 | - * @return bool |
|
136 | - * |
|
137 | - * @link https://secure.php.net/manual/en/function.pdf-add-thumbnail.php |
|
138 | - */ |
|
139 | - public function add_thumbnail($image) {} |
|
140 | - |
|
141 | - /** |
|
142 | - * Adds a weblink annotation to a target url on the Web. |
|
143 | - * |
|
144 | - * @param float $lowerleftx |
|
145 | - * @param float $lowerlefty |
|
146 | - * @param float $upperrightx |
|
147 | - * @param float $upperrighty |
|
148 | - * @param string $url |
|
149 | - * |
|
150 | - * @return bool |
|
151 | - * |
|
152 | - * @link https://secure.php.net/manual/en/function.pdf-add-weblink.php |
|
153 | - * @see PDF_create_action() |
|
154 | - */ |
|
155 | - #[Deprecated('This function is deprecated since PDFlib version 6, use PDF_create_action() with type=URI and PDF_create_annotation() with type=Link instead.')] |
|
156 | - public function add_weblink($lowerleftx, $lowerlefty, $upperrightx, $upperrighty, $url) {} |
|
157 | - |
|
158 | - /** |
|
159 | - * Adds a counterclockwise circular arc |
|
160 | - * |
|
161 | - * @param float $x |
|
162 | - * @param float $y |
|
163 | - * @param float $r |
|
164 | - * @param float $alpha |
|
165 | - * @param float $beta |
|
166 | - * |
|
167 | - * @return bool |
|
168 | - * |
|
169 | - * @link https://secure.php.net/manual/en/function.pdf-arc.php |
|
170 | - */ |
|
171 | - public function arc($x, $y, $r, $alpha, $beta) {} |
|
172 | - |
|
173 | - /** |
|
174 | - * Except for the drawing direction, this function behaves exactly like PDF_arc(). |
|
175 | - * |
|
176 | - * @param float $x |
|
177 | - * @param float $y |
|
178 | - * @param float $r |
|
179 | - * @param float $alpha |
|
180 | - * @param float $beta |
|
181 | - * |
|
182 | - * @return bool |
|
183 | - * |
|
184 | - * @link https://secure.php.net/manual/en/function.pdf-arcn.php |
|
185 | - */ |
|
186 | - public function arcn($x, $y, $r, $alpha, $beta) {} |
|
187 | - |
|
188 | - /** |
|
189 | - * Adds a file attachment annotation. |
|
190 | - * |
|
191 | - * @param float $llx |
|
192 | - * @param float $lly |
|
193 | - * @param float $urx |
|
194 | - * @param float $ury |
|
195 | - * @param string $filename |
|
196 | - * @param string $description |
|
197 | - * @param string $author |
|
198 | - * @param string $mimetype |
|
199 | - * @param string $icon |
|
200 | - * |
|
201 | - * @return bool |
|
202 | - * |
|
203 | - * @link https://secure.php.net/manual/en/function.pdf-attach-file.php |
|
204 | - * @see PDF_create_annotation() |
|
205 | - */ |
|
206 | - #[Deprecated('This function is deprecated since PDFlib version 6, use PDF_create_annotation() with type=FileAttachment instead.')] |
|
207 | - public function attach_file($llx, $lly, $urx, $ury, $filename, $description, $author, $mimetype, $icon) {} |
|
208 | - |
|
209 | - /** |
|
210 | - * Creates a new PDF file subject to various options. |
|
211 | - * |
|
212 | - * @param string $filename |
|
213 | - * @param string $optlist |
|
214 | - * |
|
215 | - * @return int |
|
216 | - * |
|
217 | - * @link https://secure.php.net/manual/en/function.pdf-begin-document.php |
|
218 | - * @link https://www.pdflib.com/fileadmin/pdflib/pdf/manuals/PDFlib-9.1.2-API-reference.pdf |
|
219 | - */ |
|
220 | - public function begin_document($filename, $optlist) {} |
|
221 | - |
|
222 | - /** |
|
223 | - * Starts a Type 3 font definition. |
|
224 | - * |
|
225 | - * @param string $filename |
|
226 | - * @param float $a |
|
227 | - * @param float $b |
|
228 | - * @param float $c |
|
229 | - * @param float $d |
|
230 | - * @param float $e |
|
231 | - * @param float $f |
|
232 | - * @param string $optlist |
|
233 | - * |
|
234 | - * @return bool |
|
235 | - * |
|
236 | - * @link https://secure.php.net/manual/en/function.pdf-begin-font.php |
|
237 | - */ |
|
238 | - public function begin_font($filename, $a, $b, $c, $d, $e, $f, $optlist) {} |
|
239 | - |
|
240 | - /** |
|
241 | - * Starts a glyph definition for a Type 3 font. |
|
242 | - * |
|
243 | - * @param string $glyphname |
|
244 | - * @param float $wx |
|
245 | - * @param float $llx |
|
246 | - * @param float $lly |
|
247 | - * @param float $urx |
|
248 | - * @param float $ury |
|
249 | - * |
|
250 | - * @return bool |
|
251 | - * |
|
252 | - * @link https://secure.php.net/manual/en/function.pdf-begin-glyph.php |
|
253 | - */ |
|
254 | - public function begin_glyph($glyphname, $wx, $llx, $lly, $urx, $ury) {} |
|
255 | - |
|
256 | - /** |
|
257 | - * Opens a structure element or other content item with attributes supplied as options. |
|
258 | - * |
|
259 | - * @param string $tag |
|
260 | - * @param string $optlist |
|
261 | - * |
|
262 | - * @return int |
|
263 | - * |
|
264 | - * @link https://secure.php.net/manual/en/function.pdf-begin-item.php |
|
265 | - */ |
|
266 | - public function begin_item($tag, $optlist) {} |
|
267 | - |
|
268 | - /** |
|
269 | - * Starts a layer for subsequent output on the page. |
|
270 | - * |
|
271 | - * @param int $layer |
|
272 | - * |
|
273 | - * @return bool |
|
274 | - * |
|
275 | - * @link https://secure.php.net/manual/en/function.pdf-begin-layer.php |
|
276 | - */ |
|
277 | - public function begin_layer($layer) {} |
|
278 | - |
|
279 | - /** |
|
280 | - * Adds a new page to the document, and specifies various options. The parameters width and height are the dimensions of the new page in points. |
|
281 | - * |
|
282 | - * @param float $width |
|
283 | - * @param float $height |
|
284 | - * @param string $optlist |
|
285 | - * |
|
286 | - * @return bool |
|
287 | - * |
|
288 | - * @link https://secure.php.net/manual/en/function.pdf-begin-page-ext.php |
|
289 | - */ |
|
290 | - public function begin_page_ext($width, $height, $optlist) {} |
|
291 | - |
|
292 | - /** |
|
293 | - * Adds a new page to the document. |
|
294 | - * |
|
295 | - * @param float $width |
|
296 | - * @param float $height |
|
297 | - * |
|
298 | - * @return bool |
|
299 | - * |
|
300 | - * @link https://secure.php.net/manual/en/function.pdf-begin-page.php |
|
301 | - * |
|
302 | - * @see PDF_begin_page_ext() |
|
303 | - */ |
|
304 | - #[Deprecated('This function is deprecated since PDFlib version 6, use PDF_begin_page_ext() instead.')] |
|
305 | - public function begin_page($width, $height) {} |
|
306 | - |
|
307 | - /** |
|
308 | - * Starts a new pattern definition. |
|
309 | - * |
|
310 | - * @param float $width |
|
311 | - * @param float $height |
|
312 | - * @param float $xstep |
|
313 | - * @param float $ystep |
|
314 | - * @param int $painttype |
|
315 | - * |
|
316 | - * @return int |
|
317 | - * |
|
318 | - * @link https://secure.php.net/manual/en/function.pdf-begin-pattern.php |
|
319 | - */ |
|
320 | - public function begin_pattern($width, $height, $xstep, $ystep, $painttype) {} |
|
321 | - |
|
322 | - /** |
|
323 | - * Starts a new template definition. |
|
324 | - * |
|
325 | - * @param float $width |
|
326 | - * @param float $height |
|
327 | - * @param string $optlist |
|
328 | - * |
|
329 | - * @return int |
|
330 | - * |
|
331 | - * @link https://secure.php.net/manual/en/function.pdf-begin-template-ext.php |
|
332 | - */ |
|
333 | - public function begin_template_ext($width, $height, $optlist) {} |
|
334 | - |
|
335 | - /** |
|
336 | - * @param float $width |
|
337 | - * @param float $height |
|
338 | - * |
|
339 | - * @return int |
|
340 | - * |
|
341 | - * @link https://secure.php.net/manual/en/function.pdf-begin-template.php |
|
342 | - * |
|
343 | - * @see PDF_begin_template_ext |
|
344 | - */ |
|
345 | - #[Deprecated('This function is deprecated since PDFlib version 7, use PDF_begin_template_ext() instead.')] |
|
346 | - public function begin_template($width, $height) {} |
|
347 | - |
|
348 | - /** |
|
349 | - * @param float $x |
|
350 | - * @param float $y |
|
351 | - * @param float $r |
|
352 | - * |
|
353 | - * @return bool |
|
354 | - * |
|
355 | - * @link https://secure.php.net/manual/en/function.pdf-circle.php |
|
356 | - */ |
|
357 | - public function circle($x, $y, $r) {} |
|
358 | - |
|
359 | - /** |
|
360 | - * @return bool |
|
361 | - * |
|
362 | - * @link https://secure.php.net/manual/en/function.pdf-clip.php |
|
363 | - */ |
|
364 | - public function clip() {} |
|
365 | - |
|
366 | - /** |
|
367 | - * @param int $image |
|
368 | - * |
|
369 | - * @return bool |
|
370 | - * |
|
371 | - * @link https://secure.php.net/manual/en/function.pdf-close-image.php |
|
372 | - */ |
|
373 | - public function close_image($image) {} |
|
374 | - |
|
375 | - /** |
|
376 | - * Closes the page handle, and frees all page-related resources |
|
377 | - * |
|
378 | - * @param int $page |
|
379 | - * |
|
380 | - * @return bool |
|
381 | - * |
|
382 | - * @link https://secure.php.net/manual/en/function.pdf-close-pdi-page.php |
|
383 | - */ |
|
384 | - public function close_pdi_page($page) {} |
|
385 | - |
|
386 | - /** |
|
387 | - * @param int $doc |
|
388 | - * |
|
389 | - * @return bool |
|
390 | - * |
|
391 | - * @link https://secure.php.net/manual/en/function.pdf-close-pdi.php |
|
392 | - * |
|
393 | - * @see PDF_close_pdi_document() |
|
394 | - */ |
|
395 | - #[Deprecated('This function is deprecated since PDFlib version 7, use PDF_close_pdi_document() instead.')] |
|
396 | - public function close_pdi($doc) {} |
|
397 | - |
|
398 | - /** |
|
399 | - * @return bool |
|
400 | - * |
|
401 | - * @link https://secure.php.net/manual/en/function.pdf-close.php |
|
402 | - * |
|
403 | - * @see PDF_end_document |
|
404 | - */ |
|
405 | - #[Deprecated('This function is deprecated since PDFlib version 6, use PDF_end_document() instead.')] |
|
406 | - public function close() {} |
|
407 | - |
|
408 | - /** |
|
409 | - * @return bool |
|
410 | - * |
|
411 | - * @link https://secure.php.net/manual/en/function.pdf-closepath-fill-stroke.php |
|
412 | - */ |
|
413 | - public function closepath_fill_stroke() {} |
|
414 | - |
|
415 | - /** |
|
416 | - * @return bool |
|
417 | - * |
|
418 | - * @link https://secure.php.net/manual/en/function.pdf-closepath-stroke.php |
|
419 | - */ |
|
420 | - public function closepath_stroke() {} |
|
421 | - |
|
422 | - /** |
|
423 | - * @return bool |
|
424 | - * |
|
425 | - * @link https://secure.php.net/manual/en/function.pdf-closepath.php |
|
426 | - */ |
|
427 | - public function closepath() {} |
|
428 | - |
|
429 | - /** |
|
430 | - * @param float $a |
|
431 | - * @param float $b |
|
432 | - * @param float $c |
|
433 | - * @param float $d |
|
434 | - * @param float $e |
|
435 | - * @param float $f |
|
436 | - * |
|
437 | - * @return bool |
|
438 | - * |
|
439 | - * @link https://secure.php.net/manual/en/function.pdf-concat.php |
|
440 | - */ |
|
441 | - public function concat($a, $b, $c, $d, $e, $f) {} |
|
442 | - |
|
443 | - /** |
|
444 | - * @param string $text |
|
445 | - * |
|
446 | - * @return bool |
|
447 | - * |
|
448 | - * @link https://secure.php.net/manual/en/function.pdf-continue-text.php |
|
449 | - */ |
|
450 | - public function continue_text($text) {} |
|
451 | - |
|
452 | - /** |
|
453 | - * @param string $username |
|
454 | - * @param string $optlist |
|
455 | - * |
|
456 | - * @return int |
|
457 | - * |
|
458 | - * @link https://secure.php.net/manual/en/function.pdf-create-3dview.php |
|
459 | - */ |
|
460 | - public function create_3dview($username, $optlist) {} |
|
461 | - |
|
462 | - /** |
|
463 | - * @param string $type |
|
464 | - * @param string $optlist |
|
465 | - * |
|
466 | - * @return int |
|
467 | - * |
|
468 | - * @link https://secure.php.net/manual/en/function.pdf-create-action.php |
|
469 | - */ |
|
470 | - public function create_action($type, $optlist) {} |
|
471 | - |
|
472 | - /** |
|
473 | - * @param float $llx |
|
474 | - * @param float $lly |
|
475 | - * @param float $urx |
|
476 | - * @param float $ury |
|
477 | - * @param string $type |
|
478 | - * @param string $optlist |
|
479 | - * |
|
480 | - * @return bool |
|
481 | - * |
|
482 | - * @link https://secure.php.net/manual/en/function.pdf-create-annotation.php |
|
483 | - */ |
|
484 | - public function create_annotation($llx, $lly, $urx, $ury, $type, $optlist) {} |
|
485 | - |
|
486 | - /** |
|
487 | - * @param string $text |
|
488 | - * @param string $optlist |
|
489 | - * |
|
490 | - * @return int |
|
491 | - * |
|
492 | - * @link https://secure.php.net/manual/en/function.pdf-create-bookmark.php |
|
493 | - */ |
|
494 | - public function create_bookmark($text, $optlist) {} |
|
495 | - |
|
496 | - /** |
|
497 | - * @param float $llx |
|
498 | - * @param float $lly |
|
499 | - * @param float $urx |
|
500 | - * @param float $ury |
|
501 | - * @param string $name |
|
502 | - * @param string $type |
|
503 | - * @param string $optlist |
|
504 | - * |
|
505 | - * @return bool |
|
506 | - * |
|
507 | - * @link https://secure.php.net/manual/en/function.pdf-create-field.php |
|
508 | - */ |
|
509 | - public function create_field($llx, $lly, $urx, $ury, $name, $type, $optlist) {} |
|
510 | - |
|
511 | - /** |
|
512 | - * @param string $name |
|
513 | - * @param string $optlist |
|
514 | - * |
|
515 | - * @return bool |
|
516 | - * |
|
517 | - * @link https://secure.php.net/manual/en/function.pdf-create-fieldgroup.php |
|
518 | - */ |
|
519 | - public function create_fieldgroup($name, $optlist) {} |
|
520 | - |
|
521 | - /** |
|
522 | - * @param string $optlist |
|
523 | - * |
|
524 | - * @return int |
|
525 | - * |
|
526 | - * @link https://secure.php.net/manual/en/function.pdf-create-gstate.php |
|
527 | - */ |
|
528 | - public function create_gstate($optlist) {} |
|
529 | - |
|
530 | - /** |
|
531 | - * @param string $filename |
|
532 | - * @param string $data |
|
533 | - * @param string $optlist |
|
534 | - * |
|
535 | - * @return bool |
|
536 | - * |
|
537 | - * @link https://secure.php.net/manual/en/function.pdf-create-pvf.php |
|
538 | - */ |
|
539 | - public function create_pvf($filename, $data, $optlist) {} |
|
540 | - |
|
541 | - /** |
|
542 | - * @param string $text |
|
543 | - * @param string $optlist |
|
544 | - * |
|
545 | - * @return int |
|
546 | - * |
|
547 | - * @link https://secure.php.net/manual/en/function.pdf-create-textflow.php |
|
548 | - */ |
|
549 | - public function create_textflow($text, $optlist) {} |
|
550 | - |
|
551 | - /** |
|
552 | - * @param float $x1 |
|
553 | - * @param float $y1 |
|
554 | - * @param float $x2 |
|
555 | - * @param float $y2 |
|
556 | - * @param float $x3 |
|
557 | - * @param float $y3 |
|
558 | - * |
|
559 | - * @return bool |
|
560 | - * |
|
561 | - * @link https://secure.php.net/manual/en/function.pdf-curveto.php |
|
562 | - */ |
|
563 | - public function curveto($x1, $y1, $x2, $y2, $x3, $y3) {} |
|
564 | - |
|
565 | - /** |
|
566 | - * @param string $name |
|
567 | - * @param string $optlist |
|
568 | - * |
|
569 | - * @return int |
|
570 | - * |
|
571 | - * @link https://secure.php.net/manual/en/function.pdf-define-layer.php |
|
572 | - */ |
|
573 | - public function define_layer($name, $optlist) {} |
|
574 | - |
|
575 | - /** |
|
576 | - * @param string $filename |
|
577 | - * |
|
578 | - * @return int |
|
579 | - * |
|
580 | - * @link https://secure.php.net/manual/en/function.pdf-delete-pvf.php |
|
581 | - */ |
|
582 | - public function delete_pvf($filename) {} |
|
583 | - |
|
584 | - /** |
|
585 | - * @param int $table |
|
586 | - * @param string $optlist |
|
587 | - * |
|
588 | - * @return bool |
|
589 | - * |
|
590 | - * @link https://secure.php.net/manual/en/function.pdf-delete-table.php |
|
591 | - */ |
|
592 | - public function delete_table($table, $optlist) {} |
|
593 | - |
|
594 | - /** |
|
595 | - * @param int $textflow |
|
596 | - * |
|
597 | - * @return bool |
|
598 | - * |
|
599 | - * @link https://secure.php.net/manual/en/function.pdf-delete-textflow.php |
|
600 | - */ |
|
601 | - public function delete_textflow($textflow) {} |
|
602 | - |
|
603 | - /** |
|
604 | - * @return bool |
|
605 | - * |
|
606 | - * @link https://secure.php.net/manual/en/function.pdf-delete.php |
|
607 | - */ |
|
608 | - public function delete() {} |
|
609 | - |
|
610 | - /** |
|
611 | - * @param string $encoding |
|
612 | - * @param int $slot |
|
613 | - * @param string $glyphname |
|
614 | - * @param int $uv |
|
615 | - * |
|
616 | - * @return bool |
|
617 | - * |
|
618 | - * @link https://secure.php.net/manual/en/function.pdf-encoding-set-char.php |
|
619 | - */ |
|
620 | - public function encoding_set_char($encoding, $slot, $glyphname, $uv) {} |
|
621 | - |
|
622 | - /** |
|
623 | - * @param string $optlist |
|
624 | - * |
|
625 | - * @return bool |
|
626 | - * |
|
627 | - * @link https://secure.php.net/manual/en/function.pdf-end-document.php |
|
628 | - */ |
|
629 | - public function end_document($optlist) {} |
|
630 | - |
|
631 | - /** |
|
632 | - * @return bool |
|
633 | - * |
|
634 | - * @link https://secure.php.net/manual/en/function.pdf-end-font.php |
|
635 | - */ |
|
636 | - public function end_font() {} |
|
637 | - |
|
638 | - /** |
|
639 | - * @return bool |
|
640 | - * |
|
641 | - * @link https://secure.php.net/manual/en/function.pdf-end-glyph.php |
|
642 | - */ |
|
643 | - public function end_glyph() {} |
|
644 | - |
|
645 | - /** |
|
646 | - * @param int $id |
|
647 | - * |
|
648 | - * @return bool |
|
649 | - * |
|
650 | - * @link https://secure.php.net/manual/en/function.pdf-end-item.php |
|
651 | - */ |
|
652 | - public function end_item($id) {} |
|
653 | - |
|
654 | - /** |
|
655 | - * @return bool |
|
656 | - * |
|
657 | - * @link https://secure.php.net/manual/en/function.pdf-end-layer.php |
|
658 | - */ |
|
659 | - public function end_layer() {} |
|
660 | - |
|
661 | - /** |
|
662 | - * @param string $optlist |
|
663 | - * |
|
664 | - * @return bool |
|
665 | - * |
|
666 | - * @link https://secure.php.net/manual/en/function.pdf-end-page-ext.php |
|
667 | - */ |
|
668 | - public function end_page_ext($optlist) {} |
|
669 | - |
|
670 | - /** |
|
671 | - * @return bool |
|
672 | - * |
|
673 | - * @link https://secure.php.net/manual/en/function.pdf-end-page.php |
|
674 | - */ |
|
675 | - public function end_page($p) {} |
|
676 | - |
|
677 | - /** |
|
678 | - * @return bool |
|
679 | - * |
|
680 | - * @link https://secure.php.net/manual/en/function.pdf-end-pattern.php |
|
681 | - */ |
|
682 | - public function end_pattern($p) {} |
|
683 | - |
|
684 | - /** |
|
685 | - * @return bool |
|
686 | - * |
|
687 | - * @link https://secure.php.net/manual/en/function.pdf-end-template.php |
|
688 | - */ |
|
689 | - public function end_template($p) {} |
|
690 | - |
|
691 | - /** |
|
692 | - * @return bool |
|
693 | - * |
|
694 | - * @link https://secure.php.net/manual/en/function.pdf-endpath.php |
|
695 | - */ |
|
696 | - public function endpath($p) {} |
|
697 | - |
|
698 | - /** |
|
699 | - * @param int $page |
|
700 | - * @param string $blockname |
|
701 | - * @param int $image |
|
702 | - * @param string $optlist |
|
703 | - * |
|
704 | - * @return int |
|
705 | - * |
|
706 | - * @link https://secure.php.net/manual/en/function.pdf-fill-imageblock.php |
|
707 | - */ |
|
708 | - public function fill_imageblock($page, $blockname, $image, $optlist) {} |
|
709 | - |
|
710 | - /** |
|
711 | - * @param int $page |
|
712 | - * @param string $blockname |
|
713 | - * @param int $contents |
|
714 | - * @param string $optlist |
|
715 | - * |
|
716 | - * @return int |
|
717 | - * |
|
718 | - * @link https://secure.php.net/manual/en/function.pdf-fill-pdfblock.php |
|
719 | - */ |
|
720 | - public function fill_pdfblock($page, $blockname, $contents, $optlist) {} |
|
721 | - |
|
722 | - /** |
|
723 | - * @return bool |
|
724 | - * |
|
725 | - * @link https://secure.php.net/manual/en/function.pdf-fill-stroke.php |
|
726 | - */ |
|
727 | - public function fill_stroke() {} |
|
728 | - |
|
729 | - /** |
|
730 | - * @param int $page |
|
731 | - * @param string $blockname |
|
732 | - * @param string $text |
|
733 | - * @param string $optlist |
|
734 | - * |
|
735 | - * @return int |
|
736 | - * |
|
737 | - * @link https://secure.php.net/manual/en/function.pdf-fill-textblock.php |
|
738 | - */ |
|
739 | - public function fill_textblock($page, $blockname, $text, $optlist) {} |
|
740 | - |
|
741 | - /** |
|
742 | - * @return bool |
|
743 | - * |
|
744 | - * @link https://secure.php.net/manual/en/function.pdf-fill.php |
|
745 | - */ |
|
746 | - public function fill() {} |
|
747 | - /** |
|
748 | - * @param string $fontname |
|
749 | - * @param string $encoding |
|
750 | - * @param int $embed |
|
751 | - * |
|
752 | - * @return int |
|
753 | - * |
|
754 | - * @link https://secure.php.net/manual/en/function.pdf-findfont.php(Dep) |
|
755 | - */ |
|
756 | - public function findfont($fontname, $encoding, $embed) {} |
|
757 | - /** |
|
758 | - * @param int $image |
|
759 | - * @param float $x |
|
760 | - * @param float $y |
|
761 | - * @param string $optlist |
|
762 | - * |
|
763 | - * @return bool |
|
764 | - * |
|
765 | - * @link https://secure.php.net/manual/en/function.pdf-fit-image.php |
|
766 | - */ |
|
767 | - public function fit_image($image, $x, $y, $optlist) {} |
|
768 | - /** |
|
769 | - * @param int $page |
|
770 | - * @param float $x |
|
771 | - * @param float $y |
|
772 | - * @param string $optlist |
|
773 | - * |
|
774 | - * @return bool |
|
775 | - * |
|
776 | - * @link https://secure.php.net/manual/en/function.pdf-fit-pdi-page.php |
|
777 | - */ |
|
778 | - public function fit_pdi_page($page, $x, $y, $optlist) {} |
|
779 | - /** |
|
780 | - * @param int $table |
|
781 | - * @param float $llx |
|
782 | - * @param float $lly |
|
783 | - * @param float $urx |
|
784 | - * @param float $ury |
|
785 | - * @param string $optlist |
|
786 | - * |
|
787 | - * @return string |
|
788 | - * |
|
789 | - * @link https://secure.php.net/manual/en/function.pdf-fit-table.php |
|
790 | - */ |
|
791 | - public function fit_table($table, $llx, $lly, $urx, $ury, $optlist) {} |
|
792 | - /** |
|
793 | - * @param int $textflow |
|
794 | - * @param float $llx |
|
795 | - * @param float $lly |
|
796 | - * @param float $urx |
|
797 | - * @param float $ury |
|
798 | - * @param string $optlist |
|
799 | - * |
|
800 | - * @return string |
|
801 | - * |
|
802 | - * @link https://secure.php.net/manual/en/function.pdf-fit-textflow.php |
|
803 | - */ |
|
804 | - public function fit_textflow($textflow, $llx, $lly, $urx, $ury, $optlist) {} |
|
805 | - /** |
|
806 | - * @param string $text |
|
807 | - * @param float $x |
|
808 | - * @param float $y |
|
809 | - * @param string $optlist |
|
810 | - * |
|
811 | - * @return bool |
|
812 | - * |
|
813 | - * @link https://secure.php.net/manual/en/function.pdf-fit-textline.php |
|
814 | - */ |
|
815 | - public function fit_textline($text, $x, $y, $optlist) {} |
|
816 | - /** |
|
817 | - * @return string |
|
818 | - * |
|
819 | - * @link https://secure.php.net/manual/en/function.pdf-get-apiname.php |
|
820 | - */ |
|
821 | - public function get_apiname() {} |
|
822 | - /** |
|
823 | - * @return string |
|
824 | - * |
|
825 | - * @link https://secure.php.net/manual/en/function.pdf-get-buffer.php |
|
826 | - */ |
|
827 | - public function get_buffer() {} |
|
828 | - /** |
|
829 | - * @return string |
|
830 | - * |
|
831 | - * @link https://secure.php.net/manual/en/function.pdf-get-errmsg.php |
|
832 | - */ |
|
833 | - public function get_errmsg() {} |
|
834 | - /** |
|
835 | - * @return int |
|
836 | - * |
|
837 | - * @link https://secure.php.net/manual/en/function.pdf-get-errnum.php |
|
838 | - */ |
|
839 | - public function get_errnum() {} |
|
840 | - /** |
|
841 | - * @return int |
|
842 | - * |
|
843 | - * @link https://secure.php.net/manual/en/function.pdf-get-majorversion.php(dep) |
|
844 | - */ |
|
845 | - public function get_majorversion() {} |
|
846 | - /** |
|
847 | - * @return int |
|
848 | - * |
|
849 | - * @link https://secure.php.net/manual/en/function.pdf-get-minorversion.php(dep) |
|
850 | - */ |
|
851 | - public function get_minorversion() {} |
|
852 | - /** |
|
853 | - * @param string $key |
|
854 | - * @param float $modifier |
|
855 | - * |
|
856 | - * @return string |
|
857 | - * |
|
858 | - * @link https://secure.php.net/manual/en/function.pdf-get-parameter.php |
|
859 | - */ |
|
860 | - public function get_parameter($key, $modifier) {} |
|
861 | - /** |
|
862 | - * @param string $key |
|
863 | - * @param int $doc |
|
864 | - * @param int $page |
|
865 | - * @param int $reserved |
|
866 | - * |
|
867 | - * @return string |
|
868 | - * |
|
869 | - * @link https://secure.php.net/manual/en/function.pdf-get-pdi-parameter.php |
|
870 | - */ |
|
871 | - public function get_pdi_parameter($key, $doc, $page, $reserved) {} |
|
872 | - /** |
|
873 | - * @param string $key |
|
874 | - * @param int $doc |
|
875 | - * @param int $page |
|
876 | - * @param int $reserved |
|
877 | - * |
|
878 | - * @return float |
|
879 | - * |
|
880 | - * @link https://secure.php.net/manual/en/function.pdf-get-pdi-value.php |
|
881 | - */ |
|
882 | - public function get_pdi_value($key, $doc, $page, $reserved) {} |
|
883 | - /** |
|
884 | - * @param string $key |
|
885 | - * @param float $modifier |
|
886 | - * |
|
887 | - * @return float |
|
888 | - * |
|
889 | - * @link https://secure.php.net/manual/en/function.pdf-get-value.php |
|
890 | - */ |
|
891 | - public function get_value($key, $modifier) {} |
|
892 | - /** |
|
893 | - * @param int $font |
|
894 | - * @param string $keyword |
|
895 | - * @param string $optlist |
|
896 | - * |
|
897 | - * @return float |
|
898 | - * |
|
899 | - * @link https://secure.php.net/manual/en/function.pdf-info-font.php |
|
900 | - */ |
|
901 | - public function info_font($font, $keyword, $optlist) {} |
|
902 | - /** |
|
903 | - * @param string $boxname |
|
904 | - * @param int $num |
|
905 | - * @param string $keyword |
|
906 | - * |
|
907 | - * @return float |
|
908 | - * |
|
909 | - * @link https://secure.php.net/manual/en/function.pdf-info-matchbox.php |
|
910 | - */ |
|
911 | - public function info_matchbox($boxname, $num, $keyword) {} |
|
912 | - /** |
|
913 | - * @param int $table |
|
914 | - * @param string $keyword |
|
915 | - * |
|
916 | - * @return float |
|
917 | - * |
|
918 | - * @link https://secure.php.net/manual/en/function.pdf-info-table.php |
|
919 | - */ |
|
920 | - public function info_table($table, $keyword) {} |
|
921 | - /** |
|
922 | - * @param int $textflow |
|
923 | - * @param string $keyword |
|
924 | - * |
|
925 | - * @return float |
|
926 | - * |
|
927 | - * @link https://secure.php.net/manual/en/function.pdf-info-textflow.php |
|
928 | - */ |
|
929 | - public function info_textflow($textflow, $keyword) {} |
|
930 | - |
|
931 | - /** |
|
932 | - * @param string $text |
|
933 | - * @param string $keyword |
|
934 | - * @param string $optlist |
|
935 | - * |
|
936 | - * @return float |
|
937 | - * |
|
938 | - * @link https://secure.php.net/manual/en/function.pdf-info-textline.php |
|
939 | - */ |
|
940 | - public function info_textline($text, $keyword, $optlist) {} |
|
941 | - |
|
942 | - /** |
|
943 | - * @return bool |
|
944 | - * |
|
945 | - * @link https://secure.php.net/manual/en/function.pdf-initgraphics.php |
|
946 | - */ |
|
947 | - public function initgraphics() {} |
|
948 | - |
|
949 | - /** |
|
950 | - * @param float $x |
|
951 | - * @param float $y |
|
952 | - * |
|
953 | - * @return bool |
|
954 | - * |
|
955 | - * @link https://secure.php.net/manual/en/function.pdf-lineto.php |
|
956 | - */ |
|
957 | - public function lineto($x, $y) {} |
|
958 | - |
|
959 | - /** |
|
960 | - * @param string $filename |
|
961 | - * @param string $optlist |
|
962 | - * |
|
963 | - * @return int |
|
964 | - * |
|
965 | - * @link https://secure.php.net/manual/en/function.pdf-load-3ddata.php |
|
966 | - */ |
|
967 | - public function load_3ddata($filename, $optlist) {} |
|
968 | - |
|
969 | - /** |
|
970 | - * @param string $fontname |
|
971 | - * @param string $encoding |
|
972 | - * @param string $optlist |
|
973 | - * |
|
974 | - * @return int |
|
975 | - * |
|
976 | - * @link https://secure.php.net/manual/en/function.pdf-load-font.php |
|
977 | - */ |
|
978 | - public function load_font($fontname, $encoding, $optlist) {} |
|
979 | - |
|
980 | - /** |
|
981 | - * @param string $profilename |
|
982 | - * @param string $optlist |
|
983 | - * |
|
984 | - * @return int |
|
985 | - * |
|
986 | - * @link https://secure.php.net/manual/en/function.pdf-load-iccprofile.php |
|
987 | - */ |
|
988 | - public function load_iccprofile($profilename, $optlist) {} |
|
989 | - |
|
990 | - /** |
|
991 | - * @param string $imagetype |
|
992 | - * @param string $filename |
|
993 | - * @param string $optlist |
|
994 | - * |
|
995 | - * @return int |
|
996 | - * |
|
997 | - * @link https://secure.php.net/manual/en/function.pdf-load-image.php |
|
998 | - */ |
|
999 | - public function load_image($imagetype, $filename, $optlist) {} |
|
1000 | - |
|
1001 | - /** |
|
1002 | - * @param string $spotname |
|
1003 | - * |
|
1004 | - * @return int |
|
1005 | - * |
|
1006 | - * @link https://secure.php.net/manual/en/function.pdf-makespotcolor.php |
|
1007 | - */ |
|
1008 | - public function makespotcolor($spotname) {} |
|
1009 | - |
|
1010 | - /** |
|
1011 | - * @param float $x |
|
1012 | - * @param float $y |
|
1013 | - * |
|
1014 | - * @return bool |
|
1015 | - * |
|
1016 | - * @link https://secure.php.net/manual/en/function.pdf-moveto.php |
|
1017 | - */ |
|
1018 | - public function moveto($x, $y) {} |
|
1019 | - |
|
1020 | - /** |
|
1021 | - * @param string $filename |
|
1022 | - * @param int $width |
|
1023 | - * @param int $height |
|
1024 | - * @param int $BitReverse |
|
1025 | - * @param int $k |
|
1026 | - * @param int $Blackls1 |
|
1027 | - * |
|
1028 | - * @return int |
|
1029 | - * |
|
1030 | - * @link https://secure.php.net/manual/en/function.pdf-open-ccitt.php(dep) |
|
1031 | - */ |
|
1032 | - public function open_ccitt($filename, $width, $height, $BitReverse, $k, $Blackls1) {} |
|
1033 | - |
|
1034 | - /** |
|
1035 | - * @param string $filename |
|
1036 | - * |
|
1037 | - * @return bool |
|
1038 | - * |
|
1039 | - * @link https://secure.php.net/manual/en/function.pdf-open-file.php(dep) |
|
1040 | - */ |
|
1041 | - public function open_file($filename) {} |
|
1042 | - |
|
1043 | - /** |
|
1044 | - * @param string $imagetype |
|
1045 | - * @param string $filename |
|
1046 | - * @param string $stringparam |
|
1047 | - * @param int $intparam |
|
1048 | - * |
|
1049 | - * @return int |
|
1050 | - * |
|
1051 | - * @link https://secure.php.net/manual/en/function.pdf-open-image-file.php(dep) |
|
1052 | - */ |
|
1053 | - public function open_image_file($imagetype, $filename, $stringparam, $intparam) {} |
|
1054 | - |
|
1055 | - /** |
|
1056 | - * @param string $imagetype |
|
1057 | - * @param string $source |
|
1058 | - * @param string $data |
|
1059 | - * @param int $length |
|
1060 | - * @param int $width |
|
1061 | - * @param int $height |
|
1062 | - * @param int $components |
|
1063 | - * @param int $bpc |
|
1064 | - * @param string $params |
|
1065 | - * |
|
1066 | - * @return int |
|
1067 | - * |
|
1068 | - * @link https://secure.php.net/manual/en/function.pdf-open-image.php(dep) |
|
1069 | - */ |
|
1070 | - public function open_image($imagetype, $source, $data, $length, $width, $height, $components, $bpc, $params) {} |
|
1071 | - |
|
1072 | - /** |
|
1073 | - * @param resource $image |
|
1074 | - * |
|
1075 | - * @return int |
|
1076 | - * |
|
1077 | - * @link https://secure.php.net/manual/en/function.pdf-open-memory-image.php(not supported) |
|
1078 | - */ |
|
1079 | - public function open_memory_image($image) {} |
|
1080 | - |
|
1081 | - /** |
|
1082 | - * @param string $filename |
|
1083 | - * @param string $optlist |
|
1084 | - * |
|
1085 | - * @return int |
|
1086 | - * |
|
1087 | - * @link https://secure.php.net/manual/en/function.pdf-open-pdi-document.php |
|
1088 | - */ |
|
1089 | - public function open_pdi_document($filename, $optlist) {} |
|
1090 | - |
|
1091 | - /** |
|
1092 | - * @param int $doc |
|
1093 | - * @param int $pagenumber |
|
1094 | - * @param string $optlist |
|
1095 | - * |
|
1096 | - * @return int |
|
1097 | - * |
|
1098 | - * @link https://secure.php.net/manual/en/function.pdf-open-pdi-page.php |
|
1099 | - */ |
|
1100 | - public function open_pdi_page($doc, $pagenumber, $optlist) {} |
|
1101 | - |
|
1102 | - /** |
|
1103 | - * @param string $filename |
|
1104 | - * @param string $optlist |
|
1105 | - * @param int $len |
|
1106 | - * |
|
1107 | - * @return int |
|
1108 | - * |
|
1109 | - * @link https://secure.php.net/manual/en/function.pdf-open-pdi.php |
|
1110 | - */ |
|
1111 | - public function open_pdi($filename, $optlist, $len) {} |
|
1112 | - |
|
1113 | - /** |
|
1114 | - * @param int $doc |
|
1115 | - * @param string $path |
|
1116 | - * |
|
1117 | - * @return float |
|
1118 | - * |
|
1119 | - * @link https://secure.php.net/manual/en/function.pdf-pcos-get-number.php |
|
1120 | - */ |
|
1121 | - public function pcos_get_number($doc, $path) {} |
|
1122 | - |
|
1123 | - /** |
|
1124 | - * @param int $doc |
|
1125 | - * @param string $optlist |
|
1126 | - * @param string $path |
|
1127 | - * |
|
1128 | - * @return string |
|
1129 | - * |
|
1130 | - * @link https://secure.php.net/manual/en/function.pdf-pcos-get-stream.php |
|
1131 | - */ |
|
1132 | - public function pcos_get_stream($doc, $optlist, $path) {} |
|
1133 | - |
|
1134 | - /** |
|
1135 | - * @param int $doc |
|
1136 | - * @param string $path |
|
1137 | - * |
|
1138 | - * @return string |
|
1139 | - * |
|
1140 | - * @link https://secure.php.net/manual/en/function.pdf-pcos-get-string.php |
|
1141 | - */ |
|
1142 | - public function pcos_get_string($doc, $path) {} |
|
1143 | - |
|
1144 | - /** |
|
1145 | - * @param int $image |
|
1146 | - * @param float $x |
|
1147 | - * @param float $y |
|
1148 | - * @param float $scale |
|
1149 | - * |
|
1150 | - * @return bool |
|
1151 | - * |
|
1152 | - * @link https://secure.php.net/manual/en/function.pdf-place-image.php (dep) |
|
1153 | - */ |
|
1154 | - public function place_image($image, $x, $y, $scale) {} |
|
1155 | - |
|
1156 | - /** |
|
1157 | - * @param int $page |
|
1158 | - * @param float $x |
|
1159 | - * @param float $y |
|
1160 | - * @param float $sx |
|
1161 | - * @param float $sy |
|
1162 | - * |
|
1163 | - * @return bool |
|
1164 | - * |
|
1165 | - * @link https://secure.php.net/manual/en/function.pdf-place-pdi-page.php (dep) |
|
1166 | - */ |
|
1167 | - public function place_pdi_page($page, $x, $y, $sx, $sy) {} |
|
1168 | - |
|
1169 | - /** |
|
1170 | - * @param int $doc |
|
1171 | - * @param int $page |
|
1172 | - * @param string $optlist |
|
1173 | - * |
|
1174 | - * @return int |
|
1175 | - * |
|
1176 | - * @link https://secure.php.net/manual/en/function.pdf-process-pdi.php |
|
1177 | - */ |
|
1178 | - public function process_pdi($doc, $page, $optlist) {} |
|
1179 | - |
|
1180 | - /** |
|
1181 | - * @param float $x |
|
1182 | - * @param float $y |
|
1183 | - * @param float $width |
|
1184 | - * @param float $height |
|
1185 | - * |
|
1186 | - * @return bool |
|
1187 | - * |
|
1188 | - * @link https://secure.php.net/manual/en/function.pdf-rect.php |
|
1189 | - */ |
|
1190 | - public function rect($x, $y, $width, $height) {} |
|
1191 | - |
|
1192 | - /** |
|
1193 | - * @return bool |
|
1194 | - * |
|
1195 | - * @link https://secure.php.net/manual/en/function.pdf-restore.php |
|
1196 | - */ |
|
1197 | - public function restore($p) {} |
|
1198 | - |
|
1199 | - /** |
|
1200 | - * @param string $optlist |
|
1201 | - * |
|
1202 | - * @return bool |
|
1203 | - * |
|
1204 | - * @link https://secure.php.net/manual/en/function.pdf-resume-page.php |
|
1205 | - */ |
|
1206 | - public function resume_page($optlist) {} |
|
1207 | - |
|
1208 | - /** |
|
1209 | - * @param float $phi |
|
1210 | - * |
|
1211 | - * @return bool |
|
1212 | - * |
|
1213 | - * @link https://secure.php.net/manual/en/function.pdf-rotate.php |
|
1214 | - */ |
|
1215 | - public function rotate($phi) {} |
|
1216 | - |
|
1217 | - /** |
|
1218 | - * @return bool |
|
1219 | - * |
|
1220 | - * @link https://secure.php.net/manual/en/function.pdf-save.php |
|
1221 | - */ |
|
1222 | - public function save($p) {} |
|
1223 | - |
|
1224 | - /** |
|
1225 | - * @param float $sx |
|
1226 | - * @param float $sy |
|
1227 | - * |
|
1228 | - * @return bool |
|
1229 | - * |
|
1230 | - * @link https://secure.php.net/manual/en/function.pdf-scale.php |
|
1231 | - */ |
|
1232 | - public function scale($sx, $sy) {} |
|
1233 | - |
|
1234 | - /** |
|
1235 | - * @param float $red |
|
1236 | - * @param float $green |
|
1237 | - * @param float $blue |
|
1238 | - * |
|
1239 | - * @return bool |
|
1240 | - * |
|
1241 | - * @link https://secure.php.net/manual/en/function.pdf-set-border-color.php (dep) |
|
1242 | - */ |
|
1243 | - public function set_border_color($red, $green, $blue) {} |
|
1244 | - |
|
1245 | - /** |
|
1246 | - * @param float $black |
|
1247 | - * @param float $white |
|
1248 | - * |
|
1249 | - * @return bool |
|
1250 | - * |
|
1251 | - * @link https://secure.php.net/manual/en/function.pdf-set-border-dash.php (dep) |
|
1252 | - */ |
|
1253 | - public function set_border_dash($black, $white) {} |
|
1254 | - |
|
1255 | - /** |
|
1256 | - * @param string $style |
|
1257 | - * @param float $width |
|
1258 | - * |
|
1259 | - * @return bool |
|
1260 | - * |
|
1261 | - * @link https://secure.php.net/manual/en/function.pdf-set-border-style.php (dep) |
|
1262 | - */ |
|
1263 | - public function set_border_style($style, $width) {} |
|
1264 | - |
|
1265 | - /** |
|
1266 | - * @param int $gstate |
|
1267 | - * |
|
1268 | - * @return bool |
|
1269 | - * |
|
1270 | - * @link https://secure.php.net/manual/en/function.pdf-set-gstate.php |
|
1271 | - */ |
|
1272 | - public function set_gstate($gstate) {} |
|
1273 | - |
|
1274 | - /** |
|
1275 | - * @param string $key |
|
1276 | - * @param string $value |
|
1277 | - * |
|
1278 | - * @return bool |
|
1279 | - * |
|
1280 | - * @link https://secure.php.net/manual/en/function.pdf-set-info.php |
|
1281 | - */ |
|
1282 | - public function set_info($key, $value) {} |
|
1283 | - |
|
1284 | - /** |
|
1285 | - * @param string $type |
|
1286 | - * @param string $optlist |
|
1287 | - * |
|
1288 | - * @return bool |
|
1289 | - * |
|
1290 | - * @link https://secure.php.net/manual/en/function.pdf-set-layer-dependency.php |
|
1291 | - */ |
|
1292 | - public function set_layer_dependency($type, $optlist) {} |
|
1293 | - |
|
1294 | - /** |
|
1295 | - * @param string $key |
|
1296 | - * @param string $value |
|
1297 | - * |
|
1298 | - * @return bool |
|
1299 | - * |
|
1300 | - * @link https://secure.php.net/manual/en/function.pdf-set-parameter.php |
|
1301 | - */ |
|
1302 | - public function set_parameter($key, $value) {} |
|
1303 | - |
|
1304 | - /** |
|
1305 | - * @param float $x |
|
1306 | - * @param float $y |
|
1307 | - * |
|
1308 | - * @return bool |
|
1309 | - * |
|
1310 | - * @link https://secure.php.net/manual/en/function.pdf-set-text-pos.php |
|
1311 | - */ |
|
1312 | - public function set_text_pos($x, $y) {} |
|
1313 | - |
|
1314 | - /** |
|
1315 | - * @param string $key |
|
1316 | - * @param float $value |
|
1317 | - * |
|
1318 | - * @return bool |
|
1319 | - * |
|
1320 | - * @link https://secure.php.net/manual/en/function.pdf-set-value.php |
|
1321 | - */ |
|
1322 | - public function set_value($key, $value) {} |
|
1323 | - |
|
1324 | - /** |
|
1325 | - * @param string $fstype |
|
1326 | - * @param string $colorspace |
|
1327 | - * @param float $c1 |
|
1328 | - * @param float $c2 |
|
1329 | - * @param float $c3 |
|
1330 | - * @param float $c4 |
|
1331 | - * |
|
1332 | - * @return bool |
|
1333 | - * |
|
1334 | - * @link https://secure.php.net/manual/en/function.pdf-setcolor.php |
|
1335 | - */ |
|
1336 | - public function setcolor($fstype, $colorspace, $c1, $c2, $c3, $c4) {} |
|
1337 | - |
|
1338 | - /** |
|
1339 | - * @param float $b |
|
1340 | - * @param float $w |
|
1341 | - * |
|
1342 | - * @return bool |
|
1343 | - * |
|
1344 | - * @link https://secure.php.net/manual/en/function.pdf-setdash.php |
|
1345 | - */ |
|
1346 | - public function setdash($b, $w) {} |
|
1347 | - |
|
1348 | - /** |
|
1349 | - * @param string $optlist |
|
1350 | - * |
|
1351 | - * @return bool |
|
1352 | - * |
|
1353 | - * @link https://secure.php.net/manual/en/function.pdf-setdashpattern.php |
|
1354 | - */ |
|
1355 | - public function setdashpattern($optlist) {} |
|
1356 | - |
|
1357 | - /** |
|
1358 | - * @param float $flatness |
|
1359 | - * |
|
1360 | - * @return bool |
|
1361 | - * |
|
1362 | - * @link https://secure.php.net/manual/en/function.pdf-setflat.php |
|
1363 | - */ |
|
1364 | - public function setflat($flatness) {} |
|
1365 | - |
|
1366 | - /** |
|
1367 | - * @param int $font |
|
1368 | - * @param float $fontsize |
|
1369 | - * |
|
1370 | - * @return bool |
|
1371 | - * |
|
1372 | - * @link https://secure.php.net/manual/en/function.pdf-setfont.php |
|
1373 | - */ |
|
1374 | - public function setfont($font, $fontsize) {} |
|
1375 | - |
|
1376 | - /** |
|
1377 | - * @param float $g |
|
1378 | - * |
|
1379 | - * @return bool |
|
1380 | - * |
|
1381 | - * @link https://secure.php.net/manual/en/function.pdf-setgray-fill.php (dep) |
|
1382 | - */ |
|
1383 | - public function setgray_fill($g) {} |
|
1384 | - |
|
1385 | - /** |
|
1386 | - * @param float $g |
|
1387 | - * |
|
1388 | - * @return bool |
|
1389 | - * |
|
1390 | - * @link https://secure.php.net/manual/en/function.pdf-setgray-stroke.php (dep) |
|
1391 | - */ |
|
1392 | - public function setgray_stroke($g) {} |
|
1393 | - |
|
1394 | - /** |
|
1395 | - * @param float $g |
|
1396 | - * |
|
1397 | - * @return bool |
|
1398 | - * |
|
1399 | - * @link https://secure.php.net/manual/en/function.pdf-setgray.php (dep) |
|
1400 | - */ |
|
1401 | - public function setgray($g) {} |
|
1402 | - |
|
1403 | - /** |
|
1404 | - * @param int $linecap |
|
1405 | - * |
|
1406 | - * @return bool |
|
1407 | - * |
|
1408 | - * @link https://secure.php.net/manual/en/function.pdf-setlinecap.php |
|
1409 | - */ |
|
1410 | - public function setlinecap($linecap) {} |
|
1411 | - |
|
1412 | - /** |
|
1413 | - * @param int $value |
|
1414 | - * |
|
1415 | - * @return bool |
|
1416 | - * |
|
1417 | - * @link https://secure.php.net/manual/en/function.pdf-setlinejoin.php |
|
1418 | - */ |
|
1419 | - public function setlinejoin($value) {} |
|
1420 | - |
|
1421 | - /** |
|
1422 | - * @param float $width |
|
1423 | - * |
|
1424 | - * @return bool |
|
1425 | - * |
|
1426 | - * @link https://secure.php.net/manual/en/function.pdf-setlinewidth.php |
|
1427 | - */ |
|
1428 | - public function setlinewidth($width) {} |
|
1429 | - |
|
1430 | - /** |
|
1431 | - * @param float $a |
|
1432 | - * @param float $b |
|
1433 | - * @param float $c |
|
1434 | - * @param float $d |
|
1435 | - * @param float $e |
|
1436 | - * @param float $f |
|
1437 | - * |
|
1438 | - * @return bool |
|
1439 | - * |
|
1440 | - * @link https://secure.php.net/manual/en/function.pdf-setmatrix.php |
|
1441 | - */ |
|
1442 | - public function setmatrix($a, $b, $c, $d, $e, $f) {} |
|
1443 | - |
|
1444 | - /** |
|
1445 | - * @param float $miter |
|
1446 | - * |
|
1447 | - * @return bool |
|
1448 | - * |
|
1449 | - * @link https://secure.php.net/manual/en/function.pdf-setmiterlimit.php |
|
1450 | - */ |
|
1451 | - public function setmiterlimit($miter) {} |
|
1452 | - |
|
1453 | - /** |
|
1454 | - * @param float $red |
|
1455 | - * @param float $green |
|
1456 | - * @param float $blue |
|
1457 | - * |
|
1458 | - * @return bool |
|
1459 | - * |
|
1460 | - * @link https://secure.php.net/manual/en/function.pdf-setrgbcolor-fill.php (dep) |
|
1461 | - */ |
|
1462 | - public function setrgbcolor_fill($red, $green, $blue) {} |
|
1463 | - |
|
1464 | - /** |
|
1465 | - * @param float $red |
|
1466 | - * @param float $green |
|
1467 | - * @param float $blue |
|
1468 | - * |
|
1469 | - * @return bool |
|
1470 | - * |
|
1471 | - * @link https://secure.php.net/manual/en/function.pdf-setrgbcolor-stroke.php (dep) |
|
1472 | - */ |
|
1473 | - public function setrgbcolor_stroke($red, $green, $blue) {} |
|
1474 | - |
|
1475 | - /** |
|
1476 | - * @param float $red |
|
1477 | - * @param float $green |
|
1478 | - * @param float $blue |
|
1479 | - * |
|
1480 | - * @return bool |
|
1481 | - * |
|
1482 | - * @link https://secure.php.net/manual/en/function.pdf-setrgbcolor.php (dep) |
|
1483 | - */ |
|
1484 | - public function setrgbcolor($red, $green, $blue) {} |
|
1485 | - |
|
1486 | - /** |
|
1487 | - * @param int $shading |
|
1488 | - * @param string $optlist |
|
1489 | - * |
|
1490 | - * @return int |
|
1491 | - * |
|
1492 | - * @link https://secure.php.net/manual/en/function.pdf-shading-pattern.php |
|
1493 | - */ |
|
1494 | - public function shading_pattern($shading, $optlist) {} |
|
1495 | - |
|
1496 | - /** |
|
1497 | - * @param string $shtype |
|
1498 | - * @param float $x0 |
|
1499 | - * @param float $y0 |
|
1500 | - * @param float $x1 |
|
1501 | - * @param float $y1 |
|
1502 | - * @param float $c1 |
|
1503 | - * @param float $c2 |
|
1504 | - * @param float $c3 |
|
1505 | - * @param float $c4 |
|
1506 | - * @param string $optlist |
|
1507 | - * |
|
1508 | - * @return int |
|
1509 | - * |
|
1510 | - * @link https://secure.php.net/manual/en/function.pdf-shading.php |
|
1511 | - */ |
|
1512 | - public function shading($shtype, $x0, $y0, $x1, $y1, $c1, $c2, $c3, $c4, $optlist) {} |
|
1513 | - |
|
1514 | - /** |
|
1515 | - * @param int $shading |
|
1516 | - * |
|
1517 | - * @return bool |
|
1518 | - * |
|
1519 | - * @link https://secure.php.net/manual/en/function.pdf-shfill.php |
|
1520 | - */ |
|
1521 | - public function shfill($shading) {} |
|
1522 | - |
|
1523 | - /** |
|
1524 | - * @param string $text |
|
1525 | - * @param float $left |
|
1526 | - * @param float $top |
|
1527 | - * @param float $width |
|
1528 | - * @param float $height |
|
1529 | - * @param string $mode |
|
1530 | - * @param string $feature |
|
1531 | - * |
|
1532 | - * @return int |
|
1533 | - * |
|
1534 | - * @link https://secure.php.net/manual/en/function.pdf-show-boxed.php (dep) |
|
1535 | - */ |
|
1536 | - public function show_boxed($text, $left, $top, $width, $height, $mode, $feature) {} |
|
1537 | - |
|
1538 | - /** |
|
1539 | - * @param string $text |
|
1540 | - * @param float $x |
|
1541 | - * @param float $y |
|
1542 | - * |
|
1543 | - * @return bool |
|
1544 | - * |
|
1545 | - * @link https://secure.php.net/manual/en/function.pdf-show-xy.php |
|
1546 | - */ |
|
1547 | - public function show_xy($text, $x, $y) {} |
|
1548 | - |
|
1549 | - /** |
|
1550 | - * @param string $text |
|
1551 | - * |
|
1552 | - * @return bool |
|
1553 | - * |
|
1554 | - * @link https://secure.php.net/manual/en/function.pdf-show.php |
|
1555 | - */ |
|
1556 | - public function show($text) {} |
|
1557 | - |
|
1558 | - /** |
|
1559 | - * @param float $alpha |
|
1560 | - * @param float $beta |
|
1561 | - * |
|
1562 | - * @return bool |
|
1563 | - * |
|
1564 | - * @link https://secure.php.net/manual/en/function.pdf-skew.php |
|
1565 | - */ |
|
1566 | - public function skew($alpha, $beta) {} |
|
1567 | - |
|
1568 | - /** |
|
1569 | - * @param string $text |
|
1570 | - * @param int $font |
|
1571 | - * @param float $fontsize |
|
1572 | - * |
|
1573 | - * @return float |
|
1574 | - * |
|
1575 | - * @link https://secure.php.net/manual/en/function.pdf-stringwidth.php |
|
1576 | - */ |
|
1577 | - public function stringwidth($text, $font, $fontsize) {} |
|
1578 | - |
|
1579 | - /** |
|
1580 | - * @return bool |
|
1581 | - * |
|
1582 | - * @link https://secure.php.net/manual/en/function.pdf-stroke.php |
|
1583 | - */ |
|
1584 | - public function stroke() {} |
|
1585 | - |
|
1586 | - /** |
|
1587 | - * @param string $optlist |
|
1588 | - * |
|
1589 | - * @return bool |
|
1590 | - * |
|
1591 | - * @link https://secure.php.net/manual/en/function.pdf-suspend-page.php |
|
1592 | - */ |
|
1593 | - public function suspend_page($optlist) {} |
|
1594 | - |
|
1595 | - /** |
|
1596 | - * @param float $tx |
|
1597 | - * @param float $ty |
|
1598 | - * |
|
1599 | - * @return bool |
|
1600 | - * |
|
1601 | - * @link https://secure.php.net/manual/en/function.pdf-translate.php |
|
1602 | - */ |
|
1603 | - public function translate($tx, $ty) {} |
|
1604 | - |
|
1605 | - /** |
|
1606 | - * @param string $utf16string |
|
1607 | - * |
|
1608 | - * @return string |
|
1609 | - * |
|
1610 | - * @link https://secure.php.net/manual/en/function.pdf-utf16-to-utf8.php |
|
1611 | - */ |
|
1612 | - public function utf16_to_utf8($utf16string) {} |
|
1613 | - |
|
1614 | - /** |
|
1615 | - * @param string $utf32string |
|
1616 | - * @param string $ordering |
|
1617 | - * |
|
1618 | - * @return string |
|
1619 | - * |
|
1620 | - * @link https://secure.php.net/manual/en/function.pdf-utf32-to-utf16.php |
|
1621 | - */ |
|
1622 | - public function utf32_to_utf16($utf32string, $ordering) {} |
|
1623 | - |
|
1624 | - /** |
|
1625 | - * @param string $utf8string |
|
1626 | - * @param string $ordering |
|
1627 | - * |
|
1628 | - * @return string |
|
1629 | - * |
|
1630 | - * @link https://secure.php.net/manual/en/function.pdf-utf8-to-utf16.php |
|
1631 | - */ |
|
1632 | - public function utf8_to_utf16($utf8string, $ordering) {} |
|
7 | + /** |
|
8 | + * Activates a previously created structure element or other content item. |
|
9 | + * @param $id |
|
10 | + * |
|
11 | + * @return bool |
|
12 | + * |
|
13 | + * @link https://secure.php.net/manual/en/function.pdf-activate-item.php |
|
14 | + */ |
|
15 | + public function activate_item($id) {} |
|
16 | + |
|
17 | + /** |
|
18 | + * Adds a link to a web resource. |
|
19 | + * @param float $llx |
|
20 | + * @param float $lly |
|
21 | + * @param float $urx |
|
22 | + * @param float $ury |
|
23 | + * @param string $filename |
|
24 | + * |
|
25 | + * @return bool |
|
26 | + * |
|
27 | + * @link https://secure.php.net/manual/en/function.pdf-add-launchlink.php |
|
28 | + * @see PDF_create_action() |
|
29 | + */ |
|
30 | + #[Deprecated(" This function is deprecated since PDFlib version 6, use PDF_create_action() with type=Launch and PDF_create_annotation() with type=Link instead.")] |
|
31 | + public function add_launchlink($llx, $lly, $urx, $ury, $filename) {} |
|
32 | + |
|
33 | + /** |
|
34 | + * Add a link annotation to a target within the current PDF file. |
|
35 | + * |
|
36 | + * @param float $lowerleftx |
|
37 | + * @param float $lowerlefty |
|
38 | + * @param float $upperrightx |
|
39 | + * @param float $upperrighty |
|
40 | + * @param int $page |
|
41 | + * @param string $dest |
|
42 | + * |
|
43 | + * @return bool |
|
44 | + * |
|
45 | + * @link https://secure.php.net/manual/en/function.pdf-add-locallink.php |
|
46 | + * @see PDF_create_action() |
|
47 | + */ |
|
48 | + #[Deprecated('This function is deprecated since PDFlib version 6, use PDF_create_action() with type=GoTo and PDF_create_annotation() with type=Link instead.')] |
|
49 | + public function add_locallink($lowerleftx, $lowerlefty, $upperrightx, $upperrighty, $page, $dest) {} |
|
50 | + |
|
51 | + /** |
|
52 | + * Creates a named destination on an arbitrary page in the current document. |
|
53 | + * |
|
54 | + * @param string $name |
|
55 | + * @param string $optlist |
|
56 | + * |
|
57 | + * @return bool |
|
58 | + * |
|
59 | + * @link https://secure.php.net/manual/en/function.pdf-add-nameddest.php |
|
60 | + */ |
|
61 | + public function add_nameddest($name, $optlist) {} |
|
62 | + |
|
63 | + /** |
|
64 | + * Sets an annotation for the current page. |
|
65 | + * |
|
66 | + * @param float $llx |
|
67 | + * @param float $lly |
|
68 | + * @param float $urx |
|
69 | + * @param float $ury |
|
70 | + * @param string $contents |
|
71 | + * @param string $title |
|
72 | + * @param string $icon |
|
73 | + * @param int $open |
|
74 | + * |
|
75 | + * @return bool |
|
76 | + * |
|
77 | + * @link https://secure.php.net/manual/en/function.pdf-add-note.php |
|
78 | + * @see PDF_create_annotation() |
|
79 | + */ |
|
80 | + #[Deprecated('This function is deprecated since PDFlib version 6, use PDF_create_annotation() with type=Text instead.')] |
|
81 | + public function add_note($llx, $lly, $urx, $ury, $contents, $title, $icon, $open) {} |
|
82 | + |
|
83 | + /** |
|
84 | + * Add a file link annotation to a PDF target. |
|
85 | + * |
|
86 | + * @param float $bottom_left_x |
|
87 | + * @param float $bottom_left_y |
|
88 | + * @param float $up_right_x |
|
89 | + * @param float $up_right_y |
|
90 | + * @param string $filename |
|
91 | + * @param int $page |
|
92 | + * @param string $dest |
|
93 | + * |
|
94 | + * @return bool |
|
95 | + * |
|
96 | + * @link https://secure.php.net/manual/en/function.pdf-add-pdflink.php |
|
97 | + * @see PDF_create_action |
|
98 | + */ |
|
99 | + #[Deprecated('This function is deprecated since PDFlib version 6, use PDF_create_action() with type=GoToR and PDF_create_annotation() with type=Link instead.')] |
|
100 | + public function add_pdflink($bottom_left_x, $bottom_left_y, $up_right_x, $up_right_y, $filename, $page, $dest) {} |
|
101 | + |
|
102 | + /** |
|
103 | + * Adds a cell to a new or existing table. |
|
104 | + * |
|
105 | + * @param int $table |
|
106 | + * @param int $column |
|
107 | + * @param int $row |
|
108 | + * @param string $text |
|
109 | + * @param string $optlist |
|
110 | + * |
|
111 | + * @return int |
|
112 | + * |
|
113 | + * @link https://secure.php.net/manual/en/function.pdf-add-table-cell.php |
|
114 | + */ |
|
115 | + public function add_table_cell($table, $column, $row, $text, $optlist) {} |
|
116 | + |
|
117 | + /** |
|
118 | + * Creates a Textflow object, or adds text and explicit options to an existing Textflow. |
|
119 | + * |
|
120 | + * @param int $textflow |
|
121 | + * @param string $text |
|
122 | + * @param string $optlist |
|
123 | + * |
|
124 | + * @return int |
|
125 | + * |
|
126 | + * @link https://secure.php.net/manual/en/function.pdf-add-textflow.php |
|
127 | + */ |
|
128 | + public function add_textflow($textflow, $text, $optlist) {} |
|
129 | + |
|
130 | + /** |
|
131 | + * Adds an existing image as thumbnail for the current page. |
|
132 | + * |
|
133 | + * @param int $image |
|
134 | + * |
|
135 | + * @return bool |
|
136 | + * |
|
137 | + * @link https://secure.php.net/manual/en/function.pdf-add-thumbnail.php |
|
138 | + */ |
|
139 | + public function add_thumbnail($image) {} |
|
140 | + |
|
141 | + /** |
|
142 | + * Adds a weblink annotation to a target url on the Web. |
|
143 | + * |
|
144 | + * @param float $lowerleftx |
|
145 | + * @param float $lowerlefty |
|
146 | + * @param float $upperrightx |
|
147 | + * @param float $upperrighty |
|
148 | + * @param string $url |
|
149 | + * |
|
150 | + * @return bool |
|
151 | + * |
|
152 | + * @link https://secure.php.net/manual/en/function.pdf-add-weblink.php |
|
153 | + * @see PDF_create_action() |
|
154 | + */ |
|
155 | + #[Deprecated('This function is deprecated since PDFlib version 6, use PDF_create_action() with type=URI and PDF_create_annotation() with type=Link instead.')] |
|
156 | + public function add_weblink($lowerleftx, $lowerlefty, $upperrightx, $upperrighty, $url) {} |
|
157 | + |
|
158 | + /** |
|
159 | + * Adds a counterclockwise circular arc |
|
160 | + * |
|
161 | + * @param float $x |
|
162 | + * @param float $y |
|
163 | + * @param float $r |
|
164 | + * @param float $alpha |
|
165 | + * @param float $beta |
|
166 | + * |
|
167 | + * @return bool |
|
168 | + * |
|
169 | + * @link https://secure.php.net/manual/en/function.pdf-arc.php |
|
170 | + */ |
|
171 | + public function arc($x, $y, $r, $alpha, $beta) {} |
|
172 | + |
|
173 | + /** |
|
174 | + * Except for the drawing direction, this function behaves exactly like PDF_arc(). |
|
175 | + * |
|
176 | + * @param float $x |
|
177 | + * @param float $y |
|
178 | + * @param float $r |
|
179 | + * @param float $alpha |
|
180 | + * @param float $beta |
|
181 | + * |
|
182 | + * @return bool |
|
183 | + * |
|
184 | + * @link https://secure.php.net/manual/en/function.pdf-arcn.php |
|
185 | + */ |
|
186 | + public function arcn($x, $y, $r, $alpha, $beta) {} |
|
187 | + |
|
188 | + /** |
|
189 | + * Adds a file attachment annotation. |
|
190 | + * |
|
191 | + * @param float $llx |
|
192 | + * @param float $lly |
|
193 | + * @param float $urx |
|
194 | + * @param float $ury |
|
195 | + * @param string $filename |
|
196 | + * @param string $description |
|
197 | + * @param string $author |
|
198 | + * @param string $mimetype |
|
199 | + * @param string $icon |
|
200 | + * |
|
201 | + * @return bool |
|
202 | + * |
|
203 | + * @link https://secure.php.net/manual/en/function.pdf-attach-file.php |
|
204 | + * @see PDF_create_annotation() |
|
205 | + */ |
|
206 | + #[Deprecated('This function is deprecated since PDFlib version 6, use PDF_create_annotation() with type=FileAttachment instead.')] |
|
207 | + public function attach_file($llx, $lly, $urx, $ury, $filename, $description, $author, $mimetype, $icon) {} |
|
208 | + |
|
209 | + /** |
|
210 | + * Creates a new PDF file subject to various options. |
|
211 | + * |
|
212 | + * @param string $filename |
|
213 | + * @param string $optlist |
|
214 | + * |
|
215 | + * @return int |
|
216 | + * |
|
217 | + * @link https://secure.php.net/manual/en/function.pdf-begin-document.php |
|
218 | + * @link https://www.pdflib.com/fileadmin/pdflib/pdf/manuals/PDFlib-9.1.2-API-reference.pdf |
|
219 | + */ |
|
220 | + public function begin_document($filename, $optlist) {} |
|
221 | + |
|
222 | + /** |
|
223 | + * Starts a Type 3 font definition. |
|
224 | + * |
|
225 | + * @param string $filename |
|
226 | + * @param float $a |
|
227 | + * @param float $b |
|
228 | + * @param float $c |
|
229 | + * @param float $d |
|
230 | + * @param float $e |
|
231 | + * @param float $f |
|
232 | + * @param string $optlist |
|
233 | + * |
|
234 | + * @return bool |
|
235 | + * |
|
236 | + * @link https://secure.php.net/manual/en/function.pdf-begin-font.php |
|
237 | + */ |
|
238 | + public function begin_font($filename, $a, $b, $c, $d, $e, $f, $optlist) {} |
|
239 | + |
|
240 | + /** |
|
241 | + * Starts a glyph definition for a Type 3 font. |
|
242 | + * |
|
243 | + * @param string $glyphname |
|
244 | + * @param float $wx |
|
245 | + * @param float $llx |
|
246 | + * @param float $lly |
|
247 | + * @param float $urx |
|
248 | + * @param float $ury |
|
249 | + * |
|
250 | + * @return bool |
|
251 | + * |
|
252 | + * @link https://secure.php.net/manual/en/function.pdf-begin-glyph.php |
|
253 | + */ |
|
254 | + public function begin_glyph($glyphname, $wx, $llx, $lly, $urx, $ury) {} |
|
255 | + |
|
256 | + /** |
|
257 | + * Opens a structure element or other content item with attributes supplied as options. |
|
258 | + * |
|
259 | + * @param string $tag |
|
260 | + * @param string $optlist |
|
261 | + * |
|
262 | + * @return int |
|
263 | + * |
|
264 | + * @link https://secure.php.net/manual/en/function.pdf-begin-item.php |
|
265 | + */ |
|
266 | + public function begin_item($tag, $optlist) {} |
|
267 | + |
|
268 | + /** |
|
269 | + * Starts a layer for subsequent output on the page. |
|
270 | + * |
|
271 | + * @param int $layer |
|
272 | + * |
|
273 | + * @return bool |
|
274 | + * |
|
275 | + * @link https://secure.php.net/manual/en/function.pdf-begin-layer.php |
|
276 | + */ |
|
277 | + public function begin_layer($layer) {} |
|
278 | + |
|
279 | + /** |
|
280 | + * Adds a new page to the document, and specifies various options. The parameters width and height are the dimensions of the new page in points. |
|
281 | + * |
|
282 | + * @param float $width |
|
283 | + * @param float $height |
|
284 | + * @param string $optlist |
|
285 | + * |
|
286 | + * @return bool |
|
287 | + * |
|
288 | + * @link https://secure.php.net/manual/en/function.pdf-begin-page-ext.php |
|
289 | + */ |
|
290 | + public function begin_page_ext($width, $height, $optlist) {} |
|
291 | + |
|
292 | + /** |
|
293 | + * Adds a new page to the document. |
|
294 | + * |
|
295 | + * @param float $width |
|
296 | + * @param float $height |
|
297 | + * |
|
298 | + * @return bool |
|
299 | + * |
|
300 | + * @link https://secure.php.net/manual/en/function.pdf-begin-page.php |
|
301 | + * |
|
302 | + * @see PDF_begin_page_ext() |
|
303 | + */ |
|
304 | + #[Deprecated('This function is deprecated since PDFlib version 6, use PDF_begin_page_ext() instead.')] |
|
305 | + public function begin_page($width, $height) {} |
|
306 | + |
|
307 | + /** |
|
308 | + * Starts a new pattern definition. |
|
309 | + * |
|
310 | + * @param float $width |
|
311 | + * @param float $height |
|
312 | + * @param float $xstep |
|
313 | + * @param float $ystep |
|
314 | + * @param int $painttype |
|
315 | + * |
|
316 | + * @return int |
|
317 | + * |
|
318 | + * @link https://secure.php.net/manual/en/function.pdf-begin-pattern.php |
|
319 | + */ |
|
320 | + public function begin_pattern($width, $height, $xstep, $ystep, $painttype) {} |
|
321 | + |
|
322 | + /** |
|
323 | + * Starts a new template definition. |
|
324 | + * |
|
325 | + * @param float $width |
|
326 | + * @param float $height |
|
327 | + * @param string $optlist |
|
328 | + * |
|
329 | + * @return int |
|
330 | + * |
|
331 | + * @link https://secure.php.net/manual/en/function.pdf-begin-template-ext.php |
|
332 | + */ |
|
333 | + public function begin_template_ext($width, $height, $optlist) {} |
|
334 | + |
|
335 | + /** |
|
336 | + * @param float $width |
|
337 | + * @param float $height |
|
338 | + * |
|
339 | + * @return int |
|
340 | + * |
|
341 | + * @link https://secure.php.net/manual/en/function.pdf-begin-template.php |
|
342 | + * |
|
343 | + * @see PDF_begin_template_ext |
|
344 | + */ |
|
345 | + #[Deprecated('This function is deprecated since PDFlib version 7, use PDF_begin_template_ext() instead.')] |
|
346 | + public function begin_template($width, $height) {} |
|
347 | + |
|
348 | + /** |
|
349 | + * @param float $x |
|
350 | + * @param float $y |
|
351 | + * @param float $r |
|
352 | + * |
|
353 | + * @return bool |
|
354 | + * |
|
355 | + * @link https://secure.php.net/manual/en/function.pdf-circle.php |
|
356 | + */ |
|
357 | + public function circle($x, $y, $r) {} |
|
358 | + |
|
359 | + /** |
|
360 | + * @return bool |
|
361 | + * |
|
362 | + * @link https://secure.php.net/manual/en/function.pdf-clip.php |
|
363 | + */ |
|
364 | + public function clip() {} |
|
365 | + |
|
366 | + /** |
|
367 | + * @param int $image |
|
368 | + * |
|
369 | + * @return bool |
|
370 | + * |
|
371 | + * @link https://secure.php.net/manual/en/function.pdf-close-image.php |
|
372 | + */ |
|
373 | + public function close_image($image) {} |
|
374 | + |
|
375 | + /** |
|
376 | + * Closes the page handle, and frees all page-related resources |
|
377 | + * |
|
378 | + * @param int $page |
|
379 | + * |
|
380 | + * @return bool |
|
381 | + * |
|
382 | + * @link https://secure.php.net/manual/en/function.pdf-close-pdi-page.php |
|
383 | + */ |
|
384 | + public function close_pdi_page($page) {} |
|
385 | + |
|
386 | + /** |
|
387 | + * @param int $doc |
|
388 | + * |
|
389 | + * @return bool |
|
390 | + * |
|
391 | + * @link https://secure.php.net/manual/en/function.pdf-close-pdi.php |
|
392 | + * |
|
393 | + * @see PDF_close_pdi_document() |
|
394 | + */ |
|
395 | + #[Deprecated('This function is deprecated since PDFlib version 7, use PDF_close_pdi_document() instead.')] |
|
396 | + public function close_pdi($doc) {} |
|
397 | + |
|
398 | + /** |
|
399 | + * @return bool |
|
400 | + * |
|
401 | + * @link https://secure.php.net/manual/en/function.pdf-close.php |
|
402 | + * |
|
403 | + * @see PDF_end_document |
|
404 | + */ |
|
405 | + #[Deprecated('This function is deprecated since PDFlib version 6, use PDF_end_document() instead.')] |
|
406 | + public function close() {} |
|
407 | + |
|
408 | + /** |
|
409 | + * @return bool |
|
410 | + * |
|
411 | + * @link https://secure.php.net/manual/en/function.pdf-closepath-fill-stroke.php |
|
412 | + */ |
|
413 | + public function closepath_fill_stroke() {} |
|
414 | + |
|
415 | + /** |
|
416 | + * @return bool |
|
417 | + * |
|
418 | + * @link https://secure.php.net/manual/en/function.pdf-closepath-stroke.php |
|
419 | + */ |
|
420 | + public function closepath_stroke() {} |
|
421 | + |
|
422 | + /** |
|
423 | + * @return bool |
|
424 | + * |
|
425 | + * @link https://secure.php.net/manual/en/function.pdf-closepath.php |
|
426 | + */ |
|
427 | + public function closepath() {} |
|
428 | + |
|
429 | + /** |
|
430 | + * @param float $a |
|
431 | + * @param float $b |
|
432 | + * @param float $c |
|
433 | + * @param float $d |
|
434 | + * @param float $e |
|
435 | + * @param float $f |
|
436 | + * |
|
437 | + * @return bool |
|
438 | + * |
|
439 | + * @link https://secure.php.net/manual/en/function.pdf-concat.php |
|
440 | + */ |
|
441 | + public function concat($a, $b, $c, $d, $e, $f) {} |
|
442 | + |
|
443 | + /** |
|
444 | + * @param string $text |
|
445 | + * |
|
446 | + * @return bool |
|
447 | + * |
|
448 | + * @link https://secure.php.net/manual/en/function.pdf-continue-text.php |
|
449 | + */ |
|
450 | + public function continue_text($text) {} |
|
451 | + |
|
452 | + /** |
|
453 | + * @param string $username |
|
454 | + * @param string $optlist |
|
455 | + * |
|
456 | + * @return int |
|
457 | + * |
|
458 | + * @link https://secure.php.net/manual/en/function.pdf-create-3dview.php |
|
459 | + */ |
|
460 | + public function create_3dview($username, $optlist) {} |
|
461 | + |
|
462 | + /** |
|
463 | + * @param string $type |
|
464 | + * @param string $optlist |
|
465 | + * |
|
466 | + * @return int |
|
467 | + * |
|
468 | + * @link https://secure.php.net/manual/en/function.pdf-create-action.php |
|
469 | + */ |
|
470 | + public function create_action($type, $optlist) {} |
|
471 | + |
|
472 | + /** |
|
473 | + * @param float $llx |
|
474 | + * @param float $lly |
|
475 | + * @param float $urx |
|
476 | + * @param float $ury |
|
477 | + * @param string $type |
|
478 | + * @param string $optlist |
|
479 | + * |
|
480 | + * @return bool |
|
481 | + * |
|
482 | + * @link https://secure.php.net/manual/en/function.pdf-create-annotation.php |
|
483 | + */ |
|
484 | + public function create_annotation($llx, $lly, $urx, $ury, $type, $optlist) {} |
|
485 | + |
|
486 | + /** |
|
487 | + * @param string $text |
|
488 | + * @param string $optlist |
|
489 | + * |
|
490 | + * @return int |
|
491 | + * |
|
492 | + * @link https://secure.php.net/manual/en/function.pdf-create-bookmark.php |
|
493 | + */ |
|
494 | + public function create_bookmark($text, $optlist) {} |
|
495 | + |
|
496 | + /** |
|
497 | + * @param float $llx |
|
498 | + * @param float $lly |
|
499 | + * @param float $urx |
|
500 | + * @param float $ury |
|
501 | + * @param string $name |
|
502 | + * @param string $type |
|
503 | + * @param string $optlist |
|
504 | + * |
|
505 | + * @return bool |
|
506 | + * |
|
507 | + * @link https://secure.php.net/manual/en/function.pdf-create-field.php |
|
508 | + */ |
|
509 | + public function create_field($llx, $lly, $urx, $ury, $name, $type, $optlist) {} |
|
510 | + |
|
511 | + /** |
|
512 | + * @param string $name |
|
513 | + * @param string $optlist |
|
514 | + * |
|
515 | + * @return bool |
|
516 | + * |
|
517 | + * @link https://secure.php.net/manual/en/function.pdf-create-fieldgroup.php |
|
518 | + */ |
|
519 | + public function create_fieldgroup($name, $optlist) {} |
|
520 | + |
|
521 | + /** |
|
522 | + * @param string $optlist |
|
523 | + * |
|
524 | + * @return int |
|
525 | + * |
|
526 | + * @link https://secure.php.net/manual/en/function.pdf-create-gstate.php |
|
527 | + */ |
|
528 | + public function create_gstate($optlist) {} |
|
529 | + |
|
530 | + /** |
|
531 | + * @param string $filename |
|
532 | + * @param string $data |
|
533 | + * @param string $optlist |
|
534 | + * |
|
535 | + * @return bool |
|
536 | + * |
|
537 | + * @link https://secure.php.net/manual/en/function.pdf-create-pvf.php |
|
538 | + */ |
|
539 | + public function create_pvf($filename, $data, $optlist) {} |
|
540 | + |
|
541 | + /** |
|
542 | + * @param string $text |
|
543 | + * @param string $optlist |
|
544 | + * |
|
545 | + * @return int |
|
546 | + * |
|
547 | + * @link https://secure.php.net/manual/en/function.pdf-create-textflow.php |
|
548 | + */ |
|
549 | + public function create_textflow($text, $optlist) {} |
|
550 | + |
|
551 | + /** |
|
552 | + * @param float $x1 |
|
553 | + * @param float $y1 |
|
554 | + * @param float $x2 |
|
555 | + * @param float $y2 |
|
556 | + * @param float $x3 |
|
557 | + * @param float $y3 |
|
558 | + * |
|
559 | + * @return bool |
|
560 | + * |
|
561 | + * @link https://secure.php.net/manual/en/function.pdf-curveto.php |
|
562 | + */ |
|
563 | + public function curveto($x1, $y1, $x2, $y2, $x3, $y3) {} |
|
564 | + |
|
565 | + /** |
|
566 | + * @param string $name |
|
567 | + * @param string $optlist |
|
568 | + * |
|
569 | + * @return int |
|
570 | + * |
|
571 | + * @link https://secure.php.net/manual/en/function.pdf-define-layer.php |
|
572 | + */ |
|
573 | + public function define_layer($name, $optlist) {} |
|
574 | + |
|
575 | + /** |
|
576 | + * @param string $filename |
|
577 | + * |
|
578 | + * @return int |
|
579 | + * |
|
580 | + * @link https://secure.php.net/manual/en/function.pdf-delete-pvf.php |
|
581 | + */ |
|
582 | + public function delete_pvf($filename) {} |
|
583 | + |
|
584 | + /** |
|
585 | + * @param int $table |
|
586 | + * @param string $optlist |
|
587 | + * |
|
588 | + * @return bool |
|
589 | + * |
|
590 | + * @link https://secure.php.net/manual/en/function.pdf-delete-table.php |
|
591 | + */ |
|
592 | + public function delete_table($table, $optlist) {} |
|
593 | + |
|
594 | + /** |
|
595 | + * @param int $textflow |
|
596 | + * |
|
597 | + * @return bool |
|
598 | + * |
|
599 | + * @link https://secure.php.net/manual/en/function.pdf-delete-textflow.php |
|
600 | + */ |
|
601 | + public function delete_textflow($textflow) {} |
|
602 | + |
|
603 | + /** |
|
604 | + * @return bool |
|
605 | + * |
|
606 | + * @link https://secure.php.net/manual/en/function.pdf-delete.php |
|
607 | + */ |
|
608 | + public function delete() {} |
|
609 | + |
|
610 | + /** |
|
611 | + * @param string $encoding |
|
612 | + * @param int $slot |
|
613 | + * @param string $glyphname |
|
614 | + * @param int $uv |
|
615 | + * |
|
616 | + * @return bool |
|
617 | + * |
|
618 | + * @link https://secure.php.net/manual/en/function.pdf-encoding-set-char.php |
|
619 | + */ |
|
620 | + public function encoding_set_char($encoding, $slot, $glyphname, $uv) {} |
|
621 | + |
|
622 | + /** |
|
623 | + * @param string $optlist |
|
624 | + * |
|
625 | + * @return bool |
|
626 | + * |
|
627 | + * @link https://secure.php.net/manual/en/function.pdf-end-document.php |
|
628 | + */ |
|
629 | + public function end_document($optlist) {} |
|
630 | + |
|
631 | + /** |
|
632 | + * @return bool |
|
633 | + * |
|
634 | + * @link https://secure.php.net/manual/en/function.pdf-end-font.php |
|
635 | + */ |
|
636 | + public function end_font() {} |
|
637 | + |
|
638 | + /** |
|
639 | + * @return bool |
|
640 | + * |
|
641 | + * @link https://secure.php.net/manual/en/function.pdf-end-glyph.php |
|
642 | + */ |
|
643 | + public function end_glyph() {} |
|
644 | + |
|
645 | + /** |
|
646 | + * @param int $id |
|
647 | + * |
|
648 | + * @return bool |
|
649 | + * |
|
650 | + * @link https://secure.php.net/manual/en/function.pdf-end-item.php |
|
651 | + */ |
|
652 | + public function end_item($id) {} |
|
653 | + |
|
654 | + /** |
|
655 | + * @return bool |
|
656 | + * |
|
657 | + * @link https://secure.php.net/manual/en/function.pdf-end-layer.php |
|
658 | + */ |
|
659 | + public function end_layer() {} |
|
660 | + |
|
661 | + /** |
|
662 | + * @param string $optlist |
|
663 | + * |
|
664 | + * @return bool |
|
665 | + * |
|
666 | + * @link https://secure.php.net/manual/en/function.pdf-end-page-ext.php |
|
667 | + */ |
|
668 | + public function end_page_ext($optlist) {} |
|
669 | + |
|
670 | + /** |
|
671 | + * @return bool |
|
672 | + * |
|
673 | + * @link https://secure.php.net/manual/en/function.pdf-end-page.php |
|
674 | + */ |
|
675 | + public function end_page($p) {} |
|
676 | + |
|
677 | + /** |
|
678 | + * @return bool |
|
679 | + * |
|
680 | + * @link https://secure.php.net/manual/en/function.pdf-end-pattern.php |
|
681 | + */ |
|
682 | + public function end_pattern($p) {} |
|
683 | + |
|
684 | + /** |
|
685 | + * @return bool |
|
686 | + * |
|
687 | + * @link https://secure.php.net/manual/en/function.pdf-end-template.php |
|
688 | + */ |
|
689 | + public function end_template($p) {} |
|
690 | + |
|
691 | + /** |
|
692 | + * @return bool |
|
693 | + * |
|
694 | + * @link https://secure.php.net/manual/en/function.pdf-endpath.php |
|
695 | + */ |
|
696 | + public function endpath($p) {} |
|
697 | + |
|
698 | + /** |
|
699 | + * @param int $page |
|
700 | + * @param string $blockname |
|
701 | + * @param int $image |
|
702 | + * @param string $optlist |
|
703 | + * |
|
704 | + * @return int |
|
705 | + * |
|
706 | + * @link https://secure.php.net/manual/en/function.pdf-fill-imageblock.php |
|
707 | + */ |
|
708 | + public function fill_imageblock($page, $blockname, $image, $optlist) {} |
|
709 | + |
|
710 | + /** |
|
711 | + * @param int $page |
|
712 | + * @param string $blockname |
|
713 | + * @param int $contents |
|
714 | + * @param string $optlist |
|
715 | + * |
|
716 | + * @return int |
|
717 | + * |
|
718 | + * @link https://secure.php.net/manual/en/function.pdf-fill-pdfblock.php |
|
719 | + */ |
|
720 | + public function fill_pdfblock($page, $blockname, $contents, $optlist) {} |
|
721 | + |
|
722 | + /** |
|
723 | + * @return bool |
|
724 | + * |
|
725 | + * @link https://secure.php.net/manual/en/function.pdf-fill-stroke.php |
|
726 | + */ |
|
727 | + public function fill_stroke() {} |
|
728 | + |
|
729 | + /** |
|
730 | + * @param int $page |
|
731 | + * @param string $blockname |
|
732 | + * @param string $text |
|
733 | + * @param string $optlist |
|
734 | + * |
|
735 | + * @return int |
|
736 | + * |
|
737 | + * @link https://secure.php.net/manual/en/function.pdf-fill-textblock.php |
|
738 | + */ |
|
739 | + public function fill_textblock($page, $blockname, $text, $optlist) {} |
|
740 | + |
|
741 | + /** |
|
742 | + * @return bool |
|
743 | + * |
|
744 | + * @link https://secure.php.net/manual/en/function.pdf-fill.php |
|
745 | + */ |
|
746 | + public function fill() {} |
|
747 | + /** |
|
748 | + * @param string $fontname |
|
749 | + * @param string $encoding |
|
750 | + * @param int $embed |
|
751 | + * |
|
752 | + * @return int |
|
753 | + * |
|
754 | + * @link https://secure.php.net/manual/en/function.pdf-findfont.php(Dep) |
|
755 | + */ |
|
756 | + public function findfont($fontname, $encoding, $embed) {} |
|
757 | + /** |
|
758 | + * @param int $image |
|
759 | + * @param float $x |
|
760 | + * @param float $y |
|
761 | + * @param string $optlist |
|
762 | + * |
|
763 | + * @return bool |
|
764 | + * |
|
765 | + * @link https://secure.php.net/manual/en/function.pdf-fit-image.php |
|
766 | + */ |
|
767 | + public function fit_image($image, $x, $y, $optlist) {} |
|
768 | + /** |
|
769 | + * @param int $page |
|
770 | + * @param float $x |
|
771 | + * @param float $y |
|
772 | + * @param string $optlist |
|
773 | + * |
|
774 | + * @return bool |
|
775 | + * |
|
776 | + * @link https://secure.php.net/manual/en/function.pdf-fit-pdi-page.php |
|
777 | + */ |
|
778 | + public function fit_pdi_page($page, $x, $y, $optlist) {} |
|
779 | + /** |
|
780 | + * @param int $table |
|
781 | + * @param float $llx |
|
782 | + * @param float $lly |
|
783 | + * @param float $urx |
|
784 | + * @param float $ury |
|
785 | + * @param string $optlist |
|
786 | + * |
|
787 | + * @return string |
|
788 | + * |
|
789 | + * @link https://secure.php.net/manual/en/function.pdf-fit-table.php |
|
790 | + */ |
|
791 | + public function fit_table($table, $llx, $lly, $urx, $ury, $optlist) {} |
|
792 | + /** |
|
793 | + * @param int $textflow |
|
794 | + * @param float $llx |
|
795 | + * @param float $lly |
|
796 | + * @param float $urx |
|
797 | + * @param float $ury |
|
798 | + * @param string $optlist |
|
799 | + * |
|
800 | + * @return string |
|
801 | + * |
|
802 | + * @link https://secure.php.net/manual/en/function.pdf-fit-textflow.php |
|
803 | + */ |
|
804 | + public function fit_textflow($textflow, $llx, $lly, $urx, $ury, $optlist) {} |
|
805 | + /** |
|
806 | + * @param string $text |
|
807 | + * @param float $x |
|
808 | + * @param float $y |
|
809 | + * @param string $optlist |
|
810 | + * |
|
811 | + * @return bool |
|
812 | + * |
|
813 | + * @link https://secure.php.net/manual/en/function.pdf-fit-textline.php |
|
814 | + */ |
|
815 | + public function fit_textline($text, $x, $y, $optlist) {} |
|
816 | + /** |
|
817 | + * @return string |
|
818 | + * |
|
819 | + * @link https://secure.php.net/manual/en/function.pdf-get-apiname.php |
|
820 | + */ |
|
821 | + public function get_apiname() {} |
|
822 | + /** |
|
823 | + * @return string |
|
824 | + * |
|
825 | + * @link https://secure.php.net/manual/en/function.pdf-get-buffer.php |
|
826 | + */ |
|
827 | + public function get_buffer() {} |
|
828 | + /** |
|
829 | + * @return string |
|
830 | + * |
|
831 | + * @link https://secure.php.net/manual/en/function.pdf-get-errmsg.php |
|
832 | + */ |
|
833 | + public function get_errmsg() {} |
|
834 | + /** |
|
835 | + * @return int |
|
836 | + * |
|
837 | + * @link https://secure.php.net/manual/en/function.pdf-get-errnum.php |
|
838 | + */ |
|
839 | + public function get_errnum() {} |
|
840 | + /** |
|
841 | + * @return int |
|
842 | + * |
|
843 | + * @link https://secure.php.net/manual/en/function.pdf-get-majorversion.php(dep) |
|
844 | + */ |
|
845 | + public function get_majorversion() {} |
|
846 | + /** |
|
847 | + * @return int |
|
848 | + * |
|
849 | + * @link https://secure.php.net/manual/en/function.pdf-get-minorversion.php(dep) |
|
850 | + */ |
|
851 | + public function get_minorversion() {} |
|
852 | + /** |
|
853 | + * @param string $key |
|
854 | + * @param float $modifier |
|
855 | + * |
|
856 | + * @return string |
|
857 | + * |
|
858 | + * @link https://secure.php.net/manual/en/function.pdf-get-parameter.php |
|
859 | + */ |
|
860 | + public function get_parameter($key, $modifier) {} |
|
861 | + /** |
|
862 | + * @param string $key |
|
863 | + * @param int $doc |
|
864 | + * @param int $page |
|
865 | + * @param int $reserved |
|
866 | + * |
|
867 | + * @return string |
|
868 | + * |
|
869 | + * @link https://secure.php.net/manual/en/function.pdf-get-pdi-parameter.php |
|
870 | + */ |
|
871 | + public function get_pdi_parameter($key, $doc, $page, $reserved) {} |
|
872 | + /** |
|
873 | + * @param string $key |
|
874 | + * @param int $doc |
|
875 | + * @param int $page |
|
876 | + * @param int $reserved |
|
877 | + * |
|
878 | + * @return float |
|
879 | + * |
|
880 | + * @link https://secure.php.net/manual/en/function.pdf-get-pdi-value.php |
|
881 | + */ |
|
882 | + public function get_pdi_value($key, $doc, $page, $reserved) {} |
|
883 | + /** |
|
884 | + * @param string $key |
|
885 | + * @param float $modifier |
|
886 | + * |
|
887 | + * @return float |
|
888 | + * |
|
889 | + * @link https://secure.php.net/manual/en/function.pdf-get-value.php |
|
890 | + */ |
|
891 | + public function get_value($key, $modifier) {} |
|
892 | + /** |
|
893 | + * @param int $font |
|
894 | + * @param string $keyword |
|
895 | + * @param string $optlist |
|
896 | + * |
|
897 | + * @return float |
|
898 | + * |
|
899 | + * @link https://secure.php.net/manual/en/function.pdf-info-font.php |
|
900 | + */ |
|
901 | + public function info_font($font, $keyword, $optlist) {} |
|
902 | + /** |
|
903 | + * @param string $boxname |
|
904 | + * @param int $num |
|
905 | + * @param string $keyword |
|
906 | + * |
|
907 | + * @return float |
|
908 | + * |
|
909 | + * @link https://secure.php.net/manual/en/function.pdf-info-matchbox.php |
|
910 | + */ |
|
911 | + public function info_matchbox($boxname, $num, $keyword) {} |
|
912 | + /** |
|
913 | + * @param int $table |
|
914 | + * @param string $keyword |
|
915 | + * |
|
916 | + * @return float |
|
917 | + * |
|
918 | + * @link https://secure.php.net/manual/en/function.pdf-info-table.php |
|
919 | + */ |
|
920 | + public function info_table($table, $keyword) {} |
|
921 | + /** |
|
922 | + * @param int $textflow |
|
923 | + * @param string $keyword |
|
924 | + * |
|
925 | + * @return float |
|
926 | + * |
|
927 | + * @link https://secure.php.net/manual/en/function.pdf-info-textflow.php |
|
928 | + */ |
|
929 | + public function info_textflow($textflow, $keyword) {} |
|
930 | + |
|
931 | + /** |
|
932 | + * @param string $text |
|
933 | + * @param string $keyword |
|
934 | + * @param string $optlist |
|
935 | + * |
|
936 | + * @return float |
|
937 | + * |
|
938 | + * @link https://secure.php.net/manual/en/function.pdf-info-textline.php |
|
939 | + */ |
|
940 | + public function info_textline($text, $keyword, $optlist) {} |
|
941 | + |
|
942 | + /** |
|
943 | + * @return bool |
|
944 | + * |
|
945 | + * @link https://secure.php.net/manual/en/function.pdf-initgraphics.php |
|
946 | + */ |
|
947 | + public function initgraphics() {} |
|
948 | + |
|
949 | + /** |
|
950 | + * @param float $x |
|
951 | + * @param float $y |
|
952 | + * |
|
953 | + * @return bool |
|
954 | + * |
|
955 | + * @link https://secure.php.net/manual/en/function.pdf-lineto.php |
|
956 | + */ |
|
957 | + public function lineto($x, $y) {} |
|
958 | + |
|
959 | + /** |
|
960 | + * @param string $filename |
|
961 | + * @param string $optlist |
|
962 | + * |
|
963 | + * @return int |
|
964 | + * |
|
965 | + * @link https://secure.php.net/manual/en/function.pdf-load-3ddata.php |
|
966 | + */ |
|
967 | + public function load_3ddata($filename, $optlist) {} |
|
968 | + |
|
969 | + /** |
|
970 | + * @param string $fontname |
|
971 | + * @param string $encoding |
|
972 | + * @param string $optlist |
|
973 | + * |
|
974 | + * @return int |
|
975 | + * |
|
976 | + * @link https://secure.php.net/manual/en/function.pdf-load-font.php |
|
977 | + */ |
|
978 | + public function load_font($fontname, $encoding, $optlist) {} |
|
979 | + |
|
980 | + /** |
|
981 | + * @param string $profilename |
|
982 | + * @param string $optlist |
|
983 | + * |
|
984 | + * @return int |
|
985 | + * |
|
986 | + * @link https://secure.php.net/manual/en/function.pdf-load-iccprofile.php |
|
987 | + */ |
|
988 | + public function load_iccprofile($profilename, $optlist) {} |
|
989 | + |
|
990 | + /** |
|
991 | + * @param string $imagetype |
|
992 | + * @param string $filename |
|
993 | + * @param string $optlist |
|
994 | + * |
|
995 | + * @return int |
|
996 | + * |
|
997 | + * @link https://secure.php.net/manual/en/function.pdf-load-image.php |
|
998 | + */ |
|
999 | + public function load_image($imagetype, $filename, $optlist) {} |
|
1000 | + |
|
1001 | + /** |
|
1002 | + * @param string $spotname |
|
1003 | + * |
|
1004 | + * @return int |
|
1005 | + * |
|
1006 | + * @link https://secure.php.net/manual/en/function.pdf-makespotcolor.php |
|
1007 | + */ |
|
1008 | + public function makespotcolor($spotname) {} |
|
1009 | + |
|
1010 | + /** |
|
1011 | + * @param float $x |
|
1012 | + * @param float $y |
|
1013 | + * |
|
1014 | + * @return bool |
|
1015 | + * |
|
1016 | + * @link https://secure.php.net/manual/en/function.pdf-moveto.php |
|
1017 | + */ |
|
1018 | + public function moveto($x, $y) {} |
|
1019 | + |
|
1020 | + /** |
|
1021 | + * @param string $filename |
|
1022 | + * @param int $width |
|
1023 | + * @param int $height |
|
1024 | + * @param int $BitReverse |
|
1025 | + * @param int $k |
|
1026 | + * @param int $Blackls1 |
|
1027 | + * |
|
1028 | + * @return int |
|
1029 | + * |
|
1030 | + * @link https://secure.php.net/manual/en/function.pdf-open-ccitt.php(dep) |
|
1031 | + */ |
|
1032 | + public function open_ccitt($filename, $width, $height, $BitReverse, $k, $Blackls1) {} |
|
1033 | + |
|
1034 | + /** |
|
1035 | + * @param string $filename |
|
1036 | + * |
|
1037 | + * @return bool |
|
1038 | + * |
|
1039 | + * @link https://secure.php.net/manual/en/function.pdf-open-file.php(dep) |
|
1040 | + */ |
|
1041 | + public function open_file($filename) {} |
|
1042 | + |
|
1043 | + /** |
|
1044 | + * @param string $imagetype |
|
1045 | + * @param string $filename |
|
1046 | + * @param string $stringparam |
|
1047 | + * @param int $intparam |
|
1048 | + * |
|
1049 | + * @return int |
|
1050 | + * |
|
1051 | + * @link https://secure.php.net/manual/en/function.pdf-open-image-file.php(dep) |
|
1052 | + */ |
|
1053 | + public function open_image_file($imagetype, $filename, $stringparam, $intparam) {} |
|
1054 | + |
|
1055 | + /** |
|
1056 | + * @param string $imagetype |
|
1057 | + * @param string $source |
|
1058 | + * @param string $data |
|
1059 | + * @param int $length |
|
1060 | + * @param int $width |
|
1061 | + * @param int $height |
|
1062 | + * @param int $components |
|
1063 | + * @param int $bpc |
|
1064 | + * @param string $params |
|
1065 | + * |
|
1066 | + * @return int |
|
1067 | + * |
|
1068 | + * @link https://secure.php.net/manual/en/function.pdf-open-image.php(dep) |
|
1069 | + */ |
|
1070 | + public function open_image($imagetype, $source, $data, $length, $width, $height, $components, $bpc, $params) {} |
|
1071 | + |
|
1072 | + /** |
|
1073 | + * @param resource $image |
|
1074 | + * |
|
1075 | + * @return int |
|
1076 | + * |
|
1077 | + * @link https://secure.php.net/manual/en/function.pdf-open-memory-image.php(not supported) |
|
1078 | + */ |
|
1079 | + public function open_memory_image($image) {} |
|
1080 | + |
|
1081 | + /** |
|
1082 | + * @param string $filename |
|
1083 | + * @param string $optlist |
|
1084 | + * |
|
1085 | + * @return int |
|
1086 | + * |
|
1087 | + * @link https://secure.php.net/manual/en/function.pdf-open-pdi-document.php |
|
1088 | + */ |
|
1089 | + public function open_pdi_document($filename, $optlist) {} |
|
1090 | + |
|
1091 | + /** |
|
1092 | + * @param int $doc |
|
1093 | + * @param int $pagenumber |
|
1094 | + * @param string $optlist |
|
1095 | + * |
|
1096 | + * @return int |
|
1097 | + * |
|
1098 | + * @link https://secure.php.net/manual/en/function.pdf-open-pdi-page.php |
|
1099 | + */ |
|
1100 | + public function open_pdi_page($doc, $pagenumber, $optlist) {} |
|
1101 | + |
|
1102 | + /** |
|
1103 | + * @param string $filename |
|
1104 | + * @param string $optlist |
|
1105 | + * @param int $len |
|
1106 | + * |
|
1107 | + * @return int |
|
1108 | + * |
|
1109 | + * @link https://secure.php.net/manual/en/function.pdf-open-pdi.php |
|
1110 | + */ |
|
1111 | + public function open_pdi($filename, $optlist, $len) {} |
|
1112 | + |
|
1113 | + /** |
|
1114 | + * @param int $doc |
|
1115 | + * @param string $path |
|
1116 | + * |
|
1117 | + * @return float |
|
1118 | + * |
|
1119 | + * @link https://secure.php.net/manual/en/function.pdf-pcos-get-number.php |
|
1120 | + */ |
|
1121 | + public function pcos_get_number($doc, $path) {} |
|
1122 | + |
|
1123 | + /** |
|
1124 | + * @param int $doc |
|
1125 | + * @param string $optlist |
|
1126 | + * @param string $path |
|
1127 | + * |
|
1128 | + * @return string |
|
1129 | + * |
|
1130 | + * @link https://secure.php.net/manual/en/function.pdf-pcos-get-stream.php |
|
1131 | + */ |
|
1132 | + public function pcos_get_stream($doc, $optlist, $path) {} |
|
1133 | + |
|
1134 | + /** |
|
1135 | + * @param int $doc |
|
1136 | + * @param string $path |
|
1137 | + * |
|
1138 | + * @return string |
|
1139 | + * |
|
1140 | + * @link https://secure.php.net/manual/en/function.pdf-pcos-get-string.php |
|
1141 | + */ |
|
1142 | + public function pcos_get_string($doc, $path) {} |
|
1143 | + |
|
1144 | + /** |
|
1145 | + * @param int $image |
|
1146 | + * @param float $x |
|
1147 | + * @param float $y |
|
1148 | + * @param float $scale |
|
1149 | + * |
|
1150 | + * @return bool |
|
1151 | + * |
|
1152 | + * @link https://secure.php.net/manual/en/function.pdf-place-image.php (dep) |
|
1153 | + */ |
|
1154 | + public function place_image($image, $x, $y, $scale) {} |
|
1155 | + |
|
1156 | + /** |
|
1157 | + * @param int $page |
|
1158 | + * @param float $x |
|
1159 | + * @param float $y |
|
1160 | + * @param float $sx |
|
1161 | + * @param float $sy |
|
1162 | + * |
|
1163 | + * @return bool |
|
1164 | + * |
|
1165 | + * @link https://secure.php.net/manual/en/function.pdf-place-pdi-page.php (dep) |
|
1166 | + */ |
|
1167 | + public function place_pdi_page($page, $x, $y, $sx, $sy) {} |
|
1168 | + |
|
1169 | + /** |
|
1170 | + * @param int $doc |
|
1171 | + * @param int $page |
|
1172 | + * @param string $optlist |
|
1173 | + * |
|
1174 | + * @return int |
|
1175 | + * |
|
1176 | + * @link https://secure.php.net/manual/en/function.pdf-process-pdi.php |
|
1177 | + */ |
|
1178 | + public function process_pdi($doc, $page, $optlist) {} |
|
1179 | + |
|
1180 | + /** |
|
1181 | + * @param float $x |
|
1182 | + * @param float $y |
|
1183 | + * @param float $width |
|
1184 | + * @param float $height |
|
1185 | + * |
|
1186 | + * @return bool |
|
1187 | + * |
|
1188 | + * @link https://secure.php.net/manual/en/function.pdf-rect.php |
|
1189 | + */ |
|
1190 | + public function rect($x, $y, $width, $height) {} |
|
1191 | + |
|
1192 | + /** |
|
1193 | + * @return bool |
|
1194 | + * |
|
1195 | + * @link https://secure.php.net/manual/en/function.pdf-restore.php |
|
1196 | + */ |
|
1197 | + public function restore($p) {} |
|
1198 | + |
|
1199 | + /** |
|
1200 | + * @param string $optlist |
|
1201 | + * |
|
1202 | + * @return bool |
|
1203 | + * |
|
1204 | + * @link https://secure.php.net/manual/en/function.pdf-resume-page.php |
|
1205 | + */ |
|
1206 | + public function resume_page($optlist) {} |
|
1207 | + |
|
1208 | + /** |
|
1209 | + * @param float $phi |
|
1210 | + * |
|
1211 | + * @return bool |
|
1212 | + * |
|
1213 | + * @link https://secure.php.net/manual/en/function.pdf-rotate.php |
|
1214 | + */ |
|
1215 | + public function rotate($phi) {} |
|
1216 | + |
|
1217 | + /** |
|
1218 | + * @return bool |
|
1219 | + * |
|
1220 | + * @link https://secure.php.net/manual/en/function.pdf-save.php |
|
1221 | + */ |
|
1222 | + public function save($p) {} |
|
1223 | + |
|
1224 | + /** |
|
1225 | + * @param float $sx |
|
1226 | + * @param float $sy |
|
1227 | + * |
|
1228 | + * @return bool |
|
1229 | + * |
|
1230 | + * @link https://secure.php.net/manual/en/function.pdf-scale.php |
|
1231 | + */ |
|
1232 | + public function scale($sx, $sy) {} |
|
1233 | + |
|
1234 | + /** |
|
1235 | + * @param float $red |
|
1236 | + * @param float $green |
|
1237 | + * @param float $blue |
|
1238 | + * |
|
1239 | + * @return bool |
|
1240 | + * |
|
1241 | + * @link https://secure.php.net/manual/en/function.pdf-set-border-color.php (dep) |
|
1242 | + */ |
|
1243 | + public function set_border_color($red, $green, $blue) {} |
|
1244 | + |
|
1245 | + /** |
|
1246 | + * @param float $black |
|
1247 | + * @param float $white |
|
1248 | + * |
|
1249 | + * @return bool |
|
1250 | + * |
|
1251 | + * @link https://secure.php.net/manual/en/function.pdf-set-border-dash.php (dep) |
|
1252 | + */ |
|
1253 | + public function set_border_dash($black, $white) {} |
|
1254 | + |
|
1255 | + /** |
|
1256 | + * @param string $style |
|
1257 | + * @param float $width |
|
1258 | + * |
|
1259 | + * @return bool |
|
1260 | + * |
|
1261 | + * @link https://secure.php.net/manual/en/function.pdf-set-border-style.php (dep) |
|
1262 | + */ |
|
1263 | + public function set_border_style($style, $width) {} |
|
1264 | + |
|
1265 | + /** |
|
1266 | + * @param int $gstate |
|
1267 | + * |
|
1268 | + * @return bool |
|
1269 | + * |
|
1270 | + * @link https://secure.php.net/manual/en/function.pdf-set-gstate.php |
|
1271 | + */ |
|
1272 | + public function set_gstate($gstate) {} |
|
1273 | + |
|
1274 | + /** |
|
1275 | + * @param string $key |
|
1276 | + * @param string $value |
|
1277 | + * |
|
1278 | + * @return bool |
|
1279 | + * |
|
1280 | + * @link https://secure.php.net/manual/en/function.pdf-set-info.php |
|
1281 | + */ |
|
1282 | + public function set_info($key, $value) {} |
|
1283 | + |
|
1284 | + /** |
|
1285 | + * @param string $type |
|
1286 | + * @param string $optlist |
|
1287 | + * |
|
1288 | + * @return bool |
|
1289 | + * |
|
1290 | + * @link https://secure.php.net/manual/en/function.pdf-set-layer-dependency.php |
|
1291 | + */ |
|
1292 | + public function set_layer_dependency($type, $optlist) {} |
|
1293 | + |
|
1294 | + /** |
|
1295 | + * @param string $key |
|
1296 | + * @param string $value |
|
1297 | + * |
|
1298 | + * @return bool |
|
1299 | + * |
|
1300 | + * @link https://secure.php.net/manual/en/function.pdf-set-parameter.php |
|
1301 | + */ |
|
1302 | + public function set_parameter($key, $value) {} |
|
1303 | + |
|
1304 | + /** |
|
1305 | + * @param float $x |
|
1306 | + * @param float $y |
|
1307 | + * |
|
1308 | + * @return bool |
|
1309 | + * |
|
1310 | + * @link https://secure.php.net/manual/en/function.pdf-set-text-pos.php |
|
1311 | + */ |
|
1312 | + public function set_text_pos($x, $y) {} |
|
1313 | + |
|
1314 | + /** |
|
1315 | + * @param string $key |
|
1316 | + * @param float $value |
|
1317 | + * |
|
1318 | + * @return bool |
|
1319 | + * |
|
1320 | + * @link https://secure.php.net/manual/en/function.pdf-set-value.php |
|
1321 | + */ |
|
1322 | + public function set_value($key, $value) {} |
|
1323 | + |
|
1324 | + /** |
|
1325 | + * @param string $fstype |
|
1326 | + * @param string $colorspace |
|
1327 | + * @param float $c1 |
|
1328 | + * @param float $c2 |
|
1329 | + * @param float $c3 |
|
1330 | + * @param float $c4 |
|
1331 | + * |
|
1332 | + * @return bool |
|
1333 | + * |
|
1334 | + * @link https://secure.php.net/manual/en/function.pdf-setcolor.php |
|
1335 | + */ |
|
1336 | + public function setcolor($fstype, $colorspace, $c1, $c2, $c3, $c4) {} |
|
1337 | + |
|
1338 | + /** |
|
1339 | + * @param float $b |
|
1340 | + * @param float $w |
|
1341 | + * |
|
1342 | + * @return bool |
|
1343 | + * |
|
1344 | + * @link https://secure.php.net/manual/en/function.pdf-setdash.php |
|
1345 | + */ |
|
1346 | + public function setdash($b, $w) {} |
|
1347 | + |
|
1348 | + /** |
|
1349 | + * @param string $optlist |
|
1350 | + * |
|
1351 | + * @return bool |
|
1352 | + * |
|
1353 | + * @link https://secure.php.net/manual/en/function.pdf-setdashpattern.php |
|
1354 | + */ |
|
1355 | + public function setdashpattern($optlist) {} |
|
1356 | + |
|
1357 | + /** |
|
1358 | + * @param float $flatness |
|
1359 | + * |
|
1360 | + * @return bool |
|
1361 | + * |
|
1362 | + * @link https://secure.php.net/manual/en/function.pdf-setflat.php |
|
1363 | + */ |
|
1364 | + public function setflat($flatness) {} |
|
1365 | + |
|
1366 | + /** |
|
1367 | + * @param int $font |
|
1368 | + * @param float $fontsize |
|
1369 | + * |
|
1370 | + * @return bool |
|
1371 | + * |
|
1372 | + * @link https://secure.php.net/manual/en/function.pdf-setfont.php |
|
1373 | + */ |
|
1374 | + public function setfont($font, $fontsize) {} |
|
1375 | + |
|
1376 | + /** |
|
1377 | + * @param float $g |
|
1378 | + * |
|
1379 | + * @return bool |
|
1380 | + * |
|
1381 | + * @link https://secure.php.net/manual/en/function.pdf-setgray-fill.php (dep) |
|
1382 | + */ |
|
1383 | + public function setgray_fill($g) {} |
|
1384 | + |
|
1385 | + /** |
|
1386 | + * @param float $g |
|
1387 | + * |
|
1388 | + * @return bool |
|
1389 | + * |
|
1390 | + * @link https://secure.php.net/manual/en/function.pdf-setgray-stroke.php (dep) |
|
1391 | + */ |
|
1392 | + public function setgray_stroke($g) {} |
|
1393 | + |
|
1394 | + /** |
|
1395 | + * @param float $g |
|
1396 | + * |
|
1397 | + * @return bool |
|
1398 | + * |
|
1399 | + * @link https://secure.php.net/manual/en/function.pdf-setgray.php (dep) |
|
1400 | + */ |
|
1401 | + public function setgray($g) {} |
|
1402 | + |
|
1403 | + /** |
|
1404 | + * @param int $linecap |
|
1405 | + * |
|
1406 | + * @return bool |
|
1407 | + * |
|
1408 | + * @link https://secure.php.net/manual/en/function.pdf-setlinecap.php |
|
1409 | + */ |
|
1410 | + public function setlinecap($linecap) {} |
|
1411 | + |
|
1412 | + /** |
|
1413 | + * @param int $value |
|
1414 | + * |
|
1415 | + * @return bool |
|
1416 | + * |
|
1417 | + * @link https://secure.php.net/manual/en/function.pdf-setlinejoin.php |
|
1418 | + */ |
|
1419 | + public function setlinejoin($value) {} |
|
1420 | + |
|
1421 | + /** |
|
1422 | + * @param float $width |
|
1423 | + * |
|
1424 | + * @return bool |
|
1425 | + * |
|
1426 | + * @link https://secure.php.net/manual/en/function.pdf-setlinewidth.php |
|
1427 | + */ |
|
1428 | + public function setlinewidth($width) {} |
|
1429 | + |
|
1430 | + /** |
|
1431 | + * @param float $a |
|
1432 | + * @param float $b |
|
1433 | + * @param float $c |
|
1434 | + * @param float $d |
|
1435 | + * @param float $e |
|
1436 | + * @param float $f |
|
1437 | + * |
|
1438 | + * @return bool |
|
1439 | + * |
|
1440 | + * @link https://secure.php.net/manual/en/function.pdf-setmatrix.php |
|
1441 | + */ |
|
1442 | + public function setmatrix($a, $b, $c, $d, $e, $f) {} |
|
1443 | + |
|
1444 | + /** |
|
1445 | + * @param float $miter |
|
1446 | + * |
|
1447 | + * @return bool |
|
1448 | + * |
|
1449 | + * @link https://secure.php.net/manual/en/function.pdf-setmiterlimit.php |
|
1450 | + */ |
|
1451 | + public function setmiterlimit($miter) {} |
|
1452 | + |
|
1453 | + /** |
|
1454 | + * @param float $red |
|
1455 | + * @param float $green |
|
1456 | + * @param float $blue |
|
1457 | + * |
|
1458 | + * @return bool |
|
1459 | + * |
|
1460 | + * @link https://secure.php.net/manual/en/function.pdf-setrgbcolor-fill.php (dep) |
|
1461 | + */ |
|
1462 | + public function setrgbcolor_fill($red, $green, $blue) {} |
|
1463 | + |
|
1464 | + /** |
|
1465 | + * @param float $red |
|
1466 | + * @param float $green |
|
1467 | + * @param float $blue |
|
1468 | + * |
|
1469 | + * @return bool |
|
1470 | + * |
|
1471 | + * @link https://secure.php.net/manual/en/function.pdf-setrgbcolor-stroke.php (dep) |
|
1472 | + */ |
|
1473 | + public function setrgbcolor_stroke($red, $green, $blue) {} |
|
1474 | + |
|
1475 | + /** |
|
1476 | + * @param float $red |
|
1477 | + * @param float $green |
|
1478 | + * @param float $blue |
|
1479 | + * |
|
1480 | + * @return bool |
|
1481 | + * |
|
1482 | + * @link https://secure.php.net/manual/en/function.pdf-setrgbcolor.php (dep) |
|
1483 | + */ |
|
1484 | + public function setrgbcolor($red, $green, $blue) {} |
|
1485 | + |
|
1486 | + /** |
|
1487 | + * @param int $shading |
|
1488 | + * @param string $optlist |
|
1489 | + * |
|
1490 | + * @return int |
|
1491 | + * |
|
1492 | + * @link https://secure.php.net/manual/en/function.pdf-shading-pattern.php |
|
1493 | + */ |
|
1494 | + public function shading_pattern($shading, $optlist) {} |
|
1495 | + |
|
1496 | + /** |
|
1497 | + * @param string $shtype |
|
1498 | + * @param float $x0 |
|
1499 | + * @param float $y0 |
|
1500 | + * @param float $x1 |
|
1501 | + * @param float $y1 |
|
1502 | + * @param float $c1 |
|
1503 | + * @param float $c2 |
|
1504 | + * @param float $c3 |
|
1505 | + * @param float $c4 |
|
1506 | + * @param string $optlist |
|
1507 | + * |
|
1508 | + * @return int |
|
1509 | + * |
|
1510 | + * @link https://secure.php.net/manual/en/function.pdf-shading.php |
|
1511 | + */ |
|
1512 | + public function shading($shtype, $x0, $y0, $x1, $y1, $c1, $c2, $c3, $c4, $optlist) {} |
|
1513 | + |
|
1514 | + /** |
|
1515 | + * @param int $shading |
|
1516 | + * |
|
1517 | + * @return bool |
|
1518 | + * |
|
1519 | + * @link https://secure.php.net/manual/en/function.pdf-shfill.php |
|
1520 | + */ |
|
1521 | + public function shfill($shading) {} |
|
1522 | + |
|
1523 | + /** |
|
1524 | + * @param string $text |
|
1525 | + * @param float $left |
|
1526 | + * @param float $top |
|
1527 | + * @param float $width |
|
1528 | + * @param float $height |
|
1529 | + * @param string $mode |
|
1530 | + * @param string $feature |
|
1531 | + * |
|
1532 | + * @return int |
|
1533 | + * |
|
1534 | + * @link https://secure.php.net/manual/en/function.pdf-show-boxed.php (dep) |
|
1535 | + */ |
|
1536 | + public function show_boxed($text, $left, $top, $width, $height, $mode, $feature) {} |
|
1537 | + |
|
1538 | + /** |
|
1539 | + * @param string $text |
|
1540 | + * @param float $x |
|
1541 | + * @param float $y |
|
1542 | + * |
|
1543 | + * @return bool |
|
1544 | + * |
|
1545 | + * @link https://secure.php.net/manual/en/function.pdf-show-xy.php |
|
1546 | + */ |
|
1547 | + public function show_xy($text, $x, $y) {} |
|
1548 | + |
|
1549 | + /** |
|
1550 | + * @param string $text |
|
1551 | + * |
|
1552 | + * @return bool |
|
1553 | + * |
|
1554 | + * @link https://secure.php.net/manual/en/function.pdf-show.php |
|
1555 | + */ |
|
1556 | + public function show($text) {} |
|
1557 | + |
|
1558 | + /** |
|
1559 | + * @param float $alpha |
|
1560 | + * @param float $beta |
|
1561 | + * |
|
1562 | + * @return bool |
|
1563 | + * |
|
1564 | + * @link https://secure.php.net/manual/en/function.pdf-skew.php |
|
1565 | + */ |
|
1566 | + public function skew($alpha, $beta) {} |
|
1567 | + |
|
1568 | + /** |
|
1569 | + * @param string $text |
|
1570 | + * @param int $font |
|
1571 | + * @param float $fontsize |
|
1572 | + * |
|
1573 | + * @return float |
|
1574 | + * |
|
1575 | + * @link https://secure.php.net/manual/en/function.pdf-stringwidth.php |
|
1576 | + */ |
|
1577 | + public function stringwidth($text, $font, $fontsize) {} |
|
1578 | + |
|
1579 | + /** |
|
1580 | + * @return bool |
|
1581 | + * |
|
1582 | + * @link https://secure.php.net/manual/en/function.pdf-stroke.php |
|
1583 | + */ |
|
1584 | + public function stroke() {} |
|
1585 | + |
|
1586 | + /** |
|
1587 | + * @param string $optlist |
|
1588 | + * |
|
1589 | + * @return bool |
|
1590 | + * |
|
1591 | + * @link https://secure.php.net/manual/en/function.pdf-suspend-page.php |
|
1592 | + */ |
|
1593 | + public function suspend_page($optlist) {} |
|
1594 | + |
|
1595 | + /** |
|
1596 | + * @param float $tx |
|
1597 | + * @param float $ty |
|
1598 | + * |
|
1599 | + * @return bool |
|
1600 | + * |
|
1601 | + * @link https://secure.php.net/manual/en/function.pdf-translate.php |
|
1602 | + */ |
|
1603 | + public function translate($tx, $ty) {} |
|
1604 | + |
|
1605 | + /** |
|
1606 | + * @param string $utf16string |
|
1607 | + * |
|
1608 | + * @return string |
|
1609 | + * |
|
1610 | + * @link https://secure.php.net/manual/en/function.pdf-utf16-to-utf8.php |
|
1611 | + */ |
|
1612 | + public function utf16_to_utf8($utf16string) {} |
|
1613 | + |
|
1614 | + /** |
|
1615 | + * @param string $utf32string |
|
1616 | + * @param string $ordering |
|
1617 | + * |
|
1618 | + * @return string |
|
1619 | + * |
|
1620 | + * @link https://secure.php.net/manual/en/function.pdf-utf32-to-utf16.php |
|
1621 | + */ |
|
1622 | + public function utf32_to_utf16($utf32string, $ordering) {} |
|
1623 | + |
|
1624 | + /** |
|
1625 | + * @param string $utf8string |
|
1626 | + * @param string $ordering |
|
1627 | + * |
|
1628 | + * @return string |
|
1629 | + * |
|
1630 | + * @link https://secure.php.net/manual/en/function.pdf-utf8-to-utf16.php |
|
1631 | + */ |
|
1632 | + public function utf8_to_utf16($utf8string, $ordering) {} |
|
1633 | 1633 | } |
1634 | 1634 | |
1635 | 1635 | /** |
@@ -2,8 +2,7 @@ |
||
2 | 2 | |
3 | 3 | use JetBrains\PhpStorm\Deprecated; |
4 | 4 | |
5 | -class PDFlib |
|
6 | -{ |
|
5 | +class PDFlib { |
|
7 | 6 | /** |
8 | 7 | * Activates a previously created structure element or other content item. |
9 | 8 | * @param $id |
@@ -19,117 +19,117 @@ discard block |
||
19 | 19 | */ |
20 | 20 | class COPY |
21 | 21 | { |
22 | - /** |
|
23 | - * Start a COPY operation from STDIN to the PostgreSQL server. |
|
24 | - */ |
|
25 | - public const FROM_STDIN = 0; |
|
26 | - /** |
|
27 | - * Start a COPY operation from the server to STDOUT. |
|
28 | - */ |
|
29 | - public const TO_STDOUT = 1; |
|
30 | - /** |
|
31 | - * The connection to the PostgreSQL server. |
|
32 | - * |
|
33 | - * @public |
|
34 | - * @readonly |
|
35 | - * @var \pq\Connection |
|
36 | - */ |
|
37 | - public $connection; |
|
38 | - /** |
|
39 | - * The expression of the COPY statement used to start the operation. |
|
40 | - * |
|
41 | - * @public |
|
42 | - * @readonly |
|
43 | - * @var string |
|
44 | - */ |
|
45 | - public $expression; |
|
46 | - /** |
|
47 | - * The drection of the COPY operation (pq\COPY::FROM_STDIN or pq\COPY::TO_STDOUT). |
|
48 | - * |
|
49 | - * @public |
|
50 | - * @readonly |
|
51 | - * @var int |
|
52 | - */ |
|
53 | - public $direction; |
|
54 | - /** |
|
55 | - * Any additional options used to start the COPY operation. |
|
56 | - * |
|
57 | - * @public |
|
58 | - * @readonly |
|
59 | - * @var string |
|
60 | - */ |
|
61 | - public $options; |
|
62 | - /** |
|
63 | - * Start a COPY operation. |
|
64 | - * |
|
65 | - * @param \pq\Connection $conn The connection to use for the COPY operation. |
|
66 | - * @param string $expression The expression generating the data to copy. |
|
67 | - * @param int $direction Data direction (pq\COPY::FROM_STDIN or pq\COPY::TO_STDOUT). |
|
68 | - * @param string $options Any COPY options (see the [official PostgreSQL documentation](http://www.postgresql.org/docs/current/static/sql-copy.html) for details. |
|
69 | - * @throws \pq\Exception\InvalidArgumentException |
|
70 | - * @throws \pq\Exception\BadMethodCallException |
|
71 | - * @throws \pq\Exception\RuntimeException |
|
72 | - */ |
|
73 | - public function __construct(pq\Connection $conn, string $expression, int $direction, string $options = null) {} |
|
74 | - /** |
|
75 | - * End the COPY operation to the server during pq\Result::COPY_IN state. |
|
76 | - * |
|
77 | - * @param string $error If set, the COPY operation will abort with provided message. |
|
78 | - * @throws \pq\Exception\InvalidArgumentException |
|
79 | - * @throws \pq\Exception\BadMethodCallException |
|
80 | - * @throws \pq\Exception\RuntimeException |
|
81 | - */ |
|
82 | - public function end(string $error = null) {} |
|
83 | - /** |
|
84 | - * Receive data from the server during pq\Result::COPY_OUT state. |
|
85 | - * |
|
86 | - * @param string &$data Data read from the server. |
|
87 | - * @throws \pq\Exception\InvalidArgumentException |
|
88 | - * @throws \pq\Exception\BadMethodCallException |
|
89 | - * @throws \pq\Exception\RuntimeException |
|
90 | - * @return bool success. |
|
91 | - */ |
|
92 | - public function get(string &$data) {} |
|
93 | - /** |
|
94 | - * Send data to the server during pq\Result::COPY_IN state. |
|
95 | - * |
|
96 | - * @param string $data Data to send to the server. |
|
97 | - * @throws \pq\Exception\InvalidArgumentException |
|
98 | - * @throws \pq\Exception\BadMethodCallException |
|
99 | - * @throws \pq\Exception\RuntimeException |
|
100 | - */ |
|
101 | - public function put(string $data) {} |
|
22 | + /** |
|
23 | + * Start a COPY operation from STDIN to the PostgreSQL server. |
|
24 | + */ |
|
25 | + public const FROM_STDIN = 0; |
|
26 | + /** |
|
27 | + * Start a COPY operation from the server to STDOUT. |
|
28 | + */ |
|
29 | + public const TO_STDOUT = 1; |
|
30 | + /** |
|
31 | + * The connection to the PostgreSQL server. |
|
32 | + * |
|
33 | + * @public |
|
34 | + * @readonly |
|
35 | + * @var \pq\Connection |
|
36 | + */ |
|
37 | + public $connection; |
|
38 | + /** |
|
39 | + * The expression of the COPY statement used to start the operation. |
|
40 | + * |
|
41 | + * @public |
|
42 | + * @readonly |
|
43 | + * @var string |
|
44 | + */ |
|
45 | + public $expression; |
|
46 | + /** |
|
47 | + * The drection of the COPY operation (pq\COPY::FROM_STDIN or pq\COPY::TO_STDOUT). |
|
48 | + * |
|
49 | + * @public |
|
50 | + * @readonly |
|
51 | + * @var int |
|
52 | + */ |
|
53 | + public $direction; |
|
54 | + /** |
|
55 | + * Any additional options used to start the COPY operation. |
|
56 | + * |
|
57 | + * @public |
|
58 | + * @readonly |
|
59 | + * @var string |
|
60 | + */ |
|
61 | + public $options; |
|
62 | + /** |
|
63 | + * Start a COPY operation. |
|
64 | + * |
|
65 | + * @param \pq\Connection $conn The connection to use for the COPY operation. |
|
66 | + * @param string $expression The expression generating the data to copy. |
|
67 | + * @param int $direction Data direction (pq\COPY::FROM_STDIN or pq\COPY::TO_STDOUT). |
|
68 | + * @param string $options Any COPY options (see the [official PostgreSQL documentation](http://www.postgresql.org/docs/current/static/sql-copy.html) for details. |
|
69 | + * @throws \pq\Exception\InvalidArgumentException |
|
70 | + * @throws \pq\Exception\BadMethodCallException |
|
71 | + * @throws \pq\Exception\RuntimeException |
|
72 | + */ |
|
73 | + public function __construct(pq\Connection $conn, string $expression, int $direction, string $options = null) {} |
|
74 | + /** |
|
75 | + * End the COPY operation to the server during pq\Result::COPY_IN state. |
|
76 | + * |
|
77 | + * @param string $error If set, the COPY operation will abort with provided message. |
|
78 | + * @throws \pq\Exception\InvalidArgumentException |
|
79 | + * @throws \pq\Exception\BadMethodCallException |
|
80 | + * @throws \pq\Exception\RuntimeException |
|
81 | + */ |
|
82 | + public function end(string $error = null) {} |
|
83 | + /** |
|
84 | + * Receive data from the server during pq\Result::COPY_OUT state. |
|
85 | + * |
|
86 | + * @param string &$data Data read from the server. |
|
87 | + * @throws \pq\Exception\InvalidArgumentException |
|
88 | + * @throws \pq\Exception\BadMethodCallException |
|
89 | + * @throws \pq\Exception\RuntimeException |
|
90 | + * @return bool success. |
|
91 | + */ |
|
92 | + public function get(string &$data) {} |
|
93 | + /** |
|
94 | + * Send data to the server during pq\Result::COPY_IN state. |
|
95 | + * |
|
96 | + * @param string $data Data to send to the server. |
|
97 | + * @throws \pq\Exception\InvalidArgumentException |
|
98 | + * @throws \pq\Exception\BadMethodCallException |
|
99 | + * @throws \pq\Exception\RuntimeException |
|
100 | + */ |
|
101 | + public function put(string $data) {} |
|
102 | 102 | } |
103 | 103 | /** |
104 | 104 | * Request cancellation of an asynchronous query. |
105 | 105 | */ |
106 | 106 | class Cancel |
107 | 107 | { |
108 | - /** |
|
109 | - * The connection to cancel the query on. |
|
110 | - * |
|
111 | - * @public |
|
112 | - * @readonly |
|
113 | - * @var \pq\Connection |
|
114 | - */ |
|
115 | - public $connection; |
|
116 | - /** |
|
117 | - * Create a new cancellation request for an [asynchronous](pq/Connection/: Asynchronous Usage) query. |
|
118 | - * |
|
119 | - * @param \pq\Connection $conn The connection to request cancellation on. |
|
120 | - * @throws \pq\Exception\InvalidArgumentException |
|
121 | - * @throws \pq\Exception\BadMethodCallException |
|
122 | - * @throws \pq\Exception\RuntimeException |
|
123 | - */ |
|
124 | - public function __construct(pq\Connection $conn) {} |
|
125 | - /** |
|
126 | - * Perform the cancellation request. |
|
127 | - * |
|
128 | - * @throws \pq\Exception\InvalidArgumentException |
|
129 | - * @throws \pq\Exception\BadMethodCallException |
|
130 | - * @throws \pq\Exception\RuntimeException |
|
131 | - */ |
|
132 | - public function cancel() {} |
|
108 | + /** |
|
109 | + * The connection to cancel the query on. |
|
110 | + * |
|
111 | + * @public |
|
112 | + * @readonly |
|
113 | + * @var \pq\Connection |
|
114 | + */ |
|
115 | + public $connection; |
|
116 | + /** |
|
117 | + * Create a new cancellation request for an [asynchronous](pq/Connection/: Asynchronous Usage) query. |
|
118 | + * |
|
119 | + * @param \pq\Connection $conn The connection to request cancellation on. |
|
120 | + * @throws \pq\Exception\InvalidArgumentException |
|
121 | + * @throws \pq\Exception\BadMethodCallException |
|
122 | + * @throws \pq\Exception\RuntimeException |
|
123 | + */ |
|
124 | + public function __construct(pq\Connection $conn) {} |
|
125 | + /** |
|
126 | + * Perform the cancellation request. |
|
127 | + * |
|
128 | + * @throws \pq\Exception\InvalidArgumentException |
|
129 | + * @throws \pq\Exception\BadMethodCallException |
|
130 | + * @throws \pq\Exception\RuntimeException |
|
131 | + */ |
|
132 | + public function cancel() {} |
|
133 | 133 | } |
134 | 134 | /** |
135 | 135 | * The connection to the PostgreSQL server. |
@@ -138,871 +138,871 @@ discard block |
||
138 | 138 | */ |
139 | 139 | class Connection |
140 | 140 | { |
141 | - /** |
|
142 | - * (Re-)open a persistent connection. |
|
143 | - */ |
|
144 | - public const PERSISTENT = 2; |
|
145 | - /** |
|
146 | - * If the connection is not already open, perform the connection attempt [asynchronously](pq/Connection/: Asynchronous Usage). |
|
147 | - */ |
|
148 | - public const ASYNC = 1; |
|
149 | - /** |
|
150 | - * Everything well; if a connection has been newly and synchronously created, the connection will always have this status right after creation. |
|
151 | - */ |
|
152 | - public const OK = 0; |
|
153 | - /** |
|
154 | - * Broken connection; consider pq\Connection::reset() or recreation. |
|
155 | - */ |
|
156 | - public const BAD = 1; |
|
157 | - /** |
|
158 | - * Waiting for connection to be made. |
|
159 | - */ |
|
160 | - public const STARTED = 2; |
|
161 | - /** |
|
162 | - * Connection okay; waiting to send. |
|
163 | - */ |
|
164 | - public const MADE = 3; |
|
165 | - /** |
|
166 | - * Waiting for a response from the server. |
|
167 | - */ |
|
168 | - public const AWAITING_RESPONSE = 4; |
|
169 | - /** |
|
170 | - * Received authentication; waiting for backend start-up to finish. |
|
171 | - */ |
|
172 | - public const AUTH_OK = 5; |
|
173 | - /** |
|
174 | - * Negotiating SSL encryption. |
|
175 | - */ |
|
176 | - public const SSL_STARTUP = 7; |
|
177 | - /** |
|
178 | - * Negotiating environment-driven parameter settings. |
|
179 | - */ |
|
180 | - public const SETENV = 6; |
|
181 | - /** |
|
182 | - * No active transaction. |
|
183 | - */ |
|
184 | - public const TRANS_IDLE = 0; |
|
185 | - /** |
|
186 | - * A transaction command is in progress. |
|
187 | - */ |
|
188 | - public const TRANS_ACTIVE = 1; |
|
189 | - /** |
|
190 | - * Idling in a valid transaction block. |
|
191 | - */ |
|
192 | - public const TRANS_INTRANS = 2; |
|
193 | - /** |
|
194 | - * Idling in a failed transaction block. |
|
195 | - */ |
|
196 | - public const TRANS_INERROR = 3; |
|
197 | - /** |
|
198 | - * Bad connection. |
|
199 | - */ |
|
200 | - public const TRANS_UNKNOWN = 4; |
|
201 | - /** |
|
202 | - * The connection procedure has failed. |
|
203 | - */ |
|
204 | - public const POLLING_FAILED = 0; |
|
205 | - /** |
|
206 | - * Select for read-readiness. |
|
207 | - */ |
|
208 | - public const POLLING_READING = 1; |
|
209 | - /** |
|
210 | - * Select for write-readiness. |
|
211 | - */ |
|
212 | - public const POLLING_WRITING = 2; |
|
213 | - /** |
|
214 | - * The connection has been successfully made. |
|
215 | - */ |
|
216 | - public const POLLING_OK = 3; |
|
217 | - /** |
|
218 | - * Register the event handler for notices. |
|
219 | - */ |
|
220 | - public const EVENT_NOTICE = 'notice'; |
|
221 | - /** |
|
222 | - * Register the event handler for any created results. |
|
223 | - */ |
|
224 | - public const EVENT_RESULT = 'result'; |
|
225 | - /** |
|
226 | - * Register the event handler for connection resets. |
|
227 | - */ |
|
228 | - public const EVENT_RESET = 'reset'; |
|
229 | - /** |
|
230 | - * A [connection status constant](pq/Connection#Connection.Status:) value. |
|
231 | - * |
|
232 | - * @public |
|
233 | - * @readonly |
|
234 | - * @var int |
|
235 | - */ |
|
236 | - public $status; |
|
237 | - /** |
|
238 | - * A [transaction status constant](pq/Connection#Transaction.Status:) value. |
|
239 | - * |
|
240 | - * @public |
|
241 | - * @readonly |
|
242 | - * @var int |
|
243 | - */ |
|
244 | - public $transactionStatus; |
|
245 | - /** |
|
246 | - * The server socket resource. |
|
247 | - * |
|
248 | - * @public |
|
249 | - * @readonly |
|
250 | - * @var resource |
|
251 | - */ |
|
252 | - public $socket; |
|
253 | - /** |
|
254 | - * Whether the connection is busy with [asynchronous operations](pq/Connection/: Asynchronous Usage). |
|
255 | - * |
|
256 | - * @public |
|
257 | - * @readonly |
|
258 | - * @var bool |
|
259 | - */ |
|
260 | - public $busy; |
|
261 | - /** |
|
262 | - * Any error message on failure. |
|
263 | - * |
|
264 | - * @public |
|
265 | - * @readonly |
|
266 | - * @var string |
|
267 | - */ |
|
268 | - public $errorMessage; |
|
269 | - /** |
|
270 | - * List of registered event handlers. |
|
271 | - * |
|
272 | - * @public |
|
273 | - * @readonly |
|
274 | - * @var array |
|
275 | - */ |
|
276 | - public $eventHandlers; |
|
277 | - /** |
|
278 | - * Connection character set. |
|
279 | - * |
|
280 | - * @public |
|
281 | - * @var string |
|
282 | - */ |
|
283 | - public $encoding = null; |
|
284 | - /** |
|
285 | - * Whether to fetch [asynchronous](pq/Connection/: Asynchronous Usage) results in unbuffered mode, i.e. each row generates a distinct pq\Result. |
|
286 | - * |
|
287 | - * @public |
|
288 | - * @var bool |
|
289 | - */ |
|
290 | - public $unbuffered = false; |
|
291 | - /** |
|
292 | - * Whether to set the underlying socket nonblocking, useful for asynchronous handling of writes. See also pq\Connection::flush(). |
|
293 | - * |
|
294 | - * ### Connection Information: |
|
295 | - * |
|
296 | - * @public |
|
297 | - * @var bool |
|
298 | - */ |
|
299 | - public $nonblocking = false; |
|
300 | - /** |
|
301 | - * The database name of the connection. |
|
302 | - * |
|
303 | - * @public |
|
304 | - * @readonly |
|
305 | - * @var string |
|
306 | - */ |
|
307 | - public $db; |
|
308 | - /** |
|
309 | - * The user name of the connection. |
|
310 | - * |
|
311 | - * @public |
|
312 | - * @readonly |
|
313 | - * @var string |
|
314 | - */ |
|
315 | - public $user; |
|
316 | - /** |
|
317 | - * The password of the connection. |
|
318 | - * |
|
319 | - * @public |
|
320 | - * @readonly |
|
321 | - * @var string |
|
322 | - */ |
|
323 | - public $pass; |
|
324 | - /** |
|
325 | - * The server host name of the connection. |
|
326 | - * |
|
327 | - * @public |
|
328 | - * @readonly |
|
329 | - * @var string |
|
330 | - */ |
|
331 | - public $host; |
|
332 | - /** |
|
333 | - * The port of the connection. |
|
334 | - * |
|
335 | - * @public |
|
336 | - * @readonly |
|
337 | - * @var string |
|
338 | - */ |
|
339 | - public $port; |
|
340 | - /** |
|
341 | - * The command-line options passed in the connection request. |
|
342 | - * |
|
343 | - * ### Inheritable Defaults: |
|
344 | - * |
|
345 | - * @public |
|
346 | - * @readonly |
|
347 | - * @var string |
|
348 | - */ |
|
349 | - public $options; |
|
350 | - /** |
|
351 | - * Default fetch type for future pq\Result instances. |
|
352 | - * |
|
353 | - * @public |
|
354 | - * @var int |
|
355 | - */ |
|
356 | - public $defaultFetchType = \pq\Result::FETCH_ARRAY; |
|
357 | - /** |
|
358 | - * Default conversion bitmask for future pq\Result instances. |
|
359 | - * |
|
360 | - * @public |
|
361 | - * @var int |
|
362 | - */ |
|
363 | - public $defaultAutoConvert = \pq\Result::CONV_ALL; |
|
364 | - /** |
|
365 | - * Default transaction isolation level for future pq\Transaction instances. |
|
366 | - * |
|
367 | - * @public |
|
368 | - * @var int |
|
369 | - */ |
|
370 | - public $defaultTransactionIsolation = \pq\Transaction::READ_COMMITTED; |
|
371 | - /** |
|
372 | - * Default transaction readonlyness for future pq\Transaction instances. |
|
373 | - * |
|
374 | - * @public |
|
375 | - * @var bool |
|
376 | - */ |
|
377 | - public $defaultTransactionReadonly = false; |
|
378 | - /** |
|
379 | - * Default transaction deferrability for future pq\Transaction instances. |
|
380 | - * |
|
381 | - * @public |
|
382 | - * @var bool |
|
383 | - */ |
|
384 | - public $defaultTransactionDeferrable = false; |
|
385 | - /** |
|
386 | - * Create a new PostgreSQL connection. |
|
387 | - * See also [General Usage](pq/Connection/: General Usage). |
|
388 | - * |
|
389 | - * @param string $dsn A ***connection string*** as described [in the PostgreSQL documentation](http://www.postgresql.org/docs/current/static/libpq-connect.html#LIBPQ-CONNSTRING). |
|
390 | - * @param int $flags See [connection flag constants](pq/Connection#Connection.Flags:). |
|
391 | - * @throws \pq\Exception\InvalidArgumentException |
|
392 | - * @throws \pq\Exception\BadMethodCallException |
|
393 | - * @throws \pq\Exception\RuntimeException |
|
394 | - */ |
|
395 | - public function __construct(string $dsn = "", int $flags = 0) {} |
|
396 | - /** |
|
397 | - * Declare a cursor for a query. |
|
398 | - * |
|
399 | - * @param string $name The identifying name of the cursor. |
|
400 | - * @param int $flags Any combination of pq\Cursor constants. |
|
401 | - * @param string $query The query for which to open a cursor. |
|
402 | - * @throws \pq\Exception\InvalidArgumentException |
|
403 | - * @throws \pq\Exception\RuntimeException |
|
404 | - * @throws \pq\Exception\BadMethodCallException |
|
405 | - * @return \pq\Cursor an open cursor instance. |
|
406 | - */ |
|
407 | - public function declare(string $name, int $flags, string $query) {} |
|
408 | - /** |
|
409 | - * [Asynchronously](pq/Connection/: Asynchronous Usage) declare a cursor for a query. |
|
410 | - * |
|
411 | - * > ***NOTE***: |
|
412 | - * If pq\Connection::$unbuffered is TRUE, each call to pq\Connection::getResult() will generate a distinct pq\Result containing exactly one row. |
|
413 | - * |
|
414 | - * @param string $name The identifying name of the cursor. |
|
415 | - * @param int $flags Any combination of pq\Cursor constants. |
|
416 | - * @param string $query The query for which to open a cursor. |
|
417 | - * @throws \pq\Exception\InvalidArgumentException |
|
418 | - * @throws \pq\Exception\RuntimeException |
|
419 | - * @throws \pq\Exception\BadMethodCallException |
|
420 | - * @return \pq\Cursor an open cursor instance. |
|
421 | - */ |
|
422 | - public function declareAsync(string $name, int $flags, string $query) {} |
|
423 | - /** |
|
424 | - * Escape binary data for use within a query with the type bytea. |
|
425 | - * |
|
426 | - * ***NOTE:*** |
|
427 | - * The result is not wrapped in single quotes. |
|
428 | - * |
|
429 | - * @param string $binary The binary data to escape. |
|
430 | - * @throws \pq\Exception\BadMethodCallException |
|
431 | - * @return string|false string the escaped binary data. |
|
432 | - * or FALSE if escaping fails. |
|
433 | - */ |
|
434 | - public function escapeBytea(string $binary) {} |
|
435 | - /** |
|
436 | - * [Execute one or multiple SQL queries](pq/Connection/: Executing Queries) on the connection. |
|
437 | - * |
|
438 | - * ***NOTE:*** |
|
439 | - * Only the last result will be returned, if the query string contains more than one SQL query. |
|
440 | - * |
|
441 | - * @param string $query The queries to send to the server, separated by semi-colon. |
|
442 | - * @throws \pq\Exception\InvalidArgumentException |
|
443 | - * @throws \pq\Exception\BadMethodCallException |
|
444 | - * @throws \pq\Exception\RuntimeException |
|
445 | - * @throws \pq\Exception\DomainException |
|
446 | - * @return \pq\Result |
|
447 | - */ |
|
448 | - public function exec(string $query) {} |
|
449 | - /** |
|
450 | - * [Asynchronously](pq/Connection/: Asynchronous Usage) [execute an SQL query](pq/Connection: Executing Queries) on the connection. |
|
451 | - * |
|
452 | - * > ***NOTE***: |
|
453 | - * If pq\Connection::$unbuffered is TRUE, each call to pq\Connection::getResult() will generate a distinct pq\Result containing exactly one row. |
|
454 | - * |
|
455 | - * @param string $query The query to send to the server. |
|
456 | - * @param callable $callback as function(pq\Result $res) |
|
457 | - * The callback to execute when the query finishes. |
|
458 | - * @throws \pq\Exception\InvalidArgumentException |
|
459 | - * @throws \pq\Exception\BadMethodCallException |
|
460 | - * @throws \pq\Exception\RuntimeException |
|
461 | - */ |
|
462 | - public function execAsync(string $query, callable $callback = null) {} |
|
463 | - /** |
|
464 | - * [Execute an SQL query](pq/Connection: Executing Queries) with properly escaped parameters substituted. |
|
465 | - * |
|
466 | - * @param string $query The query to execute. |
|
467 | - * @param array $params The parameter list to substitute. |
|
468 | - * @param array $types Corresponding list of type OIDs for the parameters. |
|
469 | - * @throws \pq\Exception\InvalidArgumentException |
|
470 | - * @throws \pq\Exception\RuntimeException |
|
471 | - * @throws \pq\Exception\DomainException |
|
472 | - * @return \pq\Result |
|
473 | - */ |
|
474 | - public function execParams(string $query, array $params, array $types = null) {} |
|
475 | - /** |
|
476 | - * [Asynchronously](pq/Connection/: Asynchronous Usage) [execute an SQL query](pq/Connection: Executing Queries) with properly escaped parameters substituted. |
|
477 | - * |
|
478 | - * > ***NOTE***: |
|
479 | - * If pq\Connection::$unbuffered is TRUE, each call to pq\Connection::getResult() will generate a distinct pq\Result containing exactly one row. |
|
480 | - * |
|
481 | - * @param string $query The query to execute. |
|
482 | - * @param array $params The parameter list to substitute. |
|
483 | - * @param array $types Corresponding list of type OIDs for the parameters. |
|
484 | - * @param callable $cb as function(\pq\Result $res) : void |
|
485 | - * Result handler callback. |
|
486 | - * @throws \pq\Exception\InvalidArgumentException |
|
487 | - * @throws \pq\Exception\RuntimeException |
|
488 | - * @throws \pq\Exception\BadMethodCallException |
|
489 | - */ |
|
490 | - public function execParamsAsync(string $query, array $params, array $types = null, callable $cb = null) {} |
|
491 | - /** |
|
492 | - * Flush pending writes on the connection. |
|
493 | - * Call after sending any command or data on a nonblocking connection. |
|
494 | - * |
|
495 | - * If it returns FALSE, wait for the socket to become read or write-ready. |
|
496 | - * If it becomes write-ready, call pq\Connection::flush() again. |
|
497 | - * If it becomes read-ready, call pq\Connection::poll(), then call pq\Connection::flush() again. |
|
498 | - * Repeat until pq\Connection::flush() returns TRUE. |
|
499 | - * |
|
500 | - * ***NOTE:*** |
|
501 | - * This method was added in v1.1.0, resp. v2.1.0. |
|
502 | - * |
|
503 | - * @throws \pq\Exception\InvalidArgumentException |
|
504 | - * @throws \pq\Exception\RuntimeException |
|
505 | - * @return bool whether everything has been flushed. |
|
506 | - */ |
|
507 | - public function flush() {} |
|
508 | - /** |
|
509 | - * Fetch the result of an [asynchronous](pq/Connection/: Asynchronous Usage) query. |
|
510 | - * |
|
511 | - * If the query hasn't finished yet, the call will block until the result is available. |
|
512 | - * |
|
513 | - * @throws \pq\Exception\InvalidArgumentException |
|
514 | - * @throws \pq\Exception\BadMethodCallException |
|
515 | - * @return \pq\Result|null NULL if there has not been a query |
|
516 | - * or \pq\Result when the query has finished |
|
517 | - */ |
|
518 | - public function getResult() {} |
|
519 | - /** |
|
520 | - * Listen on $channel for notifications. |
|
521 | - * See pq\Connection::unlisten(). |
|
522 | - * |
|
523 | - * @param string $channel The channel to listen on. |
|
524 | - * @param callable $listener as function(string $channel, string $message, int $pid) |
|
525 | - * A callback automatically called whenever a notification on $channel arrives. |
|
526 | - * @throws \pq\Exception\InvalidArgumentException |
|
527 | - * @throws \pq\Exception\BadMethodCallException |
|
528 | - * @throws \pq\Exception\RuntimeException |
|
529 | - */ |
|
530 | - public function listen(string $channel, callable $listener) {} |
|
531 | - /** |
|
532 | - * [Asynchronously](pq/Connection/: Asynchronous Usage) start listening on $channel for notifications. |
|
533 | - * See pq\Connection::listen(). |
|
534 | - * |
|
535 | - * @param string $channel The channel to listen on. |
|
536 | - * @param callable $listener as function(string $channel, string $message, int $pid) |
|
537 | - * A callback automatically called whenever a notification on $channel arrives. |
|
538 | - * @throws \pq\Exception\InvalidArgumentException |
|
539 | - * @throws \pq\Exception\BadMethodCallException |
|
540 | - * @throws \pq\Exception\RuntimeException |
|
541 | - */ |
|
542 | - public function listenAsync(string $channel, callable $listener) {} |
|
543 | - /** |
|
544 | - * Notify all listeners on $channel with $message. |
|
545 | - * |
|
546 | - * @param string $channel The channel to notify. |
|
547 | - * @param string $message The message to send. |
|
548 | - * @throws \pq\Exception\InvalidArgumentException |
|
549 | - * @throws \pq\Exception\BadMethodCallException |
|
550 | - * @throws \pq\Exception\RuntimeException |
|
551 | - */ |
|
552 | - public function notify(string $channel, string $message) {} |
|
553 | - /** |
|
554 | - * [Asynchronously](pq/Connection/: Asynchronous Usage) start notifying all listeners on $channel with $message. |
|
555 | - * |
|
556 | - * @param string $channel The channel to notify. |
|
557 | - * @param string $message The message to send. |
|
558 | - * @throws \pq\Exception\InvalidArgumentException |
|
559 | - * @throws \pq\Exception\BadMethodCallException |
|
560 | - * @throws \pq\Exception\RuntimeException |
|
561 | - */ |
|
562 | - public function notifyAsync(string $channel, string $message) {} |
|
563 | - /** |
|
564 | - * Stops listening for an event type. |
|
565 | - * |
|
566 | - * @param string $event Any pq\Connection::EVENT_*. |
|
567 | - * @throws \pq\Exception\InvalidArgumentException |
|
568 | - * @throws \pq\Exception\BadMethodCallException |
|
569 | - * @return bool success. |
|
570 | - */ |
|
571 | - public function off(string $event) {} |
|
572 | - /** |
|
573 | - * Listen for an event. |
|
574 | - * |
|
575 | - * @param string $event Any pq\Connection::EVENT_*. |
|
576 | - * @param callable $callback as function(pq\Connection $c[, pq\Result $r) |
|
577 | - * The callback to invoke on event. |
|
578 | - * @throws \pq\Exception\InvalidArgumentException |
|
579 | - * @throws \pq\Exception\BadMethodCallException |
|
580 | - * @return int number of previously attached event listeners. |
|
581 | - */ |
|
582 | - public function on(string $event, callable $callback) {} |
|
583 | - /** |
|
584 | - * Poll an [asynchronously](pq/Connection/: Asynchronous Usage) operating connection. |
|
585 | - * See pq\Connection::resetAsync() for an usage example. |
|
586 | - * |
|
587 | - * @throws \pq\Exception\InvalidArgumentException |
|
588 | - * @throws \pq\Exception\RuntimeException |
|
589 | - * @throws \pq\Exception\BadMethodCallException |
|
590 | - * @return int pq\Connection::POLLING_* constant |
|
591 | - */ |
|
592 | - public function poll() {} |
|
593 | - /** |
|
594 | - * Prepare a named statement for later execution with pq\Statement::execute(). |
|
595 | - * |
|
596 | - * @param string $name The identifying name of the prepared statement. |
|
597 | - * @param string $query The query to prepare. |
|
598 | - * @param array $types An array of type OIDs for the substitution parameters. |
|
599 | - * @throws \pq\Exception\InvalidArgumentException |
|
600 | - * @throws \pq\Exception\BadMethodCallException |
|
601 | - * @throws \pq\Exception\RuntimeException |
|
602 | - * @return \pq\Statement a prepared statement instance. |
|
603 | - */ |
|
604 | - public function prepare(string $name, string $query, array $types = null) {} |
|
605 | - /** |
|
606 | - * [Asynchronously](pq/Connection/: Asynchronous Usage) prepare a named statement for later execution with pq\Statement::exec(). |
|
607 | - * |
|
608 | - * > ***NOTE***: |
|
609 | - * If pq\Connection::$unbuffered is TRUE, each call to pq\Connection::getResult() will generate a distinct pq\Result containing exactly one row. |
|
610 | - * |
|
611 | - * @param string $name The identifying name of the prepared statement. |
|
612 | - * @param string $query The query to prepare. |
|
613 | - * @param array $types An array of type OIDs for the substitution parameters. |
|
614 | - * @throws \pq\Exception\InvalidArgumentException |
|
615 | - * @throws \pq\Exception\BadMethodCallException |
|
616 | - * @throws \pq\Exception\RuntimeException |
|
617 | - * @return \pq\Statement a prepared statement instance. |
|
618 | - */ |
|
619 | - public function prepareAsync(string $name, string $query, array $types = null) {} |
|
620 | - /** |
|
621 | - * Quote a string for safe use in a query. |
|
622 | - * The result is truncated at any zero byte and wrapped in single quotes. |
|
623 | - * |
|
624 | - * ***NOTE:*** |
|
625 | - * Beware of matching character encodings. |
|
626 | - * |
|
627 | - * @param string $payload The payload to quote for use in a query. |
|
628 | - * @throws \pq\Exception\BadMethodCallException |
|
629 | - * @return string|false string a single-quote wrapped string safe for literal use in a query. |
|
630 | - * or FALSE if quoting fails. |
|
631 | - */ |
|
632 | - public function quote(string $payload) {} |
|
633 | - /** |
|
634 | - * Quote an identifier for safe usage as name. |
|
635 | - * |
|
636 | - * ***NOTE:*** |
|
637 | - * Beware of case-sensitivity. |
|
638 | - * |
|
639 | - * @param string $name The name to quote. |
|
640 | - * @throws \pq\Exception\BadMethodCallException |
|
641 | - * @return string|false string the quoted identifier. |
|
642 | - * or FALSE if quoting fails. |
|
643 | - */ |
|
644 | - public function quoteName(string $name) {} |
|
645 | - /** |
|
646 | - * Attempt to reset a possibly broken connection to a working state. |
|
647 | - * |
|
648 | - * @throws \pq\Exception\InvalidArgumentException |
|
649 | - * @throws \pq\Exception\BadMethodCallException |
|
650 | - * @throws \pq\Exception\RuntimeException |
|
651 | - */ |
|
652 | - public function reset() {} |
|
653 | - /** |
|
654 | - * [Asynchronously](pq/Connection/: Asynchronous Usage) reset a possibly broken connection to a working state. |
|
655 | - * |
|
656 | - * @throws \pq\Exception\InvalidArgumentException |
|
657 | - * @throws \pq\Exception\BadMethodCallException |
|
658 | - * @throws \pq\Exception\RuntimeException |
|
659 | - */ |
|
660 | - public function resetAsync() {} |
|
661 | - /** |
|
662 | - * Set a data type converter. |
|
663 | - * |
|
664 | - * @param \pq\Converter $converter An instance implementing pq\Converter. |
|
665 | - * @throws \pq\Exception\InvalidArgumentException |
|
666 | - * @throws \pq\Exception\BadMethodCallException |
|
667 | - */ |
|
668 | - public function setConverter(pq\Converter $converter) {} |
|
669 | - /** |
|
670 | - * Begin a transaction. |
|
671 | - * |
|
672 | - * @param int $isolation Any pq\Transaction isolation level constant |
|
673 | - * (defaults to pq\Connection::$defaultTransactionIsolation). |
|
674 | - * @param bool $readonly Whether the transaction executes only reads |
|
675 | - * (defaults to pq\Connection::$defaultTransactionReadonly). |
|
676 | - * @param bool $deferrable Whether the transaction is deferrable |
|
677 | - * (defaults to pq\Connection::$defaultTransactionDeferrable). |
|
678 | - * |
|
679 | - * ***NOTE:*** |
|
680 | - * A transaction can only be deferrable if it also is readonly and serializable. |
|
681 | - * See the official [PostgreSQL documentation](http://www.postgresql.org/docs/current/static/sql-set-transaction.html) for further information. |
|
682 | - * |
|
683 | - * @return \pq\Transaction a begun transaction instance. |
|
684 | - * @throws \pq\Exception\BadMethodCallException |
|
685 | - * @throws \pq\Exception\RuntimeException |
|
686 | - * @throws \pq\Exception\InvalidArgumentException |
|
687 | - */ |
|
688 | - public function startTransaction(int $isolation = \pq\Transaction::READ_COMMITTED, bool $readonly = false, bool $deferrable = false) {} |
|
689 | - /** |
|
690 | - * [Asynchronously](pq/Connection/: Asynchronous Usage) begin a transaction. |
|
691 | - * |
|
692 | - * @param int $isolation Any pq\Transaction isolation level constant |
|
693 | - * (defaults to pq\Connection::$defaultTransactionIsolation). |
|
694 | - * @param bool $readonly Whether the transaction executes only reads |
|
695 | - * (defaults to pq\Connection::$defaultTransactionReadonly). |
|
696 | - * @param bool $deferrable Whether the transaction is deferrable |
|
697 | - * (defaults to pq\Connection::$defaultTransactionDeferrable). |
|
698 | - * |
|
699 | - * ***NOTE:*** |
|
700 | - * A transaction can only be deferrable if it also is readonly and serializable. |
|
701 | - * See the official [PostgreSQL documentation](http://www.postgresql.org/docs/current/static/sql-set-transaction.html) for further information. |
|
702 | - * |
|
703 | - * @return \pq\Transaction an asynchronously begun transaction instance. |
|
704 | - * @throws \pq\Exception\BadMethodCallException |
|
705 | - * @throws \pq\Exception\RuntimeException |
|
706 | - * @throws \pq\Exception\InvalidArgumentException |
|
707 | - */ |
|
708 | - public function startTransactionAsync(int $isolation = \pq\Transaction::READ_COMMITTED, bool $readonly = false, bool $deferrable = false) {} |
|
709 | - /** |
|
710 | - * Trace protocol communication with the server. |
|
711 | - * |
|
712 | - * ***NOTE:*** |
|
713 | - * Calling pq\Connection::trace() without argument or NULL stops tracing. |
|
714 | - * |
|
715 | - * @param resource $stream The resource to which the protocol trace will be output. |
|
716 | - * (The stream must be castable to STDIO). |
|
717 | - * @throws \pq\Exception\BadMethodCallException |
|
718 | - * @return bool success. |
|
719 | - */ |
|
720 | - public function trace($stream = null) {} |
|
721 | - /** |
|
722 | - * Unescape bytea data retrieved from the server. |
|
723 | - * |
|
724 | - * @param string $bytea Bytea data retrieved from the server. |
|
725 | - * @throws \pq\Exception\BadMethodCallException |
|
726 | - * @return string|false string unescaped binary data. |
|
727 | - * or FALSE if unescaping fails. |
|
728 | - */ |
|
729 | - public function unescapeBytea(string $bytea) {} |
|
730 | - /** |
|
731 | - * Stop listening for notifications on channel $channel. |
|
732 | - * See pq\Connection::listen(). |
|
733 | - * |
|
734 | - * @param string $channel The name of a channel which is currently listened on. |
|
735 | - * @throws \pq\Exception\InvalidArgumentException |
|
736 | - * @throws \pq\Exception\BadMethodCallException |
|
737 | - * @throws \pq\Exception\RuntimeException |
|
738 | - */ |
|
739 | - public function unlisten(string $channel) {} |
|
740 | - /** |
|
741 | - * [Asynchronously](pq/Connection/: Asynchronous Usage) stop listening for notifications on channel $channel. |
|
742 | - * See pq\Connection::unlisten() and pq\Connection::listenAsync(). |
|
743 | - * |
|
744 | - * @param string $channel The name of a channel which is currently listened on. |
|
745 | - * @throws \pq\Exception\InvalidArgumentException |
|
746 | - * @throws \pq\Exception\BadMethodCallException |
|
747 | - * @throws \pq\Exception\RuntimeException |
|
748 | - */ |
|
749 | - public function unlistenAsync(string $channel) {} |
|
750 | - /** |
|
751 | - * Stop applying a data type converter. |
|
752 | - * |
|
753 | - * @param \pq\Converter $converter A converter previously set with pq\Connection::setConverter(). |
|
754 | - * @throws \pq\Exception\InvalidArgumentException |
|
755 | - * @throws \pq\Exception\BadMethodCallException |
|
756 | - */ |
|
757 | - public function unsetConverter(pq\Converter $converter) {} |
|
141 | + /** |
|
142 | + * (Re-)open a persistent connection. |
|
143 | + */ |
|
144 | + public const PERSISTENT = 2; |
|
145 | + /** |
|
146 | + * If the connection is not already open, perform the connection attempt [asynchronously](pq/Connection/: Asynchronous Usage). |
|
147 | + */ |
|
148 | + public const ASYNC = 1; |
|
149 | + /** |
|
150 | + * Everything well; if a connection has been newly and synchronously created, the connection will always have this status right after creation. |
|
151 | + */ |
|
152 | + public const OK = 0; |
|
153 | + /** |
|
154 | + * Broken connection; consider pq\Connection::reset() or recreation. |
|
155 | + */ |
|
156 | + public const BAD = 1; |
|
157 | + /** |
|
158 | + * Waiting for connection to be made. |
|
159 | + */ |
|
160 | + public const STARTED = 2; |
|
161 | + /** |
|
162 | + * Connection okay; waiting to send. |
|
163 | + */ |
|
164 | + public const MADE = 3; |
|
165 | + /** |
|
166 | + * Waiting for a response from the server. |
|
167 | + */ |
|
168 | + public const AWAITING_RESPONSE = 4; |
|
169 | + /** |
|
170 | + * Received authentication; waiting for backend start-up to finish. |
|
171 | + */ |
|
172 | + public const AUTH_OK = 5; |
|
173 | + /** |
|
174 | + * Negotiating SSL encryption. |
|
175 | + */ |
|
176 | + public const SSL_STARTUP = 7; |
|
177 | + /** |
|
178 | + * Negotiating environment-driven parameter settings. |
|
179 | + */ |
|
180 | + public const SETENV = 6; |
|
181 | + /** |
|
182 | + * No active transaction. |
|
183 | + */ |
|
184 | + public const TRANS_IDLE = 0; |
|
185 | + /** |
|
186 | + * A transaction command is in progress. |
|
187 | + */ |
|
188 | + public const TRANS_ACTIVE = 1; |
|
189 | + /** |
|
190 | + * Idling in a valid transaction block. |
|
191 | + */ |
|
192 | + public const TRANS_INTRANS = 2; |
|
193 | + /** |
|
194 | + * Idling in a failed transaction block. |
|
195 | + */ |
|
196 | + public const TRANS_INERROR = 3; |
|
197 | + /** |
|
198 | + * Bad connection. |
|
199 | + */ |
|
200 | + public const TRANS_UNKNOWN = 4; |
|
201 | + /** |
|
202 | + * The connection procedure has failed. |
|
203 | + */ |
|
204 | + public const POLLING_FAILED = 0; |
|
205 | + /** |
|
206 | + * Select for read-readiness. |
|
207 | + */ |
|
208 | + public const POLLING_READING = 1; |
|
209 | + /** |
|
210 | + * Select for write-readiness. |
|
211 | + */ |
|
212 | + public const POLLING_WRITING = 2; |
|
213 | + /** |
|
214 | + * The connection has been successfully made. |
|
215 | + */ |
|
216 | + public const POLLING_OK = 3; |
|
217 | + /** |
|
218 | + * Register the event handler for notices. |
|
219 | + */ |
|
220 | + public const EVENT_NOTICE = 'notice'; |
|
221 | + /** |
|
222 | + * Register the event handler for any created results. |
|
223 | + */ |
|
224 | + public const EVENT_RESULT = 'result'; |
|
225 | + /** |
|
226 | + * Register the event handler for connection resets. |
|
227 | + */ |
|
228 | + public const EVENT_RESET = 'reset'; |
|
229 | + /** |
|
230 | + * A [connection status constant](pq/Connection#Connection.Status:) value. |
|
231 | + * |
|
232 | + * @public |
|
233 | + * @readonly |
|
234 | + * @var int |
|
235 | + */ |
|
236 | + public $status; |
|
237 | + /** |
|
238 | + * A [transaction status constant](pq/Connection#Transaction.Status:) value. |
|
239 | + * |
|
240 | + * @public |
|
241 | + * @readonly |
|
242 | + * @var int |
|
243 | + */ |
|
244 | + public $transactionStatus; |
|
245 | + /** |
|
246 | + * The server socket resource. |
|
247 | + * |
|
248 | + * @public |
|
249 | + * @readonly |
|
250 | + * @var resource |
|
251 | + */ |
|
252 | + public $socket; |
|
253 | + /** |
|
254 | + * Whether the connection is busy with [asynchronous operations](pq/Connection/: Asynchronous Usage). |
|
255 | + * |
|
256 | + * @public |
|
257 | + * @readonly |
|
258 | + * @var bool |
|
259 | + */ |
|
260 | + public $busy; |
|
261 | + /** |
|
262 | + * Any error message on failure. |
|
263 | + * |
|
264 | + * @public |
|
265 | + * @readonly |
|
266 | + * @var string |
|
267 | + */ |
|
268 | + public $errorMessage; |
|
269 | + /** |
|
270 | + * List of registered event handlers. |
|
271 | + * |
|
272 | + * @public |
|
273 | + * @readonly |
|
274 | + * @var array |
|
275 | + */ |
|
276 | + public $eventHandlers; |
|
277 | + /** |
|
278 | + * Connection character set. |
|
279 | + * |
|
280 | + * @public |
|
281 | + * @var string |
|
282 | + */ |
|
283 | + public $encoding = null; |
|
284 | + /** |
|
285 | + * Whether to fetch [asynchronous](pq/Connection/: Asynchronous Usage) results in unbuffered mode, i.e. each row generates a distinct pq\Result. |
|
286 | + * |
|
287 | + * @public |
|
288 | + * @var bool |
|
289 | + */ |
|
290 | + public $unbuffered = false; |
|
291 | + /** |
|
292 | + * Whether to set the underlying socket nonblocking, useful for asynchronous handling of writes. See also pq\Connection::flush(). |
|
293 | + * |
|
294 | + * ### Connection Information: |
|
295 | + * |
|
296 | + * @public |
|
297 | + * @var bool |
|
298 | + */ |
|
299 | + public $nonblocking = false; |
|
300 | + /** |
|
301 | + * The database name of the connection. |
|
302 | + * |
|
303 | + * @public |
|
304 | + * @readonly |
|
305 | + * @var string |
|
306 | + */ |
|
307 | + public $db; |
|
308 | + /** |
|
309 | + * The user name of the connection. |
|
310 | + * |
|
311 | + * @public |
|
312 | + * @readonly |
|
313 | + * @var string |
|
314 | + */ |
|
315 | + public $user; |
|
316 | + /** |
|
317 | + * The password of the connection. |
|
318 | + * |
|
319 | + * @public |
|
320 | + * @readonly |
|
321 | + * @var string |
|
322 | + */ |
|
323 | + public $pass; |
|
324 | + /** |
|
325 | + * The server host name of the connection. |
|
326 | + * |
|
327 | + * @public |
|
328 | + * @readonly |
|
329 | + * @var string |
|
330 | + */ |
|
331 | + public $host; |
|
332 | + /** |
|
333 | + * The port of the connection. |
|
334 | + * |
|
335 | + * @public |
|
336 | + * @readonly |
|
337 | + * @var string |
|
338 | + */ |
|
339 | + public $port; |
|
340 | + /** |
|
341 | + * The command-line options passed in the connection request. |
|
342 | + * |
|
343 | + * ### Inheritable Defaults: |
|
344 | + * |
|
345 | + * @public |
|
346 | + * @readonly |
|
347 | + * @var string |
|
348 | + */ |
|
349 | + public $options; |
|
350 | + /** |
|
351 | + * Default fetch type for future pq\Result instances. |
|
352 | + * |
|
353 | + * @public |
|
354 | + * @var int |
|
355 | + */ |
|
356 | + public $defaultFetchType = \pq\Result::FETCH_ARRAY; |
|
357 | + /** |
|
358 | + * Default conversion bitmask for future pq\Result instances. |
|
359 | + * |
|
360 | + * @public |
|
361 | + * @var int |
|
362 | + */ |
|
363 | + public $defaultAutoConvert = \pq\Result::CONV_ALL; |
|
364 | + /** |
|
365 | + * Default transaction isolation level for future pq\Transaction instances. |
|
366 | + * |
|
367 | + * @public |
|
368 | + * @var int |
|
369 | + */ |
|
370 | + public $defaultTransactionIsolation = \pq\Transaction::READ_COMMITTED; |
|
371 | + /** |
|
372 | + * Default transaction readonlyness for future pq\Transaction instances. |
|
373 | + * |
|
374 | + * @public |
|
375 | + * @var bool |
|
376 | + */ |
|
377 | + public $defaultTransactionReadonly = false; |
|
378 | + /** |
|
379 | + * Default transaction deferrability for future pq\Transaction instances. |
|
380 | + * |
|
381 | + * @public |
|
382 | + * @var bool |
|
383 | + */ |
|
384 | + public $defaultTransactionDeferrable = false; |
|
385 | + /** |
|
386 | + * Create a new PostgreSQL connection. |
|
387 | + * See also [General Usage](pq/Connection/: General Usage). |
|
388 | + * |
|
389 | + * @param string $dsn A ***connection string*** as described [in the PostgreSQL documentation](http://www.postgresql.org/docs/current/static/libpq-connect.html#LIBPQ-CONNSTRING). |
|
390 | + * @param int $flags See [connection flag constants](pq/Connection#Connection.Flags:). |
|
391 | + * @throws \pq\Exception\InvalidArgumentException |
|
392 | + * @throws \pq\Exception\BadMethodCallException |
|
393 | + * @throws \pq\Exception\RuntimeException |
|
394 | + */ |
|
395 | + public function __construct(string $dsn = "", int $flags = 0) {} |
|
396 | + /** |
|
397 | + * Declare a cursor for a query. |
|
398 | + * |
|
399 | + * @param string $name The identifying name of the cursor. |
|
400 | + * @param int $flags Any combination of pq\Cursor constants. |
|
401 | + * @param string $query The query for which to open a cursor. |
|
402 | + * @throws \pq\Exception\InvalidArgumentException |
|
403 | + * @throws \pq\Exception\RuntimeException |
|
404 | + * @throws \pq\Exception\BadMethodCallException |
|
405 | + * @return \pq\Cursor an open cursor instance. |
|
406 | + */ |
|
407 | + public function declare(string $name, int $flags, string $query) {} |
|
408 | + /** |
|
409 | + * [Asynchronously](pq/Connection/: Asynchronous Usage) declare a cursor for a query. |
|
410 | + * |
|
411 | + * > ***NOTE***: |
|
412 | + * If pq\Connection::$unbuffered is TRUE, each call to pq\Connection::getResult() will generate a distinct pq\Result containing exactly one row. |
|
413 | + * |
|
414 | + * @param string $name The identifying name of the cursor. |
|
415 | + * @param int $flags Any combination of pq\Cursor constants. |
|
416 | + * @param string $query The query for which to open a cursor. |
|
417 | + * @throws \pq\Exception\InvalidArgumentException |
|
418 | + * @throws \pq\Exception\RuntimeException |
|
419 | + * @throws \pq\Exception\BadMethodCallException |
|
420 | + * @return \pq\Cursor an open cursor instance. |
|
421 | + */ |
|
422 | + public function declareAsync(string $name, int $flags, string $query) {} |
|
423 | + /** |
|
424 | + * Escape binary data for use within a query with the type bytea. |
|
425 | + * |
|
426 | + * ***NOTE:*** |
|
427 | + * The result is not wrapped in single quotes. |
|
428 | + * |
|
429 | + * @param string $binary The binary data to escape. |
|
430 | + * @throws \pq\Exception\BadMethodCallException |
|
431 | + * @return string|false string the escaped binary data. |
|
432 | + * or FALSE if escaping fails. |
|
433 | + */ |
|
434 | + public function escapeBytea(string $binary) {} |
|
435 | + /** |
|
436 | + * [Execute one or multiple SQL queries](pq/Connection/: Executing Queries) on the connection. |
|
437 | + * |
|
438 | + * ***NOTE:*** |
|
439 | + * Only the last result will be returned, if the query string contains more than one SQL query. |
|
440 | + * |
|
441 | + * @param string $query The queries to send to the server, separated by semi-colon. |
|
442 | + * @throws \pq\Exception\InvalidArgumentException |
|
443 | + * @throws \pq\Exception\BadMethodCallException |
|
444 | + * @throws \pq\Exception\RuntimeException |
|
445 | + * @throws \pq\Exception\DomainException |
|
446 | + * @return \pq\Result |
|
447 | + */ |
|
448 | + public function exec(string $query) {} |
|
449 | + /** |
|
450 | + * [Asynchronously](pq/Connection/: Asynchronous Usage) [execute an SQL query](pq/Connection: Executing Queries) on the connection. |
|
451 | + * |
|
452 | + * > ***NOTE***: |
|
453 | + * If pq\Connection::$unbuffered is TRUE, each call to pq\Connection::getResult() will generate a distinct pq\Result containing exactly one row. |
|
454 | + * |
|
455 | + * @param string $query The query to send to the server. |
|
456 | + * @param callable $callback as function(pq\Result $res) |
|
457 | + * The callback to execute when the query finishes. |
|
458 | + * @throws \pq\Exception\InvalidArgumentException |
|
459 | + * @throws \pq\Exception\BadMethodCallException |
|
460 | + * @throws \pq\Exception\RuntimeException |
|
461 | + */ |
|
462 | + public function execAsync(string $query, callable $callback = null) {} |
|
463 | + /** |
|
464 | + * [Execute an SQL query](pq/Connection: Executing Queries) with properly escaped parameters substituted. |
|
465 | + * |
|
466 | + * @param string $query The query to execute. |
|
467 | + * @param array $params The parameter list to substitute. |
|
468 | + * @param array $types Corresponding list of type OIDs for the parameters. |
|
469 | + * @throws \pq\Exception\InvalidArgumentException |
|
470 | + * @throws \pq\Exception\RuntimeException |
|
471 | + * @throws \pq\Exception\DomainException |
|
472 | + * @return \pq\Result |
|
473 | + */ |
|
474 | + public function execParams(string $query, array $params, array $types = null) {} |
|
475 | + /** |
|
476 | + * [Asynchronously](pq/Connection/: Asynchronous Usage) [execute an SQL query](pq/Connection: Executing Queries) with properly escaped parameters substituted. |
|
477 | + * |
|
478 | + * > ***NOTE***: |
|
479 | + * If pq\Connection::$unbuffered is TRUE, each call to pq\Connection::getResult() will generate a distinct pq\Result containing exactly one row. |
|
480 | + * |
|
481 | + * @param string $query The query to execute. |
|
482 | + * @param array $params The parameter list to substitute. |
|
483 | + * @param array $types Corresponding list of type OIDs for the parameters. |
|
484 | + * @param callable $cb as function(\pq\Result $res) : void |
|
485 | + * Result handler callback. |
|
486 | + * @throws \pq\Exception\InvalidArgumentException |
|
487 | + * @throws \pq\Exception\RuntimeException |
|
488 | + * @throws \pq\Exception\BadMethodCallException |
|
489 | + */ |
|
490 | + public function execParamsAsync(string $query, array $params, array $types = null, callable $cb = null) {} |
|
491 | + /** |
|
492 | + * Flush pending writes on the connection. |
|
493 | + * Call after sending any command or data on a nonblocking connection. |
|
494 | + * |
|
495 | + * If it returns FALSE, wait for the socket to become read or write-ready. |
|
496 | + * If it becomes write-ready, call pq\Connection::flush() again. |
|
497 | + * If it becomes read-ready, call pq\Connection::poll(), then call pq\Connection::flush() again. |
|
498 | + * Repeat until pq\Connection::flush() returns TRUE. |
|
499 | + * |
|
500 | + * ***NOTE:*** |
|
501 | + * This method was added in v1.1.0, resp. v2.1.0. |
|
502 | + * |
|
503 | + * @throws \pq\Exception\InvalidArgumentException |
|
504 | + * @throws \pq\Exception\RuntimeException |
|
505 | + * @return bool whether everything has been flushed. |
|
506 | + */ |
|
507 | + public function flush() {} |
|
508 | + /** |
|
509 | + * Fetch the result of an [asynchronous](pq/Connection/: Asynchronous Usage) query. |
|
510 | + * |
|
511 | + * If the query hasn't finished yet, the call will block until the result is available. |
|
512 | + * |
|
513 | + * @throws \pq\Exception\InvalidArgumentException |
|
514 | + * @throws \pq\Exception\BadMethodCallException |
|
515 | + * @return \pq\Result|null NULL if there has not been a query |
|
516 | + * or \pq\Result when the query has finished |
|
517 | + */ |
|
518 | + public function getResult() {} |
|
519 | + /** |
|
520 | + * Listen on $channel for notifications. |
|
521 | + * See pq\Connection::unlisten(). |
|
522 | + * |
|
523 | + * @param string $channel The channel to listen on. |
|
524 | + * @param callable $listener as function(string $channel, string $message, int $pid) |
|
525 | + * A callback automatically called whenever a notification on $channel arrives. |
|
526 | + * @throws \pq\Exception\InvalidArgumentException |
|
527 | + * @throws \pq\Exception\BadMethodCallException |
|
528 | + * @throws \pq\Exception\RuntimeException |
|
529 | + */ |
|
530 | + public function listen(string $channel, callable $listener) {} |
|
531 | + /** |
|
532 | + * [Asynchronously](pq/Connection/: Asynchronous Usage) start listening on $channel for notifications. |
|
533 | + * See pq\Connection::listen(). |
|
534 | + * |
|
535 | + * @param string $channel The channel to listen on. |
|
536 | + * @param callable $listener as function(string $channel, string $message, int $pid) |
|
537 | + * A callback automatically called whenever a notification on $channel arrives. |
|
538 | + * @throws \pq\Exception\InvalidArgumentException |
|
539 | + * @throws \pq\Exception\BadMethodCallException |
|
540 | + * @throws \pq\Exception\RuntimeException |
|
541 | + */ |
|
542 | + public function listenAsync(string $channel, callable $listener) {} |
|
543 | + /** |
|
544 | + * Notify all listeners on $channel with $message. |
|
545 | + * |
|
546 | + * @param string $channel The channel to notify. |
|
547 | + * @param string $message The message to send. |
|
548 | + * @throws \pq\Exception\InvalidArgumentException |
|
549 | + * @throws \pq\Exception\BadMethodCallException |
|
550 | + * @throws \pq\Exception\RuntimeException |
|
551 | + */ |
|
552 | + public function notify(string $channel, string $message) {} |
|
553 | + /** |
|
554 | + * [Asynchronously](pq/Connection/: Asynchronous Usage) start notifying all listeners on $channel with $message. |
|
555 | + * |
|
556 | + * @param string $channel The channel to notify. |
|
557 | + * @param string $message The message to send. |
|
558 | + * @throws \pq\Exception\InvalidArgumentException |
|
559 | + * @throws \pq\Exception\BadMethodCallException |
|
560 | + * @throws \pq\Exception\RuntimeException |
|
561 | + */ |
|
562 | + public function notifyAsync(string $channel, string $message) {} |
|
563 | + /** |
|
564 | + * Stops listening for an event type. |
|
565 | + * |
|
566 | + * @param string $event Any pq\Connection::EVENT_*. |
|
567 | + * @throws \pq\Exception\InvalidArgumentException |
|
568 | + * @throws \pq\Exception\BadMethodCallException |
|
569 | + * @return bool success. |
|
570 | + */ |
|
571 | + public function off(string $event) {} |
|
572 | + /** |
|
573 | + * Listen for an event. |
|
574 | + * |
|
575 | + * @param string $event Any pq\Connection::EVENT_*. |
|
576 | + * @param callable $callback as function(pq\Connection $c[, pq\Result $r) |
|
577 | + * The callback to invoke on event. |
|
578 | + * @throws \pq\Exception\InvalidArgumentException |
|
579 | + * @throws \pq\Exception\BadMethodCallException |
|
580 | + * @return int number of previously attached event listeners. |
|
581 | + */ |
|
582 | + public function on(string $event, callable $callback) {} |
|
583 | + /** |
|
584 | + * Poll an [asynchronously](pq/Connection/: Asynchronous Usage) operating connection. |
|
585 | + * See pq\Connection::resetAsync() for an usage example. |
|
586 | + * |
|
587 | + * @throws \pq\Exception\InvalidArgumentException |
|
588 | + * @throws \pq\Exception\RuntimeException |
|
589 | + * @throws \pq\Exception\BadMethodCallException |
|
590 | + * @return int pq\Connection::POLLING_* constant |
|
591 | + */ |
|
592 | + public function poll() {} |
|
593 | + /** |
|
594 | + * Prepare a named statement for later execution with pq\Statement::execute(). |
|
595 | + * |
|
596 | + * @param string $name The identifying name of the prepared statement. |
|
597 | + * @param string $query The query to prepare. |
|
598 | + * @param array $types An array of type OIDs for the substitution parameters. |
|
599 | + * @throws \pq\Exception\InvalidArgumentException |
|
600 | + * @throws \pq\Exception\BadMethodCallException |
|
601 | + * @throws \pq\Exception\RuntimeException |
|
602 | + * @return \pq\Statement a prepared statement instance. |
|
603 | + */ |
|
604 | + public function prepare(string $name, string $query, array $types = null) {} |
|
605 | + /** |
|
606 | + * [Asynchronously](pq/Connection/: Asynchronous Usage) prepare a named statement for later execution with pq\Statement::exec(). |
|
607 | + * |
|
608 | + * > ***NOTE***: |
|
609 | + * If pq\Connection::$unbuffered is TRUE, each call to pq\Connection::getResult() will generate a distinct pq\Result containing exactly one row. |
|
610 | + * |
|
611 | + * @param string $name The identifying name of the prepared statement. |
|
612 | + * @param string $query The query to prepare. |
|
613 | + * @param array $types An array of type OIDs for the substitution parameters. |
|
614 | + * @throws \pq\Exception\InvalidArgumentException |
|
615 | + * @throws \pq\Exception\BadMethodCallException |
|
616 | + * @throws \pq\Exception\RuntimeException |
|
617 | + * @return \pq\Statement a prepared statement instance. |
|
618 | + */ |
|
619 | + public function prepareAsync(string $name, string $query, array $types = null) {} |
|
620 | + /** |
|
621 | + * Quote a string for safe use in a query. |
|
622 | + * The result is truncated at any zero byte and wrapped in single quotes. |
|
623 | + * |
|
624 | + * ***NOTE:*** |
|
625 | + * Beware of matching character encodings. |
|
626 | + * |
|
627 | + * @param string $payload The payload to quote for use in a query. |
|
628 | + * @throws \pq\Exception\BadMethodCallException |
|
629 | + * @return string|false string a single-quote wrapped string safe for literal use in a query. |
|
630 | + * or FALSE if quoting fails. |
|
631 | + */ |
|
632 | + public function quote(string $payload) {} |
|
633 | + /** |
|
634 | + * Quote an identifier for safe usage as name. |
|
635 | + * |
|
636 | + * ***NOTE:*** |
|
637 | + * Beware of case-sensitivity. |
|
638 | + * |
|
639 | + * @param string $name The name to quote. |
|
640 | + * @throws \pq\Exception\BadMethodCallException |
|
641 | + * @return string|false string the quoted identifier. |
|
642 | + * or FALSE if quoting fails. |
|
643 | + */ |
|
644 | + public function quoteName(string $name) {} |
|
645 | + /** |
|
646 | + * Attempt to reset a possibly broken connection to a working state. |
|
647 | + * |
|
648 | + * @throws \pq\Exception\InvalidArgumentException |
|
649 | + * @throws \pq\Exception\BadMethodCallException |
|
650 | + * @throws \pq\Exception\RuntimeException |
|
651 | + */ |
|
652 | + public function reset() {} |
|
653 | + /** |
|
654 | + * [Asynchronously](pq/Connection/: Asynchronous Usage) reset a possibly broken connection to a working state. |
|
655 | + * |
|
656 | + * @throws \pq\Exception\InvalidArgumentException |
|
657 | + * @throws \pq\Exception\BadMethodCallException |
|
658 | + * @throws \pq\Exception\RuntimeException |
|
659 | + */ |
|
660 | + public function resetAsync() {} |
|
661 | + /** |
|
662 | + * Set a data type converter. |
|
663 | + * |
|
664 | + * @param \pq\Converter $converter An instance implementing pq\Converter. |
|
665 | + * @throws \pq\Exception\InvalidArgumentException |
|
666 | + * @throws \pq\Exception\BadMethodCallException |
|
667 | + */ |
|
668 | + public function setConverter(pq\Converter $converter) {} |
|
669 | + /** |
|
670 | + * Begin a transaction. |
|
671 | + * |
|
672 | + * @param int $isolation Any pq\Transaction isolation level constant |
|
673 | + * (defaults to pq\Connection::$defaultTransactionIsolation). |
|
674 | + * @param bool $readonly Whether the transaction executes only reads |
|
675 | + * (defaults to pq\Connection::$defaultTransactionReadonly). |
|
676 | + * @param bool $deferrable Whether the transaction is deferrable |
|
677 | + * (defaults to pq\Connection::$defaultTransactionDeferrable). |
|
678 | + * |
|
679 | + * ***NOTE:*** |
|
680 | + * A transaction can only be deferrable if it also is readonly and serializable. |
|
681 | + * See the official [PostgreSQL documentation](http://www.postgresql.org/docs/current/static/sql-set-transaction.html) for further information. |
|
682 | + * |
|
683 | + * @return \pq\Transaction a begun transaction instance. |
|
684 | + * @throws \pq\Exception\BadMethodCallException |
|
685 | + * @throws \pq\Exception\RuntimeException |
|
686 | + * @throws \pq\Exception\InvalidArgumentException |
|
687 | + */ |
|
688 | + public function startTransaction(int $isolation = \pq\Transaction::READ_COMMITTED, bool $readonly = false, bool $deferrable = false) {} |
|
689 | + /** |
|
690 | + * [Asynchronously](pq/Connection/: Asynchronous Usage) begin a transaction. |
|
691 | + * |
|
692 | + * @param int $isolation Any pq\Transaction isolation level constant |
|
693 | + * (defaults to pq\Connection::$defaultTransactionIsolation). |
|
694 | + * @param bool $readonly Whether the transaction executes only reads |
|
695 | + * (defaults to pq\Connection::$defaultTransactionReadonly). |
|
696 | + * @param bool $deferrable Whether the transaction is deferrable |
|
697 | + * (defaults to pq\Connection::$defaultTransactionDeferrable). |
|
698 | + * |
|
699 | + * ***NOTE:*** |
|
700 | + * A transaction can only be deferrable if it also is readonly and serializable. |
|
701 | + * See the official [PostgreSQL documentation](http://www.postgresql.org/docs/current/static/sql-set-transaction.html) for further information. |
|
702 | + * |
|
703 | + * @return \pq\Transaction an asynchronously begun transaction instance. |
|
704 | + * @throws \pq\Exception\BadMethodCallException |
|
705 | + * @throws \pq\Exception\RuntimeException |
|
706 | + * @throws \pq\Exception\InvalidArgumentException |
|
707 | + */ |
|
708 | + public function startTransactionAsync(int $isolation = \pq\Transaction::READ_COMMITTED, bool $readonly = false, bool $deferrable = false) {} |
|
709 | + /** |
|
710 | + * Trace protocol communication with the server. |
|
711 | + * |
|
712 | + * ***NOTE:*** |
|
713 | + * Calling pq\Connection::trace() without argument or NULL stops tracing. |
|
714 | + * |
|
715 | + * @param resource $stream The resource to which the protocol trace will be output. |
|
716 | + * (The stream must be castable to STDIO). |
|
717 | + * @throws \pq\Exception\BadMethodCallException |
|
718 | + * @return bool success. |
|
719 | + */ |
|
720 | + public function trace($stream = null) {} |
|
721 | + /** |
|
722 | + * Unescape bytea data retrieved from the server. |
|
723 | + * |
|
724 | + * @param string $bytea Bytea data retrieved from the server. |
|
725 | + * @throws \pq\Exception\BadMethodCallException |
|
726 | + * @return string|false string unescaped binary data. |
|
727 | + * or FALSE if unescaping fails. |
|
728 | + */ |
|
729 | + public function unescapeBytea(string $bytea) {} |
|
730 | + /** |
|
731 | + * Stop listening for notifications on channel $channel. |
|
732 | + * See pq\Connection::listen(). |
|
733 | + * |
|
734 | + * @param string $channel The name of a channel which is currently listened on. |
|
735 | + * @throws \pq\Exception\InvalidArgumentException |
|
736 | + * @throws \pq\Exception\BadMethodCallException |
|
737 | + * @throws \pq\Exception\RuntimeException |
|
738 | + */ |
|
739 | + public function unlisten(string $channel) {} |
|
740 | + /** |
|
741 | + * [Asynchronously](pq/Connection/: Asynchronous Usage) stop listening for notifications on channel $channel. |
|
742 | + * See pq\Connection::unlisten() and pq\Connection::listenAsync(). |
|
743 | + * |
|
744 | + * @param string $channel The name of a channel which is currently listened on. |
|
745 | + * @throws \pq\Exception\InvalidArgumentException |
|
746 | + * @throws \pq\Exception\BadMethodCallException |
|
747 | + * @throws \pq\Exception\RuntimeException |
|
748 | + */ |
|
749 | + public function unlistenAsync(string $channel) {} |
|
750 | + /** |
|
751 | + * Stop applying a data type converter. |
|
752 | + * |
|
753 | + * @param \pq\Converter $converter A converter previously set with pq\Connection::setConverter(). |
|
754 | + * @throws \pq\Exception\InvalidArgumentException |
|
755 | + * @throws \pq\Exception\BadMethodCallException |
|
756 | + */ |
|
757 | + public function unsetConverter(pq\Converter $converter) {} |
|
758 | 758 | } |
759 | 759 | /** |
760 | 760 | * Interface for type conversions. |
761 | 761 | */ |
762 | 762 | interface Converter |
763 | 763 | { |
764 | - /** |
|
765 | - * Convert a string received from the PostgreSQL server back to a PHP type. |
|
766 | - * |
|
767 | - * @param string $data String data received from the server. |
|
768 | - * @param int $type The type OID of the data. Irrelevant for single-type converters. |
|
769 | - * @return mixed the value converted to a PHP type. |
|
770 | - */ |
|
771 | - public function convertFromString(string $data, int $type); |
|
772 | - /** |
|
773 | - * Convert a value to a string for use in a query. |
|
774 | - * |
|
775 | - * @param mixed $value The PHP value which should be converted to a string. |
|
776 | - * @param int $type The type OID the converter should handle. Irrelevant for singly-type converters. |
|
777 | - * @return string a textual representation of the value accepted by the PostgreSQL server. |
|
778 | - */ |
|
779 | - public function convertToString($value, int $type); |
|
780 | - /** |
|
781 | - * Announce which types the implementing converter can handle. |
|
782 | - * |
|
783 | - * @return array OIDs of handled types. |
|
784 | - */ |
|
785 | - public function convertTypes(); |
|
764 | + /** |
|
765 | + * Convert a string received from the PostgreSQL server back to a PHP type. |
|
766 | + * |
|
767 | + * @param string $data String data received from the server. |
|
768 | + * @param int $type The type OID of the data. Irrelevant for single-type converters. |
|
769 | + * @return mixed the value converted to a PHP type. |
|
770 | + */ |
|
771 | + public function convertFromString(string $data, int $type); |
|
772 | + /** |
|
773 | + * Convert a value to a string for use in a query. |
|
774 | + * |
|
775 | + * @param mixed $value The PHP value which should be converted to a string. |
|
776 | + * @param int $type The type OID the converter should handle. Irrelevant for singly-type converters. |
|
777 | + * @return string a textual representation of the value accepted by the PostgreSQL server. |
|
778 | + */ |
|
779 | + public function convertToString($value, int $type); |
|
780 | + /** |
|
781 | + * Announce which types the implementing converter can handle. |
|
782 | + * |
|
783 | + * @return array OIDs of handled types. |
|
784 | + */ |
|
785 | + public function convertTypes(); |
|
786 | 786 | } |
787 | 787 | /** |
788 | 788 | * Declare a cursor. |
789 | 789 | */ |
790 | 790 | class Cursor |
791 | 791 | { |
792 | - /** |
|
793 | - * Causes the cursor to return data in binary rather than in text format. You probably do not want to use that. |
|
794 | - */ |
|
795 | - public const BINARY = 1; |
|
796 | - /** |
|
797 | - * The data returned by the cursor should be unaffected by updates to the tables underlying the cursor that take place after the cursor was opened. |
|
798 | - */ |
|
799 | - public const INSENSITIVE = 2; |
|
800 | - /** |
|
801 | - * The cursor should stay usable after the transaction that created it was successfully committed. |
|
802 | - */ |
|
803 | - public const WITH_HOLD = 4; |
|
804 | - /** |
|
805 | - * Force that rows can be retrieved in any order from the cursor. |
|
806 | - */ |
|
807 | - public const SCROLL = 16; |
|
808 | - /** |
|
809 | - * Force that rows are only retrievable in sequiential order. |
|
810 | - * |
|
811 | - * ***NOTE:*** |
|
812 | - * See the [notes in the official PostgreSQL documentation](http://www.postgresql.org/docs/current/static/sql-declare.html#SQL-DECLARE-NOTES) for more information. |
|
813 | - */ |
|
814 | - public const NO_SCROLL = 32; |
|
815 | - /** |
|
816 | - * The connection the cursor was declared on. |
|
817 | - * |
|
818 | - * @public |
|
819 | - * @readonly |
|
820 | - * @var \pq\Connection |
|
821 | - */ |
|
822 | - public $connection; |
|
823 | - /** |
|
824 | - * The identifying name of the cursor. |
|
825 | - * |
|
826 | - * @public |
|
827 | - * @readonly |
|
828 | - * @var string |
|
829 | - */ |
|
830 | - public $name; |
|
831 | - /** |
|
832 | - * Declare a cursor. |
|
833 | - * See pq\Connection::declare(). |
|
834 | - * |
|
835 | - * @param \pq\Connection $connection The connection on which the cursor should be declared. |
|
836 | - * @param string $name The name of the cursor. |
|
837 | - * @param int $flags See pq\Cursor constants. |
|
838 | - * @param string $query The query for which the cursor should be opened. |
|
839 | - * @param bool $async Whether to declare the cursor [asynchronously](pq/Connection/: Asynchronous Usage). |
|
840 | - * @throws \pq\Exception\InvalidArgumentException |
|
841 | - * @throws \pq\Exception\BadMethodCallException |
|
842 | - * @throws \pq\Exception\RuntimeException |
|
843 | - */ |
|
844 | - public function __construct(pq\Connection $connection, string $name, int $flags, string $query, bool $async) {} |
|
845 | - /** |
|
846 | - * Close an open cursor. |
|
847 | - * This is a no-op on already closed cursors. |
|
848 | - * |
|
849 | - * @throws \pq\Exception\InvalidArgumentException |
|
850 | - * @throws \pq\Exception\BadMethodCallException |
|
851 | - * @throws \pq\Exception\RuntimeException |
|
852 | - */ |
|
853 | - public function close() {} |
|
854 | - /** |
|
855 | - * [Asynchronously](pq/Connection/: Asynchronous Usage) close an open cursor. |
|
856 | - * See pq\Cursor::close(). |
|
857 | - * |
|
858 | - * @throws \pq\Exception\InvalidArgumentException |
|
859 | - * @throws \pq\Exception\BadMethodCallException |
|
860 | - * @throws \pq\Exception\RuntimeException |
|
861 | - */ |
|
862 | - public function closeAsync() {} |
|
863 | - /** |
|
864 | - * Fetch rows from the cursor. |
|
865 | - * See pq\Cursor::move(). |
|
866 | - * |
|
867 | - * @param string $spec What to fetch. |
|
868 | - * |
|
869 | - * ### Fetch argument: |
|
870 | - * |
|
871 | - * FETCH and MOVE usually accepts arguments like the following, where `count` is the number of rows: |
|
872 | - * @throws \pq\Exception\InvalidArgumentException |
|
873 | - * @throws \pq\Exception\BadMethodCallException |
|
874 | - * @throws \pq\Exception\RuntimeException |
|
875 | - * @return \pq\Result the fetched row(s). |
|
876 | - */ |
|
877 | - public function fetch(string $spec = "1") {} |
|
878 | - /** |
|
879 | - * [Asynchronously](pq/Connection/: Asynchronous Usage) fetch rows from the cursor. |
|
880 | - * See pq\Cursor::fetch(). |
|
881 | - * |
|
882 | - * @param string $spec What to fetch. |
|
883 | - * @param callable $callback as function(pq\Result $res) |
|
884 | - * A callback to execute when the result is ready. |
|
885 | - * @throws \pq\Exception\InvalidArgumentException |
|
886 | - * @throws \pq\Exception\BadMethodCallException |
|
887 | - * @throws \pq\Exception\RuntimeException |
|
888 | - */ |
|
889 | - public function fetchAsync(string $spec = "1", callable $callback = null) {} |
|
890 | - /** |
|
891 | - * Move the cursor. |
|
892 | - * See pq\Cursor::fetch(). |
|
893 | - * |
|
894 | - * @param string $spec What to fetch. |
|
895 | - * |
|
896 | - * ### Fetch argument: |
|
897 | - * |
|
898 | - * FETCH and MOVE usually accepts arguments like the following, where `count` is the number of rows: |
|
899 | - * @throws \pq\Exception\InvalidArgumentException |
|
900 | - * @throws \pq\Exception\BadMethodCallException |
|
901 | - * @throws \pq\Exception\RuntimeException |
|
902 | - * @return \pq\Result command status. |
|
903 | - */ |
|
904 | - public function move(string $spec = "1") {} |
|
905 | - /** |
|
906 | - * [Asynchronously](pq/Connection/: Asynchronous Usage) move the cursor. |
|
907 | - * See pq\Cursor::move(). |
|
908 | - * |
|
909 | - * @param string $spec What to fetch. |
|
910 | - * @param callable $callback as function(pq\Result $res) |
|
911 | - * A callback to execute when the command completed. |
|
912 | - * @throws \pq\Exception\InvalidArgumentException |
|
913 | - * @throws \pq\Exception\BadMethodCallException |
|
914 | - * @throws \pq\Exception\RuntimeException |
|
915 | - */ |
|
916 | - public function moveAsync(string $spec = "1", callable $callback = null) {} |
|
917 | - /** |
|
918 | - * Reopen a cursor. |
|
919 | - * This is a no-op on already open cursors. |
|
920 | - * |
|
921 | - * ***NOTE:*** |
|
922 | - * Only cursors closed by pq\Cursor::close() will be reopened. |
|
923 | - * |
|
924 | - * @throws \pq\Exception\InvalidArgumentException |
|
925 | - * @throws \pq\Exception\BadMethodCallException |
|
926 | - * @throws \pq\Exception\RuntimeException |
|
927 | - */ |
|
928 | - public function open() {} |
|
929 | - /** |
|
930 | - * [Asynchronously](pq/Connection/: Asynchronous Usage) reopen a cursor. |
|
931 | - * See pq\Cursor::open(). |
|
932 | - * |
|
933 | - * @throws \pq\Exception\InvalidArgumentException |
|
934 | - * @throws \pq\Exception\BadMethodCallException |
|
935 | - * @throws \pq\Exception\RuntimeException |
|
936 | - */ |
|
937 | - public function openAsync() {} |
|
792 | + /** |
|
793 | + * Causes the cursor to return data in binary rather than in text format. You probably do not want to use that. |
|
794 | + */ |
|
795 | + public const BINARY = 1; |
|
796 | + /** |
|
797 | + * The data returned by the cursor should be unaffected by updates to the tables underlying the cursor that take place after the cursor was opened. |
|
798 | + */ |
|
799 | + public const INSENSITIVE = 2; |
|
800 | + /** |
|
801 | + * The cursor should stay usable after the transaction that created it was successfully committed. |
|
802 | + */ |
|
803 | + public const WITH_HOLD = 4; |
|
804 | + /** |
|
805 | + * Force that rows can be retrieved in any order from the cursor. |
|
806 | + */ |
|
807 | + public const SCROLL = 16; |
|
808 | + /** |
|
809 | + * Force that rows are only retrievable in sequiential order. |
|
810 | + * |
|
811 | + * ***NOTE:*** |
|
812 | + * See the [notes in the official PostgreSQL documentation](http://www.postgresql.org/docs/current/static/sql-declare.html#SQL-DECLARE-NOTES) for more information. |
|
813 | + */ |
|
814 | + public const NO_SCROLL = 32; |
|
815 | + /** |
|
816 | + * The connection the cursor was declared on. |
|
817 | + * |
|
818 | + * @public |
|
819 | + * @readonly |
|
820 | + * @var \pq\Connection |
|
821 | + */ |
|
822 | + public $connection; |
|
823 | + /** |
|
824 | + * The identifying name of the cursor. |
|
825 | + * |
|
826 | + * @public |
|
827 | + * @readonly |
|
828 | + * @var string |
|
829 | + */ |
|
830 | + public $name; |
|
831 | + /** |
|
832 | + * Declare a cursor. |
|
833 | + * See pq\Connection::declare(). |
|
834 | + * |
|
835 | + * @param \pq\Connection $connection The connection on which the cursor should be declared. |
|
836 | + * @param string $name The name of the cursor. |
|
837 | + * @param int $flags See pq\Cursor constants. |
|
838 | + * @param string $query The query for which the cursor should be opened. |
|
839 | + * @param bool $async Whether to declare the cursor [asynchronously](pq/Connection/: Asynchronous Usage). |
|
840 | + * @throws \pq\Exception\InvalidArgumentException |
|
841 | + * @throws \pq\Exception\BadMethodCallException |
|
842 | + * @throws \pq\Exception\RuntimeException |
|
843 | + */ |
|
844 | + public function __construct(pq\Connection $connection, string $name, int $flags, string $query, bool $async) {} |
|
845 | + /** |
|
846 | + * Close an open cursor. |
|
847 | + * This is a no-op on already closed cursors. |
|
848 | + * |
|
849 | + * @throws \pq\Exception\InvalidArgumentException |
|
850 | + * @throws \pq\Exception\BadMethodCallException |
|
851 | + * @throws \pq\Exception\RuntimeException |
|
852 | + */ |
|
853 | + public function close() {} |
|
854 | + /** |
|
855 | + * [Asynchronously](pq/Connection/: Asynchronous Usage) close an open cursor. |
|
856 | + * See pq\Cursor::close(). |
|
857 | + * |
|
858 | + * @throws \pq\Exception\InvalidArgumentException |
|
859 | + * @throws \pq\Exception\BadMethodCallException |
|
860 | + * @throws \pq\Exception\RuntimeException |
|
861 | + */ |
|
862 | + public function closeAsync() {} |
|
863 | + /** |
|
864 | + * Fetch rows from the cursor. |
|
865 | + * See pq\Cursor::move(). |
|
866 | + * |
|
867 | + * @param string $spec What to fetch. |
|
868 | + * |
|
869 | + * ### Fetch argument: |
|
870 | + * |
|
871 | + * FETCH and MOVE usually accepts arguments like the following, where `count` is the number of rows: |
|
872 | + * @throws \pq\Exception\InvalidArgumentException |
|
873 | + * @throws \pq\Exception\BadMethodCallException |
|
874 | + * @throws \pq\Exception\RuntimeException |
|
875 | + * @return \pq\Result the fetched row(s). |
|
876 | + */ |
|
877 | + public function fetch(string $spec = "1") {} |
|
878 | + /** |
|
879 | + * [Asynchronously](pq/Connection/: Asynchronous Usage) fetch rows from the cursor. |
|
880 | + * See pq\Cursor::fetch(). |
|
881 | + * |
|
882 | + * @param string $spec What to fetch. |
|
883 | + * @param callable $callback as function(pq\Result $res) |
|
884 | + * A callback to execute when the result is ready. |
|
885 | + * @throws \pq\Exception\InvalidArgumentException |
|
886 | + * @throws \pq\Exception\BadMethodCallException |
|
887 | + * @throws \pq\Exception\RuntimeException |
|
888 | + */ |
|
889 | + public function fetchAsync(string $spec = "1", callable $callback = null) {} |
|
890 | + /** |
|
891 | + * Move the cursor. |
|
892 | + * See pq\Cursor::fetch(). |
|
893 | + * |
|
894 | + * @param string $spec What to fetch. |
|
895 | + * |
|
896 | + * ### Fetch argument: |
|
897 | + * |
|
898 | + * FETCH and MOVE usually accepts arguments like the following, where `count` is the number of rows: |
|
899 | + * @throws \pq\Exception\InvalidArgumentException |
|
900 | + * @throws \pq\Exception\BadMethodCallException |
|
901 | + * @throws \pq\Exception\RuntimeException |
|
902 | + * @return \pq\Result command status. |
|
903 | + */ |
|
904 | + public function move(string $spec = "1") {} |
|
905 | + /** |
|
906 | + * [Asynchronously](pq/Connection/: Asynchronous Usage) move the cursor. |
|
907 | + * See pq\Cursor::move(). |
|
908 | + * |
|
909 | + * @param string $spec What to fetch. |
|
910 | + * @param callable $callback as function(pq\Result $res) |
|
911 | + * A callback to execute when the command completed. |
|
912 | + * @throws \pq\Exception\InvalidArgumentException |
|
913 | + * @throws \pq\Exception\BadMethodCallException |
|
914 | + * @throws \pq\Exception\RuntimeException |
|
915 | + */ |
|
916 | + public function moveAsync(string $spec = "1", callable $callback = null) {} |
|
917 | + /** |
|
918 | + * Reopen a cursor. |
|
919 | + * This is a no-op on already open cursors. |
|
920 | + * |
|
921 | + * ***NOTE:*** |
|
922 | + * Only cursors closed by pq\Cursor::close() will be reopened. |
|
923 | + * |
|
924 | + * @throws \pq\Exception\InvalidArgumentException |
|
925 | + * @throws \pq\Exception\BadMethodCallException |
|
926 | + * @throws \pq\Exception\RuntimeException |
|
927 | + */ |
|
928 | + public function open() {} |
|
929 | + /** |
|
930 | + * [Asynchronously](pq/Connection/: Asynchronous Usage) reopen a cursor. |
|
931 | + * See pq\Cursor::open(). |
|
932 | + * |
|
933 | + * @throws \pq\Exception\InvalidArgumentException |
|
934 | + * @throws \pq\Exception\BadMethodCallException |
|
935 | + * @throws \pq\Exception\RuntimeException |
|
936 | + */ |
|
937 | + public function openAsync() {} |
|
938 | 938 | } |
939 | 939 | /** |
940 | 940 | * A simple DateTime wrapper with predefined formats which supports stringification and JSON. |
941 | 941 | */ |
942 | 942 | class DateTime extends \DateTime implements \JsonSerializable |
943 | 943 | { |
944 | - /** |
|
945 | - * The default format of any date/time type automatically converted by pq\Result (depends on the actual type of the column). |
|
946 | - * |
|
947 | - * @public |
|
948 | - * @var string |
|
949 | - */ |
|
950 | - public $format = "Y-m-d H:i:s.uO"; |
|
951 | - /** |
|
952 | - * Stringify the DateTime instance according to pq\DateTime::$format. |
|
953 | - * |
|
954 | - * @return string the DateTime as string. |
|
955 | - */ |
|
956 | - public function __toString() {} |
|
957 | - /** |
|
958 | - * Serialize to JSON. |
|
959 | - * Alias of pq\DateTime::__toString(). |
|
960 | - * |
|
961 | - * @return string the DateTime stringified according to pq\DateTime::$format. |
|
962 | - */ |
|
963 | - public function jsonSerialize() {} |
|
944 | + /** |
|
945 | + * The default format of any date/time type automatically converted by pq\Result (depends on the actual type of the column). |
|
946 | + * |
|
947 | + * @public |
|
948 | + * @var string |
|
949 | + */ |
|
950 | + public $format = "Y-m-d H:i:s.uO"; |
|
951 | + /** |
|
952 | + * Stringify the DateTime instance according to pq\DateTime::$format. |
|
953 | + * |
|
954 | + * @return string the DateTime as string. |
|
955 | + */ |
|
956 | + public function __toString() {} |
|
957 | + /** |
|
958 | + * Serialize to JSON. |
|
959 | + * Alias of pq\DateTime::__toString(). |
|
960 | + * |
|
961 | + * @return string the DateTime stringified according to pq\DateTime::$format. |
|
962 | + */ |
|
963 | + public function jsonSerialize() {} |
|
964 | 964 | } |
965 | 965 | /** |
966 | 966 | * A base interface for all pq\Exception classes. |
967 | 967 | */ |
968 | 968 | interface Exception |
969 | 969 | { |
970 | - /** |
|
971 | - * An invalid argument was passed to a method (pq\Exception\InvalidArgumentException). |
|
972 | - */ |
|
973 | - public const INVALID_ARGUMENT = 0; |
|
974 | - /** |
|
975 | - * A runtime exception occurred (pq\Exception\RuntimeException). |
|
976 | - */ |
|
977 | - public const RUNTIME = 1; |
|
978 | - /** |
|
979 | - * The connection failed (pq\Exception\RuntimeException). |
|
980 | - */ |
|
981 | - public const CONNECTION_FAILED = 2; |
|
982 | - /** |
|
983 | - * An input/output exception occurred (pq\Exception\RuntimeException). |
|
984 | - */ |
|
985 | - public const IO = 3; |
|
986 | - /** |
|
987 | - * Escaping an argument or identifier failed internally (pq\Exception\RuntimeException). |
|
988 | - */ |
|
989 | - public const ESCAPE = 4; |
|
990 | - /** |
|
991 | - * An object's constructor was not called (pq\Exception\BadMethodCallException). |
|
992 | - */ |
|
993 | - public const UNINITIALIZED = 6; |
|
994 | - /** |
|
995 | - * Calling this method was not expected (yet) (pq\Exception\BadMethodCallException). |
|
996 | - */ |
|
997 | - public const BAD_METHODCALL = 5; |
|
998 | - /** |
|
999 | - * SQL syntax error (pq\Exception\DomainException). |
|
1000 | - */ |
|
1001 | - public const SQL = 8; |
|
1002 | - /** |
|
1003 | - * Implementation domain error (pq\Exception\DomainException). |
|
1004 | - */ |
|
1005 | - public const DOMAIN = 7; |
|
970 | + /** |
|
971 | + * An invalid argument was passed to a method (pq\Exception\InvalidArgumentException). |
|
972 | + */ |
|
973 | + public const INVALID_ARGUMENT = 0; |
|
974 | + /** |
|
975 | + * A runtime exception occurred (pq\Exception\RuntimeException). |
|
976 | + */ |
|
977 | + public const RUNTIME = 1; |
|
978 | + /** |
|
979 | + * The connection failed (pq\Exception\RuntimeException). |
|
980 | + */ |
|
981 | + public const CONNECTION_FAILED = 2; |
|
982 | + /** |
|
983 | + * An input/output exception occurred (pq\Exception\RuntimeException). |
|
984 | + */ |
|
985 | + public const IO = 3; |
|
986 | + /** |
|
987 | + * Escaping an argument or identifier failed internally (pq\Exception\RuntimeException). |
|
988 | + */ |
|
989 | + public const ESCAPE = 4; |
|
990 | + /** |
|
991 | + * An object's constructor was not called (pq\Exception\BadMethodCallException). |
|
992 | + */ |
|
993 | + public const UNINITIALIZED = 6; |
|
994 | + /** |
|
995 | + * Calling this method was not expected (yet) (pq\Exception\BadMethodCallException). |
|
996 | + */ |
|
997 | + public const BAD_METHODCALL = 5; |
|
998 | + /** |
|
999 | + * SQL syntax error (pq\Exception\DomainException). |
|
1000 | + */ |
|
1001 | + public const SQL = 8; |
|
1002 | + /** |
|
1003 | + * Implementation domain error (pq\Exception\DomainException). |
|
1004 | + */ |
|
1005 | + public const DOMAIN = 7; |
|
1006 | 1006 | } |
1007 | 1007 | /** |
1008 | 1008 | * A *large object*. |
@@ -1012,97 +1012,97 @@ discard block |
||
1012 | 1012 | */ |
1013 | 1013 | class LOB |
1014 | 1014 | { |
1015 | - /** |
|
1016 | - * 0, representing an invalid OID. |
|
1017 | - */ |
|
1018 | - public const INVALID_OID = 0; |
|
1019 | - /** |
|
1020 | - * Read/write mode. |
|
1021 | - */ |
|
1022 | - public const RW = 393216; |
|
1023 | - /** |
|
1024 | - * The transaction wrapping the operations on the *large object*. |
|
1025 | - * |
|
1026 | - * @public |
|
1027 | - * @readonly |
|
1028 | - * @var \pq\Transaction |
|
1029 | - */ |
|
1030 | - public $transaction; |
|
1031 | - /** |
|
1032 | - * The OID of the *large object*. |
|
1033 | - * |
|
1034 | - * @public |
|
1035 | - * @readonly |
|
1036 | - * @var int |
|
1037 | - */ |
|
1038 | - public $oid; |
|
1039 | - /** |
|
1040 | - * The stream connected to the *large object*. |
|
1041 | - * |
|
1042 | - * @public |
|
1043 | - * @readonly |
|
1044 | - * @var resource |
|
1045 | - */ |
|
1046 | - public $stream; |
|
1047 | - /** |
|
1048 | - * Open or create a *large object*. |
|
1049 | - * See pq\Transaction::openLOB() and pq\Transaction::createLOB(). |
|
1050 | - * |
|
1051 | - * @param \pq\Transaction $txn The transaction which wraps the *large object* operations. |
|
1052 | - * @param int $oid The OID of the existing *large object* to open. |
|
1053 | - * @param int $mode Access mode (read, write or read/write). |
|
1054 | - * @throws \pq\Exception\InvalidArgumentException |
|
1055 | - * @throws \pq\Exception\BadMethodCallException |
|
1056 | - * @throws \pq\Exception\RuntimeException |
|
1057 | - */ |
|
1058 | - public function __construct(pq\Transaction $txn, int $oid = \pq\LOB::INVALID_OID, int $mode = \pq\LOB::RW) {} |
|
1059 | - /** |
|
1060 | - * Read a string of data from the current position of the *large object*. |
|
1061 | - * |
|
1062 | - * @param int $length The amount of bytes to read from the *large object*. |
|
1063 | - * @param int &$read The amount of bytes actually read from the *large object*. |
|
1064 | - * @throws \pq\Exception\InvalidArgumentException |
|
1065 | - * @throws \pq\Exception\BadMethodCallException |
|
1066 | - * @throws \pq\Exception\RuntimeException |
|
1067 | - * @return string the data read. |
|
1068 | - */ |
|
1069 | - public function read(int $length = 0x1000, int &$read = null) {} |
|
1070 | - /** |
|
1071 | - * Seek to a position within the *large object*. |
|
1072 | - * |
|
1073 | - * @param int $offset The position to seek to. |
|
1074 | - * @param int $whence From where to seek (SEEK_SET, SEEK_CUR or SEEK_END). |
|
1075 | - * @throws \pq\Exception\InvalidArgumentException |
|
1076 | - * @throws \pq\Exception\BadMethodCallException |
|
1077 | - * @throws \pq\Exception\RuntimeException |
|
1078 | - * @return int the new position. |
|
1079 | - */ |
|
1080 | - public function seek(int $offset, int $whence = SEEK_SET) {} |
|
1081 | - /** |
|
1082 | - * Retrieve the current position within the *large object*. |
|
1083 | - * |
|
1084 | - * @throws \pq\Exception\InvalidArgumentException |
|
1085 | - * @throws \pq\Exception\BadMethodCallException |
|
1086 | - * @throws \pq\Exception\RuntimeException |
|
1087 | - * @return int the current position. |
|
1088 | - */ |
|
1089 | - public function tell() {} |
|
1090 | - /** |
|
1091 | - * Truncate the *large object*. |
|
1092 | - * |
|
1093 | - * @param int $length The length to truncate to. |
|
1094 | - * @throws \pq\Exception\InvalidArgumentException |
|
1095 | - * @throws \pq\Exception\BadMethodCallException |
|
1096 | - * @throws \pq\Exception\RuntimeException |
|
1097 | - */ |
|
1098 | - public function truncate(int $length = 0) {} |
|
1099 | - /** |
|
1100 | - * Write data to the *large object*. |
|
1101 | - * |
|
1102 | - * @param string $data The data that should be written to the current position. |
|
1103 | - * @return int the number of bytes written. |
|
1104 | - */ |
|
1105 | - public function write(string $data) {} |
|
1015 | + /** |
|
1016 | + * 0, representing an invalid OID. |
|
1017 | + */ |
|
1018 | + public const INVALID_OID = 0; |
|
1019 | + /** |
|
1020 | + * Read/write mode. |
|
1021 | + */ |
|
1022 | + public const RW = 393216; |
|
1023 | + /** |
|
1024 | + * The transaction wrapping the operations on the *large object*. |
|
1025 | + * |
|
1026 | + * @public |
|
1027 | + * @readonly |
|
1028 | + * @var \pq\Transaction |
|
1029 | + */ |
|
1030 | + public $transaction; |
|
1031 | + /** |
|
1032 | + * The OID of the *large object*. |
|
1033 | + * |
|
1034 | + * @public |
|
1035 | + * @readonly |
|
1036 | + * @var int |
|
1037 | + */ |
|
1038 | + public $oid; |
|
1039 | + /** |
|
1040 | + * The stream connected to the *large object*. |
|
1041 | + * |
|
1042 | + * @public |
|
1043 | + * @readonly |
|
1044 | + * @var resource |
|
1045 | + */ |
|
1046 | + public $stream; |
|
1047 | + /** |
|
1048 | + * Open or create a *large object*. |
|
1049 | + * See pq\Transaction::openLOB() and pq\Transaction::createLOB(). |
|
1050 | + * |
|
1051 | + * @param \pq\Transaction $txn The transaction which wraps the *large object* operations. |
|
1052 | + * @param int $oid The OID of the existing *large object* to open. |
|
1053 | + * @param int $mode Access mode (read, write or read/write). |
|
1054 | + * @throws \pq\Exception\InvalidArgumentException |
|
1055 | + * @throws \pq\Exception\BadMethodCallException |
|
1056 | + * @throws \pq\Exception\RuntimeException |
|
1057 | + */ |
|
1058 | + public function __construct(pq\Transaction $txn, int $oid = \pq\LOB::INVALID_OID, int $mode = \pq\LOB::RW) {} |
|
1059 | + /** |
|
1060 | + * Read a string of data from the current position of the *large object*. |
|
1061 | + * |
|
1062 | + * @param int $length The amount of bytes to read from the *large object*. |
|
1063 | + * @param int &$read The amount of bytes actually read from the *large object*. |
|
1064 | + * @throws \pq\Exception\InvalidArgumentException |
|
1065 | + * @throws \pq\Exception\BadMethodCallException |
|
1066 | + * @throws \pq\Exception\RuntimeException |
|
1067 | + * @return string the data read. |
|
1068 | + */ |
|
1069 | + public function read(int $length = 0x1000, int &$read = null) {} |
|
1070 | + /** |
|
1071 | + * Seek to a position within the *large object*. |
|
1072 | + * |
|
1073 | + * @param int $offset The position to seek to. |
|
1074 | + * @param int $whence From where to seek (SEEK_SET, SEEK_CUR or SEEK_END). |
|
1075 | + * @throws \pq\Exception\InvalidArgumentException |
|
1076 | + * @throws \pq\Exception\BadMethodCallException |
|
1077 | + * @throws \pq\Exception\RuntimeException |
|
1078 | + * @return int the new position. |
|
1079 | + */ |
|
1080 | + public function seek(int $offset, int $whence = SEEK_SET) {} |
|
1081 | + /** |
|
1082 | + * Retrieve the current position within the *large object*. |
|
1083 | + * |
|
1084 | + * @throws \pq\Exception\InvalidArgumentException |
|
1085 | + * @throws \pq\Exception\BadMethodCallException |
|
1086 | + * @throws \pq\Exception\RuntimeException |
|
1087 | + * @return int the current position. |
|
1088 | + */ |
|
1089 | + public function tell() {} |
|
1090 | + /** |
|
1091 | + * Truncate the *large object*. |
|
1092 | + * |
|
1093 | + * @param int $length The length to truncate to. |
|
1094 | + * @throws \pq\Exception\InvalidArgumentException |
|
1095 | + * @throws \pq\Exception\BadMethodCallException |
|
1096 | + * @throws \pq\Exception\RuntimeException |
|
1097 | + */ |
|
1098 | + public function truncate(int $length = 0) {} |
|
1099 | + /** |
|
1100 | + * Write data to the *large object*. |
|
1101 | + * |
|
1102 | + * @param string $data The data that should be written to the current position. |
|
1103 | + * @return int the number of bytes written. |
|
1104 | + */ |
|
1105 | + public function write(string $data) {} |
|
1106 | 1106 | } |
1107 | 1107 | /** |
1108 | 1108 | * A query result. |
@@ -1111,257 +1111,257 @@ discard block |
||
1111 | 1111 | */ |
1112 | 1112 | class Result implements \Traversable, \Countable |
1113 | 1113 | { |
1114 | - /** |
|
1115 | - * The query sent to the server was empty. |
|
1116 | - */ |
|
1117 | - public const EMPTY_QUERY = 0; |
|
1118 | - /** |
|
1119 | - * The query did not generate a result set and completed successfully. |
|
1120 | - */ |
|
1121 | - public const COMMAND_OK = 1; |
|
1122 | - /** |
|
1123 | - * The query successfully generated a result set. |
|
1124 | - */ |
|
1125 | - public const TUPLES_OK = 2; |
|
1126 | - /** |
|
1127 | - * The result contains a single row of the result set when using pq\Connection::$unbuffered. |
|
1128 | - */ |
|
1129 | - public const SINGLE_TUPLE = 9; |
|
1130 | - /** |
|
1131 | - * COPY data can be received from the server. |
|
1132 | - */ |
|
1133 | - public const COPY_OUT = 3; |
|
1134 | - /** |
|
1135 | - * COPY data can be sent to the server. |
|
1136 | - */ |
|
1137 | - public const COPY_IN = 4; |
|
1138 | - /** |
|
1139 | - * COPY in/out data transfer in progress. |
|
1140 | - */ |
|
1141 | - public const COPY_BOTH = 8; |
|
1142 | - /** |
|
1143 | - * The server sent a bad response. |
|
1144 | - */ |
|
1145 | - public const BAD_RESPONSE = 5; |
|
1146 | - /** |
|
1147 | - * A nonfatal error (notice or warning) occurred. |
|
1148 | - */ |
|
1149 | - public const NONFATAL_ERROR = 6; |
|
1150 | - /** |
|
1151 | - * A fatal error occurred. |
|
1152 | - */ |
|
1153 | - public const FATAL_ERROR = 7; |
|
1154 | - /** |
|
1155 | - * Fetch rows numerically indexed, where the index start with 0. |
|
1156 | - */ |
|
1157 | - public const FETCH_ARRAY = 0; |
|
1158 | - /** |
|
1159 | - * Fetch rows associatively indexed by column name. |
|
1160 | - */ |
|
1161 | - public const FETCH_ASSOC = 1; |
|
1162 | - /** |
|
1163 | - * Fetch rows as stdClass instance, where the column names are the property names. |
|
1164 | - */ |
|
1165 | - public const FETCH_OBJECT = 2; |
|
1166 | - /** |
|
1167 | - * Automatically convert 'f' and 't' to FALSE and TRUE and vice versa. |
|
1168 | - */ |
|
1169 | - public const CONV_BOOL = 1; |
|
1170 | - /** |
|
1171 | - * Automatically convert integral strings to either int if it fits into maximum integer size or else to float and vice versa. |
|
1172 | - */ |
|
1173 | - public const CONV_INT = 2; |
|
1174 | - /** |
|
1175 | - * Automatically convert floating point numbers. |
|
1176 | - */ |
|
1177 | - public const CONV_FLOAT = 4; |
|
1178 | - /** |
|
1179 | - * Do all scalar conversions listed above. |
|
1180 | - */ |
|
1181 | - public const CONV_SCALAR = 15; |
|
1182 | - /** |
|
1183 | - * Automatically convert arrays. |
|
1184 | - */ |
|
1185 | - public const CONV_ARRAY = 16; |
|
1186 | - /** |
|
1187 | - * Automatically convert date strings to pq\DateTime and vice versa. |
|
1188 | - */ |
|
1189 | - public const CONV_DATETIME = 32; |
|
1190 | - /** |
|
1191 | - * Automatically convert JSON. |
|
1192 | - */ |
|
1193 | - public const CONV_JSON = 256; |
|
1194 | - /** |
|
1195 | - * Do all of the above. |
|
1196 | - */ |
|
1197 | - public const CONV_ALL = 65535; |
|
1198 | - /** |
|
1199 | - * A [status constant](pq/Result#Status.values:). |
|
1200 | - * |
|
1201 | - * @public |
|
1202 | - * @readonly |
|
1203 | - * @var int |
|
1204 | - */ |
|
1205 | - public $status; |
|
1206 | - /** |
|
1207 | - * The accompanying status message. |
|
1208 | - * |
|
1209 | - * @public |
|
1210 | - * @readonly |
|
1211 | - * @var string |
|
1212 | - */ |
|
1213 | - public $statusMessage; |
|
1214 | - /** |
|
1215 | - * Any error message if $status indicates an error. |
|
1216 | - * |
|
1217 | - * @public |
|
1218 | - * @readonly |
|
1219 | - * @var string |
|
1220 | - */ |
|
1221 | - public $errorMessage; |
|
1222 | - /** |
|
1223 | - * The number of rows in the result set. |
|
1224 | - * |
|
1225 | - * @public |
|
1226 | - * @readonly |
|
1227 | - * @var int |
|
1228 | - */ |
|
1229 | - public $numRows; |
|
1230 | - /** |
|
1231 | - * The number of fields in a single tuple of the result set. |
|
1232 | - * |
|
1233 | - * @public |
|
1234 | - * @readonly |
|
1235 | - * @var int |
|
1236 | - */ |
|
1237 | - public $numCols; |
|
1238 | - /** |
|
1239 | - * The number of rows affected by a statement. |
|
1240 | - * |
|
1241 | - * @public |
|
1242 | - * @readonly |
|
1243 | - * @var int |
|
1244 | - */ |
|
1245 | - public $affectedRows; |
|
1246 | - /** |
|
1247 | - * Error details. See [PQresultErrorField](https://www.postgresql.org/docs/current/static/libpq-exec.html#LIBPQ-PQRESULTERRORFIELD) docs. |
|
1248 | - * |
|
1249 | - * @public |
|
1250 | - * @readonly |
|
1251 | - * @var array |
|
1252 | - */ |
|
1253 | - public $diag; |
|
1254 | - /** |
|
1255 | - * The [type of return value](pq/Result#Fetch.types:) the fetch methods should return when no fetch type argument was given. Defaults to pq\Connection::$defaultFetchType. |
|
1256 | - * |
|
1257 | - * @public |
|
1258 | - * @var int |
|
1259 | - */ |
|
1260 | - public $fetchType = \pq\Result::FETCH_ARRAY; |
|
1261 | - /** |
|
1262 | - * What [type of conversions](pq/Result#Conversion.bits:) to perform automatically. |
|
1263 | - * |
|
1264 | - * @public |
|
1265 | - * @var int |
|
1266 | - */ |
|
1267 | - public $autoConvert = \pq\Result::CONV_ALL; |
|
1268 | - /** |
|
1269 | - * Bind a variable to a result column. |
|
1270 | - * See pq\Result::fetchBound(). |
|
1271 | - * |
|
1272 | - * @param mixed $col The column name or index to bind to. |
|
1273 | - * @param mixed $var The variable reference. |
|
1274 | - * @throws \pq\Exception\InvalidArgumentException |
|
1275 | - * @throws \pq\Exception\BadMethodCallException |
|
1276 | - * @return bool success. |
|
1277 | - */ |
|
1278 | - public function bind($col, $var) {} |
|
1279 | - /** |
|
1280 | - * Count number of rows in this result set. |
|
1281 | - * |
|
1282 | - * @throws \pq\Exception\InvalidArgumentException |
|
1283 | - * @throws \pq\Exception\BadMethodCallException |
|
1284 | - * @return int the number of rows. |
|
1285 | - */ |
|
1286 | - public function count() {} |
|
1287 | - /** |
|
1288 | - * Describe a prepared statement. |
|
1289 | - * |
|
1290 | - * ***NOTE:*** |
|
1291 | - * This will only return meaningful information for a result of pq\Statement::desc(). |
|
1292 | - * |
|
1293 | - * @throws \pq\Exception\InvalidArgumentException |
|
1294 | - * @throws \pq\Exception\BadMethodCallException |
|
1295 | - * @return array list of parameter type OIDs for the prepared statement. |
|
1296 | - */ |
|
1297 | - public function desc() {} |
|
1298 | - /** |
|
1299 | - * Fetch all rows at once. |
|
1300 | - * |
|
1301 | - * @param int $fetch_type The type the return value should have, see pq\Result::FETCH_* constants, defaults to pq\Result::$fetchType. |
|
1302 | - * @throws \pq\Exception\InvalidArgumentException |
|
1303 | - * @throws \pq\Exception\BadMethodCallException |
|
1304 | - * @return array all fetched rows. |
|
1305 | - */ |
|
1306 | - public function fetchAll(int $fetch_type = null) {} |
|
1307 | - /** |
|
1308 | - * Fetch all rows of a single column. |
|
1309 | - * |
|
1310 | - * @param int $col The column name or index to fetch. |
|
1311 | - * @throws \pq\Exception\InvalidArgumentException |
|
1312 | - * @throws \pq\Exception\BadMethodCallException |
|
1313 | - * @throws \pq\Exception\RuntimeException |
|
1314 | - * @return array list of column values. |
|
1315 | - */ |
|
1316 | - public function fetchAllCols(int $col = 0) {} |
|
1317 | - /** |
|
1318 | - * Iteratively fetch a row into bound variables. |
|
1319 | - * See pq\Result::bind(). |
|
1320 | - * |
|
1321 | - * @throws \pq\Exception\InvalidArgumentException |
|
1322 | - * @throws \pq\Exception\BadMethodCallException |
|
1323 | - * @throws \pq\Exception\RuntimeException |
|
1324 | - * @return array|null array the fetched row as numerically indexed array. |
|
1325 | - * or NULL when iteration ends. |
|
1326 | - */ |
|
1327 | - public function fetchBound() {} |
|
1328 | - /** |
|
1329 | - * Iteratively fetch a single column. |
|
1330 | - * |
|
1331 | - * @param mixed $ref The variable where the column value will be stored in. |
|
1332 | - * @param mixed $col The column name or index. |
|
1333 | - * @throws \pq\Exception\InvalidArgumentException |
|
1334 | - * @throws \pq\Exception\BadMethodCallException |
|
1335 | - * @throws \pq\Exception\RuntimeException |
|
1336 | - * @return bool|null bool success. |
|
1337 | - * or NULL when iteration ends. |
|
1338 | - */ |
|
1339 | - public function fetchCol($ref, $col = 0) {} |
|
1340 | - /** |
|
1341 | - * Iteratively fetch a row. |
|
1342 | - * |
|
1343 | - * @param int $fetch_type The type the return value should have, see pq\Result::FETCH_* constants, defaults to pq\Result::$fetchType. |
|
1344 | - * @throws \pq\Exception\InvalidArgumentException |
|
1345 | - * @throws \pq\Exception\BadMethodCallException |
|
1346 | - * @throws \pq\Exception\RuntimeException |
|
1347 | - * @return array|array|object|null array numerically indexed for pq\Result::FETCH_ARRAY |
|
1348 | - * or array associatively indexed for pq\Result::FETCH_ASSOC |
|
1349 | - * or object stdClass instance for pq\Result::FETCH_OBJECT |
|
1350 | - * or NULL when iteration ends. |
|
1351 | - */ |
|
1352 | - public function fetchRow(int $fetch_type = null) {} |
|
1353 | - /** |
|
1354 | - * Fetch the complete result set as a simple map, a *multi dimensional array*, each dimension indexed by a column. |
|
1355 | - * |
|
1356 | - * @param mixed $keys The the column indices/names used to index the map. |
|
1357 | - * @param mixed $vals The column indices/names which should build up the leaf entry of the map. |
|
1358 | - * @param int $fetch_type The type the return value should have, see pq\Result::FETCH_* constants, defaults to pq\Result::$fetchType. |
|
1359 | - * @throws \pq\Exception\InvalidArgumentException |
|
1360 | - * @throws \pq\Exception\BadMethodCallException |
|
1361 | - * @throws \pq\Exception\RuntimeException |
|
1362 | - * @return array |object, the mapped columns. |
|
1363 | - */ |
|
1364 | - public function map($keys = 0, $vals = null, int $fetch_type = null) {} |
|
1114 | + /** |
|
1115 | + * The query sent to the server was empty. |
|
1116 | + */ |
|
1117 | + public const EMPTY_QUERY = 0; |
|
1118 | + /** |
|
1119 | + * The query did not generate a result set and completed successfully. |
|
1120 | + */ |
|
1121 | + public const COMMAND_OK = 1; |
|
1122 | + /** |
|
1123 | + * The query successfully generated a result set. |
|
1124 | + */ |
|
1125 | + public const TUPLES_OK = 2; |
|
1126 | + /** |
|
1127 | + * The result contains a single row of the result set when using pq\Connection::$unbuffered. |
|
1128 | + */ |
|
1129 | + public const SINGLE_TUPLE = 9; |
|
1130 | + /** |
|
1131 | + * COPY data can be received from the server. |
|
1132 | + */ |
|
1133 | + public const COPY_OUT = 3; |
|
1134 | + /** |
|
1135 | + * COPY data can be sent to the server. |
|
1136 | + */ |
|
1137 | + public const COPY_IN = 4; |
|
1138 | + /** |
|
1139 | + * COPY in/out data transfer in progress. |
|
1140 | + */ |
|
1141 | + public const COPY_BOTH = 8; |
|
1142 | + /** |
|
1143 | + * The server sent a bad response. |
|
1144 | + */ |
|
1145 | + public const BAD_RESPONSE = 5; |
|
1146 | + /** |
|
1147 | + * A nonfatal error (notice or warning) occurred. |
|
1148 | + */ |
|
1149 | + public const NONFATAL_ERROR = 6; |
|
1150 | + /** |
|
1151 | + * A fatal error occurred. |
|
1152 | + */ |
|
1153 | + public const FATAL_ERROR = 7; |
|
1154 | + /** |
|
1155 | + * Fetch rows numerically indexed, where the index start with 0. |
|
1156 | + */ |
|
1157 | + public const FETCH_ARRAY = 0; |
|
1158 | + /** |
|
1159 | + * Fetch rows associatively indexed by column name. |
|
1160 | + */ |
|
1161 | + public const FETCH_ASSOC = 1; |
|
1162 | + /** |
|
1163 | + * Fetch rows as stdClass instance, where the column names are the property names. |
|
1164 | + */ |
|
1165 | + public const FETCH_OBJECT = 2; |
|
1166 | + /** |
|
1167 | + * Automatically convert 'f' and 't' to FALSE and TRUE and vice versa. |
|
1168 | + */ |
|
1169 | + public const CONV_BOOL = 1; |
|
1170 | + /** |
|
1171 | + * Automatically convert integral strings to either int if it fits into maximum integer size or else to float and vice versa. |
|
1172 | + */ |
|
1173 | + public const CONV_INT = 2; |
|
1174 | + /** |
|
1175 | + * Automatically convert floating point numbers. |
|
1176 | + */ |
|
1177 | + public const CONV_FLOAT = 4; |
|
1178 | + /** |
|
1179 | + * Do all scalar conversions listed above. |
|
1180 | + */ |
|
1181 | + public const CONV_SCALAR = 15; |
|
1182 | + /** |
|
1183 | + * Automatically convert arrays. |
|
1184 | + */ |
|
1185 | + public const CONV_ARRAY = 16; |
|
1186 | + /** |
|
1187 | + * Automatically convert date strings to pq\DateTime and vice versa. |
|
1188 | + */ |
|
1189 | + public const CONV_DATETIME = 32; |
|
1190 | + /** |
|
1191 | + * Automatically convert JSON. |
|
1192 | + */ |
|
1193 | + public const CONV_JSON = 256; |
|
1194 | + /** |
|
1195 | + * Do all of the above. |
|
1196 | + */ |
|
1197 | + public const CONV_ALL = 65535; |
|
1198 | + /** |
|
1199 | + * A [status constant](pq/Result#Status.values:). |
|
1200 | + * |
|
1201 | + * @public |
|
1202 | + * @readonly |
|
1203 | + * @var int |
|
1204 | + */ |
|
1205 | + public $status; |
|
1206 | + /** |
|
1207 | + * The accompanying status message. |
|
1208 | + * |
|
1209 | + * @public |
|
1210 | + * @readonly |
|
1211 | + * @var string |
|
1212 | + */ |
|
1213 | + public $statusMessage; |
|
1214 | + /** |
|
1215 | + * Any error message if $status indicates an error. |
|
1216 | + * |
|
1217 | + * @public |
|
1218 | + * @readonly |
|
1219 | + * @var string |
|
1220 | + */ |
|
1221 | + public $errorMessage; |
|
1222 | + /** |
|
1223 | + * The number of rows in the result set. |
|
1224 | + * |
|
1225 | + * @public |
|
1226 | + * @readonly |
|
1227 | + * @var int |
|
1228 | + */ |
|
1229 | + public $numRows; |
|
1230 | + /** |
|
1231 | + * The number of fields in a single tuple of the result set. |
|
1232 | + * |
|
1233 | + * @public |
|
1234 | + * @readonly |
|
1235 | + * @var int |
|
1236 | + */ |
|
1237 | + public $numCols; |
|
1238 | + /** |
|
1239 | + * The number of rows affected by a statement. |
|
1240 | + * |
|
1241 | + * @public |
|
1242 | + * @readonly |
|
1243 | + * @var int |
|
1244 | + */ |
|
1245 | + public $affectedRows; |
|
1246 | + /** |
|
1247 | + * Error details. See [PQresultErrorField](https://www.postgresql.org/docs/current/static/libpq-exec.html#LIBPQ-PQRESULTERRORFIELD) docs. |
|
1248 | + * |
|
1249 | + * @public |
|
1250 | + * @readonly |
|
1251 | + * @var array |
|
1252 | + */ |
|
1253 | + public $diag; |
|
1254 | + /** |
|
1255 | + * The [type of return value](pq/Result#Fetch.types:) the fetch methods should return when no fetch type argument was given. Defaults to pq\Connection::$defaultFetchType. |
|
1256 | + * |
|
1257 | + * @public |
|
1258 | + * @var int |
|
1259 | + */ |
|
1260 | + public $fetchType = \pq\Result::FETCH_ARRAY; |
|
1261 | + /** |
|
1262 | + * What [type of conversions](pq/Result#Conversion.bits:) to perform automatically. |
|
1263 | + * |
|
1264 | + * @public |
|
1265 | + * @var int |
|
1266 | + */ |
|
1267 | + public $autoConvert = \pq\Result::CONV_ALL; |
|
1268 | + /** |
|
1269 | + * Bind a variable to a result column. |
|
1270 | + * See pq\Result::fetchBound(). |
|
1271 | + * |
|
1272 | + * @param mixed $col The column name or index to bind to. |
|
1273 | + * @param mixed $var The variable reference. |
|
1274 | + * @throws \pq\Exception\InvalidArgumentException |
|
1275 | + * @throws \pq\Exception\BadMethodCallException |
|
1276 | + * @return bool success. |
|
1277 | + */ |
|
1278 | + public function bind($col, $var) {} |
|
1279 | + /** |
|
1280 | + * Count number of rows in this result set. |
|
1281 | + * |
|
1282 | + * @throws \pq\Exception\InvalidArgumentException |
|
1283 | + * @throws \pq\Exception\BadMethodCallException |
|
1284 | + * @return int the number of rows. |
|
1285 | + */ |
|
1286 | + public function count() {} |
|
1287 | + /** |
|
1288 | + * Describe a prepared statement. |
|
1289 | + * |
|
1290 | + * ***NOTE:*** |
|
1291 | + * This will only return meaningful information for a result of pq\Statement::desc(). |
|
1292 | + * |
|
1293 | + * @throws \pq\Exception\InvalidArgumentException |
|
1294 | + * @throws \pq\Exception\BadMethodCallException |
|
1295 | + * @return array list of parameter type OIDs for the prepared statement. |
|
1296 | + */ |
|
1297 | + public function desc() {} |
|
1298 | + /** |
|
1299 | + * Fetch all rows at once. |
|
1300 | + * |
|
1301 | + * @param int $fetch_type The type the return value should have, see pq\Result::FETCH_* constants, defaults to pq\Result::$fetchType. |
|
1302 | + * @throws \pq\Exception\InvalidArgumentException |
|
1303 | + * @throws \pq\Exception\BadMethodCallException |
|
1304 | + * @return array all fetched rows. |
|
1305 | + */ |
|
1306 | + public function fetchAll(int $fetch_type = null) {} |
|
1307 | + /** |
|
1308 | + * Fetch all rows of a single column. |
|
1309 | + * |
|
1310 | + * @param int $col The column name or index to fetch. |
|
1311 | + * @throws \pq\Exception\InvalidArgumentException |
|
1312 | + * @throws \pq\Exception\BadMethodCallException |
|
1313 | + * @throws \pq\Exception\RuntimeException |
|
1314 | + * @return array list of column values. |
|
1315 | + */ |
|
1316 | + public function fetchAllCols(int $col = 0) {} |
|
1317 | + /** |
|
1318 | + * Iteratively fetch a row into bound variables. |
|
1319 | + * See pq\Result::bind(). |
|
1320 | + * |
|
1321 | + * @throws \pq\Exception\InvalidArgumentException |
|
1322 | + * @throws \pq\Exception\BadMethodCallException |
|
1323 | + * @throws \pq\Exception\RuntimeException |
|
1324 | + * @return array|null array the fetched row as numerically indexed array. |
|
1325 | + * or NULL when iteration ends. |
|
1326 | + */ |
|
1327 | + public function fetchBound() {} |
|
1328 | + /** |
|
1329 | + * Iteratively fetch a single column. |
|
1330 | + * |
|
1331 | + * @param mixed $ref The variable where the column value will be stored in. |
|
1332 | + * @param mixed $col The column name or index. |
|
1333 | + * @throws \pq\Exception\InvalidArgumentException |
|
1334 | + * @throws \pq\Exception\BadMethodCallException |
|
1335 | + * @throws \pq\Exception\RuntimeException |
|
1336 | + * @return bool|null bool success. |
|
1337 | + * or NULL when iteration ends. |
|
1338 | + */ |
|
1339 | + public function fetchCol($ref, $col = 0) {} |
|
1340 | + /** |
|
1341 | + * Iteratively fetch a row. |
|
1342 | + * |
|
1343 | + * @param int $fetch_type The type the return value should have, see pq\Result::FETCH_* constants, defaults to pq\Result::$fetchType. |
|
1344 | + * @throws \pq\Exception\InvalidArgumentException |
|
1345 | + * @throws \pq\Exception\BadMethodCallException |
|
1346 | + * @throws \pq\Exception\RuntimeException |
|
1347 | + * @return array|array|object|null array numerically indexed for pq\Result::FETCH_ARRAY |
|
1348 | + * or array associatively indexed for pq\Result::FETCH_ASSOC |
|
1349 | + * or object stdClass instance for pq\Result::FETCH_OBJECT |
|
1350 | + * or NULL when iteration ends. |
|
1351 | + */ |
|
1352 | + public function fetchRow(int $fetch_type = null) {} |
|
1353 | + /** |
|
1354 | + * Fetch the complete result set as a simple map, a *multi dimensional array*, each dimension indexed by a column. |
|
1355 | + * |
|
1356 | + * @param mixed $keys The the column indices/names used to index the map. |
|
1357 | + * @param mixed $vals The column indices/names which should build up the leaf entry of the map. |
|
1358 | + * @param int $fetch_type The type the return value should have, see pq\Result::FETCH_* constants, defaults to pq\Result::$fetchType. |
|
1359 | + * @throws \pq\Exception\InvalidArgumentException |
|
1360 | + * @throws \pq\Exception\BadMethodCallException |
|
1361 | + * @throws \pq\Exception\RuntimeException |
|
1362 | + * @return array |object, the mapped columns. |
|
1363 | + */ |
|
1364 | + public function map($keys = 0, $vals = null, int $fetch_type = null) {} |
|
1365 | 1365 | } |
1366 | 1366 | /** |
1367 | 1367 | * A named prepared statement. |
@@ -1369,140 +1369,140 @@ discard block |
||
1369 | 1369 | */ |
1370 | 1370 | class Statement |
1371 | 1371 | { |
1372 | - /** |
|
1373 | - * The connection to the server. |
|
1374 | - * |
|
1375 | - * @public |
|
1376 | - * @readonly |
|
1377 | - * @var \pq\Connection |
|
1378 | - */ |
|
1379 | - public $connection; |
|
1380 | - /** |
|
1381 | - * The identifiying name of the prepared statement. |
|
1382 | - * |
|
1383 | - * @public |
|
1384 | - * @readonly |
|
1385 | - * @var string |
|
1386 | - */ |
|
1387 | - public $name; |
|
1388 | - /** |
|
1389 | - * The query string used to prepare the statement. |
|
1390 | - * |
|
1391 | - * @public |
|
1392 | - * @readonly |
|
1393 | - * @var string |
|
1394 | - */ |
|
1395 | - public $query; |
|
1396 | - /** |
|
1397 | - * List of corresponding query parameter type OIDs for the prepared statement. |
|
1398 | - * |
|
1399 | - * @public |
|
1400 | - * @readonly |
|
1401 | - * @var array |
|
1402 | - */ |
|
1403 | - public $types; |
|
1404 | - /** |
|
1405 | - * Prepare a new statement. |
|
1406 | - * See pq\Connection::prepare(). |
|
1407 | - * |
|
1408 | - * @param \pq\Connection $conn The connection to prepare the statement on. |
|
1409 | - * @param string $name The name identifying this statement. |
|
1410 | - * @param string $query The actual query to prepare. |
|
1411 | - * @param array $types A list of corresponding query parameter type OIDs. |
|
1412 | - * @param bool $async Whether to prepare the statement [asynchronously](pq/Connection/: Asynchronous Usage). |
|
1413 | - * @throws \pq\Exception\InvalidArgumentException |
|
1414 | - * @throws \pq\Exception\BadMethodCallException |
|
1415 | - * @throws \pq\Exception\RuntimeException |
|
1416 | - * @throws \pq\Exception\DomainException |
|
1417 | - */ |
|
1418 | - public function __construct(pq\Connection $conn, string $name, string $query, array $types = null, bool $async = false) {} |
|
1419 | - /** |
|
1420 | - * Bind a variable to an input parameter. |
|
1421 | - * |
|
1422 | - * @param int $param_no The parameter index to bind to. |
|
1423 | - * @param mixed &$param_ref The variable to bind. |
|
1424 | - * @throws \pq\Exception\InvalidArgumentException |
|
1425 | - * @throws \pq\Exception\BadMethodCallException |
|
1426 | - */ |
|
1427 | - public function bind(int $param_no, &$param_ref) {} |
|
1428 | - /** |
|
1429 | - * Free the server resources used by the prepared statement, so it can no longer be executed. |
|
1430 | - * This is done implicitly when the object is destroyed. |
|
1431 | - * |
|
1432 | - * @throws \pq\Exception\InvalidArgumentException |
|
1433 | - * @throws \pq\Exception\BadMethodCallException |
|
1434 | - * @throws \pq\Exception\RuntimeException |
|
1435 | - */ |
|
1436 | - public function deallocate() {} |
|
1437 | - /** |
|
1438 | - * [Asynchronously](pq/Connection/: Asynchronous Usage) free the server resources used by the |
|
1439 | - * prepared statement, so it can no longer be executed. |
|
1440 | - * |
|
1441 | - * @throws \pq\Exception\InvalidArgumentException |
|
1442 | - * @throws \pq\Exception\BadMethodCallException |
|
1443 | - * @throws \pq\Exception\RuntimeException |
|
1444 | - */ |
|
1445 | - public function deallocateAsync() {} |
|
1446 | - /** |
|
1447 | - * Describe the parameters of the prepared statement. |
|
1448 | - * |
|
1449 | - * @throws \pq\Exception\InvalidArgumentException |
|
1450 | - * @throws \pq\Exception\BadMethodCallException |
|
1451 | - * @throws \pq\Exception\RuntimeException |
|
1452 | - * @throws \pq\Exception\DomainException |
|
1453 | - * @return array list of type OIDs of the substitution parameters. |
|
1454 | - */ |
|
1455 | - public function desc() {} |
|
1456 | - /** |
|
1457 | - * [Asynchronously](pq/Connection/: Asynchronous Usage) describe the parameters of the prepared statement. |
|
1458 | - * |
|
1459 | - * @param callable $callback as function(array $oids) |
|
1460 | - * A callback to receive list of type OIDs of the substitution parameters. |
|
1461 | - * @throws \pq\Exception\InvalidArgumentException |
|
1462 | - * @throws \pq\Exception\BadMethodCallException |
|
1463 | - * @throws \pq\Exception\RuntimeException |
|
1464 | - */ |
|
1465 | - public function descAsync(callable $callback) {} |
|
1466 | - /** |
|
1467 | - * Execute the prepared statement. |
|
1468 | - * |
|
1469 | - * @param array $params Any parameters to substitute in the prepared statement (defaults to any bou |
|
1470 | - * nd variables). |
|
1471 | - * @throws \pq\Exception\InvalidArgumentException |
|
1472 | - * @throws \pq\Exception\BadMethodCallException |
|
1473 | - * @throws \pq\Exception\RuntimeException |
|
1474 | - * @return \pq\Result the result of the execution of the prepared statement. |
|
1475 | - */ |
|
1476 | - public function exec(array $params = null) {} |
|
1477 | - /** |
|
1478 | - * [Asynchronously](pq/Connection/: Asynchronous Usage) execute the prepared statement. |
|
1479 | - * |
|
1480 | - * @param array $params Any parameters to substitute in the prepared statement (defaults to any bou |
|
1481 | - * nd variables). |
|
1482 | - * @param callable $cb as function(\pq\Result $res) : void |
|
1483 | - * Result handler callback. |
|
1484 | - * @throws \pq\Exception\InvalidArgumentException |
|
1485 | - * @throws \pq\Exception\BadMethodCallException |
|
1486 | - * @throws \pq\Exception\RuntimeException |
|
1487 | - */ |
|
1488 | - public function execAsync(array $params = null, callable $cb = null) {} |
|
1489 | - /** |
|
1490 | - * Re-prepare a statement that has been deallocated. This is a no-op on already open statements. |
|
1491 | - * |
|
1492 | - * @throws \pq\Exception\InvalidArgumentException |
|
1493 | - * @throws \pq\Exception\BadMethodCallException |
|
1494 | - * @throws \pq\Exception\RuntimeException |
|
1495 | - */ |
|
1496 | - public function prepare() {} |
|
1497 | - /** |
|
1498 | - * [Asynchronously](pq/Connection/: Asynchronous Usage) re-prepare a statement that has been |
|
1499 | - * deallocated. This is a no-op on already open statements. |
|
1500 | - * |
|
1501 | - * @throws \pq\Exception\InvalidArgumentException |
|
1502 | - * @throws \pq\Exception\BadMethodCallException |
|
1503 | - * @throws \pq\Exception\RuntimeException |
|
1504 | - */ |
|
1505 | - public function prepareAsync() {} |
|
1372 | + /** |
|
1373 | + * The connection to the server. |
|
1374 | + * |
|
1375 | + * @public |
|
1376 | + * @readonly |
|
1377 | + * @var \pq\Connection |
|
1378 | + */ |
|
1379 | + public $connection; |
|
1380 | + /** |
|
1381 | + * The identifiying name of the prepared statement. |
|
1382 | + * |
|
1383 | + * @public |
|
1384 | + * @readonly |
|
1385 | + * @var string |
|
1386 | + */ |
|
1387 | + public $name; |
|
1388 | + /** |
|
1389 | + * The query string used to prepare the statement. |
|
1390 | + * |
|
1391 | + * @public |
|
1392 | + * @readonly |
|
1393 | + * @var string |
|
1394 | + */ |
|
1395 | + public $query; |
|
1396 | + /** |
|
1397 | + * List of corresponding query parameter type OIDs for the prepared statement. |
|
1398 | + * |
|
1399 | + * @public |
|
1400 | + * @readonly |
|
1401 | + * @var array |
|
1402 | + */ |
|
1403 | + public $types; |
|
1404 | + /** |
|
1405 | + * Prepare a new statement. |
|
1406 | + * See pq\Connection::prepare(). |
|
1407 | + * |
|
1408 | + * @param \pq\Connection $conn The connection to prepare the statement on. |
|
1409 | + * @param string $name The name identifying this statement. |
|
1410 | + * @param string $query The actual query to prepare. |
|
1411 | + * @param array $types A list of corresponding query parameter type OIDs. |
|
1412 | + * @param bool $async Whether to prepare the statement [asynchronously](pq/Connection/: Asynchronous Usage). |
|
1413 | + * @throws \pq\Exception\InvalidArgumentException |
|
1414 | + * @throws \pq\Exception\BadMethodCallException |
|
1415 | + * @throws \pq\Exception\RuntimeException |
|
1416 | + * @throws \pq\Exception\DomainException |
|
1417 | + */ |
|
1418 | + public function __construct(pq\Connection $conn, string $name, string $query, array $types = null, bool $async = false) {} |
|
1419 | + /** |
|
1420 | + * Bind a variable to an input parameter. |
|
1421 | + * |
|
1422 | + * @param int $param_no The parameter index to bind to. |
|
1423 | + * @param mixed &$param_ref The variable to bind. |
|
1424 | + * @throws \pq\Exception\InvalidArgumentException |
|
1425 | + * @throws \pq\Exception\BadMethodCallException |
|
1426 | + */ |
|
1427 | + public function bind(int $param_no, &$param_ref) {} |
|
1428 | + /** |
|
1429 | + * Free the server resources used by the prepared statement, so it can no longer be executed. |
|
1430 | + * This is done implicitly when the object is destroyed. |
|
1431 | + * |
|
1432 | + * @throws \pq\Exception\InvalidArgumentException |
|
1433 | + * @throws \pq\Exception\BadMethodCallException |
|
1434 | + * @throws \pq\Exception\RuntimeException |
|
1435 | + */ |
|
1436 | + public function deallocate() {} |
|
1437 | + /** |
|
1438 | + * [Asynchronously](pq/Connection/: Asynchronous Usage) free the server resources used by the |
|
1439 | + * prepared statement, so it can no longer be executed. |
|
1440 | + * |
|
1441 | + * @throws \pq\Exception\InvalidArgumentException |
|
1442 | + * @throws \pq\Exception\BadMethodCallException |
|
1443 | + * @throws \pq\Exception\RuntimeException |
|
1444 | + */ |
|
1445 | + public function deallocateAsync() {} |
|
1446 | + /** |
|
1447 | + * Describe the parameters of the prepared statement. |
|
1448 | + * |
|
1449 | + * @throws \pq\Exception\InvalidArgumentException |
|
1450 | + * @throws \pq\Exception\BadMethodCallException |
|
1451 | + * @throws \pq\Exception\RuntimeException |
|
1452 | + * @throws \pq\Exception\DomainException |
|
1453 | + * @return array list of type OIDs of the substitution parameters. |
|
1454 | + */ |
|
1455 | + public function desc() {} |
|
1456 | + /** |
|
1457 | + * [Asynchronously](pq/Connection/: Asynchronous Usage) describe the parameters of the prepared statement. |
|
1458 | + * |
|
1459 | + * @param callable $callback as function(array $oids) |
|
1460 | + * A callback to receive list of type OIDs of the substitution parameters. |
|
1461 | + * @throws \pq\Exception\InvalidArgumentException |
|
1462 | + * @throws \pq\Exception\BadMethodCallException |
|
1463 | + * @throws \pq\Exception\RuntimeException |
|
1464 | + */ |
|
1465 | + public function descAsync(callable $callback) {} |
|
1466 | + /** |
|
1467 | + * Execute the prepared statement. |
|
1468 | + * |
|
1469 | + * @param array $params Any parameters to substitute in the prepared statement (defaults to any bou |
|
1470 | + * nd variables). |
|
1471 | + * @throws \pq\Exception\InvalidArgumentException |
|
1472 | + * @throws \pq\Exception\BadMethodCallException |
|
1473 | + * @throws \pq\Exception\RuntimeException |
|
1474 | + * @return \pq\Result the result of the execution of the prepared statement. |
|
1475 | + */ |
|
1476 | + public function exec(array $params = null) {} |
|
1477 | + /** |
|
1478 | + * [Asynchronously](pq/Connection/: Asynchronous Usage) execute the prepared statement. |
|
1479 | + * |
|
1480 | + * @param array $params Any parameters to substitute in the prepared statement (defaults to any bou |
|
1481 | + * nd variables). |
|
1482 | + * @param callable $cb as function(\pq\Result $res) : void |
|
1483 | + * Result handler callback. |
|
1484 | + * @throws \pq\Exception\InvalidArgumentException |
|
1485 | + * @throws \pq\Exception\BadMethodCallException |
|
1486 | + * @throws \pq\Exception\RuntimeException |
|
1487 | + */ |
|
1488 | + public function execAsync(array $params = null, callable $cb = null) {} |
|
1489 | + /** |
|
1490 | + * Re-prepare a statement that has been deallocated. This is a no-op on already open statements. |
|
1491 | + * |
|
1492 | + * @throws \pq\Exception\InvalidArgumentException |
|
1493 | + * @throws \pq\Exception\BadMethodCallException |
|
1494 | + * @throws \pq\Exception\RuntimeException |
|
1495 | + */ |
|
1496 | + public function prepare() {} |
|
1497 | + /** |
|
1498 | + * [Asynchronously](pq/Connection/: Asynchronous Usage) re-prepare a statement that has been |
|
1499 | + * deallocated. This is a no-op on already open statements. |
|
1500 | + * |
|
1501 | + * @throws \pq\Exception\InvalidArgumentException |
|
1502 | + * @throws \pq\Exception\BadMethodCallException |
|
1503 | + * @throws \pq\Exception\RuntimeException |
|
1504 | + */ |
|
1505 | + public function prepareAsync() {} |
|
1506 | 1506 | } |
1507 | 1507 | /** |
1508 | 1508 | * A database transaction. |
@@ -1512,222 +1512,222 @@ discard block |
||
1512 | 1512 | */ |
1513 | 1513 | class Transaction |
1514 | 1514 | { |
1515 | - /** |
|
1516 | - * Transaction isolation level where only rows committed before the transaction began can be seen. |
|
1517 | - */ |
|
1518 | - public const READ_COMMITTED = 0; |
|
1519 | - /** |
|
1520 | - * Transaction isolation level where only rows committed before the first query was executed in this transaction. |
|
1521 | - */ |
|
1522 | - public const REPEATABLE_READ = 1; |
|
1523 | - /** |
|
1524 | - * Transaction isolation level that guarantees serializable repeatability which might lead to serialization_failure on high concurrency. |
|
1525 | - */ |
|
1526 | - public const SERIALIZABLE = 2; |
|
1527 | - /** |
|
1528 | - * The connection the transaction was started on. |
|
1529 | - * |
|
1530 | - * @public |
|
1531 | - * @readonly |
|
1532 | - * @var \pq\Connection |
|
1533 | - */ |
|
1534 | - public $connection; |
|
1535 | - /** |
|
1536 | - * The transaction isolation level. |
|
1537 | - * |
|
1538 | - * @public |
|
1539 | - * @var int |
|
1540 | - */ |
|
1541 | - public $isolation = \pq\Transaction::READ_COMMITTED; |
|
1542 | - /** |
|
1543 | - * Whether this transaction performs read only queries. |
|
1544 | - * |
|
1545 | - * @public |
|
1546 | - * @var bool |
|
1547 | - */ |
|
1548 | - public $readonly = false; |
|
1549 | - /** |
|
1550 | - * Whether the transaction is deferrable. See pq\Connection::startTransaction(). |
|
1551 | - * |
|
1552 | - * @public |
|
1553 | - * @var bool |
|
1554 | - */ |
|
1555 | - public $deferrable = false; |
|
1556 | - /** |
|
1557 | - * Start a transaction. |
|
1558 | - * See pq\Connection::startTransaction(). |
|
1559 | - * |
|
1560 | - * @param \pq\Connection $conn The connection to start the transaction on. |
|
1561 | - * @param bool $async Whether to start the transaction [asynchronously](pq/Connection/: Asynchronous Usage). |
|
1562 | - * @param int $isolation The transaction isolation level (defaults to pq\Connection::$defaultTransactionIsolation). |
|
1563 | - * @param bool $readonly Whether the transaction is readonly (defaults to pq\Connection::$defaultTransactionReadonly). |
|
1564 | - * @param bool $deferrable Whether the transaction is deferrable (defaults to pq\Connection::$defaultTransactionDeferrable). |
|
1565 | - * @throws \pq\Exception\InvalidArgumentException |
|
1566 | - * @throws \pq\Exception\BadMethodCallException |
|
1567 | - * @throws \pq\Exception\RuntimeException |
|
1568 | - */ |
|
1569 | - public function __construct(pq\Connection $conn, bool $async = false, int $isolation = \pq\Transaction::READ_COMMITTED, bool $readonly = false, bool $deferrable = false) {} |
|
1570 | - /** |
|
1571 | - * Commit the transaction or release the previous savepoint. |
|
1572 | - * See pq\Transaction::savepoint(). |
|
1573 | - * |
|
1574 | - * @throws \pq\Exception\InvalidArgumentException |
|
1575 | - * @throws \pq\Exception\BadMethodCallException |
|
1576 | - * @throws \pq\Exception\RuntimeException |
|
1577 | - * @throws \pq\Exception\DomainException |
|
1578 | - */ |
|
1579 | - public function commit() {} |
|
1580 | - /** |
|
1581 | - * [Asynchronously](pq/Connection/: Asynchronous Usage) commit the transaction or release the previous savepoint. |
|
1582 | - * See pq\Transaction::commit() and pq\Transaction::savepoint(). |
|
1583 | - * |
|
1584 | - * @throws \pq\Exception\InvalidArgumentException |
|
1585 | - * @throws \pq\Exception\BadMethodCallException |
|
1586 | - * @throws \pq\Exception\RuntimeException |
|
1587 | - */ |
|
1588 | - public function commitAsync() {} |
|
1589 | - /** |
|
1590 | - * Create a new *large object* and open it. |
|
1591 | - * See pq\Transaction::openLOB(). |
|
1592 | - * |
|
1593 | - * @param int $mode How to open the *large object* (read, write or both; see pq\LOB constants). |
|
1594 | - * @throws \pq\Exception\InvalidArgumentException |
|
1595 | - * @throws \pq\Exception\BadMethodCallException |
|
1596 | - * @throws \pq\Exception\RuntimeException |
|
1597 | - * @return \pq\LOB instance of the new *large object*. |
|
1598 | - */ |
|
1599 | - public function createLOB(int $mode = \pq\LOB::RW) {} |
|
1600 | - /** |
|
1601 | - * Export a *large object* to a local file. |
|
1602 | - * See pq\Transaction::importLOB(). |
|
1603 | - * |
|
1604 | - * @param int $oid The OID of the *large object*. |
|
1605 | - * @param string $path The path of a local file to export to. |
|
1606 | - * @throws \pq\Exception\InvalidArgumentException |
|
1607 | - * @throws \pq\Exception\BadMethodCallException |
|
1608 | - * @throws \pq\Exception\RuntimeException |
|
1609 | - */ |
|
1610 | - public function exportLOB(int $oid, string $path) {} |
|
1611 | - /** |
|
1612 | - * Export a snapshot for transaction synchronization. |
|
1613 | - * See pq\Transaction::importSnapshot(). |
|
1614 | - * |
|
1615 | - * @throws \pq\Exception\InvalidArgumentException |
|
1616 | - * @throws \pq\Exception\BadMethodCallException |
|
1617 | - * @throws \pq\Exception\RuntimeException |
|
1618 | - * @throws \pq\Exception\DomainException |
|
1619 | - * @return string the snapshot identifier usable with pq\Transaction::importSnapshot(). |
|
1620 | - */ |
|
1621 | - public function exportSnapshot() {} |
|
1622 | - /** |
|
1623 | - * [Asynchronously](pq/Connection/: Asynchronous Usage) export a snapshot for transaction synchronization. |
|
1624 | - * See pq\Transaction::exportSnapshot(). |
|
1625 | - * |
|
1626 | - * @throws \pq\Exception\InvalidArgumentException |
|
1627 | - * @throws \pq\Exception\BadMethodCallException |
|
1628 | - * @throws \pq\Exception\RuntimeException |
|
1629 | - */ |
|
1630 | - public function exportSnapshotAsync() {} |
|
1631 | - /** |
|
1632 | - * Import a local file into a *large object*. |
|
1633 | - * |
|
1634 | - * @param string $local_path A path to a local file to import. |
|
1635 | - * @param int $oid The target OID. A new *large object* will be created if INVALID_OID. |
|
1636 | - * @throws \pq\Exception\InvalidArgumentException |
|
1637 | - * @throws \pq\Exception\BadMethodCallException |
|
1638 | - * @throws \pq\Exception\RuntimeException |
|
1639 | - * @return int the (new) OID of the *large object*. |
|
1640 | - */ |
|
1641 | - public function importLOB(string $local_path, int $oid = \pq\LOB::INVALID_OID) {} |
|
1642 | - /** |
|
1643 | - * Import a snapshot from another transaction to synchronize with. |
|
1644 | - * See pq\Transaction::exportSnapshot(). |
|
1645 | - * |
|
1646 | - * ***NOTE:*** |
|
1647 | - * The transaction must have an isolation level of at least pq\Transaction::REPEATABLE_READ. |
|
1648 | - * |
|
1649 | - * @param string $snapshot_id The snapshot identifier obtained by exporting a snapshot from a transaction. |
|
1650 | - * @throws \pq\Exception\InvalidArgumentException |
|
1651 | - * @throws \pq\Exception\BadMethodCallException |
|
1652 | - * @throws \pq\Exception\RuntimeException |
|
1653 | - * @throws \pq\Exception\DomainException |
|
1654 | - */ |
|
1655 | - public function importSnapshot(string $snapshot_id) {} |
|
1656 | - /** |
|
1657 | - * [Asynchronously](pq/Connection/: Asynchronous Usage) import a snapshot from another transaction to synchronize with. |
|
1658 | - * See pq\Transaction::importSnapshot(). |
|
1659 | - * |
|
1660 | - * ***NOTE:*** |
|
1661 | - * The transaction must have an isolation level of at least pq\Transaction::REPEATABLE_READ. |
|
1662 | - * |
|
1663 | - * @param string $snapshot_id The snapshot identifier obtained by exporting a snapshot from a transaction. |
|
1664 | - * @throws \pq\Exception\InvalidArgumentException |
|
1665 | - * @throws \pq\Exception\BadMethodCallException |
|
1666 | - * @throws \pq\Exception\RuntimeException |
|
1667 | - */ |
|
1668 | - public function importSnapshotAsync(string $snapshot_id) {} |
|
1669 | - /** |
|
1670 | - * Open a *large object*. |
|
1671 | - * See pq\Transaction::createLOB(). |
|
1672 | - * |
|
1673 | - * @param int $oid The OID of the *large object*. |
|
1674 | - * @param int $mode Operational mode; read, write or both. |
|
1675 | - * @throws \pq\Exception\InvalidArgumentException |
|
1676 | - * @throws \pq\Exception\BadMethodCallException |
|
1677 | - * @throws \pq\Exception\RuntimeException |
|
1678 | - * @return \pq\LOB instance of the opened *large object*. |
|
1679 | - */ |
|
1680 | - public function openLOB(int $oid, int $mode = \pq\LOB::RW) {} |
|
1681 | - /** |
|
1682 | - * Rollback the transaction or to the previous savepoint within this transaction. |
|
1683 | - * See pq\Transaction::commit() and pq\Transaction::savepoint(). |
|
1684 | - * |
|
1685 | - * @throws \pq\Exception\InvalidArgumentException |
|
1686 | - * @throws \pq\Exception\BadMethodCallException |
|
1687 | - * @throws \pq\Exception\RuntimeException |
|
1688 | - * @throws \pq\Exception\DomainException |
|
1689 | - */ |
|
1690 | - public function rollback() {} |
|
1691 | - /** |
|
1692 | - * [Asynchronously](pq/Connection/: Asynchronous Usage) rollback the transaction or to the previous savepoint within this transaction. |
|
1693 | - * See pq\Transaction::rollback() and pq\Transaction::savepoint(). |
|
1694 | - * |
|
1695 | - * @throws \pq\Exception\InvalidArgumentException |
|
1696 | - * @throws \pq\Exception\BadMethodCallException |
|
1697 | - * @throws \pq\Exception\RuntimeException |
|
1698 | - */ |
|
1699 | - public function rollbackAsync() {} |
|
1700 | - /** |
|
1701 | - * Create a `SAVEPOINT` within this transaction. |
|
1702 | - * |
|
1703 | - * ***NOTE:*** |
|
1704 | - * pq\Transaction tracks an internal counter as savepoint identifier. |
|
1705 | - * |
|
1706 | - * @throws \pq\Exception\InvalidArgumentException |
|
1707 | - * @throws \pq\Exception\BadMethodCallException |
|
1708 | - * @throws \pq\Exception\RuntimeException |
|
1709 | - */ |
|
1710 | - public function savepoint() {} |
|
1711 | - /** |
|
1712 | - * [Asynchronously](pq/Connection/: Asynchronous Usage) create a `SAVEPOINT` within this transaction. |
|
1713 | - * See pq\Transaction::savepoint(). |
|
1714 | - * |
|
1715 | - * @throws \pq\Exception\InvalidArgumentException |
|
1716 | - * @throws \pq\Exception\BadMethodCallException |
|
1717 | - * @throws \pq\Exception\RuntimeException |
|
1718 | - */ |
|
1719 | - public function savepointAsync() {} |
|
1720 | - /** |
|
1721 | - * Unlink a *large object*. |
|
1722 | - * See pq\Transaction::createLOB(). |
|
1723 | - * |
|
1724 | - * @param int $oid The OID of the *large object*. |
|
1725 | - * @throws \pq\Exception\InvalidArgumentException |
|
1726 | - * @throws \pq\Exception\BadMethodCallException |
|
1727 | - * @throws \pq\Exception\RuntimeException |
|
1728 | - * @return \pq\LOB instance of the opened *large object*. |
|
1729 | - */ |
|
1730 | - public function unlinkLOB(int $oid) {} |
|
1515 | + /** |
|
1516 | + * Transaction isolation level where only rows committed before the transaction began can be seen. |
|
1517 | + */ |
|
1518 | + public const READ_COMMITTED = 0; |
|
1519 | + /** |
|
1520 | + * Transaction isolation level where only rows committed before the first query was executed in this transaction. |
|
1521 | + */ |
|
1522 | + public const REPEATABLE_READ = 1; |
|
1523 | + /** |
|
1524 | + * Transaction isolation level that guarantees serializable repeatability which might lead to serialization_failure on high concurrency. |
|
1525 | + */ |
|
1526 | + public const SERIALIZABLE = 2; |
|
1527 | + /** |
|
1528 | + * The connection the transaction was started on. |
|
1529 | + * |
|
1530 | + * @public |
|
1531 | + * @readonly |
|
1532 | + * @var \pq\Connection |
|
1533 | + */ |
|
1534 | + public $connection; |
|
1535 | + /** |
|
1536 | + * The transaction isolation level. |
|
1537 | + * |
|
1538 | + * @public |
|
1539 | + * @var int |
|
1540 | + */ |
|
1541 | + public $isolation = \pq\Transaction::READ_COMMITTED; |
|
1542 | + /** |
|
1543 | + * Whether this transaction performs read only queries. |
|
1544 | + * |
|
1545 | + * @public |
|
1546 | + * @var bool |
|
1547 | + */ |
|
1548 | + public $readonly = false; |
|
1549 | + /** |
|
1550 | + * Whether the transaction is deferrable. See pq\Connection::startTransaction(). |
|
1551 | + * |
|
1552 | + * @public |
|
1553 | + * @var bool |
|
1554 | + */ |
|
1555 | + public $deferrable = false; |
|
1556 | + /** |
|
1557 | + * Start a transaction. |
|
1558 | + * See pq\Connection::startTransaction(). |
|
1559 | + * |
|
1560 | + * @param \pq\Connection $conn The connection to start the transaction on. |
|
1561 | + * @param bool $async Whether to start the transaction [asynchronously](pq/Connection/: Asynchronous Usage). |
|
1562 | + * @param int $isolation The transaction isolation level (defaults to pq\Connection::$defaultTransactionIsolation). |
|
1563 | + * @param bool $readonly Whether the transaction is readonly (defaults to pq\Connection::$defaultTransactionReadonly). |
|
1564 | + * @param bool $deferrable Whether the transaction is deferrable (defaults to pq\Connection::$defaultTransactionDeferrable). |
|
1565 | + * @throws \pq\Exception\InvalidArgumentException |
|
1566 | + * @throws \pq\Exception\BadMethodCallException |
|
1567 | + * @throws \pq\Exception\RuntimeException |
|
1568 | + */ |
|
1569 | + public function __construct(pq\Connection $conn, bool $async = false, int $isolation = \pq\Transaction::READ_COMMITTED, bool $readonly = false, bool $deferrable = false) {} |
|
1570 | + /** |
|
1571 | + * Commit the transaction or release the previous savepoint. |
|
1572 | + * See pq\Transaction::savepoint(). |
|
1573 | + * |
|
1574 | + * @throws \pq\Exception\InvalidArgumentException |
|
1575 | + * @throws \pq\Exception\BadMethodCallException |
|
1576 | + * @throws \pq\Exception\RuntimeException |
|
1577 | + * @throws \pq\Exception\DomainException |
|
1578 | + */ |
|
1579 | + public function commit() {} |
|
1580 | + /** |
|
1581 | + * [Asynchronously](pq/Connection/: Asynchronous Usage) commit the transaction or release the previous savepoint. |
|
1582 | + * See pq\Transaction::commit() and pq\Transaction::savepoint(). |
|
1583 | + * |
|
1584 | + * @throws \pq\Exception\InvalidArgumentException |
|
1585 | + * @throws \pq\Exception\BadMethodCallException |
|
1586 | + * @throws \pq\Exception\RuntimeException |
|
1587 | + */ |
|
1588 | + public function commitAsync() {} |
|
1589 | + /** |
|
1590 | + * Create a new *large object* and open it. |
|
1591 | + * See pq\Transaction::openLOB(). |
|
1592 | + * |
|
1593 | + * @param int $mode How to open the *large object* (read, write or both; see pq\LOB constants). |
|
1594 | + * @throws \pq\Exception\InvalidArgumentException |
|
1595 | + * @throws \pq\Exception\BadMethodCallException |
|
1596 | + * @throws \pq\Exception\RuntimeException |
|
1597 | + * @return \pq\LOB instance of the new *large object*. |
|
1598 | + */ |
|
1599 | + public function createLOB(int $mode = \pq\LOB::RW) {} |
|
1600 | + /** |
|
1601 | + * Export a *large object* to a local file. |
|
1602 | + * See pq\Transaction::importLOB(). |
|
1603 | + * |
|
1604 | + * @param int $oid The OID of the *large object*. |
|
1605 | + * @param string $path The path of a local file to export to. |
|
1606 | + * @throws \pq\Exception\InvalidArgumentException |
|
1607 | + * @throws \pq\Exception\BadMethodCallException |
|
1608 | + * @throws \pq\Exception\RuntimeException |
|
1609 | + */ |
|
1610 | + public function exportLOB(int $oid, string $path) {} |
|
1611 | + /** |
|
1612 | + * Export a snapshot for transaction synchronization. |
|
1613 | + * See pq\Transaction::importSnapshot(). |
|
1614 | + * |
|
1615 | + * @throws \pq\Exception\InvalidArgumentException |
|
1616 | + * @throws \pq\Exception\BadMethodCallException |
|
1617 | + * @throws \pq\Exception\RuntimeException |
|
1618 | + * @throws \pq\Exception\DomainException |
|
1619 | + * @return string the snapshot identifier usable with pq\Transaction::importSnapshot(). |
|
1620 | + */ |
|
1621 | + public function exportSnapshot() {} |
|
1622 | + /** |
|
1623 | + * [Asynchronously](pq/Connection/: Asynchronous Usage) export a snapshot for transaction synchronization. |
|
1624 | + * See pq\Transaction::exportSnapshot(). |
|
1625 | + * |
|
1626 | + * @throws \pq\Exception\InvalidArgumentException |
|
1627 | + * @throws \pq\Exception\BadMethodCallException |
|
1628 | + * @throws \pq\Exception\RuntimeException |
|
1629 | + */ |
|
1630 | + public function exportSnapshotAsync() {} |
|
1631 | + /** |
|
1632 | + * Import a local file into a *large object*. |
|
1633 | + * |
|
1634 | + * @param string $local_path A path to a local file to import. |
|
1635 | + * @param int $oid The target OID. A new *large object* will be created if INVALID_OID. |
|
1636 | + * @throws \pq\Exception\InvalidArgumentException |
|
1637 | + * @throws \pq\Exception\BadMethodCallException |
|
1638 | + * @throws \pq\Exception\RuntimeException |
|
1639 | + * @return int the (new) OID of the *large object*. |
|
1640 | + */ |
|
1641 | + public function importLOB(string $local_path, int $oid = \pq\LOB::INVALID_OID) {} |
|
1642 | + /** |
|
1643 | + * Import a snapshot from another transaction to synchronize with. |
|
1644 | + * See pq\Transaction::exportSnapshot(). |
|
1645 | + * |
|
1646 | + * ***NOTE:*** |
|
1647 | + * The transaction must have an isolation level of at least pq\Transaction::REPEATABLE_READ. |
|
1648 | + * |
|
1649 | + * @param string $snapshot_id The snapshot identifier obtained by exporting a snapshot from a transaction. |
|
1650 | + * @throws \pq\Exception\InvalidArgumentException |
|
1651 | + * @throws \pq\Exception\BadMethodCallException |
|
1652 | + * @throws \pq\Exception\RuntimeException |
|
1653 | + * @throws \pq\Exception\DomainException |
|
1654 | + */ |
|
1655 | + public function importSnapshot(string $snapshot_id) {} |
|
1656 | + /** |
|
1657 | + * [Asynchronously](pq/Connection/: Asynchronous Usage) import a snapshot from another transaction to synchronize with. |
|
1658 | + * See pq\Transaction::importSnapshot(). |
|
1659 | + * |
|
1660 | + * ***NOTE:*** |
|
1661 | + * The transaction must have an isolation level of at least pq\Transaction::REPEATABLE_READ. |
|
1662 | + * |
|
1663 | + * @param string $snapshot_id The snapshot identifier obtained by exporting a snapshot from a transaction. |
|
1664 | + * @throws \pq\Exception\InvalidArgumentException |
|
1665 | + * @throws \pq\Exception\BadMethodCallException |
|
1666 | + * @throws \pq\Exception\RuntimeException |
|
1667 | + */ |
|
1668 | + public function importSnapshotAsync(string $snapshot_id) {} |
|
1669 | + /** |
|
1670 | + * Open a *large object*. |
|
1671 | + * See pq\Transaction::createLOB(). |
|
1672 | + * |
|
1673 | + * @param int $oid The OID of the *large object*. |
|
1674 | + * @param int $mode Operational mode; read, write or both. |
|
1675 | + * @throws \pq\Exception\InvalidArgumentException |
|
1676 | + * @throws \pq\Exception\BadMethodCallException |
|
1677 | + * @throws \pq\Exception\RuntimeException |
|
1678 | + * @return \pq\LOB instance of the opened *large object*. |
|
1679 | + */ |
|
1680 | + public function openLOB(int $oid, int $mode = \pq\LOB::RW) {} |
|
1681 | + /** |
|
1682 | + * Rollback the transaction or to the previous savepoint within this transaction. |
|
1683 | + * See pq\Transaction::commit() and pq\Transaction::savepoint(). |
|
1684 | + * |
|
1685 | + * @throws \pq\Exception\InvalidArgumentException |
|
1686 | + * @throws \pq\Exception\BadMethodCallException |
|
1687 | + * @throws \pq\Exception\RuntimeException |
|
1688 | + * @throws \pq\Exception\DomainException |
|
1689 | + */ |
|
1690 | + public function rollback() {} |
|
1691 | + /** |
|
1692 | + * [Asynchronously](pq/Connection/: Asynchronous Usage) rollback the transaction or to the previous savepoint within this transaction. |
|
1693 | + * See pq\Transaction::rollback() and pq\Transaction::savepoint(). |
|
1694 | + * |
|
1695 | + * @throws \pq\Exception\InvalidArgumentException |
|
1696 | + * @throws \pq\Exception\BadMethodCallException |
|
1697 | + * @throws \pq\Exception\RuntimeException |
|
1698 | + */ |
|
1699 | + public function rollbackAsync() {} |
|
1700 | + /** |
|
1701 | + * Create a `SAVEPOINT` within this transaction. |
|
1702 | + * |
|
1703 | + * ***NOTE:*** |
|
1704 | + * pq\Transaction tracks an internal counter as savepoint identifier. |
|
1705 | + * |
|
1706 | + * @throws \pq\Exception\InvalidArgumentException |
|
1707 | + * @throws \pq\Exception\BadMethodCallException |
|
1708 | + * @throws \pq\Exception\RuntimeException |
|
1709 | + */ |
|
1710 | + public function savepoint() {} |
|
1711 | + /** |
|
1712 | + * [Asynchronously](pq/Connection/: Asynchronous Usage) create a `SAVEPOINT` within this transaction. |
|
1713 | + * See pq\Transaction::savepoint(). |
|
1714 | + * |
|
1715 | + * @throws \pq\Exception\InvalidArgumentException |
|
1716 | + * @throws \pq\Exception\BadMethodCallException |
|
1717 | + * @throws \pq\Exception\RuntimeException |
|
1718 | + */ |
|
1719 | + public function savepointAsync() {} |
|
1720 | + /** |
|
1721 | + * Unlink a *large object*. |
|
1722 | + * See pq\Transaction::createLOB(). |
|
1723 | + * |
|
1724 | + * @param int $oid The OID of the *large object*. |
|
1725 | + * @throws \pq\Exception\InvalidArgumentException |
|
1726 | + * @throws \pq\Exception\BadMethodCallException |
|
1727 | + * @throws \pq\Exception\RuntimeException |
|
1728 | + * @return \pq\LOB instance of the opened *large object*. |
|
1729 | + */ |
|
1730 | + public function unlinkLOB(int $oid) {} |
|
1731 | 1731 | } |
1732 | 1732 | /** |
1733 | 1733 | * Accessor to the PostgreSQL `pg_type` relation. |
@@ -1735,641 +1735,641 @@ discard block |
||
1735 | 1735 | */ |
1736 | 1736 | class Types implements \ArrayAccess |
1737 | 1737 | { |
1738 | - /** |
|
1739 | - * OID of the `bool` type. |
|
1740 | - */ |
|
1741 | - public const BOOL = 16; |
|
1742 | - /** |
|
1743 | - * OID of the `bytea` type. |
|
1744 | - */ |
|
1745 | - public const BYTEA = 17; |
|
1746 | - /** |
|
1747 | - * OID of the `char` type. |
|
1748 | - */ |
|
1749 | - public const CHAR = 18; |
|
1750 | - /** |
|
1751 | - * OID of the `name` type. |
|
1752 | - */ |
|
1753 | - public const NAME = 19; |
|
1754 | - /** |
|
1755 | - * OID of the `int8` type. |
|
1756 | - */ |
|
1757 | - public const INT8 = 20; |
|
1758 | - /** |
|
1759 | - * OID of the `int2` type. |
|
1760 | - */ |
|
1761 | - public const INT2 = 21; |
|
1762 | - /** |
|
1763 | - * OID of the `int2vector` type. |
|
1764 | - */ |
|
1765 | - public const INT2VECTOR = 22; |
|
1766 | - /** |
|
1767 | - * OID of the `int4` type. |
|
1768 | - */ |
|
1769 | - public const INT4 = 23; |
|
1770 | - /** |
|
1771 | - * OID of the `regproc` type. |
|
1772 | - */ |
|
1773 | - public const REGPROC = 24; |
|
1774 | - /** |
|
1775 | - * OID of the `text` type. |
|
1776 | - */ |
|
1777 | - public const TEXT = 25; |
|
1778 | - /** |
|
1779 | - * OID of the `oid` type. |
|
1780 | - */ |
|
1781 | - public const OID = 26; |
|
1782 | - /** |
|
1783 | - * OID of the `tid` type. |
|
1784 | - */ |
|
1785 | - public const TID = 27; |
|
1786 | - /** |
|
1787 | - * OID of the `xid` type. |
|
1788 | - */ |
|
1789 | - public const XID = 28; |
|
1790 | - /** |
|
1791 | - * OID of the `cid` type. |
|
1792 | - */ |
|
1793 | - public const CID = 29; |
|
1794 | - /** |
|
1795 | - * OID of the `oidvector` type. |
|
1796 | - */ |
|
1797 | - public const OIDVECTOR = 30; |
|
1798 | - /** |
|
1799 | - * OID of the `pg_type` type. |
|
1800 | - */ |
|
1801 | - public const PG_TYPE = 71; |
|
1802 | - /** |
|
1803 | - * OID of the `pg_attribute` type. |
|
1804 | - */ |
|
1805 | - public const PG_ATTRIBUTE = 75; |
|
1806 | - /** |
|
1807 | - * OID of the `pg_proc` type. |
|
1808 | - */ |
|
1809 | - public const PG_PROC = 81; |
|
1810 | - /** |
|
1811 | - * OID of the `pg_class` type. |
|
1812 | - */ |
|
1813 | - public const PG_CLASS = 83; |
|
1814 | - /** |
|
1815 | - * OID of the `json` type. |
|
1816 | - */ |
|
1817 | - public const JSON = 114; |
|
1818 | - /** |
|
1819 | - * OID of the `xml` type. |
|
1820 | - */ |
|
1821 | - public const XML = 142; |
|
1822 | - /** |
|
1823 | - * OID of the `xmlarray` type. |
|
1824 | - */ |
|
1825 | - public const XMLARRAY = 143; |
|
1826 | - /** |
|
1827 | - * OID of the `jsonarray` type. |
|
1828 | - */ |
|
1829 | - public const JSONARRAY = 199; |
|
1830 | - /** |
|
1831 | - * OID of the `pg_node_tree` type. |
|
1832 | - */ |
|
1833 | - public const PG_NODE_TREE = 194; |
|
1834 | - /** |
|
1835 | - * OID of the `smgr` type. |
|
1836 | - */ |
|
1837 | - public const SMGR = 210; |
|
1838 | - /** |
|
1839 | - * OID of the `point` type. |
|
1840 | - */ |
|
1841 | - public const POINT = 600; |
|
1842 | - /** |
|
1843 | - * OID of the `lseg` type. |
|
1844 | - */ |
|
1845 | - public const LSEG = 601; |
|
1846 | - /** |
|
1847 | - * OID of the `path` type. |
|
1848 | - */ |
|
1849 | - public const PATH = 602; |
|
1850 | - /** |
|
1851 | - * OID of the `box` type. |
|
1852 | - */ |
|
1853 | - public const BOX = 603; |
|
1854 | - /** |
|
1855 | - * OID of the `polygon` type. |
|
1856 | - */ |
|
1857 | - public const POLYGON = 604; |
|
1858 | - /** |
|
1859 | - * OID of the `line` type. |
|
1860 | - */ |
|
1861 | - public const LINE = 628; |
|
1862 | - /** |
|
1863 | - * OID of the `linearray` type. |
|
1864 | - */ |
|
1865 | - public const LINEARRAY = 629; |
|
1866 | - /** |
|
1867 | - * OID of the `float4` type. |
|
1868 | - */ |
|
1869 | - public const FLOAT4 = 700; |
|
1870 | - /** |
|
1871 | - * OID of the `float8` type. |
|
1872 | - */ |
|
1873 | - public const FLOAT8 = 701; |
|
1874 | - /** |
|
1875 | - * OID of the `abstime` type. |
|
1876 | - */ |
|
1877 | - public const ABSTIME = 702; |
|
1878 | - /** |
|
1879 | - * OID of the `reltime` type. |
|
1880 | - */ |
|
1881 | - public const RELTIME = 703; |
|
1882 | - /** |
|
1883 | - * OID of the `tinterval` type. |
|
1884 | - */ |
|
1885 | - public const TINTERVAL = 704; |
|
1886 | - /** |
|
1887 | - * OID of the `unknown` type. |
|
1888 | - */ |
|
1889 | - public const UNKNOWN = 705; |
|
1890 | - /** |
|
1891 | - * OID of the `circle` type. |
|
1892 | - */ |
|
1893 | - public const CIRCLE = 718; |
|
1894 | - /** |
|
1895 | - * OID of the `circlearray` type. |
|
1896 | - */ |
|
1897 | - public const CIRCLEARRAY = 719; |
|
1898 | - /** |
|
1899 | - * OID of the `money` type. |
|
1900 | - */ |
|
1901 | - public const MONEY = 790; |
|
1902 | - /** |
|
1903 | - * OID of the `moneyarray` type. |
|
1904 | - */ |
|
1905 | - public const MONEYARRAY = 791; |
|
1906 | - /** |
|
1907 | - * OID of the `macaddr` type. |
|
1908 | - */ |
|
1909 | - public const MACADDR = 829; |
|
1910 | - /** |
|
1911 | - * OID of the `inet` type. |
|
1912 | - */ |
|
1913 | - public const INET = 869; |
|
1914 | - /** |
|
1915 | - * OID of the `cidr` type. |
|
1916 | - */ |
|
1917 | - public const CIDR = 650; |
|
1918 | - /** |
|
1919 | - * OID of the `boolarray` type. |
|
1920 | - */ |
|
1921 | - public const BOOLARRAY = 1000; |
|
1922 | - /** |
|
1923 | - * OID of the `byteaarray` type. |
|
1924 | - */ |
|
1925 | - public const BYTEAARRAY = 1001; |
|
1926 | - /** |
|
1927 | - * OID of the `chararray` type. |
|
1928 | - */ |
|
1929 | - public const CHARARRAY = 1002; |
|
1930 | - /** |
|
1931 | - * OID of the `namearray` type. |
|
1932 | - */ |
|
1933 | - public const NAMEARRAY = 1003; |
|
1934 | - /** |
|
1935 | - * OID of the `int2array` type. |
|
1936 | - */ |
|
1937 | - public const INT2ARRAY = 1005; |
|
1938 | - /** |
|
1939 | - * OID of the `int2vectorarray` type. |
|
1940 | - */ |
|
1941 | - public const INT2VECTORARRAY = 1006; |
|
1942 | - /** |
|
1943 | - * OID of the `int4array` type. |
|
1944 | - */ |
|
1945 | - public const INT4ARRAY = 1007; |
|
1946 | - /** |
|
1947 | - * OID of the `regprocarray` type. |
|
1948 | - */ |
|
1949 | - public const REGPROCARRAY = 1008; |
|
1950 | - /** |
|
1951 | - * OID of the `textarray` type. |
|
1952 | - */ |
|
1953 | - public const TEXTARRAY = 1009; |
|
1954 | - /** |
|
1955 | - * OID of the `oidarray` type. |
|
1956 | - */ |
|
1957 | - public const OIDARRAY = 1028; |
|
1958 | - /** |
|
1959 | - * OID of the `tidarray` type. |
|
1960 | - */ |
|
1961 | - public const TIDARRAY = 1010; |
|
1962 | - /** |
|
1963 | - * OID of the `xidarray` type. |
|
1964 | - */ |
|
1965 | - public const XIDARRAY = 1011; |
|
1966 | - /** |
|
1967 | - * OID of the `cidarray` type. |
|
1968 | - */ |
|
1969 | - public const CIDARRAY = 1012; |
|
1970 | - /** |
|
1971 | - * OID of the `oidvectorarray` type. |
|
1972 | - */ |
|
1973 | - public const OIDVECTORARRAY = 1013; |
|
1974 | - /** |
|
1975 | - * OID of the `bpchararray` type. |
|
1976 | - */ |
|
1977 | - public const BPCHARARRAY = 1014; |
|
1978 | - /** |
|
1979 | - * OID of the `varchararray` type. |
|
1980 | - */ |
|
1981 | - public const VARCHARARRAY = 1015; |
|
1982 | - /** |
|
1983 | - * OID of the `int8array` type. |
|
1984 | - */ |
|
1985 | - public const INT8ARRAY = 1016; |
|
1986 | - /** |
|
1987 | - * OID of the `pointarray` type. |
|
1988 | - */ |
|
1989 | - public const POINTARRAY = 1017; |
|
1990 | - /** |
|
1991 | - * OID of the `lsegarray` type. |
|
1992 | - */ |
|
1993 | - public const LSEGARRAY = 1018; |
|
1994 | - /** |
|
1995 | - * OID of the `patharray` type. |
|
1996 | - */ |
|
1997 | - public const PATHARRAY = 1019; |
|
1998 | - /** |
|
1999 | - * OID of the `boxarray` type. |
|
2000 | - */ |
|
2001 | - public const BOXARRAY = 1020; |
|
2002 | - /** |
|
2003 | - * OID of the `float4array` type. |
|
2004 | - */ |
|
2005 | - public const FLOAT4ARRAY = 1021; |
|
2006 | - /** |
|
2007 | - * OID of the `float8array` type. |
|
2008 | - */ |
|
2009 | - public const FLOAT8ARRAY = 1022; |
|
2010 | - /** |
|
2011 | - * OID of the `abstimearray` type. |
|
2012 | - */ |
|
2013 | - public const ABSTIMEARRAY = 1023; |
|
2014 | - /** |
|
2015 | - * OID of the `reltimearray` type. |
|
2016 | - */ |
|
2017 | - public const RELTIMEARRAY = 1024; |
|
2018 | - /** |
|
2019 | - * OID of the `tintervalarray` type. |
|
2020 | - */ |
|
2021 | - public const TINTERVALARRAY = 1025; |
|
2022 | - /** |
|
2023 | - * OID of the `polygonarray` type. |
|
2024 | - */ |
|
2025 | - public const POLYGONARRAY = 1027; |
|
2026 | - /** |
|
2027 | - * OID of the `aclitem` type. |
|
2028 | - */ |
|
2029 | - public const ACLITEM = 1033; |
|
2030 | - /** |
|
2031 | - * OID of the `aclitemarray` type. |
|
2032 | - */ |
|
2033 | - public const ACLITEMARRAY = 1034; |
|
2034 | - /** |
|
2035 | - * OID of the `macaddrarray` type. |
|
2036 | - */ |
|
2037 | - public const MACADDRARRAY = 1040; |
|
2038 | - /** |
|
2039 | - * OID of the `inetarray` type. |
|
2040 | - */ |
|
2041 | - public const INETARRAY = 1041; |
|
2042 | - /** |
|
2043 | - * OID of the `cidrarray` type. |
|
2044 | - */ |
|
2045 | - public const CIDRARRAY = 651; |
|
2046 | - /** |
|
2047 | - * OID of the `cstringarray` type. |
|
2048 | - */ |
|
2049 | - public const CSTRINGARRAY = 1263; |
|
2050 | - /** |
|
2051 | - * OID of the `bpchar` type. |
|
2052 | - */ |
|
2053 | - public const BPCHAR = 1042; |
|
2054 | - /** |
|
2055 | - * OID of the `varchar` type. |
|
2056 | - */ |
|
2057 | - public const VARCHAR = 1043; |
|
2058 | - /** |
|
2059 | - * OID of the `date` type. |
|
2060 | - */ |
|
2061 | - public const DATE = 1082; |
|
2062 | - /** |
|
2063 | - * OID of the `time` type. |
|
2064 | - */ |
|
2065 | - public const TIME = 1083; |
|
2066 | - /** |
|
2067 | - * OID of the `timestamp` type. |
|
2068 | - */ |
|
2069 | - public const TIMESTAMP = 1114; |
|
2070 | - /** |
|
2071 | - * OID of the `timestamparray` type. |
|
2072 | - */ |
|
2073 | - public const TIMESTAMPARRAY = 1115; |
|
2074 | - /** |
|
2075 | - * OID of the `datearray` type. |
|
2076 | - */ |
|
2077 | - public const DATEARRAY = 1182; |
|
2078 | - /** |
|
2079 | - * OID of the `timearray` type. |
|
2080 | - */ |
|
2081 | - public const TIMEARRAY = 1183; |
|
2082 | - /** |
|
2083 | - * OID of the `timestamptz` type. |
|
2084 | - */ |
|
2085 | - public const TIMESTAMPTZ = 1184; |
|
2086 | - /** |
|
2087 | - * OID of the `timestamptzarray` type. |
|
2088 | - */ |
|
2089 | - public const TIMESTAMPTZARRAY = 1185; |
|
2090 | - /** |
|
2091 | - * OID of the `interval` type. |
|
2092 | - */ |
|
2093 | - public const INTERVAL = 1186; |
|
2094 | - /** |
|
2095 | - * OID of the `intervalarray` type. |
|
2096 | - */ |
|
2097 | - public const INTERVALARRAY = 1187; |
|
2098 | - /** |
|
2099 | - * OID of the `numericarray` type. |
|
2100 | - */ |
|
2101 | - public const NUMERICARRAY = 1231; |
|
2102 | - /** |
|
2103 | - * OID of the `timetz` type. |
|
2104 | - */ |
|
2105 | - public const TIMETZ = 1266; |
|
2106 | - /** |
|
2107 | - * OID of the `timetzarray` type. |
|
2108 | - */ |
|
2109 | - public const TIMETZARRAY = 1270; |
|
2110 | - /** |
|
2111 | - * OID of the `bit` type. |
|
2112 | - */ |
|
2113 | - public const BIT = 1560; |
|
2114 | - /** |
|
2115 | - * OID of the `bitarray` type. |
|
2116 | - */ |
|
2117 | - public const BITARRAY = 1561; |
|
2118 | - /** |
|
2119 | - * OID of the `varbit` type. |
|
2120 | - */ |
|
2121 | - public const VARBIT = 1562; |
|
2122 | - /** |
|
2123 | - * OID of the `varbitarray` type. |
|
2124 | - */ |
|
2125 | - public const VARBITARRAY = 1563; |
|
2126 | - /** |
|
2127 | - * OID of the `numeric` type. |
|
2128 | - */ |
|
2129 | - public const NUMERIC = 1700; |
|
2130 | - /** |
|
2131 | - * OID of the `refcursor` type. |
|
2132 | - */ |
|
2133 | - public const REFCURSOR = 1790; |
|
2134 | - /** |
|
2135 | - * OID of the `refcursorarray` type. |
|
2136 | - */ |
|
2137 | - public const REFCURSORARRAY = 2201; |
|
2138 | - /** |
|
2139 | - * OID of the `regprocedure` type. |
|
2140 | - */ |
|
2141 | - public const REGPROCEDURE = 2202; |
|
2142 | - /** |
|
2143 | - * OID of the `regoper` type. |
|
2144 | - */ |
|
2145 | - public const REGOPER = 2203; |
|
2146 | - /** |
|
2147 | - * OID of the `regoperator` type. |
|
2148 | - */ |
|
2149 | - public const REGOPERATOR = 2204; |
|
2150 | - /** |
|
2151 | - * OID of the `regclass` type. |
|
2152 | - */ |
|
2153 | - public const REGCLASS = 2205; |
|
2154 | - /** |
|
2155 | - * OID of the `regtype` type. |
|
2156 | - */ |
|
2157 | - public const REGTYPE = 2206; |
|
2158 | - /** |
|
2159 | - * OID of the `regprocedurearray` type. |
|
2160 | - */ |
|
2161 | - public const REGPROCEDUREARRAY = 2207; |
|
2162 | - /** |
|
2163 | - * OID of the `regoperarray` type. |
|
2164 | - */ |
|
2165 | - public const REGOPERARRAY = 2208; |
|
2166 | - /** |
|
2167 | - * OID of the `regoperatorarray` type. |
|
2168 | - */ |
|
2169 | - public const REGOPERATORARRAY = 2209; |
|
2170 | - /** |
|
2171 | - * OID of the `regclassarray` type. |
|
2172 | - */ |
|
2173 | - public const REGCLASSARRAY = 2210; |
|
2174 | - /** |
|
2175 | - * OID of the `regtypearray` type. |
|
2176 | - */ |
|
2177 | - public const REGTYPEARRAY = 2211; |
|
2178 | - /** |
|
2179 | - * OID of the `uuid` type. |
|
2180 | - */ |
|
2181 | - public const UUID = 2950; |
|
2182 | - /** |
|
2183 | - * OID of the `uuidarray` type. |
|
2184 | - */ |
|
2185 | - public const UUIDARRAY = 2951; |
|
2186 | - /** |
|
2187 | - * OID of the `tsvector` type. |
|
2188 | - */ |
|
2189 | - public const TSVECTOR = 3614; |
|
2190 | - /** |
|
2191 | - * OID of the `gtsvector` type. |
|
2192 | - */ |
|
2193 | - public const GTSVECTOR = 3642; |
|
2194 | - /** |
|
2195 | - * OID of the `tsquery` type. |
|
2196 | - */ |
|
2197 | - public const TSQUERY = 3615; |
|
2198 | - /** |
|
2199 | - * OID of the `regconfig` type. |
|
2200 | - */ |
|
2201 | - public const REGCONFIG = 3734; |
|
2202 | - /** |
|
2203 | - * OID of the `regdictionary` type. |
|
2204 | - */ |
|
2205 | - public const REGDICTIONARY = 3769; |
|
2206 | - /** |
|
2207 | - * OID of the `tsvectorarray` type. |
|
2208 | - */ |
|
2209 | - public const TSVECTORARRAY = 3643; |
|
2210 | - /** |
|
2211 | - * OID of the `gtsvectorarray` type. |
|
2212 | - */ |
|
2213 | - public const GTSVECTORARRAY = 3644; |
|
2214 | - /** |
|
2215 | - * OID of the `tsqueryarray` type. |
|
2216 | - */ |
|
2217 | - public const TSQUERYARRAY = 3645; |
|
2218 | - /** |
|
2219 | - * OID of the `regconfigarray` type. |
|
2220 | - */ |
|
2221 | - public const REGCONFIGARRAY = 3735; |
|
2222 | - /** |
|
2223 | - * OID of the `regdictionaryarray` type. |
|
2224 | - */ |
|
2225 | - public const REGDICTIONARYARRAY = 3770; |
|
2226 | - /** |
|
2227 | - * OID of the `txid_snapshot` type. |
|
2228 | - */ |
|
2229 | - public const TXID_SNAPSHOT = 2970; |
|
2230 | - /** |
|
2231 | - * OID of the `txid_snapshotarray` type. |
|
2232 | - */ |
|
2233 | - public const TXID_SNAPSHOTARRAY = 2949; |
|
2234 | - /** |
|
2235 | - * OID of the `int4range` type. |
|
2236 | - */ |
|
2237 | - public const INT4RANGE = 3904; |
|
2238 | - /** |
|
2239 | - * OID of the `int4rangearray` type. |
|
2240 | - */ |
|
2241 | - public const INT4RANGEARRAY = 3905; |
|
2242 | - /** |
|
2243 | - * OID of the `numrange` type. |
|
2244 | - */ |
|
2245 | - public const NUMRANGE = 3906; |
|
2246 | - /** |
|
2247 | - * OID of the `numrangearray` type. |
|
2248 | - */ |
|
2249 | - public const NUMRANGEARRAY = 3907; |
|
2250 | - /** |
|
2251 | - * OID of the `tsrange` type. |
|
2252 | - */ |
|
2253 | - public const TSRANGE = 3908; |
|
2254 | - /** |
|
2255 | - * OID of the `tsrangearray` type. |
|
2256 | - */ |
|
2257 | - public const TSRANGEARRAY = 3909; |
|
2258 | - /** |
|
2259 | - * OID of the `tstzrange` type. |
|
2260 | - */ |
|
2261 | - public const TSTZRANGE = 3910; |
|
2262 | - /** |
|
2263 | - * OID of the `tstzrangearray` type. |
|
2264 | - */ |
|
2265 | - public const TSTZRANGEARRAY = 3911; |
|
2266 | - /** |
|
2267 | - * OID of the `daterange` type. |
|
2268 | - */ |
|
2269 | - public const DATERANGE = 3912; |
|
2270 | - /** |
|
2271 | - * OID of the `daterangearray` type. |
|
2272 | - */ |
|
2273 | - public const DATERANGEARRAY = 3913; |
|
2274 | - /** |
|
2275 | - * OID of the `int8range` type. |
|
2276 | - */ |
|
2277 | - public const INT8RANGE = 3926; |
|
2278 | - /** |
|
2279 | - * OID of the `int8rangearray` type. |
|
2280 | - */ |
|
2281 | - public const INT8RANGEARRAY = 3927; |
|
2282 | - /** |
|
2283 | - * OID of the `record` type. |
|
2284 | - */ |
|
2285 | - public const RECORD = 2249; |
|
2286 | - /** |
|
2287 | - * OID of the `recordarray` type. |
|
2288 | - */ |
|
2289 | - public const RECORDARRAY = 2287; |
|
2290 | - /** |
|
2291 | - * OID of the `cstring` type. |
|
2292 | - */ |
|
2293 | - public const CSTRING = 2275; |
|
2294 | - /** |
|
2295 | - * OID of the `any` type. |
|
2296 | - */ |
|
2297 | - public const ANY = 2276; |
|
2298 | - /** |
|
2299 | - * OID of the `anyarray` type. |
|
2300 | - */ |
|
2301 | - public const ANYARRAY = 2277; |
|
2302 | - /** |
|
2303 | - * OID of the `void` type. |
|
2304 | - */ |
|
2305 | - public const VOID = 2278; |
|
2306 | - /** |
|
2307 | - * OID of the `trigger` type. |
|
2308 | - */ |
|
2309 | - public const TRIGGER = 2279; |
|
2310 | - /** |
|
2311 | - * OID of the `event_trigger` type. |
|
2312 | - */ |
|
2313 | - public const EVENT_TRIGGER = 3838; |
|
2314 | - /** |
|
2315 | - * OID of the `language_handler` type. |
|
2316 | - */ |
|
2317 | - public const LANGUAGE_HANDLER = 2280; |
|
2318 | - /** |
|
2319 | - * OID of the `internal` type. |
|
2320 | - */ |
|
2321 | - public const INTERNAL = 2281; |
|
2322 | - /** |
|
2323 | - * OID of the `opaque` type. |
|
2324 | - */ |
|
2325 | - public const OPAQUE = 2282; |
|
2326 | - /** |
|
2327 | - * OID of the `anyelement` type. |
|
2328 | - */ |
|
2329 | - public const ANYELEMENT = 2283; |
|
2330 | - /** |
|
2331 | - * OID of the `anynonarray` type. |
|
2332 | - */ |
|
2333 | - public const ANYNONARRAY = 2776; |
|
2334 | - /** |
|
2335 | - * OID of the `anyenum` type. |
|
2336 | - */ |
|
2337 | - public const ANYENUM = 3500; |
|
2338 | - /** |
|
2339 | - * OID of the `fdw_handler` type. |
|
2340 | - */ |
|
2341 | - public const FDW_HANDLER = 3115; |
|
2342 | - /** |
|
2343 | - * OID of the `anyrange` type. |
|
2344 | - */ |
|
2345 | - public const ANYRANGE = 3831; |
|
2346 | - /** |
|
2347 | - * The connection which was used to obtain type information. |
|
2348 | - * |
|
2349 | - * @public |
|
2350 | - * @readonly |
|
2351 | - * @var \pq\Connection |
|
2352 | - */ |
|
2353 | - public $connection; |
|
2354 | - /** |
|
2355 | - * Create a new instance populated with information obtained from the `pg_type` relation. |
|
2356 | - * |
|
2357 | - * @param \pq\Connection $conn The connection to use. |
|
2358 | - * @param array $namespaces Which namespaces to query (defaults to `public` and `pg_catalog`). |
|
2359 | - * @throws \pq\Exception\InvalidArgumentException |
|
2360 | - * @throws \pq\Exception\BadMethodCallException |
|
2361 | - * @throws \pq\Exception\RuntimeException |
|
2362 | - */ |
|
2363 | - public function __construct(pq\Connection $conn, array $namespaces = null) {} |
|
2364 | - /** |
|
2365 | - * Refresh type information from `pg_type`. |
|
2366 | - * |
|
2367 | - * @param array $namespaces Which namespaces to query (defaults to `public` and `pg_catalog`). |
|
2368 | - * @throws \pq\Exception\InvalidArgumentException |
|
2369 | - * @throws \pq\Exception\BadMethodCallException |
|
2370 | - * @throws \pq\Exception\RuntimeException |
|
2371 | - */ |
|
2372 | - public function refresh(array $namespaces = null) {} |
|
1738 | + /** |
|
1739 | + * OID of the `bool` type. |
|
1740 | + */ |
|
1741 | + public const BOOL = 16; |
|
1742 | + /** |
|
1743 | + * OID of the `bytea` type. |
|
1744 | + */ |
|
1745 | + public const BYTEA = 17; |
|
1746 | + /** |
|
1747 | + * OID of the `char` type. |
|
1748 | + */ |
|
1749 | + public const CHAR = 18; |
|
1750 | + /** |
|
1751 | + * OID of the `name` type. |
|
1752 | + */ |
|
1753 | + public const NAME = 19; |
|
1754 | + /** |
|
1755 | + * OID of the `int8` type. |
|
1756 | + */ |
|
1757 | + public const INT8 = 20; |
|
1758 | + /** |
|
1759 | + * OID of the `int2` type. |
|
1760 | + */ |
|
1761 | + public const INT2 = 21; |
|
1762 | + /** |
|
1763 | + * OID of the `int2vector` type. |
|
1764 | + */ |
|
1765 | + public const INT2VECTOR = 22; |
|
1766 | + /** |
|
1767 | + * OID of the `int4` type. |
|
1768 | + */ |
|
1769 | + public const INT4 = 23; |
|
1770 | + /** |
|
1771 | + * OID of the `regproc` type. |
|
1772 | + */ |
|
1773 | + public const REGPROC = 24; |
|
1774 | + /** |
|
1775 | + * OID of the `text` type. |
|
1776 | + */ |
|
1777 | + public const TEXT = 25; |
|
1778 | + /** |
|
1779 | + * OID of the `oid` type. |
|
1780 | + */ |
|
1781 | + public const OID = 26; |
|
1782 | + /** |
|
1783 | + * OID of the `tid` type. |
|
1784 | + */ |
|
1785 | + public const TID = 27; |
|
1786 | + /** |
|
1787 | + * OID of the `xid` type. |
|
1788 | + */ |
|
1789 | + public const XID = 28; |
|
1790 | + /** |
|
1791 | + * OID of the `cid` type. |
|
1792 | + */ |
|
1793 | + public const CID = 29; |
|
1794 | + /** |
|
1795 | + * OID of the `oidvector` type. |
|
1796 | + */ |
|
1797 | + public const OIDVECTOR = 30; |
|
1798 | + /** |
|
1799 | + * OID of the `pg_type` type. |
|
1800 | + */ |
|
1801 | + public const PG_TYPE = 71; |
|
1802 | + /** |
|
1803 | + * OID of the `pg_attribute` type. |
|
1804 | + */ |
|
1805 | + public const PG_ATTRIBUTE = 75; |
|
1806 | + /** |
|
1807 | + * OID of the `pg_proc` type. |
|
1808 | + */ |
|
1809 | + public const PG_PROC = 81; |
|
1810 | + /** |
|
1811 | + * OID of the `pg_class` type. |
|
1812 | + */ |
|
1813 | + public const PG_CLASS = 83; |
|
1814 | + /** |
|
1815 | + * OID of the `json` type. |
|
1816 | + */ |
|
1817 | + public const JSON = 114; |
|
1818 | + /** |
|
1819 | + * OID of the `xml` type. |
|
1820 | + */ |
|
1821 | + public const XML = 142; |
|
1822 | + /** |
|
1823 | + * OID of the `xmlarray` type. |
|
1824 | + */ |
|
1825 | + public const XMLARRAY = 143; |
|
1826 | + /** |
|
1827 | + * OID of the `jsonarray` type. |
|
1828 | + */ |
|
1829 | + public const JSONARRAY = 199; |
|
1830 | + /** |
|
1831 | + * OID of the `pg_node_tree` type. |
|
1832 | + */ |
|
1833 | + public const PG_NODE_TREE = 194; |
|
1834 | + /** |
|
1835 | + * OID of the `smgr` type. |
|
1836 | + */ |
|
1837 | + public const SMGR = 210; |
|
1838 | + /** |
|
1839 | + * OID of the `point` type. |
|
1840 | + */ |
|
1841 | + public const POINT = 600; |
|
1842 | + /** |
|
1843 | + * OID of the `lseg` type. |
|
1844 | + */ |
|
1845 | + public const LSEG = 601; |
|
1846 | + /** |
|
1847 | + * OID of the `path` type. |
|
1848 | + */ |
|
1849 | + public const PATH = 602; |
|
1850 | + /** |
|
1851 | + * OID of the `box` type. |
|
1852 | + */ |
|
1853 | + public const BOX = 603; |
|
1854 | + /** |
|
1855 | + * OID of the `polygon` type. |
|
1856 | + */ |
|
1857 | + public const POLYGON = 604; |
|
1858 | + /** |
|
1859 | + * OID of the `line` type. |
|
1860 | + */ |
|
1861 | + public const LINE = 628; |
|
1862 | + /** |
|
1863 | + * OID of the `linearray` type. |
|
1864 | + */ |
|
1865 | + public const LINEARRAY = 629; |
|
1866 | + /** |
|
1867 | + * OID of the `float4` type. |
|
1868 | + */ |
|
1869 | + public const FLOAT4 = 700; |
|
1870 | + /** |
|
1871 | + * OID of the `float8` type. |
|
1872 | + */ |
|
1873 | + public const FLOAT8 = 701; |
|
1874 | + /** |
|
1875 | + * OID of the `abstime` type. |
|
1876 | + */ |
|
1877 | + public const ABSTIME = 702; |
|
1878 | + /** |
|
1879 | + * OID of the `reltime` type. |
|
1880 | + */ |
|
1881 | + public const RELTIME = 703; |
|
1882 | + /** |
|
1883 | + * OID of the `tinterval` type. |
|
1884 | + */ |
|
1885 | + public const TINTERVAL = 704; |
|
1886 | + /** |
|
1887 | + * OID of the `unknown` type. |
|
1888 | + */ |
|
1889 | + public const UNKNOWN = 705; |
|
1890 | + /** |
|
1891 | + * OID of the `circle` type. |
|
1892 | + */ |
|
1893 | + public const CIRCLE = 718; |
|
1894 | + /** |
|
1895 | + * OID of the `circlearray` type. |
|
1896 | + */ |
|
1897 | + public const CIRCLEARRAY = 719; |
|
1898 | + /** |
|
1899 | + * OID of the `money` type. |
|
1900 | + */ |
|
1901 | + public const MONEY = 790; |
|
1902 | + /** |
|
1903 | + * OID of the `moneyarray` type. |
|
1904 | + */ |
|
1905 | + public const MONEYARRAY = 791; |
|
1906 | + /** |
|
1907 | + * OID of the `macaddr` type. |
|
1908 | + */ |
|
1909 | + public const MACADDR = 829; |
|
1910 | + /** |
|
1911 | + * OID of the `inet` type. |
|
1912 | + */ |
|
1913 | + public const INET = 869; |
|
1914 | + /** |
|
1915 | + * OID of the `cidr` type. |
|
1916 | + */ |
|
1917 | + public const CIDR = 650; |
|
1918 | + /** |
|
1919 | + * OID of the `boolarray` type. |
|
1920 | + */ |
|
1921 | + public const BOOLARRAY = 1000; |
|
1922 | + /** |
|
1923 | + * OID of the `byteaarray` type. |
|
1924 | + */ |
|
1925 | + public const BYTEAARRAY = 1001; |
|
1926 | + /** |
|
1927 | + * OID of the `chararray` type. |
|
1928 | + */ |
|
1929 | + public const CHARARRAY = 1002; |
|
1930 | + /** |
|
1931 | + * OID of the `namearray` type. |
|
1932 | + */ |
|
1933 | + public const NAMEARRAY = 1003; |
|
1934 | + /** |
|
1935 | + * OID of the `int2array` type. |
|
1936 | + */ |
|
1937 | + public const INT2ARRAY = 1005; |
|
1938 | + /** |
|
1939 | + * OID of the `int2vectorarray` type. |
|
1940 | + */ |
|
1941 | + public const INT2VECTORARRAY = 1006; |
|
1942 | + /** |
|
1943 | + * OID of the `int4array` type. |
|
1944 | + */ |
|
1945 | + public const INT4ARRAY = 1007; |
|
1946 | + /** |
|
1947 | + * OID of the `regprocarray` type. |
|
1948 | + */ |
|
1949 | + public const REGPROCARRAY = 1008; |
|
1950 | + /** |
|
1951 | + * OID of the `textarray` type. |
|
1952 | + */ |
|
1953 | + public const TEXTARRAY = 1009; |
|
1954 | + /** |
|
1955 | + * OID of the `oidarray` type. |
|
1956 | + */ |
|
1957 | + public const OIDARRAY = 1028; |
|
1958 | + /** |
|
1959 | + * OID of the `tidarray` type. |
|
1960 | + */ |
|
1961 | + public const TIDARRAY = 1010; |
|
1962 | + /** |
|
1963 | + * OID of the `xidarray` type. |
|
1964 | + */ |
|
1965 | + public const XIDARRAY = 1011; |
|
1966 | + /** |
|
1967 | + * OID of the `cidarray` type. |
|
1968 | + */ |
|
1969 | + public const CIDARRAY = 1012; |
|
1970 | + /** |
|
1971 | + * OID of the `oidvectorarray` type. |
|
1972 | + */ |
|
1973 | + public const OIDVECTORARRAY = 1013; |
|
1974 | + /** |
|
1975 | + * OID of the `bpchararray` type. |
|
1976 | + */ |
|
1977 | + public const BPCHARARRAY = 1014; |
|
1978 | + /** |
|
1979 | + * OID of the `varchararray` type. |
|
1980 | + */ |
|
1981 | + public const VARCHARARRAY = 1015; |
|
1982 | + /** |
|
1983 | + * OID of the `int8array` type. |
|
1984 | + */ |
|
1985 | + public const INT8ARRAY = 1016; |
|
1986 | + /** |
|
1987 | + * OID of the `pointarray` type. |
|
1988 | + */ |
|
1989 | + public const POINTARRAY = 1017; |
|
1990 | + /** |
|
1991 | + * OID of the `lsegarray` type. |
|
1992 | + */ |
|
1993 | + public const LSEGARRAY = 1018; |
|
1994 | + /** |
|
1995 | + * OID of the `patharray` type. |
|
1996 | + */ |
|
1997 | + public const PATHARRAY = 1019; |
|
1998 | + /** |
|
1999 | + * OID of the `boxarray` type. |
|
2000 | + */ |
|
2001 | + public const BOXARRAY = 1020; |
|
2002 | + /** |
|
2003 | + * OID of the `float4array` type. |
|
2004 | + */ |
|
2005 | + public const FLOAT4ARRAY = 1021; |
|
2006 | + /** |
|
2007 | + * OID of the `float8array` type. |
|
2008 | + */ |
|
2009 | + public const FLOAT8ARRAY = 1022; |
|
2010 | + /** |
|
2011 | + * OID of the `abstimearray` type. |
|
2012 | + */ |
|
2013 | + public const ABSTIMEARRAY = 1023; |
|
2014 | + /** |
|
2015 | + * OID of the `reltimearray` type. |
|
2016 | + */ |
|
2017 | + public const RELTIMEARRAY = 1024; |
|
2018 | + /** |
|
2019 | + * OID of the `tintervalarray` type. |
|
2020 | + */ |
|
2021 | + public const TINTERVALARRAY = 1025; |
|
2022 | + /** |
|
2023 | + * OID of the `polygonarray` type. |
|
2024 | + */ |
|
2025 | + public const POLYGONARRAY = 1027; |
|
2026 | + /** |
|
2027 | + * OID of the `aclitem` type. |
|
2028 | + */ |
|
2029 | + public const ACLITEM = 1033; |
|
2030 | + /** |
|
2031 | + * OID of the `aclitemarray` type. |
|
2032 | + */ |
|
2033 | + public const ACLITEMARRAY = 1034; |
|
2034 | + /** |
|
2035 | + * OID of the `macaddrarray` type. |
|
2036 | + */ |
|
2037 | + public const MACADDRARRAY = 1040; |
|
2038 | + /** |
|
2039 | + * OID of the `inetarray` type. |
|
2040 | + */ |
|
2041 | + public const INETARRAY = 1041; |
|
2042 | + /** |
|
2043 | + * OID of the `cidrarray` type. |
|
2044 | + */ |
|
2045 | + public const CIDRARRAY = 651; |
|
2046 | + /** |
|
2047 | + * OID of the `cstringarray` type. |
|
2048 | + */ |
|
2049 | + public const CSTRINGARRAY = 1263; |
|
2050 | + /** |
|
2051 | + * OID of the `bpchar` type. |
|
2052 | + */ |
|
2053 | + public const BPCHAR = 1042; |
|
2054 | + /** |
|
2055 | + * OID of the `varchar` type. |
|
2056 | + */ |
|
2057 | + public const VARCHAR = 1043; |
|
2058 | + /** |
|
2059 | + * OID of the `date` type. |
|
2060 | + */ |
|
2061 | + public const DATE = 1082; |
|
2062 | + /** |
|
2063 | + * OID of the `time` type. |
|
2064 | + */ |
|
2065 | + public const TIME = 1083; |
|
2066 | + /** |
|
2067 | + * OID of the `timestamp` type. |
|
2068 | + */ |
|
2069 | + public const TIMESTAMP = 1114; |
|
2070 | + /** |
|
2071 | + * OID of the `timestamparray` type. |
|
2072 | + */ |
|
2073 | + public const TIMESTAMPARRAY = 1115; |
|
2074 | + /** |
|
2075 | + * OID of the `datearray` type. |
|
2076 | + */ |
|
2077 | + public const DATEARRAY = 1182; |
|
2078 | + /** |
|
2079 | + * OID of the `timearray` type. |
|
2080 | + */ |
|
2081 | + public const TIMEARRAY = 1183; |
|
2082 | + /** |
|
2083 | + * OID of the `timestamptz` type. |
|
2084 | + */ |
|
2085 | + public const TIMESTAMPTZ = 1184; |
|
2086 | + /** |
|
2087 | + * OID of the `timestamptzarray` type. |
|
2088 | + */ |
|
2089 | + public const TIMESTAMPTZARRAY = 1185; |
|
2090 | + /** |
|
2091 | + * OID of the `interval` type. |
|
2092 | + */ |
|
2093 | + public const INTERVAL = 1186; |
|
2094 | + /** |
|
2095 | + * OID of the `intervalarray` type. |
|
2096 | + */ |
|
2097 | + public const INTERVALARRAY = 1187; |
|
2098 | + /** |
|
2099 | + * OID of the `numericarray` type. |
|
2100 | + */ |
|
2101 | + public const NUMERICARRAY = 1231; |
|
2102 | + /** |
|
2103 | + * OID of the `timetz` type. |
|
2104 | + */ |
|
2105 | + public const TIMETZ = 1266; |
|
2106 | + /** |
|
2107 | + * OID of the `timetzarray` type. |
|
2108 | + */ |
|
2109 | + public const TIMETZARRAY = 1270; |
|
2110 | + /** |
|
2111 | + * OID of the `bit` type. |
|
2112 | + */ |
|
2113 | + public const BIT = 1560; |
|
2114 | + /** |
|
2115 | + * OID of the `bitarray` type. |
|
2116 | + */ |
|
2117 | + public const BITARRAY = 1561; |
|
2118 | + /** |
|
2119 | + * OID of the `varbit` type. |
|
2120 | + */ |
|
2121 | + public const VARBIT = 1562; |
|
2122 | + /** |
|
2123 | + * OID of the `varbitarray` type. |
|
2124 | + */ |
|
2125 | + public const VARBITARRAY = 1563; |
|
2126 | + /** |
|
2127 | + * OID of the `numeric` type. |
|
2128 | + */ |
|
2129 | + public const NUMERIC = 1700; |
|
2130 | + /** |
|
2131 | + * OID of the `refcursor` type. |
|
2132 | + */ |
|
2133 | + public const REFCURSOR = 1790; |
|
2134 | + /** |
|
2135 | + * OID of the `refcursorarray` type. |
|
2136 | + */ |
|
2137 | + public const REFCURSORARRAY = 2201; |
|
2138 | + /** |
|
2139 | + * OID of the `regprocedure` type. |
|
2140 | + */ |
|
2141 | + public const REGPROCEDURE = 2202; |
|
2142 | + /** |
|
2143 | + * OID of the `regoper` type. |
|
2144 | + */ |
|
2145 | + public const REGOPER = 2203; |
|
2146 | + /** |
|
2147 | + * OID of the `regoperator` type. |
|
2148 | + */ |
|
2149 | + public const REGOPERATOR = 2204; |
|
2150 | + /** |
|
2151 | + * OID of the `regclass` type. |
|
2152 | + */ |
|
2153 | + public const REGCLASS = 2205; |
|
2154 | + /** |
|
2155 | + * OID of the `regtype` type. |
|
2156 | + */ |
|
2157 | + public const REGTYPE = 2206; |
|
2158 | + /** |
|
2159 | + * OID of the `regprocedurearray` type. |
|
2160 | + */ |
|
2161 | + public const REGPROCEDUREARRAY = 2207; |
|
2162 | + /** |
|
2163 | + * OID of the `regoperarray` type. |
|
2164 | + */ |
|
2165 | + public const REGOPERARRAY = 2208; |
|
2166 | + /** |
|
2167 | + * OID of the `regoperatorarray` type. |
|
2168 | + */ |
|
2169 | + public const REGOPERATORARRAY = 2209; |
|
2170 | + /** |
|
2171 | + * OID of the `regclassarray` type. |
|
2172 | + */ |
|
2173 | + public const REGCLASSARRAY = 2210; |
|
2174 | + /** |
|
2175 | + * OID of the `regtypearray` type. |
|
2176 | + */ |
|
2177 | + public const REGTYPEARRAY = 2211; |
|
2178 | + /** |
|
2179 | + * OID of the `uuid` type. |
|
2180 | + */ |
|
2181 | + public const UUID = 2950; |
|
2182 | + /** |
|
2183 | + * OID of the `uuidarray` type. |
|
2184 | + */ |
|
2185 | + public const UUIDARRAY = 2951; |
|
2186 | + /** |
|
2187 | + * OID of the `tsvector` type. |
|
2188 | + */ |
|
2189 | + public const TSVECTOR = 3614; |
|
2190 | + /** |
|
2191 | + * OID of the `gtsvector` type. |
|
2192 | + */ |
|
2193 | + public const GTSVECTOR = 3642; |
|
2194 | + /** |
|
2195 | + * OID of the `tsquery` type. |
|
2196 | + */ |
|
2197 | + public const TSQUERY = 3615; |
|
2198 | + /** |
|
2199 | + * OID of the `regconfig` type. |
|
2200 | + */ |
|
2201 | + public const REGCONFIG = 3734; |
|
2202 | + /** |
|
2203 | + * OID of the `regdictionary` type. |
|
2204 | + */ |
|
2205 | + public const REGDICTIONARY = 3769; |
|
2206 | + /** |
|
2207 | + * OID of the `tsvectorarray` type. |
|
2208 | + */ |
|
2209 | + public const TSVECTORARRAY = 3643; |
|
2210 | + /** |
|
2211 | + * OID of the `gtsvectorarray` type. |
|
2212 | + */ |
|
2213 | + public const GTSVECTORARRAY = 3644; |
|
2214 | + /** |
|
2215 | + * OID of the `tsqueryarray` type. |
|
2216 | + */ |
|
2217 | + public const TSQUERYARRAY = 3645; |
|
2218 | + /** |
|
2219 | + * OID of the `regconfigarray` type. |
|
2220 | + */ |
|
2221 | + public const REGCONFIGARRAY = 3735; |
|
2222 | + /** |
|
2223 | + * OID of the `regdictionaryarray` type. |
|
2224 | + */ |
|
2225 | + public const REGDICTIONARYARRAY = 3770; |
|
2226 | + /** |
|
2227 | + * OID of the `txid_snapshot` type. |
|
2228 | + */ |
|
2229 | + public const TXID_SNAPSHOT = 2970; |
|
2230 | + /** |
|
2231 | + * OID of the `txid_snapshotarray` type. |
|
2232 | + */ |
|
2233 | + public const TXID_SNAPSHOTARRAY = 2949; |
|
2234 | + /** |
|
2235 | + * OID of the `int4range` type. |
|
2236 | + */ |
|
2237 | + public const INT4RANGE = 3904; |
|
2238 | + /** |
|
2239 | + * OID of the `int4rangearray` type. |
|
2240 | + */ |
|
2241 | + public const INT4RANGEARRAY = 3905; |
|
2242 | + /** |
|
2243 | + * OID of the `numrange` type. |
|
2244 | + */ |
|
2245 | + public const NUMRANGE = 3906; |
|
2246 | + /** |
|
2247 | + * OID of the `numrangearray` type. |
|
2248 | + */ |
|
2249 | + public const NUMRANGEARRAY = 3907; |
|
2250 | + /** |
|
2251 | + * OID of the `tsrange` type. |
|
2252 | + */ |
|
2253 | + public const TSRANGE = 3908; |
|
2254 | + /** |
|
2255 | + * OID of the `tsrangearray` type. |
|
2256 | + */ |
|
2257 | + public const TSRANGEARRAY = 3909; |
|
2258 | + /** |
|
2259 | + * OID of the `tstzrange` type. |
|
2260 | + */ |
|
2261 | + public const TSTZRANGE = 3910; |
|
2262 | + /** |
|
2263 | + * OID of the `tstzrangearray` type. |
|
2264 | + */ |
|
2265 | + public const TSTZRANGEARRAY = 3911; |
|
2266 | + /** |
|
2267 | + * OID of the `daterange` type. |
|
2268 | + */ |
|
2269 | + public const DATERANGE = 3912; |
|
2270 | + /** |
|
2271 | + * OID of the `daterangearray` type. |
|
2272 | + */ |
|
2273 | + public const DATERANGEARRAY = 3913; |
|
2274 | + /** |
|
2275 | + * OID of the `int8range` type. |
|
2276 | + */ |
|
2277 | + public const INT8RANGE = 3926; |
|
2278 | + /** |
|
2279 | + * OID of the `int8rangearray` type. |
|
2280 | + */ |
|
2281 | + public const INT8RANGEARRAY = 3927; |
|
2282 | + /** |
|
2283 | + * OID of the `record` type. |
|
2284 | + */ |
|
2285 | + public const RECORD = 2249; |
|
2286 | + /** |
|
2287 | + * OID of the `recordarray` type. |
|
2288 | + */ |
|
2289 | + public const RECORDARRAY = 2287; |
|
2290 | + /** |
|
2291 | + * OID of the `cstring` type. |
|
2292 | + */ |
|
2293 | + public const CSTRING = 2275; |
|
2294 | + /** |
|
2295 | + * OID of the `any` type. |
|
2296 | + */ |
|
2297 | + public const ANY = 2276; |
|
2298 | + /** |
|
2299 | + * OID of the `anyarray` type. |
|
2300 | + */ |
|
2301 | + public const ANYARRAY = 2277; |
|
2302 | + /** |
|
2303 | + * OID of the `void` type. |
|
2304 | + */ |
|
2305 | + public const VOID = 2278; |
|
2306 | + /** |
|
2307 | + * OID of the `trigger` type. |
|
2308 | + */ |
|
2309 | + public const TRIGGER = 2279; |
|
2310 | + /** |
|
2311 | + * OID of the `event_trigger` type. |
|
2312 | + */ |
|
2313 | + public const EVENT_TRIGGER = 3838; |
|
2314 | + /** |
|
2315 | + * OID of the `language_handler` type. |
|
2316 | + */ |
|
2317 | + public const LANGUAGE_HANDLER = 2280; |
|
2318 | + /** |
|
2319 | + * OID of the `internal` type. |
|
2320 | + */ |
|
2321 | + public const INTERNAL = 2281; |
|
2322 | + /** |
|
2323 | + * OID of the `opaque` type. |
|
2324 | + */ |
|
2325 | + public const OPAQUE = 2282; |
|
2326 | + /** |
|
2327 | + * OID of the `anyelement` type. |
|
2328 | + */ |
|
2329 | + public const ANYELEMENT = 2283; |
|
2330 | + /** |
|
2331 | + * OID of the `anynonarray` type. |
|
2332 | + */ |
|
2333 | + public const ANYNONARRAY = 2776; |
|
2334 | + /** |
|
2335 | + * OID of the `anyenum` type. |
|
2336 | + */ |
|
2337 | + public const ANYENUM = 3500; |
|
2338 | + /** |
|
2339 | + * OID of the `fdw_handler` type. |
|
2340 | + */ |
|
2341 | + public const FDW_HANDLER = 3115; |
|
2342 | + /** |
|
2343 | + * OID of the `anyrange` type. |
|
2344 | + */ |
|
2345 | + public const ANYRANGE = 3831; |
|
2346 | + /** |
|
2347 | + * The connection which was used to obtain type information. |
|
2348 | + * |
|
2349 | + * @public |
|
2350 | + * @readonly |
|
2351 | + * @var \pq\Connection |
|
2352 | + */ |
|
2353 | + public $connection; |
|
2354 | + /** |
|
2355 | + * Create a new instance populated with information obtained from the `pg_type` relation. |
|
2356 | + * |
|
2357 | + * @param \pq\Connection $conn The connection to use. |
|
2358 | + * @param array $namespaces Which namespaces to query (defaults to `public` and `pg_catalog`). |
|
2359 | + * @throws \pq\Exception\InvalidArgumentException |
|
2360 | + * @throws \pq\Exception\BadMethodCallException |
|
2361 | + * @throws \pq\Exception\RuntimeException |
|
2362 | + */ |
|
2363 | + public function __construct(pq\Connection $conn, array $namespaces = null) {} |
|
2364 | + /** |
|
2365 | + * Refresh type information from `pg_type`. |
|
2366 | + * |
|
2367 | + * @param array $namespaces Which namespaces to query (defaults to `public` and `pg_catalog`). |
|
2368 | + * @throws \pq\Exception\InvalidArgumentException |
|
2369 | + * @throws \pq\Exception\BadMethodCallException |
|
2370 | + * @throws \pq\Exception\RuntimeException |
|
2371 | + */ |
|
2372 | + public function refresh(array $namespaces = null) {} |
|
2373 | 2373 | } |
2374 | 2374 | |
2375 | 2375 | namespace pq\Exception; |
@@ -2383,14 +2383,14 @@ discard block |
||
2383 | 2383 | */ |
2384 | 2384 | class DomainException extends \DomainException implements \pq\Exception |
2385 | 2385 | { |
2386 | - /** |
|
2387 | - * The SQLSTATE code, see the [official documentation](http://www.postgresql.org/docs/current/static/errcodes-appendix.html) for further information. |
|
2388 | - * |
|
2389 | - * @public |
|
2390 | - * @readonly |
|
2391 | - * @var string |
|
2392 | - */ |
|
2393 | - public $sqlstate; |
|
2386 | + /** |
|
2387 | + * The SQLSTATE code, see the [official documentation](http://www.postgresql.org/docs/current/static/errcodes-appendix.html) for further information. |
|
2388 | + * |
|
2389 | + * @public |
|
2390 | + * @readonly |
|
2391 | + * @var string |
|
2392 | + */ |
|
2393 | + public $sqlstate; |
|
2394 | 2394 | } |
2395 | 2395 | /** |
2396 | 2396 | * An invalid argument was passed to a method. |
@@ -404,7 +404,7 @@ |
||
404 | 404 | * @throws \pq\Exception\BadMethodCallException |
405 | 405 | * @return \pq\Cursor an open cursor instance. |
406 | 406 | */ |
407 | - public function declare(string $name, int $flags, string $query) {} |
|
407 | + public function declare(string$name,int$flags,string$query) {} |
|
408 | 408 | /** |
409 | 409 | * [Asynchronously](pq/Connection/: Asynchronous Usage) declare a cursor for a query. |
410 | 410 | * |
@@ -17,8 +17,7 @@ discard block |
||
17 | 17 | /** |
18 | 18 | * Fast import/export using COPY. |
19 | 19 | */ |
20 | -class COPY |
|
21 | -{ |
|
20 | +class COPY { |
|
22 | 21 | /** |
23 | 22 | * Start a COPY operation from STDIN to the PostgreSQL server. |
24 | 23 | */ |
@@ -103,8 +102,7 @@ discard block |
||
103 | 102 | /** |
104 | 103 | * Request cancellation of an asynchronous query. |
105 | 104 | */ |
106 | -class Cancel |
|
107 | -{ |
|
105 | +class Cancel { |
|
108 | 106 | /** |
109 | 107 | * The connection to cancel the query on. |
110 | 108 | * |
@@ -136,8 +134,7 @@ discard block |
||
136 | 134 | * |
137 | 135 | * See the [General Usage](pq/Connection/: General Usage) page for an introduction on how to use this class. |
138 | 136 | */ |
139 | -class Connection |
|
140 | -{ |
|
137 | +class Connection { |
|
141 | 138 | /** |
142 | 139 | * (Re-)open a persistent connection. |
143 | 140 | */ |
@@ -759,8 +756,7 @@ discard block |
||
759 | 756 | /** |
760 | 757 | * Interface for type conversions. |
761 | 758 | */ |
762 | -interface Converter |
|
763 | -{ |
|
759 | +interface Converter { |
|
764 | 760 | /** |
765 | 761 | * Convert a string received from the PostgreSQL server back to a PHP type. |
766 | 762 | * |
@@ -787,8 +783,7 @@ discard block |
||
787 | 783 | /** |
788 | 784 | * Declare a cursor. |
789 | 785 | */ |
790 | -class Cursor |
|
791 | -{ |
|
786 | +class Cursor { |
|
792 | 787 | /** |
793 | 788 | * Causes the cursor to return data in binary rather than in text format. You probably do not want to use that. |
794 | 789 | */ |
@@ -965,8 +960,7 @@ discard block |
||
965 | 960 | /** |
966 | 961 | * A base interface for all pq\Exception classes. |
967 | 962 | */ |
968 | -interface Exception |
|
969 | -{ |
|
963 | +interface Exception { |
|
970 | 964 | /** |
971 | 965 | * An invalid argument was passed to a method (pq\Exception\InvalidArgumentException). |
972 | 966 | */ |
@@ -1010,8 +1004,7 @@ discard block |
||
1010 | 1004 | * ***NOTE:*** |
1011 | 1005 | * Working with *large objects* requires an active transaction. |
1012 | 1006 | */ |
1013 | -class LOB |
|
1014 | -{ |
|
1007 | +class LOB { |
|
1015 | 1008 | /** |
1016 | 1009 | * 0, representing an invalid OID. |
1017 | 1010 | */ |
@@ -1367,8 +1360,7 @@ discard block |
||
1367 | 1360 | * A named prepared statement. |
1368 | 1361 | * See pq\Connection::prepare(). |
1369 | 1362 | */ |
1370 | -class Statement |
|
1371 | -{ |
|
1363 | +class Statement { |
|
1372 | 1364 | /** |
1373 | 1365 | * The connection to the server. |
1374 | 1366 | * |
@@ -1510,8 +1502,7 @@ discard block |
||
1510 | 1502 | * ***NOTE:*** |
1511 | 1503 | * Transactional properties like pq\Transaction::$isolation, pq\Transaction::$readonly and pq\Transaction::$deferrable can be changed after the transaction begun and the first query has been executed. Doing this will lead to appropriate `SET TRANSACTION` queries. |
1512 | 1504 | */ |
1513 | -class Transaction |
|
1514 | -{ |
|
1505 | +class Transaction { |
|
1515 | 1506 | /** |
1516 | 1507 | * Transaction isolation level where only rows committed before the transaction began can be seen. |
1517 | 1508 | */ |
@@ -703,10 +703,10 @@ discard block |
||
703 | 703 | * @since 5.5 |
704 | 704 | */ |
705 | 705 | function socket_sendmsg( |
706 | - Socket $socket, |
|
707 | - array $message, |
|
708 | - #[PhpStormStubsElementAvailable(from: '5.5', to: '7.4')] int $flags, |
|
709 | - #[PhpStormStubsElementAvailable(from: '8.0')] int $flags = 0 |
|
706 | + Socket $socket, |
|
707 | + array $message, |
|
708 | + #[PhpStormStubsElementAvailable(from: '5.5', to: '7.4')] int $flags, |
|
709 | + #[PhpStormStubsElementAvailable(from: '8.0')] int $flags = 0 |
|
710 | 710 | ): int|false {} |
711 | 711 | |
712 | 712 | /** |
@@ -793,10 +793,10 @@ discard block |
||
793 | 793 | * @since 5.5 |
794 | 794 | */ |
795 | 795 | function socket_recvmsg( |
796 | - Socket $socket, |
|
797 | - array &$message, |
|
798 | - #[PhpStormStubsElementAvailable(from: '5.5', to: '7.4')] int $flags, |
|
799 | - #[PhpStormStubsElementAvailable(from: '8.0')] int $flags = 0 |
|
796 | + Socket $socket, |
|
797 | + array &$message, |
|
798 | + #[PhpStormStubsElementAvailable(from: '5.5', to: '7.4')] int $flags, |
|
799 | + #[PhpStormStubsElementAvailable(from: '8.0')] int $flags = 0 |
|
800 | 800 | ): int|false {} |
801 | 801 | |
802 | 802 | /** |
@@ -1326,9 +1326,9 @@ discard block |
||
1326 | 1326 | * @since 5.5 |
1327 | 1327 | */ |
1328 | 1328 | function socket_cmsg_space( |
1329 | - int $level, |
|
1330 | - int $type, |
|
1331 | - #[PhpStormStubsElementAvailable(from: '8.0')] int $num = 0 |
|
1329 | + int $level, |
|
1330 | + int $type, |
|
1331 | + #[PhpStormStubsElementAvailable(from: '8.0')] int $num = 0 |
|
1332 | 1332 | ): ?int {} |
1333 | 1333 | |
1334 | 1334 | /** |
@@ -2186,11 +2186,11 @@ discard block |
||
2186 | 2186 | */ |
2187 | 2187 | final class Socket |
2188 | 2188 | { |
2189 | - /** |
|
2190 | - * Cannot directly construct Socket, use socket_create() instead |
|
2191 | - * @see socket_create() |
|
2192 | - */ |
|
2193 | - private function __construct() {} |
|
2189 | + /** |
|
2190 | + * Cannot directly construct Socket, use socket_create() instead |
|
2191 | + * @see socket_create() |
|
2192 | + */ |
|
2193 | + private function __construct() {} |
|
2194 | 2194 | } |
2195 | 2195 | |
2196 | 2196 | /** |
@@ -2198,9 +2198,9 @@ discard block |
||
2198 | 2198 | */ |
2199 | 2199 | final class AddressInfo |
2200 | 2200 | { |
2201 | - /** |
|
2202 | - * Cannot directly construct AddressInfo, use socket_addrinfo_lookup() instead |
|
2203 | - * @see socket_addrinfo_lookup() |
|
2204 | - */ |
|
2205 | - private function __construct() {} |
|
2201 | + /** |
|
2202 | + * Cannot directly construct AddressInfo, use socket_addrinfo_lookup() instead |
|
2203 | + * @see socket_addrinfo_lookup() |
|
2204 | + */ |
|
2205 | + private function __construct() {} |
|
2206 | 2206 | } |
@@ -19,7 +19,7 @@ discard block |
||
19 | 19 | * @return AddressInfo[]|false of AddrInfo resource handles that can be used with the other socket_addrinfo functions. |
20 | 20 | * @since 7.2 |
21 | 21 | */ |
22 | -function socket_addrinfo_lookup(string $host, ?string $service, array $hints): array|false {} |
|
22 | +function socket_addrinfo_lookup(string $host, ?string $service, array $hints): array | false {} |
|
23 | 23 | |
24 | 24 | /** |
25 | 25 | * Create a Socket resource, and connect it to the provided AddrInfo resource.<br/> |
@@ -31,7 +31,7 @@ discard block |
||
31 | 31 | * @return resource|Socket|null|false Socket resource on success or NULL on failure. |
32 | 32 | * @since 7.2 |
33 | 33 | */ |
34 | -function socket_addrinfo_connect(AddressInfo $address): Socket|false {} |
|
34 | +function socket_addrinfo_connect(AddressInfo $address): Socket | false {} |
|
35 | 35 | |
36 | 36 | /** |
37 | 37 | * (PHP 7 >= 7.2.0)<br/> |
@@ -44,7 +44,7 @@ discard block |
||
44 | 44 | * @return resource|Socket|null|false Socket resource on success or NULL on failure. |
45 | 45 | * @since 7.2 |
46 | 46 | */ |
47 | -function socket_addrinfo_bind(AddressInfo $address): Socket|false {} |
|
47 | +function socket_addrinfo_bind(AddressInfo $address): Socket | false {} |
|
48 | 48 | |
49 | 49 | /** |
50 | 50 | * (PHP 7 >= 7.2.0)<br/> |
@@ -106,7 +106,7 @@ discard block |
||
106 | 106 | * } |
107 | 107 | * </code> |
108 | 108 | */ |
109 | -function socket_select(?array &$read, ?array &$write, ?array &$except, ?int $seconds, int $microseconds = 0): int|false {} |
|
109 | +function socket_select(?array &$read, ?array &$write, ?array &$except, ?int $seconds, int $microseconds = 0): int | false {} |
|
110 | 110 | |
111 | 111 | /** |
112 | 112 | * Create a socket (endpoint for communication) |
@@ -244,7 +244,7 @@ discard block |
||
244 | 244 | * <b>socket_strerror</b> to get a textual explanation of the |
245 | 245 | * error. |
246 | 246 | */ |
247 | -function socket_create(int $domain, int $type, int $protocol): Socket|false {} |
|
247 | +function socket_create(int $domain, int $type, int $protocol): Socket | false {} |
|
248 | 248 | |
249 | 249 | /** |
250 | 250 | * @param resource|Socket $socket |
@@ -271,7 +271,7 @@ discard block |
||
271 | 271 | * <b>socket_strerror</b> to get a textual explanation of the |
272 | 272 | * error. |
273 | 273 | */ |
274 | -function socket_create_listen(int $port, int $backlog = 128): Socket|false {} |
|
274 | +function socket_create_listen(int $port, int $backlog = 128): Socket | false {} |
|
275 | 275 | |
276 | 276 | /** |
277 | 277 | * Creates a pair of indistinguishable sockets and stores them in an array |
@@ -318,7 +318,7 @@ discard block |
||
318 | 318 | * <b>socket_strerror</b> to get a textual explanation of the |
319 | 319 | * error. |
320 | 320 | */ |
321 | -function socket_accept(Socket $socket): Socket|false {} |
|
321 | +function socket_accept(Socket $socket): Socket | false {} |
|
322 | 322 | |
323 | 323 | /** |
324 | 324 | * Sets nonblocking mode for file descriptor fd |
@@ -407,7 +407,7 @@ discard block |
||
407 | 407 | * === operator to check for <b>FALSE</b> in case of an |
408 | 408 | * error. |
409 | 409 | */ |
410 | -function socket_write(Socket $socket, string $data, ?int $length = 0): int|false {} |
|
410 | +function socket_write(Socket $socket, string $data, ?int $length = 0): int | false {} |
|
411 | 411 | |
412 | 412 | /** |
413 | 413 | * Reads a maximum of length bytes from a socket |
@@ -438,7 +438,7 @@ discard block |
||
438 | 438 | * <b>socket_read</b> returns a zero length string ("") |
439 | 439 | * when there is no more data to read.</p> |
440 | 440 | */ |
441 | -function socket_read(Socket $socket, int $length, int $mode = PHP_BINARY_READ): string|false {} |
|
441 | +function socket_read(Socket $socket, int $length, int $mode = PHP_BINARY_READ): string | false {} |
|
442 | 442 | |
443 | 443 | /** |
444 | 444 | * Queries the local side of the given socket which may either result in host/port or in a Unix filesystem path, dependent on its type |
@@ -638,7 +638,7 @@ discard block |
||
638 | 638 | * passed to <b>socket_strerror</b> to get a textual explanation |
639 | 639 | * of the error. |
640 | 640 | */ |
641 | -function socket_recv(Socket $socket, &$data, int $length, int $flags): int|false {} |
|
641 | +function socket_recv(Socket $socket, &$data, int $length, int $flags): int | false {} |
|
642 | 642 | |
643 | 643 | /** |
644 | 644 | * Sends data to a connected socket |
@@ -690,7 +690,7 @@ discard block |
||
690 | 690 | * </p> |
691 | 691 | * @return int|false <b>socket_send</b> returns the number of bytes sent, or <b>FALSE</b> on error. |
692 | 692 | */ |
693 | -function socket_send(Socket $socket, string $data, int $length, int $flags): int|false {} |
|
693 | +function socket_send(Socket $socket, string $data, int $length, int $flags): int | false {} |
|
694 | 694 | |
695 | 695 | /** |
696 | 696 | * (PHP 5 >=5.5.0)<br/> |
@@ -705,9 +705,9 @@ discard block |
||
705 | 705 | function socket_sendmsg( |
706 | 706 | Socket $socket, |
707 | 707 | array $message, |
708 | - #[PhpStormStubsElementAvailable(from: '5.5', to: '7.4')] int $flags, |
|
709 | - #[PhpStormStubsElementAvailable(from: '8.0')] int $flags = 0 |
|
710 | -): int|false {} |
|
708 | + #[PhpStormStubsElementAvailable(from : '5.5', to : '7.4')] int $flags, |
|
709 | + #[PhpStormStubsElementAvailable(from : '8.0')] int $flags = 0 |
|
710 | +): int | false {} |
|
711 | 711 | |
712 | 712 | /** |
713 | 713 | * Receives data from a socket whether or not it is connection-oriented |
@@ -781,7 +781,7 @@ discard block |
||
781 | 781 | * passed to <b>socket_strerror</b> to get a textual explanation |
782 | 782 | * of the error. |
783 | 783 | */ |
784 | -function socket_recvfrom(Socket $socket, &$data, int $length, int $flags, &$address, &$port = null): int|false {} |
|
784 | +function socket_recvfrom(Socket $socket, &$data, int $length, int $flags, &$address, &$port = null): int | false {} |
|
785 | 785 | |
786 | 786 | /** |
787 | 787 | * Read a message |
@@ -795,9 +795,9 @@ discard block |
||
795 | 795 | function socket_recvmsg( |
796 | 796 | Socket $socket, |
797 | 797 | array &$message, |
798 | - #[PhpStormStubsElementAvailable(from: '5.5', to: '7.4')] int $flags, |
|
799 | - #[PhpStormStubsElementAvailable(from: '8.0')] int $flags = 0 |
|
800 | -): int|false {} |
|
798 | + #[PhpStormStubsElementAvailable(from : '5.5', to : '7.4')] int $flags, |
|
799 | + #[PhpStormStubsElementAvailable(from : '8.0')] int $flags = 0 |
|
800 | +): int | false {} |
|
801 | 801 | |
802 | 802 | /** |
803 | 803 | * Sends a message to a socket, whether it is connected or not |
@@ -856,7 +856,7 @@ discard block |
||
856 | 856 | * @return int|false <b>socket_sendto</b> returns the number of bytes sent to the |
857 | 857 | * remote host, or <b>FALSE</b> if an error occurred. |
858 | 858 | */ |
859 | -function socket_sendto(Socket $socket, string $data, int $length, int $flags, string $address, ?int $port = 0): int|false {} |
|
859 | +function socket_sendto(Socket $socket, string $data, int $length, int $flags, string $address, ?int $port = 0): int | false {} |
|
860 | 860 | |
861 | 861 | /** |
862 | 862 | * Gets socket options for the socket |
@@ -1222,7 +1222,7 @@ discard block |
||
1222 | 1222 | * </table> |
1223 | 1223 | * @return array|int|false the value of the given option, or <b>FALSE</b> on errors. |
1224 | 1224 | */ |
1225 | -function socket_get_option(Socket $socket, int $level, int $option): array|int|false {} |
|
1225 | +function socket_get_option(Socket $socket, int $level, int $option): array | int | false {} |
|
1226 | 1226 | |
1227 | 1227 | /** |
1228 | 1228 | * Sets socket options for the socket |
@@ -1314,7 +1314,7 @@ discard block |
||
1314 | 1314 | * @return resource|Socket|false|null <b>FALSE</b> or <b>NULL</b> on failure. |
1315 | 1315 | * @since 5.4 |
1316 | 1316 | */ |
1317 | -function socket_import_stream($stream): Socket|false {} |
|
1317 | +function socket_import_stream($stream): Socket | false {} |
|
1318 | 1318 | |
1319 | 1319 | /** |
1320 | 1320 | * Calculate message buffer size |
@@ -1328,7 +1328,7 @@ discard block |
||
1328 | 1328 | function socket_cmsg_space( |
1329 | 1329 | int $level, |
1330 | 1330 | int $type, |
1331 | - #[PhpStormStubsElementAvailable(from: '8.0')] int $num = 0 |
|
1331 | + #[PhpStormStubsElementAvailable(from : '8.0')] int $num = 0 |
|
1332 | 1332 | ): ?int {} |
1333 | 1333 | |
1334 | 1334 | /** |
@@ -1337,7 +1337,7 @@ discard block |
||
1337 | 1337 | * @param int $level |
1338 | 1338 | * @param int $option |
1339 | 1339 | */ |
1340 | -function socket_getopt(Socket $socket, int $level, int $option): array|int|false {} |
|
1340 | +function socket_getopt(Socket $socket, int $level, int $option): array | int | false {} |
|
1341 | 1341 | |
1342 | 1342 | /** |
1343 | 1343 | * Alias of {@see socket_set_option} |
@@ -2184,8 +2184,7 @@ discard block |
||
2184 | 2184 | /** |
2185 | 2185 | * @since 8.0 |
2186 | 2186 | */ |
2187 | -final class Socket |
|
2188 | -{ |
|
2187 | +final class Socket { |
|
2189 | 2188 | /** |
2190 | 2189 | * Cannot directly construct Socket, use socket_create() instead |
2191 | 2190 | * @see socket_create() |
@@ -2196,8 +2195,7 @@ discard block |
||
2196 | 2195 | /** |
2197 | 2196 | * @since 8.0 |
2198 | 2197 | */ |
2199 | -final class AddressInfo |
|
2200 | -{ |
|
2198 | +final class AddressInfo { |
|
2201 | 2199 | /** |
2202 | 2200 | * Cannot directly construct AddressInfo, use socket_addrinfo_lookup() instead |
2203 | 2201 | * @see socket_addrinfo_lookup() |