-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
StubConsoleOutput.php
91 lines (82 loc) · 2.12 KB
/
StubConsoleOutput.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
<?php
declare(strict_types=1);
/**
* CakePHP : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP Project
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Console\TestSuite;
use Cake\Console\ConsoleOutput;
/**
* StubOutput makes testing shell commands/shell helpers easier.
*
* You can use this class by injecting it into a ConsoleIo instance
* that your command/task/helper uses:
*
* ```
* use Cake\Console\ConsoleIo;
* use Cake\Console\TestSuite\StubConsoleOutput;
*
* $output = new StubConsoleOutput();
* $io = new ConsoleIo($output);
* ```
*/
class StubConsoleOutput extends ConsoleOutput
{
/**
* Buffered messages.
*
* @var array<string>
*/
protected array $_out = [];
/**
* Write output to the buffer.
*
* @param array<string>|string $message A string or an array of strings to output
* @param int $newlines Number of newlines to append
* @return int
*/
public function write(array|string $message, int $newlines = 1): int
{
foreach ((array)$message as $line) {
$this->_out[] = $line;
}
$newlines--;
while ($newlines > 0) {
$this->_out[] = '';
$newlines--;
}
return 0;
}
/**
* Get the buffered output.
*
* @return array<string>
*/
public function messages(): array
{
return $this->_out;
}
/**
* Get the output as a string
*
* @return string
*/
public function output(): string
{
return implode("\n", $this->_out);
}
}
// phpcs:disable
class_alias(
'Cake\Console\TestSuite\StubConsoleOutput',
'Cake\TestSuite\Stub\ConsoleOutput'
);
// phpcs:enable