类 ProgressHelper
使用提供的回调创建进度条。
用法
可以使用 helper() 方法从 shell 访问 ProgressHelper。
$this->helper('Progress')->output(['callback' => function ($progress) {
// Do work
$progress->increment();
});
命名空间: Cake\Command\Helper
属性摘要
-
$_config protected
array<string, mixed>运行时配置
-
$_configInitialized protected
bool配置属性是否已使用默认值配置
-
$_defaultConfig protected
array<string, mixed>此助手的默认配置。
-
$_io protected
Cake\Console\ConsoleIoConsoleIo 实例。
-
$_progress protected
float|int当前进度。
-
$_total protected
int要遍历的“项目”总数。
-
$_width protected
int条的宽度。
方法摘要
-
__construct() public
构造函数。
-
_configDelete() protected
删除单个配置键。
-
_configRead() protected
读取配置键。
-
_configWrite() protected
写入配置键。
-
configShallow() public
将提供的配置与现有配置合并。与
config()不同，它对嵌套键进行递归合并，此方法进行简单合并。 -
draw() public
根据当前状态渲染进度条。
-
getConfig() public
返回配置。
-
getConfigOrFail() public
返回此特定键的配置。
-
increment() public
递增进度条。
-
init() public
初始化进度条以供使用。
-
output() public
输出进度条。
-
setConfig() public
设置配置。
方法详细说明
__construct() ¶ public
__construct(Cake\Console\ConsoleIo $io, array<string, mixed> $config = [])构造函数。
参数
-
Cake\Console\ConsoleIo$io 要使用的 ConsoleIo 实例。
-
array<string, mixed>$config optional 此助手的设置。
_configDelete() ¶ protected
_configDelete(string $key): void删除单个配置键。
参数
-
string$key 要删除的键。
返回值
void抛出
Cake\Core\Exception\CakeException如果尝试覆盖现有配置
_configRead() ¶ protected
_configRead(string|null $key): mixed读取配置键。
参数
-
string|null$key 要读取的键。
返回值
mixed_configWrite() ¶ protected
_configWrite(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): void写入配置键。
参数
-
array<string, mixed>|string$key 要写入的键。
-
mixed$value 要写入的值。
-
string|bool$merge optional True 表示递归合并，'shallow' 表示简单合并，false 表示覆盖，默认值为 false。
返回值
void抛出
Cake\Core\Exception\CakeException如果尝试覆盖现有配置
configShallow() ¶ public
configShallow(array<string, mixed>|string $key, mixed|null $value = null): $this将提供的配置与现有配置合并。与 config() 不同，它对嵌套键进行递归合并，此方法进行简单合并。
设置特定值
$this->configShallow('key', $value);设置嵌套值
$this->configShallow('some.nested.key', $value);同时更新多个配置设置
$this->configShallow(['one' => 'value', 'another' => 'value']);参数
-
array<string, mixed>|string$key 要设置的键，或完整的配置数组。
-
mixed|null$value optional 要设置的值。
返回值
$thisgetConfig() ¶ public
getConfig(string|null $key = null, mixed $default = null): mixed返回配置。
用法
读取整个配置
$this->getConfig();读取特定值
$this->getConfig('key');读取嵌套值
$this->getConfig('some.nested.key');使用默认值读取
$this->getConfig('some-key', 'default-value');参数
-
string|null$key optional 要获取的键，或获取整个配置的 null。
-
mixed$default optional 键不存在时的返回值。
返回值
mixedgetConfigOrFail() ¶ public
getConfigOrFail(string $key): mixed返回此特定键的配置。
此键的配置值必须存在，它永远不能为 null。
参数
-
string$key 要获取的键。
返回值
mixed抛出
InvalidArgumentExceptionincrement() ¶ public
increment(float|int $num = 1): $this递增进度条。
参数
-
float|int$num optional 要前进的进度量。
返回值
$thisinit() ¶ public
init(array<string, mixed> $args = []): $this初始化进度条以供使用。
total进度条中的项目总数。默认为 100。width进度条的宽度。默认为 80。
参数
-
array<string, mixed>$args optional 初始化数据。
返回值
$thisoutput() ¶ public
output(array $args): void输出进度条。
需要一些选项来自定义行为
total进度条中的项目总数。默认为 100。width进度条的宽度。默认为 80。callback在循环中将被调用的回调，以推进进度条。
参数
-
array$args 输出进度条时要使用的参数/选项。
返回值
voidsetConfig() ¶ public
setConfig(array<string, mixed>|string $key, mixed|null $value = null, bool $merge = true): $this设置配置。
用法
设置特定值
$this->setConfig('key', $value);设置嵌套值
$this->setConfig('some.nested.key', $value);同时更新多个配置设置
$this->setConfig(['one' => 'value', 'another' => 'value']);参数
-
array<string, mixed>|string$key 要设置的键，或完整的配置数组。
-
mixed|null$value optional 要设置的值。
-
bool$merge 可选 是否递归合并或覆盖现有配置，默认值为 true。
返回值
$this抛出
Cake\Core\Exception\CakeException当尝试设置无效键时。