Class yii\console\widgets\Table

继承yii\console\widgets\Table » yii\base\Widget » yii\base\Component » yii\base\BaseObject
实现yii\base\Configurable, yii\base\ViewContextInterface
可用自版本2.0.13
源代码 https://github.com/yiisoft/yii2/blob/master/framework/console/widgets/Table.php

Table 类在控制台中显示一个表格.

示例,

$table = new Table();

echo $table
    ->setHeaders(['test1', 'test2', 'test3'])
    ->setRows([
        ['col1', 'col2', 'col3'],
        ['col1', 'col2', ['col3-0', 'col3-1', 'col3-2']],
    ])
    ->run();

echo Table::widget([
    'headers' => ['test1', 'test2', 'test3'],
    'rows' => [
        ['col1', 'col2', 'col3'],
        ['col1', 'col2', ['col3-0', 'col3-1', 'col3-2']],
    ],
]);

公共属性

隐藏继承的属性

属性类型描述定义在
$autoIdPrefix string 自动生成的小部件 ID 的前缀. yii\base\Widget
$behaviors yii\base\Behavior[] 附加到此组件的行为列表. 该属性是只读的. yii\base\Component
$counter integer 用于为小部件生成 $id 的计数器. yii\base\Widget
$id string|null 小部件的 ID. Note: 此属性的类型在 getter 和 setter 中不同. 有关详细信息, 请参阅 getId()setId(). yii\base\Widget
$stack yii\base\Widget[] 当前正在渲染的小部件(未结束). yii\base\Widget
$view yii\web\View 可用于渲染视图或视图文件的视图对象. Note: 此属性的类型在 getter 和 setter 中不同. 有关详细信息, 请参阅 getView()setView(). yii\base\Widget
$viewPath string 包含此小部件的视图文件的目录. 该属性是只读的. yii\base\Widget

公共方法

隐藏继承的方法

方法描述定义在
__call() 调用不是类方法的指定的方法. yii\base\Component
__clone() 在通过克隆现有对象创建对象之后调用此方法. yii\base\Component
__construct() 构造函数. yii\base\BaseObject
__get() 返回组件属性的值. yii\base\Component
__isset() 检查属性是否已设置, 即已定义且不为null. yii\base\Component
__set() 设置组件属性的值. yii\base\Component
__unset() 将组件属性设置为null. yii\base\Component
afterRun() 在执行小部件后立即调用该方法. yii\base\Widget
attachBehavior() 将行为附加到此组件. yii\base\Component
attachBehaviors() 将行为列表附加到组件. yii\base\Component
beforeRun() 在执行小部件之前立即调用该方法. yii\base\Widget
begin() 开始一个小部件. yii\base\Widget
behaviors() 返回此组件应该具有的行为列表. yii\base\Component
canGetProperty() 返回一个值, 指示属性是否可读取. yii\base\Component
canSetProperty() 返回一个值, 指示属性是否可设置. yii\base\Component
className() 返回此类的完全限定名称. yii\base\BaseObject
detachBehavior() 从组件中分离一个行为. yii\base\Component
detachBehaviors() 分离组件中的所有行为. yii\base\Component
end() 结束小部件. yii\base\Widget
ensureBehaviors() 确保在 behaviors() 中声明的行为已附加到此组件. yii\base\Component
getBehavior() 返回指定的行为对象. yii\base\Component
getBehaviors() 返回附加到此组件的所有行为. yii\base\Component
getId() 返回小部件的 ID. yii\base\Widget
getView() 返回可用于渲染视图或视图文件的视图对象. yii\base\Widget
getViewPath() 返回包含此小部件的视图文件的目录. yii\base\Widget
hasEventHandlers() 返回一个值, 指示是否有任何处理程序附加到指定的事件. yii\base\Component
hasMethod() 返回一个值, 指示方法是否已定义. yii\base\Component
hasProperty() 返回一个值, 指示属性是否已定义. yii\base\Component
init() 初始化该对象. yii\base\Widget
off() 从该组件分离现有的事件处理程序. yii\base\Component
on() 将事件处理程序附加到事件. yii\base\Component
render() 渲染视图. yii\base\Widget
renderFile() 渲染视图文件. yii\base\Widget
run() yii\console\widgets\Table
setChars() Set table chars. yii\console\widgets\Table
setHeaders() 设置表头. yii\console\widgets\Table
setId() 设置小部件的 ID. yii\base\Widget
setListPrefix() 设置列表前缀. yii\console\widgets\Table
setRows() 设置表行. yii\console\widgets\Table
setScreenWidth() 设置屏幕宽度. yii\console\widgets\Table
setView() 设置此小部件要使用的视图对象. yii\base\Widget
trigger() 触发事件. yii\base\Component
widget() 创建一个小部件实例并运行它. yii\base\Widget

受保护的方法

隐藏继承的方法

方法描述定义在
calculateRowHeight() 计算一行的高度. yii\console\widgets\Table
calculateRowsSize() 计算行的大小以在控制台中绘制列的锚点. yii\console\widgets\Table
getScreenWidth() 获取屏幕宽度. yii\console\widgets\Table
renderRow() 将一行数据渲染为字符串. yii\console\widgets\Table
renderSeparator() 渲染分隔符. yii\console\widgets\Table

