@@ -31,743 +31,743 @@ |
||
| 31 | 31 | */ |
| 32 | 32 | class Process implements \IteratorAggregate |
| 33 | 33 | { |
| 34 | - public const ERR = 'err'; |
|
| 35 | - public const OUT = 'out'; |
|
| 36 | - |
|
| 37 | - public const STATUS_READY = 'ready'; |
|
| 38 | - public const STATUS_STARTED = 'started'; |
|
| 39 | - public const STATUS_TERMINATED = 'terminated'; |
|
| 40 | - |
|
| 41 | - public const STDIN = 0; |
|
| 42 | - public const STDOUT = 1; |
|
| 43 | - public const STDERR = 2; |
|
| 44 | - |
|
| 45 | - // Timeout Precision in seconds. |
|
| 46 | - public const TIMEOUT_PRECISION = 0.2; |
|
| 47 | - |
|
| 48 | - public const ITER_NON_BLOCKING = 1; // By default, iterating over outputs is a blocking call, use this flag to make it non-blocking |
|
| 49 | - public const ITER_KEEP_OUTPUT = 2; // By default, outputs are cleared while iterating, use this flag to keep them in memory |
|
| 50 | - public const ITER_SKIP_OUT = 4; // Use this flag to skip STDOUT while iterating |
|
| 51 | - public const ITER_SKIP_ERR = 8; |
|
| 52 | - |
|
| 53 | - /** |
|
| 54 | - * Exit codes translation table. |
|
| 55 | - * |
|
| 56 | - * User-defined errors must use exit codes in the 64-113 range. |
|
| 57 | - */ |
|
| 58 | - public static $exitCodes = [ |
|
| 59 | - 0 => 'OK', |
|
| 60 | - 1 => 'General error', |
|
| 61 | - 2 => 'Misuse of shell builtins', |
|
| 62 | - |
|
| 63 | - 126 => 'Invoked command cannot execute', |
|
| 64 | - 127 => 'Command not found', |
|
| 65 | - 128 => 'Invalid exit argument', |
|
| 66 | - |
|
| 67 | - // signals |
|
| 68 | - 129 => 'Hangup', |
|
| 69 | - 130 => 'Interrupt', |
|
| 70 | - 131 => 'Quit and dump core', |
|
| 71 | - 132 => 'Illegal instruction', |
|
| 72 | - 133 => 'Trace/breakpoint trap', |
|
| 73 | - 134 => 'Process aborted', |
|
| 74 | - 135 => 'Bus error: "access to undefined portion of memory object"', |
|
| 75 | - 136 => 'Floating point exception: "erroneous arithmetic operation"', |
|
| 76 | - 137 => 'Kill (terminate immediately)', |
|
| 77 | - 138 => 'User-defined 1', |
|
| 78 | - 139 => 'Segmentation violation', |
|
| 79 | - 140 => 'User-defined 2', |
|
| 80 | - 141 => 'Write to pipe with no one reading', |
|
| 81 | - 142 => 'Signal raised by alarm', |
|
| 82 | - 143 => 'Termination (request to terminate)', |
|
| 83 | - // 144 - not defined |
|
| 84 | - 145 => 'Child process terminated, stopped (or continued*)', |
|
| 85 | - 146 => 'Continue if stopped', |
|
| 86 | - 147 => 'Stop executing temporarily', |
|
| 87 | - 148 => 'Terminal stop signal', |
|
| 88 | - 149 => 'Background process attempting to read from tty ("in")', |
|
| 89 | - 150 => 'Background process attempting to write to tty ("out")', |
|
| 90 | - 151 => 'Urgent data available on socket', |
|
| 91 | - 152 => 'CPU time limit exceeded', |
|
| 92 | - 153 => 'File size limit exceeded', |
|
| 93 | - 154 => 'Signal raised by timer counting virtual time: "virtual timer expired"', |
|
| 94 | - 155 => 'Profiling timer expired', |
|
| 95 | - // 156 - not defined |
|
| 96 | - 157 => 'Pollable event', |
|
| 97 | - // 158 - not defined |
|
| 98 | - 159 => 'Bad syscall', |
|
| 99 | - ]; |
|
| 100 | - |
|
| 101 | - /** |
|
| 102 | - * @param array $command The command to run and its arguments listed as separate entries |
|
| 103 | - * @param string|null $cwd The working directory or null to use the working dir of the current PHP process |
|
| 104 | - * @param array|null $env The environment variables or null to use the same environment as the current PHP process |
|
| 105 | - * @param mixed $input The input as stream resource, scalar or \Traversable, or null for no input |
|
| 106 | - * @param int|float|null $timeout The timeout in seconds or null to disable |
|
| 107 | - * |
|
| 108 | - * @throws LogicException When proc_open is not installed |
|
| 109 | - */ |
|
| 110 | - public function __construct(array $command, ?string $cwd = null, ?array $env = null, mixed $input = null, ?float $timeout = 60) |
|
| 111 | - { |
|
| 112 | - } |
|
| 113 | - |
|
| 114 | - /** |
|
| 115 | - * Creates a Process instance as a command-line to be run in a shell wrapper. |
|
| 116 | - * |
|
| 117 | - * Command-lines are parsed by the shell of your OS (/bin/sh on Unix-like, cmd.exe on Windows.) |
|
| 118 | - * This allows using e.g. pipes or conditional execution. In this mode, signals are sent to the |
|
| 119 | - * shell wrapper and not to your commands. |
|
| 120 | - * |
|
| 121 | - * In order to inject dynamic values into command-lines, we strongly recommend using placeholders. |
|
| 122 | - * This will save escaping values, which is not portable nor secure anyway: |
|
| 123 | - * |
|
| 124 | - * $process = Process::fromShellCommandline('my_command "${:MY_VAR}"'); |
|
| 125 | - * $process->run(null, ['MY_VAR' => $theValue]); |
|
| 126 | - * |
|
| 127 | - * @param string $command The command line to pass to the shell of the OS |
|
| 128 | - * @param string|null $cwd The working directory or null to use the working dir of the current PHP process |
|
| 129 | - * @param array|null $env The environment variables or null to use the same environment as the current PHP process |
|
| 130 | - * @param mixed $input The input as stream resource, scalar or \Traversable, or null for no input |
|
| 131 | - * @param int|float|null $timeout The timeout in seconds or null to disable |
|
| 132 | - * |
|
| 133 | - * @throws LogicException When proc_open is not installed |
|
| 134 | - */ |
|
| 135 | - public static function fromShellCommandline(string $command, ?string $cwd = null, ?array $env = null, mixed $input = null, ?float $timeout = 60): static |
|
| 136 | - { |
|
| 137 | - } |
|
| 138 | - |
|
| 139 | - public function __sleep(): array |
|
| 140 | - { |
|
| 141 | - } |
|
| 142 | - |
|
| 143 | - /** |
|
| 144 | - * @return void |
|
| 145 | - */ |
|
| 146 | - public function __wakeup() |
|
| 147 | - { |
|
| 148 | - } |
|
| 149 | - |
|
| 150 | - public function __destruct() |
|
| 151 | - { |
|
| 152 | - } |
|
| 153 | - |
|
| 154 | - public function __clone() |
|
| 155 | - { |
|
| 156 | - } |
|
| 157 | - |
|
| 158 | - /** |
|
| 159 | - * Runs the process. |
|
| 160 | - * |
|
| 161 | - * The callback receives the type of output (out or err) and |
|
| 162 | - * some bytes from the output in real-time. It allows to have feedback |
|
| 163 | - * from the independent process during execution. |
|
| 164 | - * |
|
| 165 | - * The STDOUT and STDERR are also available after the process is finished |
|
| 166 | - * via the getOutput() and getErrorOutput() methods. |
|
| 167 | - * |
|
| 168 | - * @param callable|null $callback A PHP callback to run whenever there is some |
|
| 169 | - * output available on STDOUT or STDERR |
|
| 170 | - * |
|
| 171 | - * @return int The exit status code |
|
| 172 | - * |
|
| 173 | - * @throws RuntimeException When process can't be launched |
|
| 174 | - * @throws RuntimeException When process is already running |
|
| 175 | - * @throws ProcessTimedOutException When process timed out |
|
| 176 | - * @throws ProcessSignaledException When process stopped after receiving signal |
|
| 177 | - * @throws LogicException In case a callback is provided and output has been disabled |
|
| 178 | - * |
|
| 179 | - * @final |
|
| 180 | - */ |
|
| 181 | - public function run(?callable $callback = null, array $env = []): int |
|
| 182 | - { |
|
| 183 | - } |
|
| 184 | - |
|
| 185 | - /** |
|
| 186 | - * Runs the process. |
|
| 187 | - * |
|
| 188 | - * This is identical to run() except that an exception is thrown if the process |
|
| 189 | - * exits with a non-zero exit code. |
|
| 190 | - * |
|
| 191 | - * @return $this |
|
| 192 | - * |
|
| 193 | - * @throws ProcessFailedException if the process didn't terminate successfully |
|
| 194 | - * |
|
| 195 | - * @final |
|
| 196 | - */ |
|
| 197 | - public function mustRun(?callable $callback = null, array $env = []): static |
|
| 198 | - { |
|
| 199 | - } |
|
| 200 | - |
|
| 201 | - /** |
|
| 202 | - * Starts the process and returns after writing the input to STDIN. |
|
| 203 | - * |
|
| 204 | - * This method blocks until all STDIN data is sent to the process then it |
|
| 205 | - * returns while the process runs in the background. |
|
| 206 | - * |
|
| 207 | - * The termination of the process can be awaited with wait(). |
|
| 208 | - * |
|
| 209 | - * The callback receives the type of output (out or err) and some bytes from |
|
| 210 | - * the output in real-time while writing the standard input to the process. |
|
| 211 | - * It allows to have feedback from the independent process during execution. |
|
| 212 | - * |
|
| 213 | - * @param callable|null $callback A PHP callback to run whenever there is some |
|
| 214 | - * output available on STDOUT or STDERR |
|
| 215 | - * |
|
| 216 | - * @return void |
|
| 217 | - * |
|
| 218 | - * @throws RuntimeException When process can't be launched |
|
| 219 | - * @throws RuntimeException When process is already running |
|
| 220 | - * @throws LogicException In case a callback is provided and output has been disabled |
|
| 221 | - */ |
|
| 222 | - public function start(?callable $callback = null, array $env = []) |
|
| 223 | - { |
|
| 224 | - } |
|
| 225 | - |
|
| 226 | - /** |
|
| 227 | - * Restarts the process. |
|
| 228 | - * |
|
| 229 | - * Be warned that the process is cloned before being started. |
|
| 230 | - * |
|
| 231 | - * @param callable|null $callback A PHP callback to run whenever there is some |
|
| 232 | - * output available on STDOUT or STDERR |
|
| 233 | - * |
|
| 234 | - * @throws RuntimeException When process can't be launched |
|
| 235 | - * @throws RuntimeException When process is already running |
|
| 236 | - * |
|
| 237 | - * @see start() |
|
| 238 | - * |
|
| 239 | - * @final |
|
| 240 | - */ |
|
| 241 | - public function restart(?callable $callback = null, array $env = []): static |
|
| 242 | - { |
|
| 243 | - } |
|
| 244 | - |
|
| 245 | - /** |
|
| 246 | - * Waits for the process to terminate. |
|
| 247 | - * |
|
| 248 | - * The callback receives the type of output (out or err) and some bytes |
|
| 249 | - * from the output in real-time while writing the standard input to the process. |
|
| 250 | - * It allows to have feedback from the independent process during execution. |
|
| 251 | - * |
|
| 252 | - * @param callable|null $callback A valid PHP callback |
|
| 253 | - * |
|
| 254 | - * @return int The exitcode of the process |
|
| 255 | - * |
|
| 256 | - * @throws ProcessTimedOutException When process timed out |
|
| 257 | - * @throws ProcessSignaledException When process stopped after receiving signal |
|
| 258 | - * @throws LogicException When process is not yet started |
|
| 259 | - */ |
|
| 260 | - public function wait(?callable $callback = null): int |
|
| 261 | - { |
|
| 262 | - } |
|
| 263 | - |
|
| 264 | - /** |
|
| 265 | - * Waits until the callback returns true. |
|
| 266 | - * |
|
| 267 | - * The callback receives the type of output (out or err) and some bytes |
|
| 268 | - * from the output in real-time while writing the standard input to the process. |
|
| 269 | - * It allows to have feedback from the independent process during execution. |
|
| 270 | - * |
|
| 271 | - * @throws RuntimeException When process timed out |
|
| 272 | - * @throws LogicException When process is not yet started |
|
| 273 | - * @throws ProcessTimedOutException In case the timeout was reached |
|
| 274 | - */ |
|
| 275 | - public function waitUntil(callable $callback): bool |
|
| 276 | - { |
|
| 277 | - } |
|
| 278 | - |
|
| 279 | - /** |
|
| 280 | - * Returns the Pid (process identifier), if applicable. |
|
| 281 | - * |
|
| 282 | - * @return int|null The process id if running, null otherwise |
|
| 283 | - */ |
|
| 284 | - public function getPid(): ?int |
|
| 285 | - { |
|
| 286 | - } |
|
| 287 | - |
|
| 288 | - /** |
|
| 289 | - * Sends a POSIX signal to the process. |
|
| 290 | - * |
|
| 291 | - * @param int $signal A valid POSIX signal (see https://php.net/pcntl.constants) |
|
| 292 | - * |
|
| 293 | - * @return $this |
|
| 294 | - * |
|
| 295 | - * @throws LogicException In case the process is not running |
|
| 296 | - * @throws RuntimeException In case --enable-sigchild is activated and the process can't be killed |
|
| 297 | - * @throws RuntimeException In case of failure |
|
| 298 | - */ |
|
| 299 | - public function signal(int $signal): static |
|
| 300 | - { |
|
| 301 | - } |
|
| 302 | - |
|
| 303 | - /** |
|
| 304 | - * Disables fetching output and error output from the underlying process. |
|
| 305 | - * |
|
| 306 | - * @return $this |
|
| 307 | - * |
|
| 308 | - * @throws RuntimeException In case the process is already running |
|
| 309 | - * @throws LogicException if an idle timeout is set |
|
| 310 | - */ |
|
| 311 | - public function disableOutput(): static |
|
| 312 | - { |
|
| 313 | - } |
|
| 314 | - |
|
| 315 | - /** |
|
| 316 | - * Enables fetching output and error output from the underlying process. |
|
| 317 | - * |
|
| 318 | - * @return $this |
|
| 319 | - * |
|
| 320 | - * @throws RuntimeException In case the process is already running |
|
| 321 | - */ |
|
| 322 | - public function enableOutput(): static |
|
| 323 | - { |
|
| 324 | - } |
|
| 325 | - |
|
| 326 | - /** |
|
| 327 | - * Returns true in case the output is disabled, false otherwise. |
|
| 328 | - */ |
|
| 329 | - public function isOutputDisabled(): bool |
|
| 330 | - { |
|
| 331 | - } |
|
| 332 | - |
|
| 333 | - /** |
|
| 334 | - * Returns the current output of the process (STDOUT). |
|
| 335 | - * |
|
| 336 | - * @throws LogicException in case the output has been disabled |
|
| 337 | - * @throws LogicException In case the process is not started |
|
| 338 | - */ |
|
| 339 | - public function getOutput(): string |
|
| 340 | - { |
|
| 341 | - } |
|
| 342 | - |
|
| 343 | - /** |
|
| 344 | - * Returns the output incrementally. |
|
| 345 | - * |
|
| 346 | - * In comparison with the getOutput method which always return the whole |
|
| 347 | - * output, this one returns the new output since the last call. |
|
| 348 | - * |
|
| 349 | - * @throws LogicException in case the output has been disabled |
|
| 350 | - * @throws LogicException In case the process is not started |
|
| 351 | - */ |
|
| 352 | - public function getIncrementalOutput(): string |
|
| 353 | - { |
|
| 354 | - } |
|
| 355 | - |
|
| 356 | - /** |
|
| 357 | - * Returns an iterator to the output of the process, with the output type as keys (Process::OUT/ERR). |
|
| 358 | - * |
|
| 359 | - * @param int $flags A bit field of Process::ITER_* flags |
|
| 360 | - * |
|
| 361 | - * @return \Generator<string, string> |
|
| 362 | - * |
|
| 363 | - * @throws LogicException in case the output has been disabled |
|
| 364 | - * @throws LogicException In case the process is not started |
|
| 365 | - */ |
|
| 366 | - public function getIterator(int $flags = 0): \Generator |
|
| 367 | - { |
|
| 368 | - } |
|
| 369 | - |
|
| 370 | - /** |
|
| 371 | - * Clears the process output. |
|
| 372 | - * |
|
| 373 | - * @return $this |
|
| 374 | - */ |
|
| 375 | - public function clearOutput(): static |
|
| 376 | - { |
|
| 377 | - } |
|
| 378 | - |
|
| 379 | - /** |
|
| 380 | - * Returns the current error output of the process (STDERR). |
|
| 381 | - * |
|
| 382 | - * @throws LogicException in case the output has been disabled |
|
| 383 | - * @throws LogicException In case the process is not started |
|
| 384 | - */ |
|
| 385 | - public function getErrorOutput(): string |
|
| 386 | - { |
|
| 387 | - } |
|
| 388 | - |
|
| 389 | - /** |
|
| 390 | - * Returns the errorOutput incrementally. |
|
| 391 | - * |
|
| 392 | - * In comparison with the getErrorOutput method which always return the |
|
| 393 | - * whole error output, this one returns the new error output since the last |
|
| 394 | - * call. |
|
| 395 | - * |
|
| 396 | - * @throws LogicException in case the output has been disabled |
|
| 397 | - * @throws LogicException In case the process is not started |
|
| 398 | - */ |
|
| 399 | - public function getIncrementalErrorOutput(): string |
|
| 400 | - { |
|
| 401 | - } |
|
| 402 | - |
|
| 403 | - /** |
|
| 404 | - * Clears the process output. |
|
| 405 | - * |
|
| 406 | - * @return $this |
|
| 407 | - */ |
|
| 408 | - public function clearErrorOutput(): static |
|
| 409 | - { |
|
| 410 | - } |
|
| 411 | - |
|
| 412 | - /** |
|
| 413 | - * Returns the exit code returned by the process. |
|
| 414 | - * |
|
| 415 | - * @return int|null The exit status code, null if the Process is not terminated |
|
| 416 | - */ |
|
| 417 | - public function getExitCode(): ?int |
|
| 418 | - { |
|
| 419 | - } |
|
| 420 | - |
|
| 421 | - /** |
|
| 422 | - * Returns a string representation for the exit code returned by the process. |
|
| 423 | - * |
|
| 424 | - * This method relies on the Unix exit code status standardization |
|
| 425 | - * and might not be relevant for other operating systems. |
|
| 426 | - * |
|
| 427 | - * @return string|null A string representation for the exit status code, null if the Process is not terminated |
|
| 428 | - * |
|
| 429 | - * @see http://tldp.org/LDP/abs/html/exitcodes.html |
|
| 430 | - * @see http://en.wikipedia.org/wiki/Unix_signal |
|
| 431 | - */ |
|
| 432 | - public function getExitCodeText(): ?string |
|
| 433 | - { |
|
| 434 | - } |
|
| 435 | - |
|
| 436 | - /** |
|
| 437 | - * Checks if the process ended successfully. |
|
| 438 | - */ |
|
| 439 | - public function isSuccessful(): bool |
|
| 440 | - { |
|
| 441 | - } |
|
| 442 | - |
|
| 443 | - /** |
|
| 444 | - * Returns true if the child process has been terminated by an uncaught signal. |
|
| 445 | - * |
|
| 446 | - * It always returns false on Windows. |
|
| 447 | - * |
|
| 448 | - * @throws LogicException In case the process is not terminated |
|
| 449 | - */ |
|
| 450 | - public function hasBeenSignaled(): bool |
|
| 451 | - { |
|
| 452 | - } |
|
| 453 | - |
|
| 454 | - /** |
|
| 455 | - * Returns the number of the signal that caused the child process to terminate its execution. |
|
| 456 | - * |
|
| 457 | - * It is only meaningful if hasBeenSignaled() returns true. |
|
| 458 | - * |
|
| 459 | - * @throws RuntimeException In case --enable-sigchild is activated |
|
| 460 | - * @throws LogicException In case the process is not terminated |
|
| 461 | - */ |
|
| 462 | - public function getTermSignal(): int |
|
| 463 | - { |
|
| 464 | - } |
|
| 465 | - |
|
| 466 | - /** |
|
| 467 | - * Returns true if the child process has been stopped by a signal. |
|
| 468 | - * |
|
| 469 | - * It always returns false on Windows. |
|
| 470 | - * |
|
| 471 | - * @throws LogicException In case the process is not terminated |
|
| 472 | - */ |
|
| 473 | - public function hasBeenStopped(): bool |
|
| 474 | - { |
|
| 475 | - } |
|
| 476 | - |
|
| 477 | - /** |
|
| 478 | - * Returns the number of the signal that caused the child process to stop its execution. |
|
| 479 | - * |
|
| 480 | - * It is only meaningful if hasBeenStopped() returns true. |
|
| 481 | - * |
|
| 482 | - * @throws LogicException In case the process is not terminated |
|
| 483 | - */ |
|
| 484 | - public function getStopSignal(): int |
|
| 485 | - { |
|
| 486 | - } |
|
| 487 | - |
|
| 488 | - /** |
|
| 489 | - * Checks if the process is currently running. |
|
| 490 | - */ |
|
| 491 | - public function isRunning(): bool |
|
| 492 | - { |
|
| 493 | - } |
|
| 494 | - |
|
| 495 | - /** |
|
| 496 | - * Checks if the process has been started with no regard to the current state. |
|
| 497 | - */ |
|
| 498 | - public function isStarted(): bool |
|
| 499 | - { |
|
| 500 | - } |
|
| 501 | - |
|
| 502 | - /** |
|
| 503 | - * Checks if the process is terminated. |
|
| 504 | - */ |
|
| 505 | - public function isTerminated(): bool |
|
| 506 | - { |
|
| 507 | - } |
|
| 508 | - |
|
| 509 | - /** |
|
| 510 | - * Gets the process status. |
|
| 511 | - * |
|
| 512 | - * The status is one of: ready, started, terminated. |
|
| 513 | - */ |
|
| 514 | - public function getStatus(): string |
|
| 515 | - { |
|
| 516 | - } |
|
| 517 | - |
|
| 518 | - /** |
|
| 519 | - * Stops the process. |
|
| 520 | - * |
|
| 521 | - * @param int|float $timeout The timeout in seconds |
|
| 522 | - * @param int|null $signal A POSIX signal to send in case the process has not stop at timeout, default is SIGKILL (9) |
|
| 523 | - * |
|
| 524 | - * @return int|null The exit-code of the process or null if it's not running |
|
| 525 | - */ |
|
| 526 | - public function stop(float $timeout = 10, ?int $signal = null): ?int |
|
| 527 | - { |
|
| 528 | - } |
|
| 529 | - |
|
| 530 | - /** |
|
| 531 | - * Adds a line to the STDOUT stream. |
|
| 532 | - * |
|
| 533 | - * @internal |
|
| 534 | - */ |
|
| 535 | - public function addOutput(string $line): void |
|
| 536 | - { |
|
| 537 | - } |
|
| 538 | - |
|
| 539 | - /** |
|
| 540 | - * Adds a line to the STDERR stream. |
|
| 541 | - * |
|
| 542 | - * @internal |
|
| 543 | - */ |
|
| 544 | - public function addErrorOutput(string $line): void |
|
| 545 | - { |
|
| 546 | - } |
|
| 547 | - |
|
| 548 | - /** |
|
| 549 | - * Gets the last output time in seconds. |
|
| 550 | - */ |
|
| 551 | - public function getLastOutputTime(): ?float |
|
| 552 | - { |
|
| 553 | - } |
|
| 554 | - |
|
| 555 | - /** |
|
| 556 | - * Gets the command line to be executed. |
|
| 557 | - */ |
|
| 558 | - public function getCommandLine(): string |
|
| 559 | - { |
|
| 560 | - } |
|
| 561 | - |
|
| 562 | - /** |
|
| 563 | - * Gets the process timeout in seconds (max. runtime). |
|
| 564 | - */ |
|
| 565 | - public function getTimeout(): ?float |
|
| 566 | - { |
|
| 567 | - } |
|
| 568 | - |
|
| 569 | - /** |
|
| 570 | - * Gets the process idle timeout in seconds (max. time since last output). |
|
| 571 | - */ |
|
| 572 | - public function getIdleTimeout(): ?float |
|
| 573 | - { |
|
| 574 | - } |
|
| 575 | - |
|
| 576 | - /** |
|
| 577 | - * Sets the process timeout (max. runtime) in seconds. |
|
| 578 | - * |
|
| 579 | - * To disable the timeout, set this value to null. |
|
| 580 | - * |
|
| 581 | - * @return $this |
|
| 582 | - * |
|
| 583 | - * @throws InvalidArgumentException if the timeout is negative |
|
| 584 | - */ |
|
| 585 | - public function setTimeout(?float $timeout): static |
|
| 586 | - { |
|
| 587 | - } |
|
| 588 | - |
|
| 589 | - /** |
|
| 590 | - * Sets the process idle timeout (max. time since last output) in seconds. |
|
| 591 | - * |
|
| 592 | - * To disable the timeout, set this value to null. |
|
| 593 | - * |
|
| 594 | - * @return $this |
|
| 595 | - * |
|
| 596 | - * @throws LogicException if the output is disabled |
|
| 597 | - * @throws InvalidArgumentException if the timeout is negative |
|
| 598 | - */ |
|
| 599 | - public function setIdleTimeout(?float $timeout): static |
|
| 600 | - { |
|
| 601 | - } |
|
| 602 | - |
|
| 603 | - /** |
|
| 604 | - * Enables or disables the TTY mode. |
|
| 605 | - * |
|
| 606 | - * @return $this |
|
| 607 | - * |
|
| 608 | - * @throws RuntimeException In case the TTY mode is not supported |
|
| 609 | - */ |
|
| 610 | - public function setTty(bool $tty): static |
|
| 611 | - { |
|
| 612 | - } |
|
| 613 | - |
|
| 614 | - /** |
|
| 615 | - * Checks if the TTY mode is enabled. |
|
| 616 | - */ |
|
| 617 | - public function isTty(): bool |
|
| 618 | - { |
|
| 619 | - } |
|
| 620 | - |
|
| 621 | - /** |
|
| 622 | - * Sets PTY mode. |
|
| 623 | - * |
|
| 624 | - * @return $this |
|
| 625 | - */ |
|
| 626 | - public function setPty(bool $bool): static |
|
| 627 | - { |
|
| 628 | - } |
|
| 629 | - |
|
| 630 | - /** |
|
| 631 | - * Returns PTY state. |
|
| 632 | - */ |
|
| 633 | - public function isPty(): bool |
|
| 634 | - { |
|
| 635 | - } |
|
| 636 | - |
|
| 637 | - /** |
|
| 638 | - * Gets the working directory. |
|
| 639 | - */ |
|
| 640 | - public function getWorkingDirectory(): ?string |
|
| 641 | - { |
|
| 642 | - } |
|
| 643 | - |
|
| 644 | - /** |
|
| 645 | - * Sets the current working directory. |
|
| 646 | - * |
|
| 647 | - * @return $this |
|
| 648 | - */ |
|
| 649 | - public function setWorkingDirectory(string $cwd): static |
|
| 650 | - { |
|
| 651 | - } |
|
| 652 | - |
|
| 653 | - /** |
|
| 654 | - * Gets the environment variables. |
|
| 655 | - */ |
|
| 656 | - public function getEnv(): array |
|
| 657 | - { |
|
| 658 | - } |
|
| 659 | - |
|
| 660 | - /** |
|
| 661 | - * Sets the environment variables. |
|
| 662 | - * |
|
| 663 | - * @param array<string|\Stringable> $env The new environment variables |
|
| 664 | - * |
|
| 665 | - * @return $this |
|
| 666 | - */ |
|
| 667 | - public function setEnv(array $env): static |
|
| 668 | - { |
|
| 669 | - } |
|
| 670 | - |
|
| 671 | - /** |
|
| 672 | - * Gets the Process input. |
|
| 673 | - * |
|
| 674 | - * @return resource|string|\Iterator|null |
|
| 675 | - */ |
|
| 676 | - public function getInput() |
|
| 677 | - { |
|
| 678 | - } |
|
| 679 | - |
|
| 680 | - /** |
|
| 681 | - * Sets the input. |
|
| 682 | - * |
|
| 683 | - * This content will be passed to the underlying process standard input. |
|
| 684 | - * |
|
| 685 | - * @param string|resource|\Traversable|self|null $input The content |
|
| 686 | - * |
|
| 687 | - * @return $this |
|
| 688 | - * |
|
| 689 | - * @throws LogicException In case the process is running |
|
| 690 | - */ |
|
| 691 | - public function setInput(mixed $input): static |
|
| 692 | - { |
|
| 693 | - } |
|
| 694 | - |
|
| 695 | - /** |
|
| 696 | - * Performs a check between the timeout definition and the time the process started. |
|
| 697 | - * |
|
| 698 | - * In case you run a background process (with the start method), you should |
|
| 699 | - * trigger this method regularly to ensure the process timeout |
|
| 700 | - * |
|
| 701 | - * @return void |
|
| 702 | - * |
|
| 703 | - * @throws ProcessTimedOutException In case the timeout was reached |
|
| 704 | - */ |
|
| 705 | - public function checkTimeout() |
|
| 706 | - { |
|
| 707 | - } |
|
| 708 | - |
|
| 709 | - /** |
|
| 710 | - * @throws LogicException in case process is not started |
|
| 711 | - */ |
|
| 712 | - public function getStartTime(): float |
|
| 713 | - { |
|
| 714 | - } |
|
| 715 | - |
|
| 716 | - /** |
|
| 717 | - * Defines options to pass to the underlying proc_open(). |
|
| 718 | - * |
|
| 719 | - * @see https://php.net/proc_open for the options supported by PHP. |
|
| 720 | - * |
|
| 721 | - * Enabling the "create_new_console" option allows a subprocess to continue |
|
| 722 | - * to run after the main process exited, on both Windows and *nix |
|
| 723 | - * |
|
| 724 | - * @return void |
|
| 725 | - */ |
|
| 726 | - public function setOptions(array $options) |
|
| 727 | - { |
|
| 728 | - } |
|
| 729 | - |
|
| 730 | - /** |
|
| 731 | - * Returns whether TTY is supported on the current operating system. |
|
| 732 | - */ |
|
| 733 | - public static function isTtySupported(): bool |
|
| 734 | - { |
|
| 735 | - } |
|
| 736 | - |
|
| 737 | - /** |
|
| 738 | - * Returns whether PTY is supported on the current operating system. |
|
| 739 | - */ |
|
| 740 | - public static function isPtySupported(): bool |
|
| 741 | - { |
|
| 742 | - } |
|
| 743 | - |
|
| 744 | - /** |
|
| 745 | - * Builds up the callback used by wait(). |
|
| 746 | - * |
|
| 747 | - * The callbacks adds all occurred output to the specific buffer and calls |
|
| 748 | - * the user callback (if present) with the received output. |
|
| 749 | - * |
|
| 750 | - * @param callable|null $callback The user defined PHP callback |
|
| 751 | - */ |
|
| 752 | - protected function buildCallback(?callable $callback = null): \Closure |
|
| 753 | - { |
|
| 754 | - } |
|
| 755 | - |
|
| 756 | - /** |
|
| 757 | - * Updates the status of the process, reads pipes. |
|
| 758 | - * |
|
| 759 | - * @param bool $blocking Whether to use a blocking read call |
|
| 760 | - * |
|
| 761 | - * @return void |
|
| 762 | - */ |
|
| 763 | - protected function updateStatus(bool $blocking) |
|
| 764 | - { |
|
| 765 | - } |
|
| 766 | - |
|
| 767 | - /** |
|
| 768 | - * Returns whether PHP has been compiled with the '--enable-sigchild' option or not. |
|
| 769 | - */ |
|
| 770 | - protected function isSigchildEnabled(): bool |
|
| 771 | - { |
|
| 772 | - } |
|
| 34 | + public const ERR = 'err'; |
|
| 35 | + public const OUT = 'out'; |
|
| 36 | + |
|
| 37 | + public const STATUS_READY = 'ready'; |
|
| 38 | + public const STATUS_STARTED = 'started'; |
|
| 39 | + public const STATUS_TERMINATED = 'terminated'; |
|
| 40 | + |
|
| 41 | + public const STDIN = 0; |
|
| 42 | + public const STDOUT = 1; |
|
| 43 | + public const STDERR = 2; |
|
| 44 | + |
|
| 45 | + // Timeout Precision in seconds. |
|
| 46 | + public const TIMEOUT_PRECISION = 0.2; |
|
| 47 | + |
|
| 48 | + public const ITER_NON_BLOCKING = 1; // By default, iterating over outputs is a blocking call, use this flag to make it non-blocking |
|
| 49 | + public const ITER_KEEP_OUTPUT = 2; // By default, outputs are cleared while iterating, use this flag to keep them in memory |
|
| 50 | + public const ITER_SKIP_OUT = 4; // Use this flag to skip STDOUT while iterating |
|
| 51 | + public const ITER_SKIP_ERR = 8; |
|
| 52 | + |
|
| 53 | + /** |
|
| 54 | + * Exit codes translation table. |
|
| 55 | + * |
|
| 56 | + * User-defined errors must use exit codes in the 64-113 range. |
|
| 57 | + */ |
|
| 58 | + public static $exitCodes = [ |
|
| 59 | + 0 => 'OK', |
|
| 60 | + 1 => 'General error', |
|
| 61 | + 2 => 'Misuse of shell builtins', |
|
| 62 | + |
|
| 63 | + 126 => 'Invoked command cannot execute', |
|
| 64 | + 127 => 'Command not found', |
|
| 65 | + 128 => 'Invalid exit argument', |
|
| 66 | + |
|
| 67 | + // signals |
|
| 68 | + 129 => 'Hangup', |
|
| 69 | + 130 => 'Interrupt', |
|
| 70 | + 131 => 'Quit and dump core', |
|
| 71 | + 132 => 'Illegal instruction', |
|
| 72 | + 133 => 'Trace/breakpoint trap', |
|
| 73 | + 134 => 'Process aborted', |
|
| 74 | + 135 => 'Bus error: "access to undefined portion of memory object"', |
|
| 75 | + 136 => 'Floating point exception: "erroneous arithmetic operation"', |
|
| 76 | + 137 => 'Kill (terminate immediately)', |
|
| 77 | + 138 => 'User-defined 1', |
|
| 78 | + 139 => 'Segmentation violation', |
|
| 79 | + 140 => 'User-defined 2', |
|
| 80 | + 141 => 'Write to pipe with no one reading', |
|
| 81 | + 142 => 'Signal raised by alarm', |
|
| 82 | + 143 => 'Termination (request to terminate)', |
|
| 83 | + // 144 - not defined |
|
| 84 | + 145 => 'Child process terminated, stopped (or continued*)', |
|
| 85 | + 146 => 'Continue if stopped', |
|
| 86 | + 147 => 'Stop executing temporarily', |
|
| 87 | + 148 => 'Terminal stop signal', |
|
| 88 | + 149 => 'Background process attempting to read from tty ("in")', |
|
| 89 | + 150 => 'Background process attempting to write to tty ("out")', |
|
| 90 | + 151 => 'Urgent data available on socket', |
|
| 91 | + 152 => 'CPU time limit exceeded', |
|
| 92 | + 153 => 'File size limit exceeded', |
|
| 93 | + 154 => 'Signal raised by timer counting virtual time: "virtual timer expired"', |
|
| 94 | + 155 => 'Profiling timer expired', |
|
| 95 | + // 156 - not defined |
|
| 96 | + 157 => 'Pollable event', |
|
| 97 | + // 158 - not defined |
|
| 98 | + 159 => 'Bad syscall', |
|
| 99 | + ]; |
|
| 100 | + |
|
| 101 | + /** |
|
| 102 | + * @param array $command The command to run and its arguments listed as separate entries |
|
| 103 | + * @param string|null $cwd The working directory or null to use the working dir of the current PHP process |
|
| 104 | + * @param array|null $env The environment variables or null to use the same environment as the current PHP process |
|
| 105 | + * @param mixed $input The input as stream resource, scalar or \Traversable, or null for no input |
|
| 106 | + * @param int|float|null $timeout The timeout in seconds or null to disable |
|
| 107 | + * |
|
| 108 | + * @throws LogicException When proc_open is not installed |
|
| 109 | + */ |
|
| 110 | + public function __construct(array $command, ?string $cwd = null, ?array $env = null, mixed $input = null, ?float $timeout = 60) |
|
| 111 | + { |
|
| 112 | + } |
|
| 113 | + |
|
| 114 | + /** |
|
| 115 | + * Creates a Process instance as a command-line to be run in a shell wrapper. |
|
| 116 | + * |
|
| 117 | + * Command-lines are parsed by the shell of your OS (/bin/sh on Unix-like, cmd.exe on Windows.) |
|
| 118 | + * This allows using e.g. pipes or conditional execution. In this mode, signals are sent to the |
|
| 119 | + * shell wrapper and not to your commands. |
|
| 120 | + * |
|
| 121 | + * In order to inject dynamic values into command-lines, we strongly recommend using placeholders. |
|
| 122 | + * This will save escaping values, which is not portable nor secure anyway: |
|
| 123 | + * |
|
| 124 | + * $process = Process::fromShellCommandline('my_command "${:MY_VAR}"'); |
|
| 125 | + * $process->run(null, ['MY_VAR' => $theValue]); |
|
| 126 | + * |
|
| 127 | + * @param string $command The command line to pass to the shell of the OS |
|
| 128 | + * @param string|null $cwd The working directory or null to use the working dir of the current PHP process |
|
| 129 | + * @param array|null $env The environment variables or null to use the same environment as the current PHP process |
|
| 130 | + * @param mixed $input The input as stream resource, scalar or \Traversable, or null for no input |
|
| 131 | + * @param int|float|null $timeout The timeout in seconds or null to disable |
|
| 132 | + * |
|
| 133 | + * @throws LogicException When proc_open is not installed |
|
| 134 | + */ |
|
| 135 | + public static function fromShellCommandline(string $command, ?string $cwd = null, ?array $env = null, mixed $input = null, ?float $timeout = 60): static |
|
| 136 | + { |
|
| 137 | + } |
|
| 138 | + |
|
| 139 | + public function __sleep(): array |
|
| 140 | + { |
|
| 141 | + } |
|
| 142 | + |
|
| 143 | + /** |
|
| 144 | + * @return void |
|
| 145 | + */ |
|
| 146 | + public function __wakeup() |
|
| 147 | + { |
|
| 148 | + } |
|
| 149 | + |
|
| 150 | + public function __destruct() |
|
| 151 | + { |
|
| 152 | + } |
|
| 153 | + |
|
| 154 | + public function __clone() |
|
| 155 | + { |
|
| 156 | + } |
|
| 157 | + |
|
| 158 | + /** |
|
| 159 | + * Runs the process. |
|
| 160 | + * |
|
| 161 | + * The callback receives the type of output (out or err) and |
|
| 162 | + * some bytes from the output in real-time. It allows to have feedback |
|
| 163 | + * from the independent process during execution. |
|
| 164 | + * |
|
| 165 | + * The STDOUT and STDERR are also available after the process is finished |
|
| 166 | + * via the getOutput() and getErrorOutput() methods. |
|
| 167 | + * |
|
| 168 | + * @param callable|null $callback A PHP callback to run whenever there is some |
|
| 169 | + * output available on STDOUT or STDERR |
|
| 170 | + * |
|
| 171 | + * @return int The exit status code |
|
| 172 | + * |
|
| 173 | + * @throws RuntimeException When process can't be launched |
|
| 174 | + * @throws RuntimeException When process is already running |
|
| 175 | + * @throws ProcessTimedOutException When process timed out |
|
| 176 | + * @throws ProcessSignaledException When process stopped after receiving signal |
|
| 177 | + * @throws LogicException In case a callback is provided and output has been disabled |
|
| 178 | + * |
|
| 179 | + * @final |
|
| 180 | + */ |
|
| 181 | + public function run(?callable $callback = null, array $env = []): int |
|
| 182 | + { |
|
| 183 | + } |
|
| 184 | + |
|
| 185 | + /** |
|
| 186 | + * Runs the process. |
|
| 187 | + * |
|
| 188 | + * This is identical to run() except that an exception is thrown if the process |
|
| 189 | + * exits with a non-zero exit code. |
|
| 190 | + * |
|
| 191 | + * @return $this |
|
| 192 | + * |
|
| 193 | + * @throws ProcessFailedException if the process didn't terminate successfully |
|
| 194 | + * |
|
| 195 | + * @final |
|
| 196 | + */ |
|
| 197 | + public function mustRun(?callable $callback = null, array $env = []): static |
|
| 198 | + { |
|
| 199 | + } |
|
| 200 | + |
|
| 201 | + /** |
|
| 202 | + * Starts the process and returns after writing the input to STDIN. |
|
| 203 | + * |
|
| 204 | + * This method blocks until all STDIN data is sent to the process then it |
|
| 205 | + * returns while the process runs in the background. |
|
| 206 | + * |
|
| 207 | + * The termination of the process can be awaited with wait(). |
|
| 208 | + * |
|
| 209 | + * The callback receives the type of output (out or err) and some bytes from |
|
| 210 | + * the output in real-time while writing the standard input to the process. |
|
| 211 | + * It allows to have feedback from the independent process during execution. |
|
| 212 | + * |
|
| 213 | + * @param callable|null $callback A PHP callback to run whenever there is some |
|
| 214 | + * output available on STDOUT or STDERR |
|
| 215 | + * |
|
| 216 | + * @return void |
|
| 217 | + * |
|
| 218 | + * @throws RuntimeException When process can't be launched |
|
| 219 | + * @throws RuntimeException When process is already running |
|
| 220 | + * @throws LogicException In case a callback is provided and output has been disabled |
|
| 221 | + */ |
|
| 222 | + public function start(?callable $callback = null, array $env = []) |
|
| 223 | + { |
|
| 224 | + } |
|
| 225 | + |
|
| 226 | + /** |
|
| 227 | + * Restarts the process. |
|
| 228 | + * |
|
| 229 | + * Be warned that the process is cloned before being started. |
|
| 230 | + * |
|
| 231 | + * @param callable|null $callback A PHP callback to run whenever there is some |
|
| 232 | + * output available on STDOUT or STDERR |
|
| 233 | + * |
|
| 234 | + * @throws RuntimeException When process can't be launched |
|
| 235 | + * @throws RuntimeException When process is already running |
|
| 236 | + * |
|
| 237 | + * @see start() |
|
| 238 | + * |
|
| 239 | + * @final |
|
| 240 | + */ |
|
| 241 | + public function restart(?callable $callback = null, array $env = []): static |
|
| 242 | + { |
|
| 243 | + } |
|
| 244 | + |
|
| 245 | + /** |
|
| 246 | + * Waits for the process to terminate. |
|
| 247 | + * |
|
| 248 | + * The callback receives the type of output (out or err) and some bytes |
|
| 249 | + * from the output in real-time while writing the standard input to the process. |
|
| 250 | + * It allows to have feedback from the independent process during execution. |
|
| 251 | + * |
|
| 252 | + * @param callable|null $callback A valid PHP callback |
|
| 253 | + * |
|
| 254 | + * @return int The exitcode of the process |
|
| 255 | + * |
|
| 256 | + * @throws ProcessTimedOutException When process timed out |
|
| 257 | + * @throws ProcessSignaledException When process stopped after receiving signal |
|
| 258 | + * @throws LogicException When process is not yet started |
|
| 259 | + */ |
|
| 260 | + public function wait(?callable $callback = null): int |
|
| 261 | + { |
|
| 262 | + } |
|
| 263 | + |
|
| 264 | + /** |
|
| 265 | + * Waits until the callback returns true. |
|
| 266 | + * |
|
| 267 | + * The callback receives the type of output (out or err) and some bytes |
|
| 268 | + * from the output in real-time while writing the standard input to the process. |
|
| 269 | + * It allows to have feedback from the independent process during execution. |
|
| 270 | + * |
|
| 271 | + * @throws RuntimeException When process timed out |
|
| 272 | + * @throws LogicException When process is not yet started |
|
| 273 | + * @throws ProcessTimedOutException In case the timeout was reached |
|
| 274 | + */ |
|
| 275 | + public function waitUntil(callable $callback): bool |
|
| 276 | + { |
|
| 277 | + } |
|
| 278 | + |
|
| 279 | + /** |
|
| 280 | + * Returns the Pid (process identifier), if applicable. |
|
| 281 | + * |
|
| 282 | + * @return int|null The process id if running, null otherwise |
|
| 283 | + */ |
|
| 284 | + public function getPid(): ?int |
|
| 285 | + { |
|
| 286 | + } |
|
| 287 | + |
|
| 288 | + /** |
|
| 289 | + * Sends a POSIX signal to the process. |
|
| 290 | + * |
|
| 291 | + * @param int $signal A valid POSIX signal (see https://php.net/pcntl.constants) |
|
| 292 | + * |
|
| 293 | + * @return $this |
|
| 294 | + * |
|
| 295 | + * @throws LogicException In case the process is not running |
|
| 296 | + * @throws RuntimeException In case --enable-sigchild is activated and the process can't be killed |
|
| 297 | + * @throws RuntimeException In case of failure |
|
| 298 | + */ |
|
| 299 | + public function signal(int $signal): static |
|
| 300 | + { |
|
| 301 | + } |
|
| 302 | + |
|
| 303 | + /** |
|
| 304 | + * Disables fetching output and error output from the underlying process. |
|
| 305 | + * |
|
| 306 | + * @return $this |
|
| 307 | + * |
|
| 308 | + * @throws RuntimeException In case the process is already running |
|
| 309 | + * @throws LogicException if an idle timeout is set |
|
| 310 | + */ |
|
| 311 | + public function disableOutput(): static |
|
| 312 | + { |
|
| 313 | + } |
|
| 314 | + |
|
| 315 | + /** |
|
| 316 | + * Enables fetching output and error output from the underlying process. |
|
| 317 | + * |
|
| 318 | + * @return $this |
|
| 319 | + * |
|
| 320 | + * @throws RuntimeException In case the process is already running |
|
| 321 | + */ |
|
| 322 | + public function enableOutput(): static |
|
| 323 | + { |
|
| 324 | + } |
|
| 325 | + |
|
| 326 | + /** |
|
| 327 | + * Returns true in case the output is disabled, false otherwise. |
|
| 328 | + */ |
|
| 329 | + public function isOutputDisabled(): bool |
|
| 330 | + { |
|
| 331 | + } |
|
| 332 | + |
|
| 333 | + /** |
|
| 334 | + * Returns the current output of the process (STDOUT). |
|
| 335 | + * |
|
| 336 | + * @throws LogicException in case the output has been disabled |
|
| 337 | + * @throws LogicException In case the process is not started |
|
| 338 | + */ |
|
| 339 | + public function getOutput(): string |
|
| 340 | + { |
|
| 341 | + } |
|
| 342 | + |
|
| 343 | + /** |
|
| 344 | + * Returns the output incrementally. |
|
| 345 | + * |
|
| 346 | + * In comparison with the getOutput method which always return the whole |
|
| 347 | + * output, this one returns the new output since the last call. |
|
| 348 | + * |
|
| 349 | + * @throws LogicException in case the output has been disabled |
|
| 350 | + * @throws LogicException In case the process is not started |
|
| 351 | + */ |
|
| 352 | + public function getIncrementalOutput(): string |
|
| 353 | + { |
|
| 354 | + } |
|
| 355 | + |
|
| 356 | + /** |
|
| 357 | + * Returns an iterator to the output of the process, with the output type as keys (Process::OUT/ERR). |
|
| 358 | + * |
|
| 359 | + * @param int $flags A bit field of Process::ITER_* flags |
|
| 360 | + * |
|
| 361 | + * @return \Generator<string, string> |
|
| 362 | + * |
|
| 363 | + * @throws LogicException in case the output has been disabled |
|
| 364 | + * @throws LogicException In case the process is not started |
|
| 365 | + */ |
|
| 366 | + public function getIterator(int $flags = 0): \Generator |
|
| 367 | + { |
|
| 368 | + } |
|
| 369 | + |
|
| 370 | + /** |
|
| 371 | + * Clears the process output. |
|
| 372 | + * |
|
| 373 | + * @return $this |
|
| 374 | + */ |
|
| 375 | + public function clearOutput(): static |
|
| 376 | + { |
|
| 377 | + } |
|
| 378 | + |
|
| 379 | + /** |
|
| 380 | + * Returns the current error output of the process (STDERR). |
|
| 381 | + * |
|
| 382 | + * @throws LogicException in case the output has been disabled |
|
| 383 | + * @throws LogicException In case the process is not started |
|
| 384 | + */ |
|
| 385 | + public function getErrorOutput(): string |
|
| 386 | + { |
|
| 387 | + } |
|
| 388 | + |
|
| 389 | + /** |
|
| 390 | + * Returns the errorOutput incrementally. |
|
| 391 | + * |
|
| 392 | + * In comparison with the getErrorOutput method which always return the |
|
| 393 | + * whole error output, this one returns the new error output since the last |
|
| 394 | + * call. |
|
| 395 | + * |
|
| 396 | + * @throws LogicException in case the output has been disabled |
|
| 397 | + * @throws LogicException In case the process is not started |
|
| 398 | + */ |
|
| 399 | + public function getIncrementalErrorOutput(): string |
|
| 400 | + { |
|
| 401 | + } |
|
| 402 | + |
|
| 403 | + /** |
|
| 404 | + * Clears the process output. |
|
| 405 | + * |
|
| 406 | + * @return $this |
|
| 407 | + */ |
|
| 408 | + public function clearErrorOutput(): static |
|
| 409 | + { |
|
| 410 | + } |
|
| 411 | + |
|
| 412 | + /** |
|
| 413 | + * Returns the exit code returned by the process. |
|
| 414 | + * |
|
| 415 | + * @return int|null The exit status code, null if the Process is not terminated |
|
| 416 | + */ |
|
| 417 | + public function getExitCode(): ?int |
|
| 418 | + { |
|
| 419 | + } |
|
| 420 | + |
|
| 421 | + /** |
|
| 422 | + * Returns a string representation for the exit code returned by the process. |
|
| 423 | + * |
|
| 424 | + * This method relies on the Unix exit code status standardization |
|
| 425 | + * and might not be relevant for other operating systems. |
|
| 426 | + * |
|
| 427 | + * @return string|null A string representation for the exit status code, null if the Process is not terminated |
|
| 428 | + * |
|
| 429 | + * @see http://tldp.org/LDP/abs/html/exitcodes.html |
|
| 430 | + * @see http://en.wikipedia.org/wiki/Unix_signal |
|
| 431 | + */ |
|
| 432 | + public function getExitCodeText(): ?string |
|
| 433 | + { |
|
| 434 | + } |
|
| 435 | + |
|
| 436 | + /** |
|
| 437 | + * Checks if the process ended successfully. |
|
| 438 | + */ |
|
| 439 | + public function isSuccessful(): bool |
|
| 440 | + { |
|
| 441 | + } |
|
| 442 | + |
|
| 443 | + /** |
|
| 444 | + * Returns true if the child process has been terminated by an uncaught signal. |
|
| 445 | + * |
|
| 446 | + * It always returns false on Windows. |
|
| 447 | + * |
|
| 448 | + * @throws LogicException In case the process is not terminated |
|
| 449 | + */ |
|
| 450 | + public function hasBeenSignaled(): bool |
|
| 451 | + { |
|
| 452 | + } |
|
| 453 | + |
|
| 454 | + /** |
|
| 455 | + * Returns the number of the signal that caused the child process to terminate its execution. |
|
| 456 | + * |
|
| 457 | + * It is only meaningful if hasBeenSignaled() returns true. |
|
| 458 | + * |
|
| 459 | + * @throws RuntimeException In case --enable-sigchild is activated |
|
| 460 | + * @throws LogicException In case the process is not terminated |
|
| 461 | + */ |
|
| 462 | + public function getTermSignal(): int |
|
| 463 | + { |
|
| 464 | + } |
|
| 465 | + |
|
| 466 | + /** |
|
| 467 | + * Returns true if the child process has been stopped by a signal. |
|
| 468 | + * |
|
| 469 | + * It always returns false on Windows. |
|
| 470 | + * |
|
| 471 | + * @throws LogicException In case the process is not terminated |
|
| 472 | + */ |
|
| 473 | + public function hasBeenStopped(): bool |
|
| 474 | + { |
|
| 475 | + } |
|
| 476 | + |
|
| 477 | + /** |
|
| 478 | + * Returns the number of the signal that caused the child process to stop its execution. |
|
| 479 | + * |
|
| 480 | + * It is only meaningful if hasBeenStopped() returns true. |
|
| 481 | + * |
|
| 482 | + * @throws LogicException In case the process is not terminated |
|
| 483 | + */ |
|
| 484 | + public function getStopSignal(): int |
|
| 485 | + { |
|
| 486 | + } |
|
| 487 | + |
|
| 488 | + /** |
|
| 489 | + * Checks if the process is currently running. |
|
| 490 | + */ |
|
| 491 | + public function isRunning(): bool |
|
| 492 | + { |
|
| 493 | + } |
|
| 494 | + |
|
| 495 | + /** |
|
| 496 | + * Checks if the process has been started with no regard to the current state. |
|
| 497 | + */ |
|
| 498 | + public function isStarted(): bool |
|
| 499 | + { |
|
| 500 | + } |
|
| 501 | + |
|
| 502 | + /** |
|
| 503 | + * Checks if the process is terminated. |
|
| 504 | + */ |
|
| 505 | + public function isTerminated(): bool |
|
| 506 | + { |
|
| 507 | + } |
|
| 508 | + |
|
| 509 | + /** |
|
| 510 | + * Gets the process status. |
|
| 511 | + * |
|
| 512 | + * The status is one of: ready, started, terminated. |
|
| 513 | + */ |
|
| 514 | + public function getStatus(): string |
|
| 515 | + { |
|
| 516 | + } |
|
| 517 | + |
|
| 518 | + /** |
|
| 519 | + * Stops the process. |
|
| 520 | + * |
|
| 521 | + * @param int|float $timeout The timeout in seconds |
|
| 522 | + * @param int|null $signal A POSIX signal to send in case the process has not stop at timeout, default is SIGKILL (9) |
|
| 523 | + * |
|
| 524 | + * @return int|null The exit-code of the process or null if it's not running |
|
| 525 | + */ |
|
| 526 | + public function stop(float $timeout = 10, ?int $signal = null): ?int |
|
| 527 | + { |
|
| 528 | + } |
|
| 529 | + |
|
| 530 | + /** |
|
| 531 | + * Adds a line to the STDOUT stream. |
|
| 532 | + * |
|
| 533 | + * @internal |
|
| 534 | + */ |
|
| 535 | + public function addOutput(string $line): void |
|
| 536 | + { |
|
| 537 | + } |
|
| 538 | + |
|
| 539 | + /** |
|
| 540 | + * Adds a line to the STDERR stream. |
|
| 541 | + * |
|
| 542 | + * @internal |
|
| 543 | + */ |
|
| 544 | + public function addErrorOutput(string $line): void |
|
| 545 | + { |
|
| 546 | + } |
|
| 547 | + |
|
| 548 | + /** |
|
| 549 | + * Gets the last output time in seconds. |
|
| 550 | + */ |
|
| 551 | + public function getLastOutputTime(): ?float |
|
| 552 | + { |
|
| 553 | + } |
|
| 554 | + |
|
| 555 | + /** |
|
| 556 | + * Gets the command line to be executed. |
|
| 557 | + */ |
|
| 558 | + public function getCommandLine(): string |
|
| 559 | + { |
|
| 560 | + } |
|
| 561 | + |
|
| 562 | + /** |
|
| 563 | + * Gets the process timeout in seconds (max. runtime). |
|
| 564 | + */ |
|
| 565 | + public function getTimeout(): ?float |
|
| 566 | + { |
|
| 567 | + } |
|
| 568 | + |
|
| 569 | + /** |
|
| 570 | + * Gets the process idle timeout in seconds (max. time since last output). |
|
| 571 | + */ |
|
| 572 | + public function getIdleTimeout(): ?float |
|
| 573 | + { |
|
| 574 | + } |
|
| 575 | + |
|
| 576 | + /** |
|
| 577 | + * Sets the process timeout (max. runtime) in seconds. |
|
| 578 | + * |
|
| 579 | + * To disable the timeout, set this value to null. |
|
| 580 | + * |
|
| 581 | + * @return $this |
|
| 582 | + * |
|
| 583 | + * @throws InvalidArgumentException if the timeout is negative |
|
| 584 | + */ |
|
| 585 | + public function setTimeout(?float $timeout): static |
|
| 586 | + { |
|
| 587 | + } |
|
| 588 | + |
|
| 589 | + /** |
|
| 590 | + * Sets the process idle timeout (max. time since last output) in seconds. |
|
| 591 | + * |
|
| 592 | + * To disable the timeout, set this value to null. |
|
| 593 | + * |
|
| 594 | + * @return $this |
|
| 595 | + * |
|
| 596 | + * @throws LogicException if the output is disabled |
|
| 597 | + * @throws InvalidArgumentException if the timeout is negative |
|
| 598 | + */ |
|
| 599 | + public function setIdleTimeout(?float $timeout): static |
|
| 600 | + { |
|
| 601 | + } |
|
| 602 | + |
|
| 603 | + /** |
|
| 604 | + * Enables or disables the TTY mode. |
|
| 605 | + * |
|
| 606 | + * @return $this |
|
| 607 | + * |
|
| 608 | + * @throws RuntimeException In case the TTY mode is not supported |
|
| 609 | + */ |
|
| 610 | + public function setTty(bool $tty): static |
|
| 611 | + { |
|
| 612 | + } |
|
| 613 | + |
|
| 614 | + /** |
|
| 615 | + * Checks if the TTY mode is enabled. |
|
| 616 | + */ |
|
| 617 | + public function isTty(): bool |
|
| 618 | + { |
|
| 619 | + } |
|
| 620 | + |
|
| 621 | + /** |
|
| 622 | + * Sets PTY mode. |
|
| 623 | + * |
|
| 624 | + * @return $this |
|
| 625 | + */ |
|
| 626 | + public function setPty(bool $bool): static |
|
| 627 | + { |
|
| 628 | + } |
|
| 629 | + |
|
| 630 | + /** |
|
| 631 | + * Returns PTY state. |
|
| 632 | + */ |
|
| 633 | + public function isPty(): bool |
|
| 634 | + { |
|
| 635 | + } |
|
| 636 | + |
|
| 637 | + /** |
|
| 638 | + * Gets the working directory. |
|
| 639 | + */ |
|
| 640 | + public function getWorkingDirectory(): ?string |
|
| 641 | + { |
|
| 642 | + } |
|
| 643 | + |
|
| 644 | + /** |
|
| 645 | + * Sets the current working directory. |
|
| 646 | + * |
|
| 647 | + * @return $this |
|
| 648 | + */ |
|
| 649 | + public function setWorkingDirectory(string $cwd): static |
|
| 650 | + { |
|
| 651 | + } |
|
| 652 | + |
|
| 653 | + /** |
|
| 654 | + * Gets the environment variables. |
|
| 655 | + */ |
|
| 656 | + public function getEnv(): array |
|
| 657 | + { |
|
| 658 | + } |
|
| 659 | + |
|
| 660 | + /** |
|
| 661 | + * Sets the environment variables. |
|
| 662 | + * |
|
| 663 | + * @param array<string|\Stringable> $env The new environment variables |
|
| 664 | + * |
|
| 665 | + * @return $this |
|
| 666 | + */ |
|
| 667 | + public function setEnv(array $env): static |
|
| 668 | + { |
|
| 669 | + } |
|
| 670 | + |
|
| 671 | + /** |
|
| 672 | + * Gets the Process input. |
|
| 673 | + * |
|
| 674 | + * @return resource|string|\Iterator|null |
|
| 675 | + */ |
|
| 676 | + public function getInput() |
|
| 677 | + { |
|
| 678 | + } |
|
| 679 | + |
|
| 680 | + /** |
|
| 681 | + * Sets the input. |
|
| 682 | + * |
|
| 683 | + * This content will be passed to the underlying process standard input. |
|
| 684 | + * |
|
| 685 | + * @param string|resource|\Traversable|self|null $input The content |
|
| 686 | + * |
|
| 687 | + * @return $this |
|
| 688 | + * |
|
| 689 | + * @throws LogicException In case the process is running |
|
| 690 | + */ |
|
| 691 | + public function setInput(mixed $input): static |
|
| 692 | + { |
|
| 693 | + } |
|
| 694 | + |
|
| 695 | + /** |
|
| 696 | + * Performs a check between the timeout definition and the time the process started. |
|
| 697 | + * |
|
| 698 | + * In case you run a background process (with the start method), you should |
|
| 699 | + * trigger this method regularly to ensure the process timeout |
|
| 700 | + * |
|
| 701 | + * @return void |
|
| 702 | + * |
|
| 703 | + * @throws ProcessTimedOutException In case the timeout was reached |
|
| 704 | + */ |
|
| 705 | + public function checkTimeout() |
|
| 706 | + { |
|
| 707 | + } |
|
| 708 | + |
|
| 709 | + /** |
|
| 710 | + * @throws LogicException in case process is not started |
|
| 711 | + */ |
|
| 712 | + public function getStartTime(): float |
|
| 713 | + { |
|
| 714 | + } |
|
| 715 | + |
|
| 716 | + /** |
|
| 717 | + * Defines options to pass to the underlying proc_open(). |
|
| 718 | + * |
|
| 719 | + * @see https://php.net/proc_open for the options supported by PHP. |
|
| 720 | + * |
|
| 721 | + * Enabling the "create_new_console" option allows a subprocess to continue |
|
| 722 | + * to run after the main process exited, on both Windows and *nix |
|
| 723 | + * |
|
| 724 | + * @return void |
|
| 725 | + */ |
|
| 726 | + public function setOptions(array $options) |
|
| 727 | + { |
|
| 728 | + } |
|
| 729 | + |
|
| 730 | + /** |
|
| 731 | + * Returns whether TTY is supported on the current operating system. |
|
| 732 | + */ |
|
| 733 | + public static function isTtySupported(): bool |
|
| 734 | + { |
|
| 735 | + } |
|
| 736 | + |
|
| 737 | + /** |
|
| 738 | + * Returns whether PTY is supported on the current operating system. |
|
| 739 | + */ |
|
| 740 | + public static function isPtySupported(): bool |
|
| 741 | + { |
|
| 742 | + } |
|
| 743 | + |
|
| 744 | + /** |
|
| 745 | + * Builds up the callback used by wait(). |
|
| 746 | + * |
|
| 747 | + * The callbacks adds all occurred output to the specific buffer and calls |
|
| 748 | + * the user callback (if present) with the received output. |
|
| 749 | + * |
|
| 750 | + * @param callable|null $callback The user defined PHP callback |
|
| 751 | + */ |
|
| 752 | + protected function buildCallback(?callable $callback = null): \Closure |
|
| 753 | + { |
|
| 754 | + } |
|
| 755 | + |
|
| 756 | + /** |
|
| 757 | + * Updates the status of the process, reads pipes. |
|
| 758 | + * |
|
| 759 | + * @param bool $blocking Whether to use a blocking read call |
|
| 760 | + * |
|
| 761 | + * @return void |
|
| 762 | + */ |
|
| 763 | + protected function updateStatus(bool $blocking) |
|
| 764 | + { |
|
| 765 | + } |
|
| 766 | + |
|
| 767 | + /** |
|
| 768 | + * Returns whether PHP has been compiled with the '--enable-sigchild' option or not. |
|
| 769 | + */ |
|
| 770 | + protected function isSigchildEnabled(): bool |
|
| 771 | + { |
|
| 772 | + } |
|
| 773 | 773 | } |
@@ -46,8 +46,8 @@ |
||
| 46 | 46 | public const TIMEOUT_PRECISION = 0.2; |
| 47 | 47 | |
| 48 | 48 | public const ITER_NON_BLOCKING = 1; // By default, iterating over outputs is a blocking call, use this flag to make it non-blocking |
| 49 | - public const ITER_KEEP_OUTPUT = 2; // By default, outputs are cleared while iterating, use this flag to keep them in memory |
|
| 50 | - public const ITER_SKIP_OUT = 4; // Use this flag to skip STDOUT while iterating |
|
| 49 | + public const ITER_KEEP_OUTPUT = 2; // By default, outputs are cleared while iterating, use this flag to keep them in memory |
|
| 50 | + public const ITER_SKIP_OUT = 4; // Use this flag to skip STDOUT while iterating |
|
| 51 | 51 | public const ITER_SKIP_ERR = 8; |
| 52 | 52 | |
| 53 | 53 | /** |
@@ -19,21 +19,21 @@ |
||
| 19 | 19 | */ |
| 20 | 20 | interface ConsoleOutputInterface extends OutputInterface |
| 21 | 21 | { |
| 22 | - /** |
|
| 23 | - * Gets the OutputInterface for errors. |
|
| 24 | - */ |
|
| 25 | - public function getErrorOutput(): OutputInterface |
|
| 26 | - { |
|
| 27 | - } |
|
| 22 | + /** |
|
| 23 | + * Gets the OutputInterface for errors. |
|
| 24 | + */ |
|
| 25 | + public function getErrorOutput(): OutputInterface |
|
| 26 | + { |
|
| 27 | + } |
|
| 28 | 28 | |
| 29 | - /** |
|
| 30 | - * @return void |
|
| 31 | - */ |
|
| 32 | - public function setErrorOutput(OutputInterface $error) |
|
| 33 | - { |
|
| 34 | - } |
|
| 29 | + /** |
|
| 30 | + * @return void |
|
| 31 | + */ |
|
| 32 | + public function setErrorOutput(OutputInterface $error) |
|
| 33 | + { |
|
| 34 | + } |
|
| 35 | 35 | |
| 36 | - public function section(): ConsoleSectionOutput |
|
| 37 | - { |
|
| 38 | - } |
|
| 36 | + public function section(): ConsoleSectionOutput |
|
| 37 | + { |
|
| 38 | + } |
|
| 39 | 39 | } |
@@ -20,116 +20,116 @@ |
||
| 20 | 20 | */ |
| 21 | 21 | interface OutputInterface |
| 22 | 22 | { |
| 23 | - public const VERBOSITY_QUIET = 16; |
|
| 24 | - public const VERBOSITY_NORMAL = 32; |
|
| 25 | - public const VERBOSITY_VERBOSE = 64; |
|
| 26 | - public const VERBOSITY_VERY_VERBOSE = 128; |
|
| 27 | - public const VERBOSITY_DEBUG = 256; |
|
| 28 | - |
|
| 29 | - public const OUTPUT_NORMAL = 1; |
|
| 30 | - public const OUTPUT_RAW = 2; |
|
| 31 | - public const OUTPUT_PLAIN = 4; |
|
| 32 | - |
|
| 33 | - /** |
|
| 34 | - * Writes a message to the output. |
|
| 35 | - * |
|
| 36 | - * @param bool $newline Whether to add a newline |
|
| 37 | - * @param int $options A bitmask of options (one of the OUTPUT or VERBOSITY constants), |
|
| 38 | - * 0 is considered the same as self::OUTPUT_NORMAL | self::VERBOSITY_NORMAL |
|
| 39 | - * |
|
| 40 | - * @return void |
|
| 41 | - */ |
|
| 42 | - public function write(string|iterable $messages, bool $newline = false, int $options = 0) |
|
| 43 | - { |
|
| 44 | - } |
|
| 45 | - |
|
| 46 | - /** |
|
| 47 | - * Writes a message to the output and adds a newline at the end. |
|
| 48 | - * |
|
| 49 | - * @param int $options A bitmask of options (one of the OUTPUT or VERBOSITY constants), |
|
| 50 | - * 0 is considered the same as self::OUTPUT_NORMAL | self::VERBOSITY_NORMAL |
|
| 51 | - * |
|
| 52 | - * @return void |
|
| 53 | - */ |
|
| 54 | - public function writeln(string|iterable $messages, int $options = 0) |
|
| 55 | - { |
|
| 56 | - } |
|
| 57 | - |
|
| 58 | - /** |
|
| 59 | - * Sets the verbosity of the output. |
|
| 60 | - * |
|
| 61 | - * @param self::VERBOSITY_* $level |
|
| 62 | - * |
|
| 63 | - * @return void |
|
| 64 | - */ |
|
| 65 | - public function setVerbosity(int $level) |
|
| 66 | - { |
|
| 67 | - } |
|
| 68 | - |
|
| 69 | - /** |
|
| 70 | - * Gets the current verbosity of the output. |
|
| 71 | - * |
|
| 72 | - * @return self::VERBOSITY_* |
|
| 73 | - */ |
|
| 74 | - public function getVerbosity(): int |
|
| 75 | - { |
|
| 76 | - } |
|
| 77 | - |
|
| 78 | - /** |
|
| 79 | - * Returns whether verbosity is quiet (-q). |
|
| 80 | - */ |
|
| 81 | - public function isQuiet(): bool |
|
| 82 | - { |
|
| 83 | - } |
|
| 84 | - |
|
| 85 | - /** |
|
| 86 | - * Returns whether verbosity is verbose (-v). |
|
| 87 | - */ |
|
| 88 | - public function isVerbose(): bool |
|
| 89 | - { |
|
| 90 | - } |
|
| 91 | - |
|
| 92 | - /** |
|
| 93 | - * Returns whether verbosity is very verbose (-vv). |
|
| 94 | - */ |
|
| 95 | - public function isVeryVerbose(): bool |
|
| 96 | - { |
|
| 97 | - } |
|
| 98 | - |
|
| 99 | - /** |
|
| 100 | - * Returns whether verbosity is debug (-vvv). |
|
| 101 | - */ |
|
| 102 | - public function isDebug(): bool |
|
| 103 | - { |
|
| 104 | - } |
|
| 105 | - |
|
| 106 | - /** |
|
| 107 | - * Sets the decorated flag. |
|
| 108 | - * |
|
| 109 | - * @return void |
|
| 110 | - */ |
|
| 111 | - public function setDecorated(bool $decorated) |
|
| 112 | - { |
|
| 113 | - } |
|
| 114 | - |
|
| 115 | - /** |
|
| 116 | - * Gets the decorated flag. |
|
| 117 | - */ |
|
| 118 | - public function isDecorated(): bool |
|
| 119 | - { |
|
| 120 | - } |
|
| 121 | - |
|
| 122 | - /** |
|
| 123 | - * @return void |
|
| 124 | - */ |
|
| 125 | - public function setFormatter(OutputFormatterInterface $formatter) |
|
| 126 | - { |
|
| 127 | - } |
|
| 128 | - |
|
| 129 | - /** |
|
| 130 | - * Returns current output formatter instance. |
|
| 131 | - */ |
|
| 132 | - public function getFormatter(): OutputFormatterInterface |
|
| 133 | - { |
|
| 134 | - } |
|
| 23 | + public const VERBOSITY_QUIET = 16; |
|
| 24 | + public const VERBOSITY_NORMAL = 32; |
|
| 25 | + public const VERBOSITY_VERBOSE = 64; |
|
| 26 | + public const VERBOSITY_VERY_VERBOSE = 128; |
|
| 27 | + public const VERBOSITY_DEBUG = 256; |
|
| 28 | + |
|
| 29 | + public const OUTPUT_NORMAL = 1; |
|
| 30 | + public const OUTPUT_RAW = 2; |
|
| 31 | + public const OUTPUT_PLAIN = 4; |
|
| 32 | + |
|
| 33 | + /** |
|
| 34 | + * Writes a message to the output. |
|
| 35 | + * |
|
| 36 | + * @param bool $newline Whether to add a newline |
|
| 37 | + * @param int $options A bitmask of options (one of the OUTPUT or VERBOSITY constants), |
|
| 38 | + * 0 is considered the same as self::OUTPUT_NORMAL | self::VERBOSITY_NORMAL |
|
| 39 | + * |
|
| 40 | + * @return void |
|
| 41 | + */ |
|
| 42 | + public function write(string|iterable $messages, bool $newline = false, int $options = 0) |
|
| 43 | + { |
|
| 44 | + } |
|
| 45 | + |
|
| 46 | + /** |
|
| 47 | + * Writes a message to the output and adds a newline at the end. |
|
| 48 | + * |
|
| 49 | + * @param int $options A bitmask of options (one of the OUTPUT or VERBOSITY constants), |
|
| 50 | + * 0 is considered the same as self::OUTPUT_NORMAL | self::VERBOSITY_NORMAL |
|
| 51 | + * |
|
| 52 | + * @return void |
|
| 53 | + */ |
|
| 54 | + public function writeln(string|iterable $messages, int $options = 0) |
|
| 55 | + { |
|
| 56 | + } |
|
| 57 | + |
|
| 58 | + /** |
|
| 59 | + * Sets the verbosity of the output. |
|
| 60 | + * |
|
| 61 | + * @param self::VERBOSITY_* $level |
|
| 62 | + * |
|
| 63 | + * @return void |
|
| 64 | + */ |
|
| 65 | + public function setVerbosity(int $level) |
|
| 66 | + { |
|
| 67 | + } |
|
| 68 | + |
|
| 69 | + /** |
|
| 70 | + * Gets the current verbosity of the output. |
|
| 71 | + * |
|
| 72 | + * @return self::VERBOSITY_* |
|
| 73 | + */ |
|
| 74 | + public function getVerbosity(): int |
|
| 75 | + { |
|
| 76 | + } |
|
| 77 | + |
|
| 78 | + /** |
|
| 79 | + * Returns whether verbosity is quiet (-q). |
|
| 80 | + */ |
|
| 81 | + public function isQuiet(): bool |
|
| 82 | + { |
|
| 83 | + } |
|
| 84 | + |
|
| 85 | + /** |
|
| 86 | + * Returns whether verbosity is verbose (-v). |
|
| 87 | + */ |
|
| 88 | + public function isVerbose(): bool |
|
| 89 | + { |
|
| 90 | + } |
|
| 91 | + |
|
| 92 | + /** |
|
| 93 | + * Returns whether verbosity is very verbose (-vv). |
|
| 94 | + */ |
|
| 95 | + public function isVeryVerbose(): bool |
|
| 96 | + { |
|
| 97 | + } |
|
| 98 | + |
|
| 99 | + /** |
|
| 100 | + * Returns whether verbosity is debug (-vvv). |
|
| 101 | + */ |
|
| 102 | + public function isDebug(): bool |
|
| 103 | + { |
|
| 104 | + } |
|
| 105 | + |
|
| 106 | + /** |
|
| 107 | + * Sets the decorated flag. |
|
| 108 | + * |
|
| 109 | + * @return void |
|
| 110 | + */ |
|
| 111 | + public function setDecorated(bool $decorated) |
|
| 112 | + { |
|
| 113 | + } |
|
| 114 | + |
|
| 115 | + /** |
|
| 116 | + * Gets the decorated flag. |
|
| 117 | + */ |
|
| 118 | + public function isDecorated(): bool |
|
| 119 | + { |
|
| 120 | + } |
|
| 121 | + |
|
| 122 | + /** |
|
| 123 | + * @return void |
|
| 124 | + */ |
|
| 125 | + public function setFormatter(OutputFormatterInterface $formatter) |
|
| 126 | + { |
|
| 127 | + } |
|
| 128 | + |
|
| 129 | + /** |
|
| 130 | + * Returns current output formatter instance. |
|
| 131 | + */ |
|
| 132 | + public function getFormatter(): OutputFormatterInterface |
|
| 133 | + { |
|
| 134 | + } |
|
| 135 | 135 | } |
@@ -39,7 +39,7 @@ discard block |
||
| 39 | 39 | * |
| 40 | 40 | * @return void |
| 41 | 41 | */ |
| 42 | - public function write(string|iterable $messages, bool $newline = false, int $options = 0) |
|
| 42 | + public function write(string | iterable $messages, bool $newline = false, int $options = 0) |
|
| 43 | 43 | { |
| 44 | 44 | } |
| 45 | 45 | |
@@ -51,7 +51,7 @@ discard block |
||
| 51 | 51 | * |
| 52 | 52 | * @return void |
| 53 | 53 | */ |
| 54 | - public function writeln(string|iterable $messages, int $options = 0) |
|
| 54 | + public function writeln(string | iterable $messages, int $options = 0) |
|
| 55 | 55 | { |
| 56 | 56 | } |
| 57 | 57 | |
@@ -44,1047 +44,1047 @@ |
||
| 44 | 44 | */ |
| 45 | 45 | class QueryBuilder |
| 46 | 46 | { |
| 47 | - /** @deprecated */ |
|
| 48 | - public const SELECT = 0; |
|
| 47 | + /** @deprecated */ |
|
| 48 | + public const SELECT = 0; |
|
| 49 | 49 | |
| 50 | - /** @deprecated */ |
|
| 51 | - public const DELETE = 1; |
|
| 50 | + /** @deprecated */ |
|
| 51 | + public const DELETE = 1; |
|
| 52 | 52 | |
| 53 | - /** @deprecated */ |
|
| 54 | - public const UPDATE = 2; |
|
| 53 | + /** @deprecated */ |
|
| 54 | + public const UPDATE = 2; |
|
| 55 | 55 | |
| 56 | - /** @deprecated */ |
|
| 57 | - public const INSERT = 3; |
|
| 56 | + /** @deprecated */ |
|
| 57 | + public const INSERT = 3; |
|
| 58 | 58 | |
| 59 | - /** @deprecated */ |
|
| 60 | - public const STATE_DIRTY = 0; |
|
| 59 | + /** @deprecated */ |
|
| 60 | + public const STATE_DIRTY = 0; |
|
| 61 | 61 | |
| 62 | - /** @deprecated */ |
|
| 63 | - public const STATE_CLEAN = 1; |
|
| 62 | + /** @deprecated */ |
|
| 63 | + public const STATE_CLEAN = 1; |
|
| 64 | 64 | |
| 65 | - /* |
|
| 65 | + /* |
|
| 66 | 66 | * The default values of SQL parts collection |
| 67 | 67 | */ |
| 68 | - private const SQL_PARTS_DEFAULTS = [ |
|
| 69 | - 'select' => [], |
|
| 70 | - 'distinct' => false, |
|
| 71 | - 'from' => [], |
|
| 72 | - 'join' => [], |
|
| 73 | - 'set' => [], |
|
| 74 | - 'where' => null, |
|
| 75 | - 'groupBy' => [], |
|
| 76 | - 'having' => null, |
|
| 77 | - 'orderBy' => [], |
|
| 78 | - 'values' => [], |
|
| 79 | - 'for_update' => null, |
|
| 80 | - ]; |
|
| 81 | - |
|
| 82 | - /** |
|
| 83 | - * Initializes a new <tt>QueryBuilder</tt>. |
|
| 84 | - * |
|
| 85 | - * @param Connection $connection The DBAL Connection. |
|
| 86 | - */ |
|
| 87 | - public function __construct(Connection $connection) |
|
| 88 | - { |
|
| 89 | - } |
|
| 90 | - |
|
| 91 | - /** |
|
| 92 | - * Gets an ExpressionBuilder used for object-oriented construction of query expressions. |
|
| 93 | - * This producer method is intended for convenient inline usage. Example: |
|
| 94 | - * |
|
| 95 | - * <code> |
|
| 96 | - * $qb = $conn->createQueryBuilder() |
|
| 97 | - * ->select('u') |
|
| 98 | - * ->from('users', 'u') |
|
| 99 | - * ->where($qb->expr()->eq('u.id', 1)); |
|
| 100 | - * </code> |
|
| 101 | - * |
|
| 102 | - * For more complex expression construction, consider storing the expression |
|
| 103 | - * builder object in a local variable. |
|
| 104 | - * |
|
| 105 | - * @return ExpressionBuilder |
|
| 106 | - */ |
|
| 107 | - public function expr() |
|
| 108 | - { |
|
| 109 | - } |
|
| 110 | - |
|
| 111 | - /** |
|
| 112 | - * Gets the type of the currently built query. |
|
| 113 | - * |
|
| 114 | - * @deprecated If necessary, track the type of the query being built outside of the builder. |
|
| 115 | - * |
|
| 116 | - * @return int |
|
| 117 | - */ |
|
| 118 | - public function getType() |
|
| 119 | - { |
|
| 120 | - } |
|
| 121 | - |
|
| 122 | - /** |
|
| 123 | - * Gets the associated DBAL Connection for this query builder. |
|
| 124 | - * |
|
| 125 | - * @deprecated Use the connection used to instantiate the builder instead. |
|
| 126 | - * |
|
| 127 | - * @return Connection |
|
| 128 | - */ |
|
| 129 | - public function getConnection() |
|
| 130 | - { |
|
| 131 | - } |
|
| 132 | - |
|
| 133 | - /** |
|
| 134 | - * Gets the state of this query builder instance. |
|
| 135 | - * |
|
| 136 | - * @deprecated The builder state is an internal concern. |
|
| 137 | - * |
|
| 138 | - * @return int Either QueryBuilder::STATE_DIRTY or QueryBuilder::STATE_CLEAN. |
|
| 139 | - * @psalm-return self::STATE_* |
|
| 140 | - */ |
|
| 141 | - public function getState() |
|
| 142 | - { |
|
| 143 | - } |
|
| 144 | - |
|
| 145 | - /** |
|
| 146 | - * Prepares and executes an SQL query and returns the first row of the result |
|
| 147 | - * as an associative array. |
|
| 148 | - * |
|
| 149 | - * @return array<string, mixed>|false False is returned if no rows are found. |
|
| 150 | - * |
|
| 151 | - * @throws Exception |
|
| 152 | - */ |
|
| 153 | - public function fetchAssociative() |
|
| 154 | - { |
|
| 155 | - } |
|
| 156 | - |
|
| 157 | - /** |
|
| 158 | - * Prepares and executes an SQL query and returns the first row of the result |
|
| 159 | - * as a numerically indexed array. |
|
| 160 | - * |
|
| 161 | - * @return array<int, mixed>|false False is returned if no rows are found. |
|
| 162 | - * |
|
| 163 | - * @throws Exception |
|
| 164 | - */ |
|
| 165 | - public function fetchNumeric() |
|
| 166 | - { |
|
| 167 | - } |
|
| 168 | - |
|
| 169 | - /** |
|
| 170 | - * Prepares and executes an SQL query and returns the value of a single column |
|
| 171 | - * of the first row of the result. |
|
| 172 | - * |
|
| 173 | - * @return mixed|false False is returned if no rows are found. |
|
| 174 | - * |
|
| 175 | - * @throws Exception |
|
| 176 | - */ |
|
| 177 | - public function fetchOne() |
|
| 178 | - { |
|
| 179 | - } |
|
| 180 | - |
|
| 181 | - /** |
|
| 182 | - * Prepares and executes an SQL query and returns the result as an array of numeric arrays. |
|
| 183 | - * |
|
| 184 | - * @return array<int,array<int,mixed>> |
|
| 185 | - * |
|
| 186 | - * @throws Exception |
|
| 187 | - */ |
|
| 188 | - public function fetchAllNumeric(): array |
|
| 189 | - { |
|
| 190 | - } |
|
| 191 | - |
|
| 192 | - /** |
|
| 193 | - * Prepares and executes an SQL query and returns the result as an array of associative arrays. |
|
| 194 | - * |
|
| 195 | - * @return array<int,array<string,mixed>> |
|
| 196 | - * |
|
| 197 | - * @throws Exception |
|
| 198 | - */ |
|
| 199 | - public function fetchAllAssociative(): array |
|
| 200 | - { |
|
| 201 | - } |
|
| 202 | - |
|
| 203 | - /** |
|
| 204 | - * Prepares and executes an SQL query and returns the result as an associative array with the keys |
|
| 205 | - * mapped to the first column and the values mapped to the second column. |
|
| 206 | - * |
|
| 207 | - * @return array<mixed,mixed> |
|
| 208 | - * |
|
| 209 | - * @throws Exception |
|
| 210 | - */ |
|
| 211 | - public function fetchAllKeyValue(): array |
|
| 212 | - { |
|
| 213 | - } |
|
| 214 | - |
|
| 215 | - /** |
|
| 216 | - * Prepares and executes an SQL query and returns the result as an associative array with the keys mapped |
|
| 217 | - * to the first column and the values being an associative array representing the rest of the columns |
|
| 218 | - * and their values. |
|
| 219 | - * |
|
| 220 | - * @return array<mixed,array<string,mixed>> |
|
| 221 | - * |
|
| 222 | - * @throws Exception |
|
| 223 | - */ |
|
| 224 | - public function fetchAllAssociativeIndexed(): array |
|
| 225 | - { |
|
| 226 | - } |
|
| 227 | - |
|
| 228 | - /** |
|
| 229 | - * Prepares and executes an SQL query and returns the result as an array of the first column values. |
|
| 230 | - * |
|
| 231 | - * @return array<int,mixed> |
|
| 232 | - * |
|
| 233 | - * @throws Exception |
|
| 234 | - */ |
|
| 235 | - public function fetchFirstColumn(): array |
|
| 236 | - { |
|
| 237 | - } |
|
| 238 | - |
|
| 239 | - /** |
|
| 240 | - * Executes an SQL query (SELECT) and returns a Result. |
|
| 241 | - * |
|
| 242 | - * @throws Exception |
|
| 243 | - */ |
|
| 244 | - public function executeQuery(): Result |
|
| 245 | - { |
|
| 246 | - } |
|
| 247 | - |
|
| 248 | - /** |
|
| 249 | - * Executes an SQL statement and returns the number of affected rows. |
|
| 250 | - * |
|
| 251 | - * Should be used for INSERT, UPDATE and DELETE |
|
| 252 | - * |
|
| 253 | - * @return int The number of affected rows. |
|
| 254 | - * |
|
| 255 | - * @throws Exception |
|
| 256 | - */ |
|
| 257 | - public function executeStatement(): int |
|
| 258 | - { |
|
| 259 | - } |
|
| 260 | - |
|
| 261 | - /** |
|
| 262 | - * Executes this query using the bound parameters and their types. |
|
| 263 | - * |
|
| 264 | - * @deprecated Use {@see executeQuery()} or {@see executeStatement()} instead. |
|
| 265 | - * |
|
| 266 | - * @return Result|int|string |
|
| 267 | - * |
|
| 268 | - * @throws Exception |
|
| 269 | - */ |
|
| 270 | - public function execute() |
|
| 271 | - { |
|
| 272 | - } |
|
| 273 | - |
|
| 274 | - /** |
|
| 275 | - * Gets the complete SQL string formed by the current specifications of this QueryBuilder. |
|
| 276 | - * |
|
| 277 | - * <code> |
|
| 278 | - * $qb = $em->createQueryBuilder() |
|
| 279 | - * ->select('u') |
|
| 280 | - * ->from('User', 'u') |
|
| 281 | - * echo $qb->getSQL(); // SELECT u FROM User u |
|
| 282 | - * </code> |
|
| 283 | - * |
|
| 284 | - * @return string The SQL query string. |
|
| 285 | - */ |
|
| 286 | - public function getSQL() |
|
| 287 | - { |
|
| 288 | - } |
|
| 289 | - |
|
| 290 | - /** |
|
| 291 | - * Sets a query parameter for the query being constructed. |
|
| 292 | - * |
|
| 293 | - * <code> |
|
| 294 | - * $qb = $conn->createQueryBuilder() |
|
| 295 | - * ->select('u') |
|
| 296 | - * ->from('users', 'u') |
|
| 297 | - * ->where('u.id = :user_id') |
|
| 298 | - * ->setParameter('user_id', 1); |
|
| 299 | - * </code> |
|
| 300 | - * |
|
| 301 | - * @param int|string $key Parameter position or name |
|
| 302 | - * @param mixed $value Parameter value |
|
| 303 | - * @param int|string|Type|null $type Parameter type |
|
| 304 | - * |
|
| 305 | - * @return $this This QueryBuilder instance. |
|
| 306 | - */ |
|
| 307 | - public function setParameter($key, $value, $type = ParameterType::STRING) |
|
| 308 | - { |
|
| 309 | - } |
|
| 310 | - |
|
| 311 | - /** |
|
| 312 | - * Sets a collection of query parameters for the query being constructed. |
|
| 313 | - * |
|
| 314 | - * <code> |
|
| 315 | - * $qb = $conn->createQueryBuilder() |
|
| 316 | - * ->select('u') |
|
| 317 | - * ->from('users', 'u') |
|
| 318 | - * ->where('u.id = :user_id1 OR u.id = :user_id2') |
|
| 319 | - * ->setParameters(array( |
|
| 320 | - * 'user_id1' => 1, |
|
| 321 | - * 'user_id2' => 2 |
|
| 322 | - * )); |
|
| 323 | - * </code> |
|
| 324 | - * |
|
| 325 | - * @param list<mixed>|array<string, mixed> $params Parameters to set |
|
| 326 | - * @param array<int, int|string|Type|null>|array<string, int|string|Type|null> $types Parameter types |
|
| 327 | - * |
|
| 328 | - * @return $this This QueryBuilder instance. |
|
| 329 | - */ |
|
| 330 | - public function setParameters(array $params, array $types = []) |
|
| 331 | - { |
|
| 332 | - } |
|
| 333 | - |
|
| 334 | - /** |
|
| 335 | - * Gets all defined query parameters for the query being constructed indexed by parameter index or name. |
|
| 336 | - * |
|
| 337 | - * @return list<mixed>|array<string, mixed> The currently defined query parameters |
|
| 338 | - */ |
|
| 339 | - public function getParameters() |
|
| 340 | - { |
|
| 341 | - } |
|
| 342 | - |
|
| 343 | - /** |
|
| 344 | - * Gets a (previously set) query parameter of the query being constructed. |
|
| 345 | - * |
|
| 346 | - * @param mixed $key The key (index or name) of the bound parameter. |
|
| 347 | - * |
|
| 348 | - * @return mixed The value of the bound parameter. |
|
| 349 | - */ |
|
| 350 | - public function getParameter($key) |
|
| 351 | - { |
|
| 352 | - } |
|
| 353 | - |
|
| 354 | - /** |
|
| 355 | - * Gets all defined query parameter types for the query being constructed indexed by parameter index or name. |
|
| 356 | - * |
|
| 357 | - * @return array<int, int|string|Type|null>|array<string, int|string|Type|null> The currently defined |
|
| 358 | - * query parameter types |
|
| 359 | - */ |
|
| 360 | - public function getParameterTypes() |
|
| 361 | - { |
|
| 362 | - } |
|
| 363 | - |
|
| 364 | - /** |
|
| 365 | - * Gets a (previously set) query parameter type of the query being constructed. |
|
| 366 | - * |
|
| 367 | - * @param int|string $key The key of the bound parameter type |
|
| 368 | - * |
|
| 369 | - * @return int|string|Type The value of the bound parameter type |
|
| 370 | - */ |
|
| 371 | - public function getParameterType($key) |
|
| 372 | - { |
|
| 373 | - } |
|
| 374 | - |
|
| 375 | - /** |
|
| 376 | - * Sets the position of the first result to retrieve (the "offset"). |
|
| 377 | - * |
|
| 378 | - * @param int $firstResult The first result to return. |
|
| 379 | - * |
|
| 380 | - * @return $this This QueryBuilder instance. |
|
| 381 | - */ |
|
| 382 | - public function setFirstResult($firstResult) |
|
| 383 | - { |
|
| 384 | - } |
|
| 385 | - |
|
| 386 | - /** |
|
| 387 | - * Gets the position of the first result the query object was set to retrieve (the "offset"). |
|
| 388 | - * |
|
| 389 | - * @return int The position of the first result. |
|
| 390 | - */ |
|
| 391 | - public function getFirstResult() |
|
| 392 | - { |
|
| 393 | - } |
|
| 394 | - |
|
| 395 | - /** |
|
| 396 | - * Sets the maximum number of results to retrieve (the "limit"). |
|
| 397 | - * |
|
| 398 | - * @param int|null $maxResults The maximum number of results to retrieve or NULL to retrieve all results. |
|
| 399 | - * |
|
| 400 | - * @return $this This QueryBuilder instance. |
|
| 401 | - */ |
|
| 402 | - public function setMaxResults($maxResults) |
|
| 403 | - { |
|
| 404 | - } |
|
| 405 | - |
|
| 406 | - /** |
|
| 407 | - * Gets the maximum number of results the query object was set to retrieve (the "limit"). |
|
| 408 | - * Returns NULL if all results will be returned. |
|
| 409 | - * |
|
| 410 | - * @return int|null The maximum number of results. |
|
| 411 | - */ |
|
| 412 | - public function getMaxResults() |
|
| 413 | - { |
|
| 414 | - } |
|
| 415 | - |
|
| 416 | - /** |
|
| 417 | - * Locks the queried rows for a subsequent update. |
|
| 418 | - * |
|
| 419 | - * @return $this |
|
| 420 | - */ |
|
| 421 | - public function forUpdate(int $conflictResolutionMode = ConflictResolutionMode::ORDINARY): self |
|
| 422 | - { |
|
| 423 | - } |
|
| 424 | - |
|
| 425 | - /** |
|
| 426 | - * Either appends to or replaces a single, generic query part. |
|
| 427 | - * |
|
| 428 | - * The available parts are: 'select', 'from', 'set', 'where', |
|
| 429 | - * 'groupBy', 'having' and 'orderBy'. |
|
| 430 | - * |
|
| 431 | - * @param string $sqlPartName |
|
| 432 | - * @param mixed $sqlPart |
|
| 433 | - * @param bool $append |
|
| 434 | - * |
|
| 435 | - * @return $this This QueryBuilder instance. |
|
| 436 | - */ |
|
| 437 | - public function add($sqlPartName, $sqlPart, $append = false) |
|
| 438 | - { |
|
| 439 | - } |
|
| 440 | - |
|
| 441 | - /** |
|
| 442 | - * Specifies an item that is to be returned in the query result. |
|
| 443 | - * Replaces any previously specified selections, if any. |
|
| 444 | - * |
|
| 445 | - * USING AN ARRAY ARGUMENT IS DEPRECATED. Pass each value as an individual argument. |
|
| 446 | - * |
|
| 447 | - * <code> |
|
| 448 | - * $qb = $conn->createQueryBuilder() |
|
| 449 | - * ->select('u.id', 'p.id') |
|
| 450 | - * ->from('users', 'u') |
|
| 451 | - * ->leftJoin('u', 'phonenumbers', 'p', 'u.id = p.user_id'); |
|
| 452 | - * </code> |
|
| 453 | - * |
|
| 454 | - * @param string|string[]|null $select The selection expression. USING AN ARRAY OR NULL IS DEPRECATED. |
|
| 455 | - * Pass each value as an individual argument. |
|
| 456 | - * |
|
| 457 | - * @return $this This QueryBuilder instance. |
|
| 458 | - */ |
|
| 459 | - public function select($select = null) |
|
| 460 | - { |
|
| 461 | - } |
|
| 462 | - |
|
| 463 | - /** |
|
| 464 | - * Adds or removes DISTINCT to/from the query. |
|
| 465 | - * |
|
| 466 | - * <code> |
|
| 467 | - * $qb = $conn->createQueryBuilder() |
|
| 468 | - * ->select('u.id') |
|
| 469 | - * ->distinct() |
|
| 470 | - * ->from('users', 'u') |
|
| 471 | - * </code> |
|
| 472 | - * |
|
| 473 | - * @return $this This QueryBuilder instance. |
|
| 474 | - */ |
|
| 475 | - public function distinct(): self |
|
| 476 | - { |
|
| 477 | - } |
|
| 478 | - |
|
| 479 | - /** |
|
| 480 | - * Adds an item that is to be returned in the query result. |
|
| 481 | - * |
|
| 482 | - * USING AN ARRAY ARGUMENT IS DEPRECATED. Pass each value as an individual argument. |
|
| 483 | - * |
|
| 484 | - * <code> |
|
| 485 | - * $qb = $conn->createQueryBuilder() |
|
| 486 | - * ->select('u.id') |
|
| 487 | - * ->addSelect('p.id') |
|
| 488 | - * ->from('users', 'u') |
|
| 489 | - * ->leftJoin('u', 'phonenumbers', 'u.id = p.user_id'); |
|
| 490 | - * </code> |
|
| 491 | - * |
|
| 492 | - * @param string|string[]|null $select The selection expression. USING AN ARRAY OR NULL IS DEPRECATED. |
|
| 493 | - * Pass each value as an individual argument. |
|
| 494 | - * |
|
| 495 | - * @return $this This QueryBuilder instance. |
|
| 496 | - */ |
|
| 497 | - public function addSelect($select = null) |
|
| 498 | - { |
|
| 499 | - } |
|
| 500 | - |
|
| 501 | - /** |
|
| 502 | - * Turns the query being built into a bulk delete query that ranges over |
|
| 503 | - * a certain table. |
|
| 504 | - * |
|
| 505 | - * <code> |
|
| 506 | - * $qb = $conn->createQueryBuilder() |
|
| 507 | - * ->delete('users', 'u') |
|
| 508 | - * ->where('u.id = :user_id') |
|
| 509 | - * ->setParameter(':user_id', 1); |
|
| 510 | - * </code> |
|
| 511 | - * |
|
| 512 | - * @param string $delete The table whose rows are subject to the deletion. |
|
| 513 | - * @param string $alias The table alias used in the constructed query. |
|
| 514 | - * |
|
| 515 | - * @return $this This QueryBuilder instance. |
|
| 516 | - */ |
|
| 517 | - public function delete($delete = null, $alias = null) |
|
| 518 | - { |
|
| 519 | - } |
|
| 520 | - |
|
| 521 | - /** |
|
| 522 | - * Turns the query being built into a bulk update query that ranges over |
|
| 523 | - * a certain table |
|
| 524 | - * |
|
| 525 | - * <code> |
|
| 526 | - * $qb = $conn->createQueryBuilder() |
|
| 527 | - * ->update('counters', 'c') |
|
| 528 | - * ->set('c.value', 'c.value + 1') |
|
| 529 | - * ->where('c.id = ?'); |
|
| 530 | - * </code> |
|
| 531 | - * |
|
| 532 | - * @param string $update The table whose rows are subject to the update. |
|
| 533 | - * @param string $alias The table alias used in the constructed query. |
|
| 534 | - * |
|
| 535 | - * @return $this This QueryBuilder instance. |
|
| 536 | - */ |
|
| 537 | - public function update($update = null, $alias = null) |
|
| 538 | - { |
|
| 539 | - } |
|
| 540 | - |
|
| 541 | - /** |
|
| 542 | - * Turns the query being built into an insert query that inserts into |
|
| 543 | - * a certain table |
|
| 544 | - * |
|
| 545 | - * <code> |
|
| 546 | - * $qb = $conn->createQueryBuilder() |
|
| 547 | - * ->insert('users') |
|
| 548 | - * ->values( |
|
| 549 | - * array( |
|
| 550 | - * 'name' => '?', |
|
| 551 | - * 'password' => '?' |
|
| 552 | - * ) |
|
| 553 | - * ); |
|
| 554 | - * </code> |
|
| 555 | - * |
|
| 556 | - * @param string $insert The table into which the rows should be inserted. |
|
| 557 | - * |
|
| 558 | - * @return $this This QueryBuilder instance. |
|
| 559 | - */ |
|
| 560 | - public function insert($insert = null) |
|
| 561 | - { |
|
| 562 | - } |
|
| 563 | - |
|
| 564 | - /** |
|
| 565 | - * Creates and adds a query root corresponding to the table identified by the |
|
| 566 | - * given alias, forming a cartesian product with any existing query roots. |
|
| 567 | - * |
|
| 568 | - * <code> |
|
| 569 | - * $qb = $conn->createQueryBuilder() |
|
| 570 | - * ->select('u.id') |
|
| 571 | - * ->from('users', 'u') |
|
| 572 | - * </code> |
|
| 573 | - * |
|
| 574 | - * @param string $from The table. |
|
| 575 | - * @param string|null $alias The alias of the table. |
|
| 576 | - * |
|
| 577 | - * @return $this This QueryBuilder instance. |
|
| 578 | - */ |
|
| 579 | - public function from($from, $alias = null) |
|
| 580 | - { |
|
| 581 | - } |
|
| 582 | - |
|
| 583 | - /** |
|
| 584 | - * Creates and adds a join to the query. |
|
| 585 | - * |
|
| 586 | - * <code> |
|
| 587 | - * $qb = $conn->createQueryBuilder() |
|
| 588 | - * ->select('u.name') |
|
| 589 | - * ->from('users', 'u') |
|
| 590 | - * ->join('u', 'phonenumbers', 'p', 'p.is_primary = 1'); |
|
| 591 | - * </code> |
|
| 592 | - * |
|
| 593 | - * @param string $fromAlias The alias that points to a from clause. |
|
| 594 | - * @param string $join The table name to join. |
|
| 595 | - * @param string $alias The alias of the join table. |
|
| 596 | - * @param string $condition The condition for the join. |
|
| 597 | - * |
|
| 598 | - * @return $this This QueryBuilder instance. |
|
| 599 | - */ |
|
| 600 | - public function join($fromAlias, $join, $alias, $condition = null) |
|
| 601 | - { |
|
| 602 | - } |
|
| 603 | - |
|
| 604 | - /** |
|
| 605 | - * Creates and adds a join to the query. |
|
| 606 | - * |
|
| 607 | - * <code> |
|
| 608 | - * $qb = $conn->createQueryBuilder() |
|
| 609 | - * ->select('u.name') |
|
| 610 | - * ->from('users', 'u') |
|
| 611 | - * ->innerJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1'); |
|
| 612 | - * </code> |
|
| 613 | - * |
|
| 614 | - * @param string $fromAlias The alias that points to a from clause. |
|
| 615 | - * @param string $join The table name to join. |
|
| 616 | - * @param string $alias The alias of the join table. |
|
| 617 | - * @param string $condition The condition for the join. |
|
| 618 | - * |
|
| 619 | - * @return $this This QueryBuilder instance. |
|
| 620 | - */ |
|
| 621 | - public function innerJoin($fromAlias, $join, $alias, $condition = null) |
|
| 622 | - { |
|
| 623 | - } |
|
| 624 | - |
|
| 625 | - /** |
|
| 626 | - * Creates and adds a left join to the query. |
|
| 627 | - * |
|
| 628 | - * <code> |
|
| 629 | - * $qb = $conn->createQueryBuilder() |
|
| 630 | - * ->select('u.name') |
|
| 631 | - * ->from('users', 'u') |
|
| 632 | - * ->leftJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1'); |
|
| 633 | - * </code> |
|
| 634 | - * |
|
| 635 | - * @param string $fromAlias The alias that points to a from clause. |
|
| 636 | - * @param string $join The table name to join. |
|
| 637 | - * @param string $alias The alias of the join table. |
|
| 638 | - * @param string $condition The condition for the join. |
|
| 639 | - * |
|
| 640 | - * @return $this This QueryBuilder instance. |
|
| 641 | - */ |
|
| 642 | - public function leftJoin($fromAlias, $join, $alias, $condition = null) |
|
| 643 | - { |
|
| 644 | - } |
|
| 645 | - |
|
| 646 | - /** |
|
| 647 | - * Creates and adds a right join to the query. |
|
| 648 | - * |
|
| 649 | - * <code> |
|
| 650 | - * $qb = $conn->createQueryBuilder() |
|
| 651 | - * ->select('u.name') |
|
| 652 | - * ->from('users', 'u') |
|
| 653 | - * ->rightJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1'); |
|
| 654 | - * </code> |
|
| 655 | - * |
|
| 656 | - * @param string $fromAlias The alias that points to a from clause. |
|
| 657 | - * @param string $join The table name to join. |
|
| 658 | - * @param string $alias The alias of the join table. |
|
| 659 | - * @param string $condition The condition for the join. |
|
| 660 | - * |
|
| 661 | - * @return $this This QueryBuilder instance. |
|
| 662 | - */ |
|
| 663 | - public function rightJoin($fromAlias, $join, $alias, $condition = null) |
|
| 664 | - { |
|
| 665 | - } |
|
| 666 | - |
|
| 667 | - /** |
|
| 668 | - * Sets a new value for a column in a bulk update query. |
|
| 669 | - * |
|
| 670 | - * <code> |
|
| 671 | - * $qb = $conn->createQueryBuilder() |
|
| 672 | - * ->update('counters', 'c') |
|
| 673 | - * ->set('c.value', 'c.value + 1') |
|
| 674 | - * ->where('c.id = ?'); |
|
| 675 | - * </code> |
|
| 676 | - * |
|
| 677 | - * @param string $key The column to set. |
|
| 678 | - * @param string $value The value, expression, placeholder, etc. |
|
| 679 | - * |
|
| 680 | - * @return $this This QueryBuilder instance. |
|
| 681 | - */ |
|
| 682 | - public function set($key, $value) |
|
| 683 | - { |
|
| 684 | - } |
|
| 685 | - |
|
| 686 | - /** |
|
| 687 | - * Specifies one or more restrictions to the query result. |
|
| 688 | - * Replaces any previously specified restrictions, if any. |
|
| 689 | - * |
|
| 690 | - * <code> |
|
| 691 | - * $qb = $conn->createQueryBuilder() |
|
| 692 | - * ->select('c.value') |
|
| 693 | - * ->from('counters', 'c') |
|
| 694 | - * ->where('c.id = ?'); |
|
| 695 | - * |
|
| 696 | - * // You can optionally programmatically build and/or expressions |
|
| 697 | - * $qb = $conn->createQueryBuilder(); |
|
| 698 | - * |
|
| 699 | - * $or = $qb->expr()->orx(); |
|
| 700 | - * $or->add($qb->expr()->eq('c.id', 1)); |
|
| 701 | - * $or->add($qb->expr()->eq('c.id', 2)); |
|
| 702 | - * |
|
| 703 | - * $qb->update('counters', 'c') |
|
| 704 | - * ->set('c.value', 'c.value + 1') |
|
| 705 | - * ->where($or); |
|
| 706 | - * </code> |
|
| 707 | - * |
|
| 708 | - * @param mixed $predicates The restriction predicates. |
|
| 709 | - * |
|
| 710 | - * @return $this This QueryBuilder instance. |
|
| 711 | - */ |
|
| 712 | - public function where($predicates) |
|
| 713 | - { |
|
| 714 | - } |
|
| 715 | - |
|
| 716 | - /** |
|
| 717 | - * Adds one or more restrictions to the query results, forming a logical |
|
| 718 | - * conjunction with any previously specified restrictions. |
|
| 719 | - * |
|
| 720 | - * <code> |
|
| 721 | - * $qb = $conn->createQueryBuilder() |
|
| 722 | - * ->select('u') |
|
| 723 | - * ->from('users', 'u') |
|
| 724 | - * ->where('u.username LIKE ?') |
|
| 725 | - * ->andWhere('u.is_active = 1'); |
|
| 726 | - * </code> |
|
| 727 | - * |
|
| 728 | - * @see where() |
|
| 729 | - * |
|
| 730 | - * @param mixed $where The query restrictions. |
|
| 731 | - * |
|
| 732 | - * @return $this This QueryBuilder instance. |
|
| 733 | - */ |
|
| 734 | - public function andWhere($where) |
|
| 735 | - { |
|
| 736 | - } |
|
| 737 | - |
|
| 738 | - /** |
|
| 739 | - * Adds one or more restrictions to the query results, forming a logical |
|
| 740 | - * disjunction with any previously specified restrictions. |
|
| 741 | - * |
|
| 742 | - * <code> |
|
| 743 | - * $qb = $em->createQueryBuilder() |
|
| 744 | - * ->select('u.name') |
|
| 745 | - * ->from('users', 'u') |
|
| 746 | - * ->where('u.id = 1') |
|
| 747 | - * ->orWhere('u.id = 2'); |
|
| 748 | - * </code> |
|
| 749 | - * |
|
| 750 | - * @see where() |
|
| 751 | - * |
|
| 752 | - * @param mixed $where The WHERE statement. |
|
| 753 | - * |
|
| 754 | - * @return $this This QueryBuilder instance. |
|
| 755 | - */ |
|
| 756 | - public function orWhere($where) |
|
| 757 | - { |
|
| 758 | - } |
|
| 759 | - |
|
| 760 | - /** |
|
| 761 | - * Specifies a grouping over the results of the query. |
|
| 762 | - * Replaces any previously specified groupings, if any. |
|
| 763 | - * |
|
| 764 | - * USING AN ARRAY ARGUMENT IS DEPRECATED. Pass each value as an individual argument. |
|
| 765 | - * |
|
| 766 | - * <code> |
|
| 767 | - * $qb = $conn->createQueryBuilder() |
|
| 768 | - * ->select('u.name') |
|
| 769 | - * ->from('users', 'u') |
|
| 770 | - * ->groupBy('u.id'); |
|
| 771 | - * </code> |
|
| 772 | - * |
|
| 773 | - * @param string|string[] $groupBy The grouping expression. USING AN ARRAY IS DEPRECATED. |
|
| 774 | - * Pass each value as an individual argument. |
|
| 775 | - * |
|
| 776 | - * @return $this This QueryBuilder instance. |
|
| 777 | - */ |
|
| 778 | - public function groupBy($groupBy) |
|
| 779 | - { |
|
| 780 | - } |
|
| 781 | - |
|
| 782 | - /** |
|
| 783 | - * Adds a grouping expression to the query. |
|
| 784 | - * |
|
| 785 | - * USING AN ARRAY ARGUMENT IS DEPRECATED. Pass each value as an individual argument. |
|
| 786 | - * |
|
| 787 | - * <code> |
|
| 788 | - * $qb = $conn->createQueryBuilder() |
|
| 789 | - * ->select('u.name') |
|
| 790 | - * ->from('users', 'u') |
|
| 791 | - * ->groupBy('u.lastLogin') |
|
| 792 | - * ->addGroupBy('u.createdAt'); |
|
| 793 | - * </code> |
|
| 794 | - * |
|
| 795 | - * @param string|string[] $groupBy The grouping expression. USING AN ARRAY IS DEPRECATED. |
|
| 796 | - * Pass each value as an individual argument. |
|
| 797 | - * |
|
| 798 | - * @return $this This QueryBuilder instance. |
|
| 799 | - */ |
|
| 800 | - public function addGroupBy($groupBy) |
|
| 801 | - { |
|
| 802 | - } |
|
| 803 | - |
|
| 804 | - /** |
|
| 805 | - * Sets a value for a column in an insert query. |
|
| 806 | - * |
|
| 807 | - * <code> |
|
| 808 | - * $qb = $conn->createQueryBuilder() |
|
| 809 | - * ->insert('users') |
|
| 810 | - * ->values( |
|
| 811 | - * array( |
|
| 812 | - * 'name' => '?' |
|
| 813 | - * ) |
|
| 814 | - * ) |
|
| 815 | - * ->setValue('password', '?'); |
|
| 816 | - * </code> |
|
| 817 | - * |
|
| 818 | - * @param string $column The column into which the value should be inserted. |
|
| 819 | - * @param string $value The value that should be inserted into the column. |
|
| 820 | - * |
|
| 821 | - * @return $this This QueryBuilder instance. |
|
| 822 | - */ |
|
| 823 | - public function setValue($column, $value) |
|
| 824 | - { |
|
| 825 | - } |
|
| 826 | - |
|
| 827 | - /** |
|
| 828 | - * Specifies values for an insert query indexed by column names. |
|
| 829 | - * Replaces any previous values, if any. |
|
| 830 | - * |
|
| 831 | - * <code> |
|
| 832 | - * $qb = $conn->createQueryBuilder() |
|
| 833 | - * ->insert('users') |
|
| 834 | - * ->values( |
|
| 835 | - * array( |
|
| 836 | - * 'name' => '?', |
|
| 837 | - * 'password' => '?' |
|
| 838 | - * ) |
|
| 839 | - * ); |
|
| 840 | - * </code> |
|
| 841 | - * |
|
| 842 | - * @param mixed[] $values The values to specify for the insert query indexed by column names. |
|
| 843 | - * |
|
| 844 | - * @return $this This QueryBuilder instance. |
|
| 845 | - */ |
|
| 846 | - public function values(array $values) |
|
| 847 | - { |
|
| 848 | - } |
|
| 849 | - |
|
| 850 | - /** |
|
| 851 | - * Specifies a restriction over the groups of the query. |
|
| 852 | - * Replaces any previous having restrictions, if any. |
|
| 853 | - * |
|
| 854 | - * @param mixed $having The restriction over the groups. |
|
| 855 | - * |
|
| 856 | - * @return $this This QueryBuilder instance. |
|
| 857 | - */ |
|
| 858 | - public function having($having) |
|
| 859 | - { |
|
| 860 | - } |
|
| 861 | - |
|
| 862 | - /** |
|
| 863 | - * Adds a restriction over the groups of the query, forming a logical |
|
| 864 | - * conjunction with any existing having restrictions. |
|
| 865 | - * |
|
| 866 | - * @param mixed $having The restriction to append. |
|
| 867 | - * |
|
| 868 | - * @return $this This QueryBuilder instance. |
|
| 869 | - */ |
|
| 870 | - public function andHaving($having) |
|
| 871 | - { |
|
| 872 | - } |
|
| 873 | - |
|
| 874 | - /** |
|
| 875 | - * Adds a restriction over the groups of the query, forming a logical |
|
| 876 | - * disjunction with any existing having restrictions. |
|
| 877 | - * |
|
| 878 | - * @param mixed $having The restriction to add. |
|
| 879 | - * |
|
| 880 | - * @return $this This QueryBuilder instance. |
|
| 881 | - */ |
|
| 882 | - public function orHaving($having) |
|
| 883 | - { |
|
| 884 | - } |
|
| 885 | - |
|
| 886 | - /** |
|
| 887 | - * Specifies an ordering for the query results. |
|
| 888 | - * Replaces any previously specified orderings, if any. |
|
| 889 | - * |
|
| 890 | - * @param string $sort The ordering expression. |
|
| 891 | - * @param string $order The ordering direction. |
|
| 892 | - * |
|
| 893 | - * @return $this This QueryBuilder instance. |
|
| 894 | - */ |
|
| 895 | - public function orderBy($sort, $order = null) |
|
| 896 | - { |
|
| 897 | - } |
|
| 898 | - |
|
| 899 | - /** |
|
| 900 | - * Adds an ordering to the query results. |
|
| 901 | - * |
|
| 902 | - * @param string $sort The ordering expression. |
|
| 903 | - * @param string $order The ordering direction. |
|
| 904 | - * |
|
| 905 | - * @return $this This QueryBuilder instance. |
|
| 906 | - */ |
|
| 907 | - public function addOrderBy($sort, $order = null) |
|
| 908 | - { |
|
| 909 | - } |
|
| 910 | - |
|
| 911 | - /** |
|
| 912 | - * Gets a query part by its name. |
|
| 913 | - * |
|
| 914 | - * @deprecated The query parts are implementation details and should not be relied upon. |
|
| 915 | - * |
|
| 916 | - * @param string $queryPartName |
|
| 917 | - * |
|
| 918 | - * @return mixed |
|
| 919 | - */ |
|
| 920 | - public function getQueryPart($queryPartName) |
|
| 921 | - { |
|
| 922 | - } |
|
| 923 | - |
|
| 924 | - /** |
|
| 925 | - * Gets all query parts. |
|
| 926 | - * |
|
| 927 | - * @deprecated The query parts are implementation details and should not be relied upon. |
|
| 928 | - * |
|
| 929 | - * @return mixed[] |
|
| 930 | - */ |
|
| 931 | - public function getQueryParts() |
|
| 932 | - { |
|
| 933 | - } |
|
| 934 | - |
|
| 935 | - /** |
|
| 936 | - * Resets SQL parts. |
|
| 937 | - * |
|
| 938 | - * @deprecated Use the dedicated reset*() methods instead. |
|
| 939 | - * |
|
| 940 | - * @param string[]|null $queryPartNames |
|
| 941 | - * |
|
| 942 | - * @return $this This QueryBuilder instance. |
|
| 943 | - */ |
|
| 944 | - public function resetQueryParts($queryPartNames = null) |
|
| 945 | - { |
|
| 946 | - } |
|
| 947 | - |
|
| 948 | - /** |
|
| 949 | - * Resets a single SQL part. |
|
| 950 | - * |
|
| 951 | - * @deprecated Use the dedicated reset*() methods instead. |
|
| 952 | - * |
|
| 953 | - * @param string $queryPartName |
|
| 954 | - * |
|
| 955 | - * @return $this This QueryBuilder instance. |
|
| 956 | - */ |
|
| 957 | - public function resetQueryPart($queryPartName) |
|
| 958 | - { |
|
| 959 | - } |
|
| 960 | - |
|
| 961 | - /** |
|
| 962 | - * Resets the WHERE conditions for the query. |
|
| 963 | - * |
|
| 964 | - * @return $this This QueryBuilder instance. |
|
| 965 | - */ |
|
| 966 | - public function resetWhere(): self |
|
| 967 | - { |
|
| 968 | - } |
|
| 969 | - |
|
| 970 | - /** |
|
| 971 | - * Resets the grouping for the query. |
|
| 972 | - * |
|
| 973 | - * @return $this This QueryBuilder instance. |
|
| 974 | - */ |
|
| 975 | - public function resetGroupBy(): self |
|
| 976 | - { |
|
| 977 | - } |
|
| 978 | - |
|
| 979 | - /** |
|
| 980 | - * Resets the HAVING conditions for the query. |
|
| 981 | - * |
|
| 982 | - * @return $this This QueryBuilder instance. |
|
| 983 | - */ |
|
| 984 | - public function resetHaving(): self |
|
| 985 | - { |
|
| 986 | - } |
|
| 987 | - |
|
| 988 | - /** |
|
| 989 | - * Resets the ordering for the query. |
|
| 990 | - * |
|
| 991 | - * @return $this This QueryBuilder instance. |
|
| 992 | - */ |
|
| 993 | - public function resetOrderBy(): self |
|
| 994 | - { |
|
| 995 | - } |
|
| 996 | - |
|
| 997 | - /** |
|
| 998 | - * Gets a string representation of this QueryBuilder which corresponds to |
|
| 999 | - * the final SQL query being constructed. |
|
| 1000 | - * |
|
| 1001 | - * @return string The string representation of this QueryBuilder. |
|
| 1002 | - */ |
|
| 1003 | - public function __toString() |
|
| 1004 | - { |
|
| 1005 | - } |
|
| 1006 | - |
|
| 1007 | - /** |
|
| 1008 | - * Creates a new named parameter and bind the value $value to it. |
|
| 1009 | - * |
|
| 1010 | - * This method provides a shortcut for {@see Statement::bindValue()} |
|
| 1011 | - * when using prepared statements. |
|
| 1012 | - * |
|
| 1013 | - * The parameter $value specifies the value that you want to bind. If |
|
| 1014 | - * $placeholder is not provided createNamedParameter() will automatically |
|
| 1015 | - * create a placeholder for you. An automatic placeholder will be of the |
|
| 1016 | - * name ':dcValue1', ':dcValue2' etc. |
|
| 1017 | - * |
|
| 1018 | - * Example: |
|
| 1019 | - * <code> |
|
| 1020 | - * $value = 2; |
|
| 1021 | - * $q->eq( 'id', $q->createNamedParameter( $value ) ); |
|
| 1022 | - * $stmt = $q->executeQuery(); // executed with 'id = 2' |
|
| 1023 | - * </code> |
|
| 1024 | - * |
|
| 1025 | - * @link http://www.zetacomponents.org |
|
| 1026 | - * |
|
| 1027 | - * @param mixed $value |
|
| 1028 | - * @param int|string|Type|null $type |
|
| 1029 | - * @param string $placeHolder The name to bind with. The string must start with a colon ':'. |
|
| 1030 | - * |
|
| 1031 | - * @return string the placeholder name used. |
|
| 1032 | - */ |
|
| 1033 | - public function createNamedParameter($value, $type = ParameterType::STRING, $placeHolder = null) |
|
| 1034 | - { |
|
| 1035 | - } |
|
| 1036 | - |
|
| 1037 | - /** |
|
| 1038 | - * Creates a new positional parameter and bind the given value to it. |
|
| 1039 | - * |
|
| 1040 | - * Attention: If you are using positional parameters with the query builder you have |
|
| 1041 | - * to be very careful to bind all parameters in the order they appear in the SQL |
|
| 1042 | - * statement , otherwise they get bound in the wrong order which can lead to serious |
|
| 1043 | - * bugs in your code. |
|
| 1044 | - * |
|
| 1045 | - * Example: |
|
| 1046 | - * <code> |
|
| 1047 | - * $qb = $conn->createQueryBuilder(); |
|
| 1048 | - * $qb->select('u.*') |
|
| 1049 | - * ->from('users', 'u') |
|
| 1050 | - * ->where('u.username = ' . $qb->createPositionalParameter('Foo', ParameterType::STRING)) |
|
| 1051 | - * ->orWhere('u.username = ' . $qb->createPositionalParameter('Bar', ParameterType::STRING)) |
|
| 1052 | - * </code> |
|
| 1053 | - * |
|
| 1054 | - * @param mixed $value |
|
| 1055 | - * @param int|string|Type|null $type |
|
| 1056 | - * |
|
| 1057 | - * @return string |
|
| 1058 | - */ |
|
| 1059 | - public function createPositionalParameter($value, $type = ParameterType::STRING) |
|
| 1060 | - { |
|
| 1061 | - } |
|
| 1062 | - |
|
| 1063 | - /** |
|
| 1064 | - * Deep clone of all expression objects in the SQL parts. |
|
| 1065 | - * |
|
| 1066 | - * @return void |
|
| 1067 | - */ |
|
| 1068 | - public function __clone() |
|
| 1069 | - { |
|
| 1070 | - } |
|
| 1071 | - |
|
| 1072 | - /** |
|
| 1073 | - * Enables caching of the results of this query, for given amount of seconds |
|
| 1074 | - * and optionally specified which key to use for the cache entry. |
|
| 1075 | - * |
|
| 1076 | - * @return $this |
|
| 1077 | - */ |
|
| 1078 | - public function enableResultCache(QueryCacheProfile $cacheProfile): self |
|
| 1079 | - { |
|
| 1080 | - } |
|
| 1081 | - |
|
| 1082 | - /** |
|
| 1083 | - * Disables caching of the results of this query. |
|
| 1084 | - * |
|
| 1085 | - * @return $this |
|
| 1086 | - */ |
|
| 1087 | - public function disableResultCache(): self |
|
| 1088 | - { |
|
| 1089 | - } |
|
| 68 | + private const SQL_PARTS_DEFAULTS = [ |
|
| 69 | + 'select' => [], |
|
| 70 | + 'distinct' => false, |
|
| 71 | + 'from' => [], |
|
| 72 | + 'join' => [], |
|
| 73 | + 'set' => [], |
|
| 74 | + 'where' => null, |
|
| 75 | + 'groupBy' => [], |
|
| 76 | + 'having' => null, |
|
| 77 | + 'orderBy' => [], |
|
| 78 | + 'values' => [], |
|
| 79 | + 'for_update' => null, |
|
| 80 | + ]; |
|
| 81 | + |
|
| 82 | + /** |
|
| 83 | + * Initializes a new <tt>QueryBuilder</tt>. |
|
| 84 | + * |
|
| 85 | + * @param Connection $connection The DBAL Connection. |
|
| 86 | + */ |
|
| 87 | + public function __construct(Connection $connection) |
|
| 88 | + { |
|
| 89 | + } |
|
| 90 | + |
|
| 91 | + /** |
|
| 92 | + * Gets an ExpressionBuilder used for object-oriented construction of query expressions. |
|
| 93 | + * This producer method is intended for convenient inline usage. Example: |
|
| 94 | + * |
|
| 95 | + * <code> |
|
| 96 | + * $qb = $conn->createQueryBuilder() |
|
| 97 | + * ->select('u') |
|
| 98 | + * ->from('users', 'u') |
|
| 99 | + * ->where($qb->expr()->eq('u.id', 1)); |
|
| 100 | + * </code> |
|
| 101 | + * |
|
| 102 | + * For more complex expression construction, consider storing the expression |
|
| 103 | + * builder object in a local variable. |
|
| 104 | + * |
|
| 105 | + * @return ExpressionBuilder |
|
| 106 | + */ |
|
| 107 | + public function expr() |
|
| 108 | + { |
|
| 109 | + } |
|
| 110 | + |
|
| 111 | + /** |
|
| 112 | + * Gets the type of the currently built query. |
|
| 113 | + * |
|
| 114 | + * @deprecated If necessary, track the type of the query being built outside of the builder. |
|
| 115 | + * |
|
| 116 | + * @return int |
|
| 117 | + */ |
|
| 118 | + public function getType() |
|
| 119 | + { |
|
| 120 | + } |
|
| 121 | + |
|
| 122 | + /** |
|
| 123 | + * Gets the associated DBAL Connection for this query builder. |
|
| 124 | + * |
|
| 125 | + * @deprecated Use the connection used to instantiate the builder instead. |
|
| 126 | + * |
|
| 127 | + * @return Connection |
|
| 128 | + */ |
|
| 129 | + public function getConnection() |
|
| 130 | + { |
|
| 131 | + } |
|
| 132 | + |
|
| 133 | + /** |
|
| 134 | + * Gets the state of this query builder instance. |
|
| 135 | + * |
|
| 136 | + * @deprecated The builder state is an internal concern. |
|
| 137 | + * |
|
| 138 | + * @return int Either QueryBuilder::STATE_DIRTY or QueryBuilder::STATE_CLEAN. |
|
| 139 | + * @psalm-return self::STATE_* |
|
| 140 | + */ |
|
| 141 | + public function getState() |
|
| 142 | + { |
|
| 143 | + } |
|
| 144 | + |
|
| 145 | + /** |
|
| 146 | + * Prepares and executes an SQL query and returns the first row of the result |
|
| 147 | + * as an associative array. |
|
| 148 | + * |
|
| 149 | + * @return array<string, mixed>|false False is returned if no rows are found. |
|
| 150 | + * |
|
| 151 | + * @throws Exception |
|
| 152 | + */ |
|
| 153 | + public function fetchAssociative() |
|
| 154 | + { |
|
| 155 | + } |
|
| 156 | + |
|
| 157 | + /** |
|
| 158 | + * Prepares and executes an SQL query and returns the first row of the result |
|
| 159 | + * as a numerically indexed array. |
|
| 160 | + * |
|
| 161 | + * @return array<int, mixed>|false False is returned if no rows are found. |
|
| 162 | + * |
|
| 163 | + * @throws Exception |
|
| 164 | + */ |
|
| 165 | + public function fetchNumeric() |
|
| 166 | + { |
|
| 167 | + } |
|
| 168 | + |
|
| 169 | + /** |
|
| 170 | + * Prepares and executes an SQL query and returns the value of a single column |
|
| 171 | + * of the first row of the result. |
|
| 172 | + * |
|
| 173 | + * @return mixed|false False is returned if no rows are found. |
|
| 174 | + * |
|
| 175 | + * @throws Exception |
|
| 176 | + */ |
|
| 177 | + public function fetchOne() |
|
| 178 | + { |
|
| 179 | + } |
|
| 180 | + |
|
| 181 | + /** |
|
| 182 | + * Prepares and executes an SQL query and returns the result as an array of numeric arrays. |
|
| 183 | + * |
|
| 184 | + * @return array<int,array<int,mixed>> |
|
| 185 | + * |
|
| 186 | + * @throws Exception |
|
| 187 | + */ |
|
| 188 | + public function fetchAllNumeric(): array |
|
| 189 | + { |
|
| 190 | + } |
|
| 191 | + |
|
| 192 | + /** |
|
| 193 | + * Prepares and executes an SQL query and returns the result as an array of associative arrays. |
|
| 194 | + * |
|
| 195 | + * @return array<int,array<string,mixed>> |
|
| 196 | + * |
|
| 197 | + * @throws Exception |
|
| 198 | + */ |
|
| 199 | + public function fetchAllAssociative(): array |
|
| 200 | + { |
|
| 201 | + } |
|
| 202 | + |
|
| 203 | + /** |
|
| 204 | + * Prepares and executes an SQL query and returns the result as an associative array with the keys |
|
| 205 | + * mapped to the first column and the values mapped to the second column. |
|
| 206 | + * |
|
| 207 | + * @return array<mixed,mixed> |
|
| 208 | + * |
|
| 209 | + * @throws Exception |
|
| 210 | + */ |
|
| 211 | + public function fetchAllKeyValue(): array |
|
| 212 | + { |
|
| 213 | + } |
|
| 214 | + |
|
| 215 | + /** |
|
| 216 | + * Prepares and executes an SQL query and returns the result as an associative array with the keys mapped |
|
| 217 | + * to the first column and the values being an associative array representing the rest of the columns |
|
| 218 | + * and their values. |
|
| 219 | + * |
|
| 220 | + * @return array<mixed,array<string,mixed>> |
|
| 221 | + * |
|
| 222 | + * @throws Exception |
|
| 223 | + */ |
|
| 224 | + public function fetchAllAssociativeIndexed(): array |
|
| 225 | + { |
|
| 226 | + } |
|
| 227 | + |
|
| 228 | + /** |
|
| 229 | + * Prepares and executes an SQL query and returns the result as an array of the first column values. |
|
| 230 | + * |
|
| 231 | + * @return array<int,mixed> |
|
| 232 | + * |
|
| 233 | + * @throws Exception |
|
| 234 | + */ |
|
| 235 | + public function fetchFirstColumn(): array |
|
| 236 | + { |
|
| 237 | + } |
|
| 238 | + |
|
| 239 | + /** |
|
| 240 | + * Executes an SQL query (SELECT) and returns a Result. |
|
| 241 | + * |
|
| 242 | + * @throws Exception |
|
| 243 | + */ |
|
| 244 | + public function executeQuery(): Result |
|
| 245 | + { |
|
| 246 | + } |
|
| 247 | + |
|
| 248 | + /** |
|
| 249 | + * Executes an SQL statement and returns the number of affected rows. |
|
| 250 | + * |
|
| 251 | + * Should be used for INSERT, UPDATE and DELETE |
|
| 252 | + * |
|
| 253 | + * @return int The number of affected rows. |
|
| 254 | + * |
|
| 255 | + * @throws Exception |
|
| 256 | + */ |
|
| 257 | + public function executeStatement(): int |
|
| 258 | + { |
|
| 259 | + } |
|
| 260 | + |
|
| 261 | + /** |
|
| 262 | + * Executes this query using the bound parameters and their types. |
|
| 263 | + * |
|
| 264 | + * @deprecated Use {@see executeQuery()} or {@see executeStatement()} instead. |
|
| 265 | + * |
|
| 266 | + * @return Result|int|string |
|
| 267 | + * |
|
| 268 | + * @throws Exception |
|
| 269 | + */ |
|
| 270 | + public function execute() |
|
| 271 | + { |
|
| 272 | + } |
|
| 273 | + |
|
| 274 | + /** |
|
| 275 | + * Gets the complete SQL string formed by the current specifications of this QueryBuilder. |
|
| 276 | + * |
|
| 277 | + * <code> |
|
| 278 | + * $qb = $em->createQueryBuilder() |
|
| 279 | + * ->select('u') |
|
| 280 | + * ->from('User', 'u') |
|
| 281 | + * echo $qb->getSQL(); // SELECT u FROM User u |
|
| 282 | + * </code> |
|
| 283 | + * |
|
| 284 | + * @return string The SQL query string. |
|
| 285 | + */ |
|
| 286 | + public function getSQL() |
|
| 287 | + { |
|
| 288 | + } |
|
| 289 | + |
|
| 290 | + /** |
|
| 291 | + * Sets a query parameter for the query being constructed. |
|
| 292 | + * |
|
| 293 | + * <code> |
|
| 294 | + * $qb = $conn->createQueryBuilder() |
|
| 295 | + * ->select('u') |
|
| 296 | + * ->from('users', 'u') |
|
| 297 | + * ->where('u.id = :user_id') |
|
| 298 | + * ->setParameter('user_id', 1); |
|
| 299 | + * </code> |
|
| 300 | + * |
|
| 301 | + * @param int|string $key Parameter position or name |
|
| 302 | + * @param mixed $value Parameter value |
|
| 303 | + * @param int|string|Type|null $type Parameter type |
|
| 304 | + * |
|
| 305 | + * @return $this This QueryBuilder instance. |
|
| 306 | + */ |
|
| 307 | + public function setParameter($key, $value, $type = ParameterType::STRING) |
|
| 308 | + { |
|
| 309 | + } |
|
| 310 | + |
|
| 311 | + /** |
|
| 312 | + * Sets a collection of query parameters for the query being constructed. |
|
| 313 | + * |
|
| 314 | + * <code> |
|
| 315 | + * $qb = $conn->createQueryBuilder() |
|
| 316 | + * ->select('u') |
|
| 317 | + * ->from('users', 'u') |
|
| 318 | + * ->where('u.id = :user_id1 OR u.id = :user_id2') |
|
| 319 | + * ->setParameters(array( |
|
| 320 | + * 'user_id1' => 1, |
|
| 321 | + * 'user_id2' => 2 |
|
| 322 | + * )); |
|
| 323 | + * </code> |
|
| 324 | + * |
|
| 325 | + * @param list<mixed>|array<string, mixed> $params Parameters to set |
|
| 326 | + * @param array<int, int|string|Type|null>|array<string, int|string|Type|null> $types Parameter types |
|
| 327 | + * |
|
| 328 | + * @return $this This QueryBuilder instance. |
|
| 329 | + */ |
|
| 330 | + public function setParameters(array $params, array $types = []) |
|
| 331 | + { |
|
| 332 | + } |
|
| 333 | + |
|
| 334 | + /** |
|
| 335 | + * Gets all defined query parameters for the query being constructed indexed by parameter index or name. |
|
| 336 | + * |
|
| 337 | + * @return list<mixed>|array<string, mixed> The currently defined query parameters |
|
| 338 | + */ |
|
| 339 | + public function getParameters() |
|
| 340 | + { |
|
| 341 | + } |
|
| 342 | + |
|
| 343 | + /** |
|
| 344 | + * Gets a (previously set) query parameter of the query being constructed. |
|
| 345 | + * |
|
| 346 | + * @param mixed $key The key (index or name) of the bound parameter. |
|
| 347 | + * |
|
| 348 | + * @return mixed The value of the bound parameter. |
|
| 349 | + */ |
|
| 350 | + public function getParameter($key) |
|
| 351 | + { |
|
| 352 | + } |
|
| 353 | + |
|
| 354 | + /** |
|
| 355 | + * Gets all defined query parameter types for the query being constructed indexed by parameter index or name. |
|
| 356 | + * |
|
| 357 | + * @return array<int, int|string|Type|null>|array<string, int|string|Type|null> The currently defined |
|
| 358 | + * query parameter types |
|
| 359 | + */ |
|
| 360 | + public function getParameterTypes() |
|
| 361 | + { |
|
| 362 | + } |
|
| 363 | + |
|
| 364 | + /** |
|
| 365 | + * Gets a (previously set) query parameter type of the query being constructed. |
|
| 366 | + * |
|
| 367 | + * @param int|string $key The key of the bound parameter type |
|
| 368 | + * |
|
| 369 | + * @return int|string|Type The value of the bound parameter type |
|
| 370 | + */ |
|
| 371 | + public function getParameterType($key) |
|
| 372 | + { |
|
| 373 | + } |
|
| 374 | + |
|
| 375 | + /** |
|
| 376 | + * Sets the position of the first result to retrieve (the "offset"). |
|
| 377 | + * |
|
| 378 | + * @param int $firstResult The first result to return. |
|
| 379 | + * |
|
| 380 | + * @return $this This QueryBuilder instance. |
|
| 381 | + */ |
|
| 382 | + public function setFirstResult($firstResult) |
|
| 383 | + { |
|
| 384 | + } |
|
| 385 | + |
|
| 386 | + /** |
|
| 387 | + * Gets the position of the first result the query object was set to retrieve (the "offset"). |
|
| 388 | + * |
|
| 389 | + * @return int The position of the first result. |
|
| 390 | + */ |
|
| 391 | + public function getFirstResult() |
|
| 392 | + { |
|
| 393 | + } |
|
| 394 | + |
|
| 395 | + /** |
|
| 396 | + * Sets the maximum number of results to retrieve (the "limit"). |
|
| 397 | + * |
|
| 398 | + * @param int|null $maxResults The maximum number of results to retrieve or NULL to retrieve all results. |
|
| 399 | + * |
|
| 400 | + * @return $this This QueryBuilder instance. |
|
| 401 | + */ |
|
| 402 | + public function setMaxResults($maxResults) |
|
| 403 | + { |
|
| 404 | + } |
|
| 405 | + |
|
| 406 | + /** |
|
| 407 | + * Gets the maximum number of results the query object was set to retrieve (the "limit"). |
|
| 408 | + * Returns NULL if all results will be returned. |
|
| 409 | + * |
|
| 410 | + * @return int|null The maximum number of results. |
|
| 411 | + */ |
|
| 412 | + public function getMaxResults() |
|
| 413 | + { |
|
| 414 | + } |
|
| 415 | + |
|
| 416 | + /** |
|
| 417 | + * Locks the queried rows for a subsequent update. |
|
| 418 | + * |
|
| 419 | + * @return $this |
|
| 420 | + */ |
|
| 421 | + public function forUpdate(int $conflictResolutionMode = ConflictResolutionMode::ORDINARY): self |
|
| 422 | + { |
|
| 423 | + } |
|
| 424 | + |
|
| 425 | + /** |
|
| 426 | + * Either appends to or replaces a single, generic query part. |
|
| 427 | + * |
|
| 428 | + * The available parts are: 'select', 'from', 'set', 'where', |
|
| 429 | + * 'groupBy', 'having' and 'orderBy'. |
|
| 430 | + * |
|
| 431 | + * @param string $sqlPartName |
|
| 432 | + * @param mixed $sqlPart |
|
| 433 | + * @param bool $append |
|
| 434 | + * |
|
| 435 | + * @return $this This QueryBuilder instance. |
|
| 436 | + */ |
|
| 437 | + public function add($sqlPartName, $sqlPart, $append = false) |
|
| 438 | + { |
|
| 439 | + } |
|
| 440 | + |
|
| 441 | + /** |
|
| 442 | + * Specifies an item that is to be returned in the query result. |
|
| 443 | + * Replaces any previously specified selections, if any. |
|
| 444 | + * |
|
| 445 | + * USING AN ARRAY ARGUMENT IS DEPRECATED. Pass each value as an individual argument. |
|
| 446 | + * |
|
| 447 | + * <code> |
|
| 448 | + * $qb = $conn->createQueryBuilder() |
|
| 449 | + * ->select('u.id', 'p.id') |
|
| 450 | + * ->from('users', 'u') |
|
| 451 | + * ->leftJoin('u', 'phonenumbers', 'p', 'u.id = p.user_id'); |
|
| 452 | + * </code> |
|
| 453 | + * |
|
| 454 | + * @param string|string[]|null $select The selection expression. USING AN ARRAY OR NULL IS DEPRECATED. |
|
| 455 | + * Pass each value as an individual argument. |
|
| 456 | + * |
|
| 457 | + * @return $this This QueryBuilder instance. |
|
| 458 | + */ |
|
| 459 | + public function select($select = null) |
|
| 460 | + { |
|
| 461 | + } |
|
| 462 | + |
|
| 463 | + /** |
|
| 464 | + * Adds or removes DISTINCT to/from the query. |
|
| 465 | + * |
|
| 466 | + * <code> |
|
| 467 | + * $qb = $conn->createQueryBuilder() |
|
| 468 | + * ->select('u.id') |
|
| 469 | + * ->distinct() |
|
| 470 | + * ->from('users', 'u') |
|
| 471 | + * </code> |
|
| 472 | + * |
|
| 473 | + * @return $this This QueryBuilder instance. |
|
| 474 | + */ |
|
| 475 | + public function distinct(): self |
|
| 476 | + { |
|
| 477 | + } |
|
| 478 | + |
|
| 479 | + /** |
|
| 480 | + * Adds an item that is to be returned in the query result. |
|
| 481 | + * |
|
| 482 | + * USING AN ARRAY ARGUMENT IS DEPRECATED. Pass each value as an individual argument. |
|
| 483 | + * |
|
| 484 | + * <code> |
|
| 485 | + * $qb = $conn->createQueryBuilder() |
|
| 486 | + * ->select('u.id') |
|
| 487 | + * ->addSelect('p.id') |
|
| 488 | + * ->from('users', 'u') |
|
| 489 | + * ->leftJoin('u', 'phonenumbers', 'u.id = p.user_id'); |
|
| 490 | + * </code> |
|
| 491 | + * |
|
| 492 | + * @param string|string[]|null $select The selection expression. USING AN ARRAY OR NULL IS DEPRECATED. |
|
| 493 | + * Pass each value as an individual argument. |
|
| 494 | + * |
|
| 495 | + * @return $this This QueryBuilder instance. |
|
| 496 | + */ |
|
| 497 | + public function addSelect($select = null) |
|
| 498 | + { |
|
| 499 | + } |
|
| 500 | + |
|
| 501 | + /** |
|
| 502 | + * Turns the query being built into a bulk delete query that ranges over |
|
| 503 | + * a certain table. |
|
| 504 | + * |
|
| 505 | + * <code> |
|
| 506 | + * $qb = $conn->createQueryBuilder() |
|
| 507 | + * ->delete('users', 'u') |
|
| 508 | + * ->where('u.id = :user_id') |
|
| 509 | + * ->setParameter(':user_id', 1); |
|
| 510 | + * </code> |
|
| 511 | + * |
|
| 512 | + * @param string $delete The table whose rows are subject to the deletion. |
|
| 513 | + * @param string $alias The table alias used in the constructed query. |
|
| 514 | + * |
|
| 515 | + * @return $this This QueryBuilder instance. |
|
| 516 | + */ |
|
| 517 | + public function delete($delete = null, $alias = null) |
|
| 518 | + { |
|
| 519 | + } |
|
| 520 | + |
|
| 521 | + /** |
|
| 522 | + * Turns the query being built into a bulk update query that ranges over |
|
| 523 | + * a certain table |
|
| 524 | + * |
|
| 525 | + * <code> |
|
| 526 | + * $qb = $conn->createQueryBuilder() |
|
| 527 | + * ->update('counters', 'c') |
|
| 528 | + * ->set('c.value', 'c.value + 1') |
|
| 529 | + * ->where('c.id = ?'); |
|
| 530 | + * </code> |
|
| 531 | + * |
|
| 532 | + * @param string $update The table whose rows are subject to the update. |
|
| 533 | + * @param string $alias The table alias used in the constructed query. |
|
| 534 | + * |
|
| 535 | + * @return $this This QueryBuilder instance. |
|
| 536 | + */ |
|
| 537 | + public function update($update = null, $alias = null) |
|
| 538 | + { |
|
| 539 | + } |
|
| 540 | + |
|
| 541 | + /** |
|
| 542 | + * Turns the query being built into an insert query that inserts into |
|
| 543 | + * a certain table |
|
| 544 | + * |
|
| 545 | + * <code> |
|
| 546 | + * $qb = $conn->createQueryBuilder() |
|
| 547 | + * ->insert('users') |
|
| 548 | + * ->values( |
|
| 549 | + * array( |
|
| 550 | + * 'name' => '?', |
|
| 551 | + * 'password' => '?' |
|
| 552 | + * ) |
|
| 553 | + * ); |
|
| 554 | + * </code> |
|
| 555 | + * |
|
| 556 | + * @param string $insert The table into which the rows should be inserted. |
|
| 557 | + * |
|
| 558 | + * @return $this This QueryBuilder instance. |
|
| 559 | + */ |
|
| 560 | + public function insert($insert = null) |
|
| 561 | + { |
|
| 562 | + } |
|
| 563 | + |
|
| 564 | + /** |
|
| 565 | + * Creates and adds a query root corresponding to the table identified by the |
|
| 566 | + * given alias, forming a cartesian product with any existing query roots. |
|
| 567 | + * |
|
| 568 | + * <code> |
|
| 569 | + * $qb = $conn->createQueryBuilder() |
|
| 570 | + * ->select('u.id') |
|
| 571 | + * ->from('users', 'u') |
|
| 572 | + * </code> |
|
| 573 | + * |
|
| 574 | + * @param string $from The table. |
|
| 575 | + * @param string|null $alias The alias of the table. |
|
| 576 | + * |
|
| 577 | + * @return $this This QueryBuilder instance. |
|
| 578 | + */ |
|
| 579 | + public function from($from, $alias = null) |
|
| 580 | + { |
|
| 581 | + } |
|
| 582 | + |
|
| 583 | + /** |
|
| 584 | + * Creates and adds a join to the query. |
|
| 585 | + * |
|
| 586 | + * <code> |
|
| 587 | + * $qb = $conn->createQueryBuilder() |
|
| 588 | + * ->select('u.name') |
|
| 589 | + * ->from('users', 'u') |
|
| 590 | + * ->join('u', 'phonenumbers', 'p', 'p.is_primary = 1'); |
|
| 591 | + * </code> |
|
| 592 | + * |
|
| 593 | + * @param string $fromAlias The alias that points to a from clause. |
|
| 594 | + * @param string $join The table name to join. |
|
| 595 | + * @param string $alias The alias of the join table. |
|
| 596 | + * @param string $condition The condition for the join. |
|
| 597 | + * |
|
| 598 | + * @return $this This QueryBuilder instance. |
|
| 599 | + */ |
|
| 600 | + public function join($fromAlias, $join, $alias, $condition = null) |
|
| 601 | + { |
|
| 602 | + } |
|
| 603 | + |
|
| 604 | + /** |
|
| 605 | + * Creates and adds a join to the query. |
|
| 606 | + * |
|
| 607 | + * <code> |
|
| 608 | + * $qb = $conn->createQueryBuilder() |
|
| 609 | + * ->select('u.name') |
|
| 610 | + * ->from('users', 'u') |
|
| 611 | + * ->innerJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1'); |
|
| 612 | + * </code> |
|
| 613 | + * |
|
| 614 | + * @param string $fromAlias The alias that points to a from clause. |
|
| 615 | + * @param string $join The table name to join. |
|
| 616 | + * @param string $alias The alias of the join table. |
|
| 617 | + * @param string $condition The condition for the join. |
|
| 618 | + * |
|
| 619 | + * @return $this This QueryBuilder instance. |
|
| 620 | + */ |
|
| 621 | + public function innerJoin($fromAlias, $join, $alias, $condition = null) |
|
| 622 | + { |
|
| 623 | + } |
|
| 624 | + |
|
| 625 | + /** |
|
| 626 | + * Creates and adds a left join to the query. |
|
| 627 | + * |
|
| 628 | + * <code> |
|
| 629 | + * $qb = $conn->createQueryBuilder() |
|
| 630 | + * ->select('u.name') |
|
| 631 | + * ->from('users', 'u') |
|
| 632 | + * ->leftJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1'); |
|
| 633 | + * </code> |
|
| 634 | + * |
|
| 635 | + * @param string $fromAlias The alias that points to a from clause. |
|
| 636 | + * @param string $join The table name to join. |
|
| 637 | + * @param string $alias The alias of the join table. |
|
| 638 | + * @param string $condition The condition for the join. |
|
| 639 | + * |
|
| 640 | + * @return $this This QueryBuilder instance. |
|
| 641 | + */ |
|
| 642 | + public function leftJoin($fromAlias, $join, $alias, $condition = null) |
|
| 643 | + { |
|
| 644 | + } |
|
| 645 | + |
|
| 646 | + /** |
|
| 647 | + * Creates and adds a right join to the query. |
|
| 648 | + * |
|
| 649 | + * <code> |
|
| 650 | + * $qb = $conn->createQueryBuilder() |
|
| 651 | + * ->select('u.name') |
|
| 652 | + * ->from('users', 'u') |
|
| 653 | + * ->rightJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1'); |
|
| 654 | + * </code> |
|
| 655 | + * |
|
| 656 | + * @param string $fromAlias The alias that points to a from clause. |
|
| 657 | + * @param string $join The table name to join. |
|
| 658 | + * @param string $alias The alias of the join table. |
|
| 659 | + * @param string $condition The condition for the join. |
|
| 660 | + * |
|
| 661 | + * @return $this This QueryBuilder instance. |
|
| 662 | + */ |
|
| 663 | + public function rightJoin($fromAlias, $join, $alias, $condition = null) |
|
| 664 | + { |
|
| 665 | + } |
|
| 666 | + |
|
| 667 | + /** |
|
| 668 | + * Sets a new value for a column in a bulk update query. |
|
| 669 | + * |
|
| 670 | + * <code> |
|
| 671 | + * $qb = $conn->createQueryBuilder() |
|
| 672 | + * ->update('counters', 'c') |
|
| 673 | + * ->set('c.value', 'c.value + 1') |
|
| 674 | + * ->where('c.id = ?'); |
|
| 675 | + * </code> |
|
| 676 | + * |
|
| 677 | + * @param string $key The column to set. |
|
| 678 | + * @param string $value The value, expression, placeholder, etc. |
|
| 679 | + * |
|
| 680 | + * @return $this This QueryBuilder instance. |
|
| 681 | + */ |
|
| 682 | + public function set($key, $value) |
|
| 683 | + { |
|
| 684 | + } |
|
| 685 | + |
|
| 686 | + /** |
|
| 687 | + * Specifies one or more restrictions to the query result. |
|
| 688 | + * Replaces any previously specified restrictions, if any. |
|
| 689 | + * |
|
| 690 | + * <code> |
|
| 691 | + * $qb = $conn->createQueryBuilder() |
|
| 692 | + * ->select('c.value') |
|
| 693 | + * ->from('counters', 'c') |
|
| 694 | + * ->where('c.id = ?'); |
|
| 695 | + * |
|
| 696 | + * // You can optionally programmatically build and/or expressions |
|
| 697 | + * $qb = $conn->createQueryBuilder(); |
|
| 698 | + * |
|
| 699 | + * $or = $qb->expr()->orx(); |
|
| 700 | + * $or->add($qb->expr()->eq('c.id', 1)); |
|
| 701 | + * $or->add($qb->expr()->eq('c.id', 2)); |
|
| 702 | + * |
|
| 703 | + * $qb->update('counters', 'c') |
|
| 704 | + * ->set('c.value', 'c.value + 1') |
|
| 705 | + * ->where($or); |
|
| 706 | + * </code> |
|
| 707 | + * |
|
| 708 | + * @param mixed $predicates The restriction predicates. |
|
| 709 | + * |
|
| 710 | + * @return $this This QueryBuilder instance. |
|
| 711 | + */ |
|
| 712 | + public function where($predicates) |
|
| 713 | + { |
|
| 714 | + } |
|
| 715 | + |
|
| 716 | + /** |
|
| 717 | + * Adds one or more restrictions to the query results, forming a logical |
|
| 718 | + * conjunction with any previously specified restrictions. |
|
| 719 | + * |
|
| 720 | + * <code> |
|
| 721 | + * $qb = $conn->createQueryBuilder() |
|
| 722 | + * ->select('u') |
|
| 723 | + * ->from('users', 'u') |
|
| 724 | + * ->where('u.username LIKE ?') |
|
| 725 | + * ->andWhere('u.is_active = 1'); |
|
| 726 | + * </code> |
|
| 727 | + * |
|
| 728 | + * @see where() |
|
| 729 | + * |
|
| 730 | + * @param mixed $where The query restrictions. |
|
| 731 | + * |
|
| 732 | + * @return $this This QueryBuilder instance. |
|
| 733 | + */ |
|
| 734 | + public function andWhere($where) |
|
| 735 | + { |
|
| 736 | + } |
|
| 737 | + |
|
| 738 | + /** |
|
| 739 | + * Adds one or more restrictions to the query results, forming a logical |
|
| 740 | + * disjunction with any previously specified restrictions. |
|
| 741 | + * |
|
| 742 | + * <code> |
|
| 743 | + * $qb = $em->createQueryBuilder() |
|
| 744 | + * ->select('u.name') |
|
| 745 | + * ->from('users', 'u') |
|
| 746 | + * ->where('u.id = 1') |
|
| 747 | + * ->orWhere('u.id = 2'); |
|
| 748 | + * </code> |
|
| 749 | + * |
|
| 750 | + * @see where() |
|
| 751 | + * |
|
| 752 | + * @param mixed $where The WHERE statement. |
|
| 753 | + * |
|
| 754 | + * @return $this This QueryBuilder instance. |
|
| 755 | + */ |
|
| 756 | + public function orWhere($where) |
|
| 757 | + { |
|
| 758 | + } |
|
| 759 | + |
|
| 760 | + /** |
|
| 761 | + * Specifies a grouping over the results of the query. |
|
| 762 | + * Replaces any previously specified groupings, if any. |
|
| 763 | + * |
|
| 764 | + * USING AN ARRAY ARGUMENT IS DEPRECATED. Pass each value as an individual argument. |
|
| 765 | + * |
|
| 766 | + * <code> |
|
| 767 | + * $qb = $conn->createQueryBuilder() |
|
| 768 | + * ->select('u.name') |
|
| 769 | + * ->from('users', 'u') |
|
| 770 | + * ->groupBy('u.id'); |
|
| 771 | + * </code> |
|
| 772 | + * |
|
| 773 | + * @param string|string[] $groupBy The grouping expression. USING AN ARRAY IS DEPRECATED. |
|
| 774 | + * Pass each value as an individual argument. |
|
| 775 | + * |
|
| 776 | + * @return $this This QueryBuilder instance. |
|
| 777 | + */ |
|
| 778 | + public function groupBy($groupBy) |
|
| 779 | + { |
|
| 780 | + } |
|
| 781 | + |
|
| 782 | + /** |
|
| 783 | + * Adds a grouping expression to the query. |
|
| 784 | + * |
|
| 785 | + * USING AN ARRAY ARGUMENT IS DEPRECATED. Pass each value as an individual argument. |
|
| 786 | + * |
|
| 787 | + * <code> |
|
| 788 | + * $qb = $conn->createQueryBuilder() |
|
| 789 | + * ->select('u.name') |
|
| 790 | + * ->from('users', 'u') |
|
| 791 | + * ->groupBy('u.lastLogin') |
|
| 792 | + * ->addGroupBy('u.createdAt'); |
|
| 793 | + * </code> |
|
| 794 | + * |
|
| 795 | + * @param string|string[] $groupBy The grouping expression. USING AN ARRAY IS DEPRECATED. |
|
| 796 | + * Pass each value as an individual argument. |
|
| 797 | + * |
|
| 798 | + * @return $this This QueryBuilder instance. |
|
| 799 | + */ |
|
| 800 | + public function addGroupBy($groupBy) |
|
| 801 | + { |
|
| 802 | + } |
|
| 803 | + |
|
| 804 | + /** |
|
| 805 | + * Sets a value for a column in an insert query. |
|
| 806 | + * |
|
| 807 | + * <code> |
|
| 808 | + * $qb = $conn->createQueryBuilder() |
|
| 809 | + * ->insert('users') |
|
| 810 | + * ->values( |
|
| 811 | + * array( |
|
| 812 | + * 'name' => '?' |
|
| 813 | + * ) |
|
| 814 | + * ) |
|
| 815 | + * ->setValue('password', '?'); |
|
| 816 | + * </code> |
|
| 817 | + * |
|
| 818 | + * @param string $column The column into which the value should be inserted. |
|
| 819 | + * @param string $value The value that should be inserted into the column. |
|
| 820 | + * |
|
| 821 | + * @return $this This QueryBuilder instance. |
|
| 822 | + */ |
|
| 823 | + public function setValue($column, $value) |
|
| 824 | + { |
|
| 825 | + } |
|
| 826 | + |
|
| 827 | + /** |
|
| 828 | + * Specifies values for an insert query indexed by column names. |
|
| 829 | + * Replaces any previous values, if any. |
|
| 830 | + * |
|
| 831 | + * <code> |
|
| 832 | + * $qb = $conn->createQueryBuilder() |
|
| 833 | + * ->insert('users') |
|
| 834 | + * ->values( |
|
| 835 | + * array( |
|
| 836 | + * 'name' => '?', |
|
| 837 | + * 'password' => '?' |
|
| 838 | + * ) |
|
| 839 | + * ); |
|
| 840 | + * </code> |
|
| 841 | + * |
|
| 842 | + * @param mixed[] $values The values to specify for the insert query indexed by column names. |
|
| 843 | + * |
|
| 844 | + * @return $this This QueryBuilder instance. |
|
| 845 | + */ |
|
| 846 | + public function values(array $values) |
|
| 847 | + { |
|
| 848 | + } |
|
| 849 | + |
|
| 850 | + /** |
|
| 851 | + * Specifies a restriction over the groups of the query. |
|
| 852 | + * Replaces any previous having restrictions, if any. |
|
| 853 | + * |
|
| 854 | + * @param mixed $having The restriction over the groups. |
|
| 855 | + * |
|
| 856 | + * @return $this This QueryBuilder instance. |
|
| 857 | + */ |
|
| 858 | + public function having($having) |
|
| 859 | + { |
|
| 860 | + } |
|
| 861 | + |
|
| 862 | + /** |
|
| 863 | + * Adds a restriction over the groups of the query, forming a logical |
|
| 864 | + * conjunction with any existing having restrictions. |
|
| 865 | + * |
|
| 866 | + * @param mixed $having The restriction to append. |
|
| 867 | + * |
|
| 868 | + * @return $this This QueryBuilder instance. |
|
| 869 | + */ |
|
| 870 | + public function andHaving($having) |
|
| 871 | + { |
|
| 872 | + } |
|
| 873 | + |
|
| 874 | + /** |
|
| 875 | + * Adds a restriction over the groups of the query, forming a logical |
|
| 876 | + * disjunction with any existing having restrictions. |
|
| 877 | + * |
|
| 878 | + * @param mixed $having The restriction to add. |
|
| 879 | + * |
|
| 880 | + * @return $this This QueryBuilder instance. |
|
| 881 | + */ |
|
| 882 | + public function orHaving($having) |
|
| 883 | + { |
|
| 884 | + } |
|
| 885 | + |
|
| 886 | + /** |
|
| 887 | + * Specifies an ordering for the query results. |
|
| 888 | + * Replaces any previously specified orderings, if any. |
|
| 889 | + * |
|
| 890 | + * @param string $sort The ordering expression. |
|
| 891 | + * @param string $order The ordering direction. |
|
| 892 | + * |
|
| 893 | + * @return $this This QueryBuilder instance. |
|
| 894 | + */ |
|
| 895 | + public function orderBy($sort, $order = null) |
|
| 896 | + { |
|
| 897 | + } |
|
| 898 | + |
|
| 899 | + /** |
|
| 900 | + * Adds an ordering to the query results. |
|
| 901 | + * |
|
| 902 | + * @param string $sort The ordering expression. |
|
| 903 | + * @param string $order The ordering direction. |
|
| 904 | + * |
|
| 905 | + * @return $this This QueryBuilder instance. |
|
| 906 | + */ |
|
| 907 | + public function addOrderBy($sort, $order = null) |
|
| 908 | + { |
|
| 909 | + } |
|
| 910 | + |
|
| 911 | + /** |
|
| 912 | + * Gets a query part by its name. |
|
| 913 | + * |
|
| 914 | + * @deprecated The query parts are implementation details and should not be relied upon. |
|
| 915 | + * |
|
| 916 | + * @param string $queryPartName |
|
| 917 | + * |
|
| 918 | + * @return mixed |
|
| 919 | + */ |
|
| 920 | + public function getQueryPart($queryPartName) |
|
| 921 | + { |
|
| 922 | + } |
|
| 923 | + |
|
| 924 | + /** |
|
| 925 | + * Gets all query parts. |
|
| 926 | + * |
|
| 927 | + * @deprecated The query parts are implementation details and should not be relied upon. |
|
| 928 | + * |
|
| 929 | + * @return mixed[] |
|
| 930 | + */ |
|
| 931 | + public function getQueryParts() |
|
| 932 | + { |
|
| 933 | + } |
|
| 934 | + |
|
| 935 | + /** |
|
| 936 | + * Resets SQL parts. |
|
| 937 | + * |
|
| 938 | + * @deprecated Use the dedicated reset*() methods instead. |
|
| 939 | + * |
|
| 940 | + * @param string[]|null $queryPartNames |
|
| 941 | + * |
|
| 942 | + * @return $this This QueryBuilder instance. |
|
| 943 | + */ |
|
| 944 | + public function resetQueryParts($queryPartNames = null) |
|
| 945 | + { |
|
| 946 | + } |
|
| 947 | + |
|
| 948 | + /** |
|
| 949 | + * Resets a single SQL part. |
|
| 950 | + * |
|
| 951 | + * @deprecated Use the dedicated reset*() methods instead. |
|
| 952 | + * |
|
| 953 | + * @param string $queryPartName |
|
| 954 | + * |
|
| 955 | + * @return $this This QueryBuilder instance. |
|
| 956 | + */ |
|
| 957 | + public function resetQueryPart($queryPartName) |
|
| 958 | + { |
|
| 959 | + } |
|
| 960 | + |
|
| 961 | + /** |
|
| 962 | + * Resets the WHERE conditions for the query. |
|
| 963 | + * |
|
| 964 | + * @return $this This QueryBuilder instance. |
|
| 965 | + */ |
|
| 966 | + public function resetWhere(): self |
|
| 967 | + { |
|
| 968 | + } |
|
| 969 | + |
|
| 970 | + /** |
|
| 971 | + * Resets the grouping for the query. |
|
| 972 | + * |
|
| 973 | + * @return $this This QueryBuilder instance. |
|
| 974 | + */ |
|
| 975 | + public function resetGroupBy(): self |
|
| 976 | + { |
|
| 977 | + } |
|
| 978 | + |
|
| 979 | + /** |
|
| 980 | + * Resets the HAVING conditions for the query. |
|
| 981 | + * |
|
| 982 | + * @return $this This QueryBuilder instance. |
|
| 983 | + */ |
|
| 984 | + public function resetHaving(): self |
|
| 985 | + { |
|
| 986 | + } |
|
| 987 | + |
|
| 988 | + /** |
|
| 989 | + * Resets the ordering for the query. |
|
| 990 | + * |
|
| 991 | + * @return $this This QueryBuilder instance. |
|
| 992 | + */ |
|
| 993 | + public function resetOrderBy(): self |
|
| 994 | + { |
|
| 995 | + } |
|
| 996 | + |
|
| 997 | + /** |
|
| 998 | + * Gets a string representation of this QueryBuilder which corresponds to |
|
| 999 | + * the final SQL query being constructed. |
|
| 1000 | + * |
|
| 1001 | + * @return string The string representation of this QueryBuilder. |
|
| 1002 | + */ |
|
| 1003 | + public function __toString() |
|
| 1004 | + { |
|
| 1005 | + } |
|
| 1006 | + |
|
| 1007 | + /** |
|
| 1008 | + * Creates a new named parameter and bind the value $value to it. |
|
| 1009 | + * |
|
| 1010 | + * This method provides a shortcut for {@see Statement::bindValue()} |
|
| 1011 | + * when using prepared statements. |
|
| 1012 | + * |
|
| 1013 | + * The parameter $value specifies the value that you want to bind. If |
|
| 1014 | + * $placeholder is not provided createNamedParameter() will automatically |
|
| 1015 | + * create a placeholder for you. An automatic placeholder will be of the |
|
| 1016 | + * name ':dcValue1', ':dcValue2' etc. |
|
| 1017 | + * |
|
| 1018 | + * Example: |
|
| 1019 | + * <code> |
|
| 1020 | + * $value = 2; |
|
| 1021 | + * $q->eq( 'id', $q->createNamedParameter( $value ) ); |
|
| 1022 | + * $stmt = $q->executeQuery(); // executed with 'id = 2' |
|
| 1023 | + * </code> |
|
| 1024 | + * |
|
| 1025 | + * @link http://www.zetacomponents.org |
|
| 1026 | + * |
|
| 1027 | + * @param mixed $value |
|
| 1028 | + * @param int|string|Type|null $type |
|
| 1029 | + * @param string $placeHolder The name to bind with. The string must start with a colon ':'. |
|
| 1030 | + * |
|
| 1031 | + * @return string the placeholder name used. |
|
| 1032 | + */ |
|
| 1033 | + public function createNamedParameter($value, $type = ParameterType::STRING, $placeHolder = null) |
|
| 1034 | + { |
|
| 1035 | + } |
|
| 1036 | + |
|
| 1037 | + /** |
|
| 1038 | + * Creates a new positional parameter and bind the given value to it. |
|
| 1039 | + * |
|
| 1040 | + * Attention: If you are using positional parameters with the query builder you have |
|
| 1041 | + * to be very careful to bind all parameters in the order they appear in the SQL |
|
| 1042 | + * statement , otherwise they get bound in the wrong order which can lead to serious |
|
| 1043 | + * bugs in your code. |
|
| 1044 | + * |
|
| 1045 | + * Example: |
|
| 1046 | + * <code> |
|
| 1047 | + * $qb = $conn->createQueryBuilder(); |
|
| 1048 | + * $qb->select('u.*') |
|
| 1049 | + * ->from('users', 'u') |
|
| 1050 | + * ->where('u.username = ' . $qb->createPositionalParameter('Foo', ParameterType::STRING)) |
|
| 1051 | + * ->orWhere('u.username = ' . $qb->createPositionalParameter('Bar', ParameterType::STRING)) |
|
| 1052 | + * </code> |
|
| 1053 | + * |
|
| 1054 | + * @param mixed $value |
|
| 1055 | + * @param int|string|Type|null $type |
|
| 1056 | + * |
|
| 1057 | + * @return string |
|
| 1058 | + */ |
|
| 1059 | + public function createPositionalParameter($value, $type = ParameterType::STRING) |
|
| 1060 | + { |
|
| 1061 | + } |
|
| 1062 | + |
|
| 1063 | + /** |
|
| 1064 | + * Deep clone of all expression objects in the SQL parts. |
|
| 1065 | + * |
|
| 1066 | + * @return void |
|
| 1067 | + */ |
|
| 1068 | + public function __clone() |
|
| 1069 | + { |
|
| 1070 | + } |
|
| 1071 | + |
|
| 1072 | + /** |
|
| 1073 | + * Enables caching of the results of this query, for given amount of seconds |
|
| 1074 | + * and optionally specified which key to use for the cache entry. |
|
| 1075 | + * |
|
| 1076 | + * @return $this |
|
| 1077 | + */ |
|
| 1078 | + public function enableResultCache(QueryCacheProfile $cacheProfile): self |
|
| 1079 | + { |
|
| 1080 | + } |
|
| 1081 | + |
|
| 1082 | + /** |
|
| 1083 | + * Disables caching of the results of this query. |
|
| 1084 | + * |
|
| 1085 | + * @return $this |
|
| 1086 | + */ |
|
| 1087 | + public function disableResultCache(): self |
|
| 1088 | + { |
|
| 1089 | + } |
|
| 1090 | 1090 | } |
@@ -158,7 +158,7 @@ |
||
| 158 | 158 | } catch (FederatedItemException $e) { |
| 159 | 159 | if ($input->getOption('status-code')) { |
| 160 | 160 | throw new FederatedItemException( |
| 161 | - ' [' . get_class($e) . ', ' . ((string)$e->getStatus()) . ']' . "\n" . $e->getMessage() |
|
| 161 | + ' ['.get_class($e).', '.((string)$e->getStatus()).']'."\n".$e->getMessage() |
|
| 162 | 162 | ); |
| 163 | 163 | } |
| 164 | 164 | |
@@ -154,19 +154,19 @@ discard block |
||
| 154 | 154 | |
| 155 | 155 | $webfinger = $this->getWebfinger($host, Application::APP_SUBJECT); |
| 156 | 156 | if ($this->input->getOption('all')) { |
| 157 | - $this->output->writeln('- Webfinger on <info>' . $host . '</info>'); |
|
| 157 | + $this->output->writeln('- Webfinger on <info>'.$host.'</info>'); |
|
| 158 | 158 | $this->output->writeln(json_encode($webfinger, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES)); |
| 159 | 159 | $this->output->writeln(''); |
| 160 | 160 | } |
| 161 | 161 | |
| 162 | 162 | if ($this->input->getOption('all')) { |
| 163 | 163 | $circleLink = $this->extractLink(Application::APP_REL, $webfinger); |
| 164 | - $this->output->writeln('- Information about Circles app on <info>' . $host . '</info>'); |
|
| 164 | + $this->output->writeln('- Information about Circles app on <info>'.$host.'</info>'); |
|
| 165 | 165 | $this->output->writeln(json_encode($circleLink, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES)); |
| 166 | 166 | $this->output->writeln(''); |
| 167 | 167 | } |
| 168 | 168 | |
| 169 | - $this->output->writeln('- Available services on <info>' . $host . '</info>'); |
|
| 169 | + $this->output->writeln('- Available services on <info>'.$host.'</info>'); |
|
| 170 | 170 | foreach ($webfinger->getLinks() as $link) { |
| 171 | 171 | $app = $link->getProperty('name'); |
| 172 | 172 | $ver = $link->getProperty('version'); |
@@ -174,14 +174,14 @@ discard block |
||
| 174 | 174 | $app .= ' '; |
| 175 | 175 | } |
| 176 | 176 | if ($ver !== '') { |
| 177 | - $ver = 'v' . $ver; |
|
| 177 | + $ver = 'v'.$ver; |
|
| 178 | 178 | } |
| 179 | 179 | |
| 180 | - $this->output->writeln(' * ' . $link->getRel() . ' ' . $app . $ver); |
|
| 180 | + $this->output->writeln(' * '.$link->getRel().' '.$app.$ver); |
|
| 181 | 181 | } |
| 182 | 182 | $this->output->writeln(''); |
| 183 | 183 | |
| 184 | - $this->output->writeln('- Resources related to Circles on <info>' . $host . '</info>'); |
|
| 184 | + $this->output->writeln('- Resources related to Circles on <info>'.$host.'</info>'); |
|
| 185 | 185 | $resource = $this->getResourceData($host, Application::APP_SUBJECT, Application::APP_REL); |
| 186 | 186 | $this->output->writeln(json_encode($resource, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES)); |
| 187 | 187 | $this->output->writeln(''); |
@@ -189,7 +189,7 @@ discard block |
||
| 189 | 189 | |
| 190 | 190 | $tempUid = $resource->g('uid'); |
| 191 | 191 | $this->output->writeln( |
| 192 | - '- Confirming UID=' . $tempUid . ' from parsed Signatory at <info>' . $host . '</info>' |
|
| 192 | + '- Confirming UID='.$tempUid.' from parsed Signatory at <info>'.$host.'</info>' |
|
| 193 | 193 | ); |
| 194 | 194 | |
| 195 | 195 | try { |
@@ -198,15 +198,15 @@ discard block |
||
| 198 | 198 | $this->output->writeln(' * No SignatureException: <info>Identity authed</info>'); |
| 199 | 199 | } catch (SignatureException $e) { |
| 200 | 200 | $this->output->writeln( |
| 201 | - '<error>' . $host . ' cannot auth its identity: ' . $e->getMessage() . '</error>' |
|
| 201 | + '<error>'.$host.' cannot auth its identity: '.$e->getMessage().'</error>' |
|
| 202 | 202 | ); |
| 203 | 203 | |
| 204 | 204 | return; |
| 205 | 205 | } |
| 206 | 206 | |
| 207 | - $this->output->writeln(' * Found <info>' . $remoteSignatory->getUid() . '</info>'); |
|
| 207 | + $this->output->writeln(' * Found <info>'.$remoteSignatory->getUid().'</info>'); |
|
| 208 | 208 | if ($remoteSignatory->getUid(true) !== $tempUid) { |
| 209 | - $this->output->writeln('<error>looks like ' . $host . ' is faking its identity'); |
|
| 209 | + $this->output->writeln('<error>looks like '.$host.' is faking its identity'); |
|
| 210 | 210 | |
| 211 | 211 | return; |
| 212 | 212 | } |
@@ -214,7 +214,7 @@ discard block |
||
| 214 | 214 | $this->output->writeln(''); |
| 215 | 215 | |
| 216 | 216 | $testUrl = $resource->g('test'); |
| 217 | - $this->output->writeln('- Testing signed payload on <info>' . $testUrl . '</info>'); |
|
| 217 | + $this->output->writeln('- Testing signed payload on <info>'.$testUrl.'</info>'); |
|
| 218 | 218 | |
| 219 | 219 | try { |
| 220 | 220 | $localSignatory = $this->remoteStreamService->getAppSignatory(); |
@@ -236,18 +236,18 @@ discard block |
||
| 236 | 236 | $this->output->writeln(''); |
| 237 | 237 | |
| 238 | 238 | $this->output->writeln(' * Clear Signature: '); |
| 239 | - $this->output->writeln('<comment>' . $signedRequest->getClearSignature() . '</comment>'); |
|
| 239 | + $this->output->writeln('<comment>'.$signedRequest->getClearSignature().'</comment>'); |
|
| 240 | 240 | $this->output->writeln(''); |
| 241 | 241 | |
| 242 | 242 | $this->output->writeln(' * Signed Signature (base64 encoded): '); |
| 243 | 243 | $this->output->writeln( |
| 244 | - '<comment>' . base64_encode($signedRequest->getSignedSignature()) . '</comment>' |
|
| 244 | + '<comment>'.base64_encode($signedRequest->getSignedSignature()).'</comment>' |
|
| 245 | 245 | ); |
| 246 | 246 | $this->output->writeln(''); |
| 247 | 247 | |
| 248 | 248 | $result = $signedRequest->getOutgoingRequest()->getResult(); |
| 249 | 249 | $code = $result->getStatusCode(); |
| 250 | - $this->output->writeln(' * Result: ' . (($code === 200) ? '<info>' . ((string)$code) . '</info>' : $code)); |
|
| 250 | + $this->output->writeln(' * Result: '.(($code === 200) ? '<info>'.((string)$code).'</info>' : $code)); |
|
| 251 | 251 | $this->output->writeln( |
| 252 | 252 | json_encode(json_decode($result->getContent(), true), JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES) |
| 253 | 253 | ); |
@@ -269,7 +269,7 @@ discard block |
||
| 269 | 269 | $stored = new RemoteInstance(); |
| 270 | 270 | $this->remoteStreamService->confirmValidRemote($remoteSignatory, $stored); |
| 271 | 271 | $this->output->writeln( |
| 272 | - '<info>The remote instance ' . $host |
|
| 272 | + '<info>The remote instance '.$host |
|
| 273 | 273 | . ' is already known with this current identity</info>' |
| 274 | 274 | ); |
| 275 | 275 | |
@@ -279,7 +279,7 @@ discard block |
||
| 279 | 279 | |
| 280 | 280 | if ($remoteSignatory->getType() !== $stored->getType()) { |
| 281 | 281 | $this->output->writeln( |
| 282 | - '- updating type from ' . $stored->getType() . ' to ' |
|
| 282 | + '- updating type from '.$stored->getType().' to ' |
|
| 283 | 283 | . $remoteSignatory->getType() |
| 284 | 284 | ); |
| 285 | 285 | $this->remoteStreamService->update( |
@@ -289,7 +289,7 @@ discard block |
||
| 289 | 289 | |
| 290 | 290 | if ($remoteSignatory->getInstance() !== $stored->getInstance()) { |
| 291 | 291 | $this->output->writeln( |
| 292 | - '- updating host from ' . $stored->getInstance() . ' to ' |
|
| 292 | + '- updating host from '.$stored->getInstance().' to ' |
|
| 293 | 293 | . $remoteSignatory->getInstance() |
| 294 | 294 | ); |
| 295 | 295 | $this->remoteStreamService->update( |
@@ -298,7 +298,7 @@ discard block |
||
| 298 | 298 | } |
| 299 | 299 | if ($remoteSignatory->getId() !== $stored->getId()) { |
| 300 | 300 | $this->output->writeln( |
| 301 | - '- updating href/Id from ' . $stored->getId() . ' to ' |
|
| 301 | + '- updating href/Id from '.$stored->getId().' to ' |
|
| 302 | 302 | . $remoteSignatory->getId() |
| 303 | 303 | ); |
| 304 | 304 | $this->remoteStreamService->update($remoteSignatory, RemoteStreamService::UPDATE_HREF); |
@@ -323,10 +323,10 @@ discard block |
||
| 323 | 323 | $helper = $this->getHelper('question'); |
| 324 | 324 | |
| 325 | 325 | $this->output->writeln( |
| 326 | - 'The remote instance <info>' . $remoteSignatory->getInstance() . '</info> looks good.' |
|
| 326 | + 'The remote instance <info>'.$remoteSignatory->getInstance().'</info> looks good.' |
|
| 327 | 327 | ); |
| 328 | 328 | $question = new ConfirmationQuestion( |
| 329 | - 'Would you like to identify this remote instance as \'<comment>' . $remoteSignatory->getType() |
|
| 329 | + 'Would you like to identify this remote instance as \'<comment>'.$remoteSignatory->getType() |
|
| 330 | 330 | . '</comment>\' using interface \'<comment>' |
| 331 | 331 | . InterfaceService::$LIST_IFACE[$remoteSignatory->getInterface()] |
| 332 | 332 | . '</comment>\' ? (y/N) ', |
@@ -355,7 +355,7 @@ discard block |
||
| 355 | 355 | $helper = $this->getHelper('question'); |
| 356 | 356 | |
| 357 | 357 | $this->output->writeln( |
| 358 | - 'The remote instance <info>' . $remoteSignatory->getInstance() |
|
| 358 | + 'The remote instance <info>'.$remoteSignatory->getInstance() |
|
| 359 | 359 | . '</info> is known but <error>its identity has changed.</error>' |
| 360 | 360 | ); |
| 361 | 361 | $this->output->writeln( |
@@ -417,7 +417,7 @@ discard block |
||
| 417 | 417 | private function verifyGSInstances(): void { |
| 418 | 418 | $instances = $this->globalScaleService->getGlobalScaleInstances(); |
| 419 | 419 | $known = array_map( |
| 420 | - function (RemoteInstance $instance): string { |
|
| 420 | + function(RemoteInstance $instance): string { |
|
| 421 | 421 | return $instance->getInstance(); |
| 422 | 422 | }, $this->remoteRequest->getFromType(RemoteInstance::TYPE_GLOBALSCALE) |
| 423 | 423 | ); |
@@ -433,7 +433,7 @@ discard block |
||
| 433 | 433 | * @param string $instance |
| 434 | 434 | */ |
| 435 | 435 | private function syncGSInstance(string $instance): void { |
| 436 | - $this->output->write('Adding <comment>' . $instance . '</comment>: '); |
|
| 436 | + $this->output->write('Adding <comment>'.$instance.'</comment>: '); |
|
| 437 | 437 | if ($this->configService->isLocalInstance($instance)) { |
| 438 | 438 | $this->output->writeln('<comment>instance is local</comment>'); |
| 439 | 439 | return; |
@@ -448,8 +448,8 @@ discard block |
||
| 448 | 448 | ); |
| 449 | 449 | $this->output->writeln('<info>ok</info>'); |
| 450 | 450 | } catch (Exception $e) { |
| 451 | - $msg = ($e->getMessage() === '') ? '' : ' (' . $e->getMessage() . ')'; |
|
| 452 | - $this->output->writeln('<error>' . get_class($e) . $msg . '</error>'); |
|
| 451 | + $msg = ($e->getMessage() === '') ? '' : ' ('.$e->getMessage().')'; |
|
| 452 | + $this->output->writeln('<error>'.get_class($e).$msg.'</error>'); |
|
| 453 | 453 | } |
| 454 | 454 | } |
| 455 | 455 | |
@@ -467,12 +467,12 @@ discard block |
||
| 467 | 467 | try { |
| 468 | 468 | $current = $this->remoteStreamService->retrieveRemoteInstance($instance->getInstance()); |
| 469 | 469 | if ($current->getUid(true) === $instance->getUid(true)) { |
| 470 | - $currentUid = '<info>' . $current->getUid(true) . '</info>'; |
|
| 470 | + $currentUid = '<info>'.$current->getUid(true).'</info>'; |
|
| 471 | 471 | } else { |
| 472 | - $currentUid = '<error>' . $current->getUid(true) . '</error>'; |
|
| 472 | + $currentUid = '<error>'.$current->getUid(true).'</error>'; |
|
| 473 | 473 | } |
| 474 | 474 | } catch (Exception $e) { |
| 475 | - $currentUid = '<error>' . $e->getMessage() . '</error>'; |
|
| 475 | + $currentUid = '<error>'.$e->getMessage().'</error>'; |
|
| 476 | 476 | } |
| 477 | 477 | |
| 478 | 478 | $table->appendRow( |
@@ -499,7 +499,7 @@ discard block |
||
| 499 | 499 | } |
| 500 | 500 | } |
| 501 | 501 | |
| 502 | - throw new Exception('Unknown type: ' . implode(', ', RemoteInstance::$LIST_TYPE)); |
|
| 502 | + throw new Exception('Unknown type: '.implode(', ', RemoteInstance::$LIST_TYPE)); |
|
| 503 | 503 | } |
| 504 | 504 | |
| 505 | 505 | /** |
@@ -512,6 +512,6 @@ discard block |
||
| 512 | 512 | } |
| 513 | 513 | } |
| 514 | 514 | |
| 515 | - throw new Exception('Unknown interface: ' . implode(', ', InterfaceService::$LIST_IFACE)); |
|
| 515 | + throw new Exception('Unknown interface: '.implode(', ', InterfaceService::$LIST_IFACE)); |
|
| 516 | 516 | } |
| 517 | 517 | } |
@@ -104,7 +104,7 @@ discard block |
||
| 104 | 104 | } catch (FederatedItemException $e) { |
| 105 | 105 | if ($input->getOption('status-code')) { |
| 106 | 106 | throw new FederatedItemException( |
| 107 | - ' [' . get_class($e) . ', ' . ((string)$e->getStatus()) . ']' . "\n" . $e->getMessage() |
|
| 107 | + ' ['.get_class($e).', '.((string)$e->getStatus()).']'."\n".$e->getMessage() |
|
| 108 | 108 | ); |
| 109 | 109 | } |
| 110 | 110 | |
@@ -116,9 +116,9 @@ discard block |
||
| 116 | 116 | } elseif (strtolower($input->getOption('output')) !== 'none') { |
| 117 | 117 | /** @var Circle $circle */ |
| 118 | 118 | $circle = $this->deserialize($outcome, Circle::class); |
| 119 | - $output->writeln('Id: <info>' . $circle->getSingleId() . '</info>'); |
|
| 120 | - $output->writeln('Name: <info>' . $circle->getDisplayName() . '</info>'); |
|
| 121 | - $output->writeln('Owner: <info>' . $circle->getOwner()->getDisplayName() . '</info>'); |
|
| 119 | + $output->writeln('Id: <info>'.$circle->getSingleId().'</info>'); |
|
| 120 | + $output->writeln('Name: <info>'.$circle->getDisplayName().'</info>'); |
|
| 121 | + $output->writeln('Owner: <info>'.$circle->getOwner()->getDisplayName().'</info>'); |
|
| 122 | 122 | } |
| 123 | 123 | |
| 124 | 124 | return 0; |
@@ -237,9 +237,9 @@ |
||
| 237 | 237 | Circle::$DEF_SOURCE[$circle->getSource()], |
| 238 | 238 | $this->cut($displayName ? $owner->getDisplayName() : $owner->getUserId(), 40), |
| 239 | 239 | $this->configService->displayInstance($owner->getInstance()), |
| 240 | - ((string)$circle->getPopulation()) . '/' |
|
| 240 | + ((string)$circle->getPopulation()).'/' |
|
| 241 | 241 | . ((string)$this->getInt('members_limit', $circle->getSettings(), -1)) |
| 242 | - . ' (' . ((string)$circle->getPopulationInherited()) . ')' |
|
| 242 | + . ' ('.((string)$circle->getPopulationInherited()).')' |
|
| 243 | 243 | ] |
| 244 | 244 | ); |
| 245 | 245 | } |
@@ -78,18 +78,18 @@ discard block |
||
| 78 | 78 | |
| 79 | 79 | $name = $rowCG['display_name']; |
| 80 | 80 | while (strlen($name) < 3) { |
| 81 | - $name = '_' . $name; |
|
| 81 | + $name = '_'.$name; |
|
| 82 | 82 | } |
| 83 | 83 | |
| 84 | 84 | // based on owner's userid, we create federateduser and a new circle |
| 85 | - $this->output->writeln('+ New Team <info>' . $name . '</info>, owner by <info>' . $ownerId . '</info>'); |
|
| 85 | + $this->output->writeln('+ New Team <info>'.$name.'</info>, owner by <info>'.$ownerId.'</info>'); |
|
| 86 | 86 | $owner = $this->cachedFed($ownerId); |
| 87 | 87 | |
| 88 | 88 | $this->circlesManager->startSession($owner); |
| 89 | 89 | try { |
| 90 | 90 | $circle = $this->circlesManager->createCircle($name); |
| 91 | 91 | } catch (\Exception $e) { |
| 92 | - $this->output->writeln('<error>' . get_class($e) . ' ' . $e->getMessage() . '</error> with data ' . json_encode($rowCG)); |
|
| 92 | + $this->output->writeln('<error>'.get_class($e).' '.$e->getMessage().'</error> with data '.json_encode($rowCG)); |
|
| 93 | 93 | $this->logger->log(2, 'error while creating circle', ['exception' => $e]); |
| 94 | 94 | $this->circlesManager->stopSession(); |
| 95 | 95 | continue; |
@@ -116,13 +116,13 @@ discard block |
||
| 116 | 116 | continue; // owner is already in the circles |
| 117 | 117 | } |
| 118 | 118 | |
| 119 | - $this->output->writeln(' - new member <info>' . $userId . '</info>'); |
|
| 119 | + $this->output->writeln(' - new member <info>'.$userId.'</info>'); |
|
| 120 | 120 | $member = $this->circlesManager->addMember($circle->getSingleId(), $this->cachedFed($userId)); |
| 121 | 121 | if ($rowM['role'] === '1') { |
| 122 | 122 | $this->circlesManager->levelMember($member->getId(), Member::LEVEL_ADMIN); |
| 123 | 123 | } |
| 124 | 124 | } catch (\Exception $e) { |
| 125 | - $this->output->writeln('<error>' . get_class($e) . ' ' . $e->getMessage() . '</error>'); |
|
| 125 | + $this->output->writeln('<error>'.get_class($e).' '.$e->getMessage().'</error>'); |
|
| 126 | 126 | $this->logger->log(2, 'error while migrating custom group member', ['exception' => $e]); |
| 127 | 127 | } |
| 128 | 128 | } |
@@ -158,7 +158,7 @@ discard block |
||
| 158 | 158 | ->where($update->expr()->in('id', $update->createNamedParameter($shareIds, IQueryBuilder::PARAM_INT_ARRAY))); |
| 159 | 159 | |
| 160 | 160 | $count = $update->executeStatement(); |
| 161 | - $this->output->writeln('> ' . ((string)$count) . ' shares updated'); |
|
| 161 | + $this->output->writeln('> '.((string)$count).' shares updated'); |
|
| 162 | 162 | |
| 163 | 163 | $this->fixShareChildren($shareIds, $memberIds); |
| 164 | 164 | } |
@@ -198,7 +198,7 @@ discard block |
||
| 198 | 198 | $count += $update->executeStatement(); |
| 199 | 199 | } |
| 200 | 200 | |
| 201 | - $this->output->writeln('> ' . ((string)$count) . ' children shares updated'); |
|
| 201 | + $this->output->writeln('> '.((string)$count).' children shares updated'); |
|
| 202 | 202 | } |
| 203 | 203 | |
| 204 | 204 | |