wp-cli/php-cli-tools

PHP 控制台工具

维护者

详细信息

github.com/wp-cli/php-cli-tools

主页

源代码

问题

安装数量: 15,510,469

依赖者: 385

建议者: 2

安全性: 0

星标: 672

关注者: 34

分支: 118

开放问题: 8

v0.12.0 2024-05-22 20:20 UTC

Requires

  • php: >= 5.6.0

Requires (Dev)

MIT 2d1da4751f47622b56e6616c87b2fb53decee4e5

  • Daniel Bachhuber <daniel.woop@handbuilt.co>
  • James Logsdon <jlogsdon.woop@php.net>

cliconsole

This package is auto-updated.

Last update: 2024-09-17 15:28:34 UTC

README

一组辅助命令行开发的函数和类。

需求

  • PHP >= 5.6

建议的 PHP 扩展

  • mbstring - 用于计算字符串宽度。

函数列表

  • cli\out($msg, ...)
  • cli\out_padded($msg, ...)
  • cli\err($msg, ...)
  • cli\line($msg = '', ...)
  • cli\input()
  • cli\prompt($question, $default = false, $marker = ':')
  • cli\choose($question, $choices = 'yn', $default = 'n')
  • cli\menu($items, $default = false, $title = 'Choose an Item')

进度指示器

  • cli\notify\Dots($msg, $dots = 3, $interval = 100)
  • cli\notify\Spinner($msg, $interval = 100)
  • cli\progress\Bar($msg, $total, $interval = 100)

表格显示

  • cli\Table::__construct(array $headers = null, array $rows = null)
  • cli\Table::setHeaders(array $headers)
  • cli\Table::setRows(array $rows)
  • cli\Table::setRenderer(cli\table\Renderer $renderer)
  • cli\Table::addRow(array $row)
  • cli\Table::sort($column)
  • cli\Table::display()

显示函数将检测输出是否通过管道传递，如果是，则渲染一个制表符分隔的表格，而不是用于可视显示的 ASCII 表格。

您还可以通过调用 cli\Table::setRenderer() 并传递一个具体 cli\table\Renderer 类的实例来显式设置使用的渲染器。

树形显示

  • cli\Tree::__construct()
  • cli\Tree::setData(array $data)
  • cli\Tree::setRenderer(cli\tree\Renderer $renderer)
  • cli\Tree::render()
  • cli\Tree::display()

参数解析器

参数解析使用一个简单的框架来接受命令行参数列表，通常直接从 $_SERVER['argv'] 中获取，并将输入与一组定义的规则进行解析。

查看 examples/arguments.php 获取示例。

用法

请参阅 examples/ 目录中的示例。

待办事项

  • 扩展此 README
  • 为其余代码添加文档块