事件

隐藏继承的事件

事件类型描述定义在
EVENT_AFTER_RUN yii\base\WidgetEvent 在执行小部件之后立即触发的事件. (available since version 2.0.11) yii\base\Widget
EVENT_BEFORE_RUN yii\base\WidgetEvent 在执行小部件之前触发的事件. (available since version 2.0.11) yii\base\Widget
EVENT_INIT yii\base\Event 当通过 init() 初始化小部件时触发的事件. (available since version 2.0.11) yii\base\Widget

常量

隐藏继承的常量

常量描述定义在
CHAR_BOTTOM 'bottom' yii\console\widgets\Table
CHAR_BOTTOM_LEFT 'bottom-left' yii\console\widgets\Table
CHAR_BOTTOM_MID 'bottom-mid' yii\console\widgets\Table
CHAR_BOTTOM_RIGHT 'bottom-right' yii\console\widgets\Table
CHAR_LEFT 'left' yii\console\widgets\Table
CHAR_LEFT_MID 'left-mid' yii\console\widgets\Table
CHAR_MID 'mid' yii\console\widgets\Table
CHAR_MIDDLE 'middle' yii\console\widgets\Table
CHAR_MID_MID 'mid-mid' yii\console\widgets\Table
CHAR_RIGHT 'right' yii\console\widgets\Table
CHAR_RIGHT_MID 'right-mid' yii\console\widgets\Table
CHAR_TOP 'top' yii\console\widgets\Table
CHAR_TOP_LEFT 'top-left' yii\console\widgets\Table
CHAR_TOP_MID 'top-mid' yii\console\widgets\Table
CHAR_TOP_RIGHT 'top-right' yii\console\widgets\Table
CONSOLE_SCROLLBAR_OFFSET 3 yii\console\widgets\Table
DEFAULT_CONSOLE_SCREEN_WIDTH 120 yii\console\widgets\Table

属性详情

$chars protected 属性 (可用自版本: 2.0.19)

Table chars

protected array $chars = [self::CHAR_TOP => '═'self::CHAR_TOP_MID => '╤'self::CHAR_TOP_LEFT => '╔'self::CHAR_TOP_RIGHT => '╗'self::CHAR_BOTTOM => '═'self::CHAR_BOTTOM_MID => '╧'self::CHAR_BOTTOM_LEFT => '╚'self::CHAR_BOTTOM_RIGHT => '╝'self::CHAR_LEFT => '║'self::CHAR_LEFT_MID => '╟'self::CHAR_MID => '─'self::CHAR_MID_MID => '┼'self::CHAR_RIGHT => '║'self::CHAR_RIGHT_MID => '╢'self::CHAR_MIDDLE => '│']
$columnWidths protected 属性 (可用自版本: 2.0.19)

表格列宽.

protected array $columnWidths = []
$headers protected 属性 (可用自版本: 2.0.19)

表头.

protected array $headers = []
$listPrefix protected 属性 (可用自版本: 2.0.19)

列表前缀.

protected string $listPrefix '• '
$rows protected 属性 (可用自版本: 2.0.19)

表行.

protected array $rows = []
$screenWidth protected 属性 (可用自版本: 2.0.19)

屏幕宽度.

protected integer $screenWidth null

方法详情

calculateRowHeight() protected 方法

计算一行的高度.

参见 yii\console\widgets\Table::render().

protected integer calculateRowHeight ( $row )
$row array
return integer

每个单元格的最大行数.

calculateRowsSize() protected 方法

计算行的大小以在控制台中绘制列的锚点.

参见 yii\console\widgets\Table::render().

protected void calculateRowsSize ( )
getScreenWidth() protected 方法

获取屏幕宽度.

如果无法确定屏幕宽度, 则将设置为默认值123.

protected integer getScreenWidth ( )
return integer

屏幕宽度.

renderRow() protected 方法

将一行数据渲染为字符串.

参见 yii\console\widgets\Table::render().

protected string renderRow ( array $row, $spanLeft, $spanMiddle, $spanRight )
$row array

数据行.

$spanLeft string

左边框字符.

$spanMiddle string

中间边框字符.

$spanRight string

右边框字符.

renderSeparator() protected 方法

渲染分隔符.

参见 yii\console\widgets\Table::render().

protected string renderSeparator ( $spanLeft, $spanMid, $spanMidMid, $spanRight )
$spanLeft string

左边框字符.

$spanMid string

中间边框字符.

$spanMidMid string

中间边框字符.

$spanRight string

右边框字符.

return string

渲染的分隔符行.

run() public 方法

public string run ( )
return string

渲染的表格.

setChars() public 方法

Set table chars.

public $this setChars ( array $chars )
$chars array

Table chars

setHeaders() public 方法

设置表头.

public $this setHeaders ( array $headers )
$headers array

表头.

setListPrefix() public 方法

设置列表前缀.

public $this setListPrefix ( $listPrefix )
$listPrefix string

列表前缀.

setRows() public 方法

设置表行.

public $this setRows ( array $rows )
$rows array

表行.

setScreenWidth() public 方法

设置屏幕宽度.

public $this setScreenWidth ( $width )
$width integer

屏幕宽度.