类 StubConsoleOutput
StubOutput 使测试 shell 命令/shell 助手变得更容易。
您可以通过将它注入到命令/任务/助手使用的 ConsoleIo 实例中来使用此类。
use Cake\Console\ConsoleIo;
use Cake\Console\TestSuite\StubConsoleOutput;
$output = new StubConsoleOutput();
$io = new ConsoleIo($output);
命名空间： Cake\Console\TestSuite
常量
属性摘要
-
$_backgroundColors protected static
array<string, int>彩色输出中使用的背景颜色。
-
$_foregroundColors protected static
array<string, int>彩色输出中使用的文本颜色。
-
$_options protected static
array<string, int>彩色输出的格式选项。
-
$_out protected
list<string>缓冲的消息。
-
$_output protected
resource输出的文件句柄。
-
$_outputAs protected
int当前输出类型。
-
$_styles protected static
array<string, array>在控制台输出中可作为标签使用的样式。您可以使用 ConsoleOutput::styles() 修改这些样式。
方法摘要
-
__construct() public
构造输出对象。
-
__destruct() public
清理并关闭句柄
-
_replaceTags() protected
用颜色代码替换标签。
-
_write() protected
将消息写入输出流。
-
clear() public
清除缓冲的输出
-
getOutputAs() public
获取如何处理格式化标签的输出类型。
-
getStyle() public
获取当前提供的样式
-
messages() public
获取缓冲的输出。
-
output() public
将输出作为字符串获取
-
setOutputAs() public
设置如何处理格式化标签的输出类型。
-
setStyle() public
设置样式。
-
styleText() public
将样式应用于文本。
-
styles() public
获取所有样式定义。
-
write() public
将输出写入缓冲区。
方法详情
__construct() ¶ public
__construct(resource|string $stream = 'php://stdout')构造输出对象。
检查是否为漂亮的控制台环境。Ansicon 和 ConEmu 允许在 Windows 上使用漂亮的控制台，并且受支持。
参数
-
resource|string$stream optional 要写入输出的流的标识符。
抛出
Cake\Console\Exception\ConsoleException如果给定的流不是有效的资源。
_replaceTags() ¶ protected
_replaceTags(array<string, string> $matches): string用颜色代码替换标签。
参数
-
array<string, string>$matches 要替换的匹配项数组。
返回值
stringsetOutputAs() ¶ public
setOutputAs(int $type): void设置如何处理格式化标签的输出类型。
参数
-
int$type 要使用的输出类型。应为类常量之一。
返回值
void抛出
InvalidArgumentException在不支持的输出类型的情况下。
setStyle() ¶ public
setStyle(string $style, array $definition): void设置样式。
创建或修改现有样式。
$output->setStyle('annoy', ['text' => 'purple', 'background' => 'yellow', 'blink' => true]);删除样式
$this->output->setStyle('annoy', []);参数
-
string$style 要设置的样式。
-
array$definition 要更改或创建的样式的数组定义。
返回值
voidstyleText() ¶ public
styleText(string $text): string将样式应用于文本。
参数
-
string$text 带有样式标签的文本。
返回值
stringwrite() ¶ public
write(list<string>|string $message, int $newlines = 1): int将输出写入缓冲区。
参数
-
list<string>|string$message 要输出的字符串或字符串数组
-
int$newlines optional 要追加的换行符数量
返回值
int