0 follower

类 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
$chars array 表格字符 yii\console\widgets\Table
$columnWidths array 表格列宽 yii\console\widgets\Table
$headers array 表格表头 yii\console\widgets\Table
$id string|null 部件的 ID。 yii\base\Widget
$listPrefix string 列表前缀 yii\console\widgets\Table
$rows array 表格行 yii\console\widgets\Table
$screenWidth integer 屏幕宽度 yii\console\widgets\Table
$view yii\web\View 可用于渲染视图或视图文件的视图对象。 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() 设置表格字符。 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 在执行部件后立即引发的事件。(从版本 2.0.11 开始可用) yii\base\Widget
EVENT_BEFORE_RUN yii\base\WidgetEvent 在执行部件之前立即引发的事件。(从版本 2.0.11 开始可用) yii\base\Widget
EVENT_INIT yii\base\Event 通过 init() 初始化部件时触发的事件。(从版本 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 受保护属性(从版本 2.0.19 开始可用)

表格字符

受保护 数组 $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 受保护属性 (available since version 2.0.19)

表格列宽

受保护 数组 $columnWidths = []
$headers 受保护属性 (available since version 2.0.19)

表格表头

受保护 数组 $headers = []
$listPrefix 受保护属性 (available since version 2.0.19)

列表前缀

受保护 字符串 $listPrefix '• '
$rows 受保护属性 (available since version 2.0.19)

表格行

受保护 数组 $rows = []
$screenWidth 受保护属性 (available since version 2.0.19)

屏幕宽度

受保护 整数 $screenWidth null

方法详情

隐藏继承的方法

__call() 公共方法

定义于: yii\base\Component::__call()

调用不是类方法的命名方法。

此方法将检查任何附加的行为是否具有指定的方法,并在可用时执行。

不要直接调用此方法,因为它是一个 PHP 魔术方法,当调用未知方法时会隐式调用。

公共 混合 __call ( $name, $params )
$name string

方法名称

$params array

方法参数

返回值 混合

方法的返回值

抛出 yii\base\UnknownMethodException

当调用未知方法时

                public function __call($name, $params)
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $object) {
        if ($object->hasMethod($name)) {
            return call_user_func_array([$object, $name], $params);
        }
    }
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}

            
__clone() 公共方法

定义于: yii\base\Component::__clone()

此方法在通过克隆现有对象创建对象后调用。

它删除所有行为,因为它们附加到旧对象。

公共 __clone ( )

                public function __clone()
{
    $this->_events = [];
    $this->_eventWildcards = [];
    $this->_behaviors = null;
}

            
__construct() 公共方法

定义于: yii\base\BaseObject::__construct()

构造函数。

默认实现做两件事

  • 使用给定的配置 $config 初始化对象。
  • 调用 init().

如果此方法在子类中被重写,建议

  • 构造函数的最后一个参数是一个配置数组,如这里的 $config
  • 在构造函数的最后调用父类实现。
公共 __construct ( $config = [] )
$config array

将用于初始化对象属性的键值对

                public function __construct($config = [])
{
    if (!empty($config)) {
        Yii::configure($this, $config);
    }
    $this->init();
}

            
__get() 公共方法

定义于: yii\base\Component::__get()

返回组件属性的值。

此方法将按以下顺序检查并相应地执行

  • 由 getter 定义的属性:返回 getter 结果
  • 行为的属性:返回行为属性值

不要直接调用此方法,因为它是一个 PHP 魔术方法,当执行 $value = $component->property; 时会隐式调用。

另见 __set().

公共 混合 __get ( $name )
$name string

属性名称

返回值 混合

属性值或行为属性的值

抛出 yii\base\UnknownPropertyException

如果未定义属性

抛出 yii\base\InvalidCallException

如果属性是只写。

                public function __get($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        // read property, e.g. getName()
        return $this->$getter();
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name;
        }
    }
    if (method_exists($this, 'set' . $name)) {
        throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}

            
__isset() 公共方法

定义于: yii\base\Component::__isset()

检查属性是否已设置,即定义且不为 null。

此方法将按以下顺序检查并相应地执行

  • 由 setter 定义的属性:返回属性是否已设置
  • 行为的属性:返回属性是否已设置
  • 对于不存在的属性,返回 false

不要直接调用此方法,因为它是一个 PHP 魔术方法,当执行 isset($component->property) 时会隐式调用。

另见 https://php.ac.cn/manual/en/function.isset.php.

public boolean __isset ( $name )
$name string

属性名称或事件名称

返回值 boolean

指定名称的属性是否已设置

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name !== null;
        }
    }
    return false;
}

            
__set() 公共方法

定义于: yii\base\Component::__set()

设置组件属性的值。

此方法将按以下顺序检查并相应地执行

  • 由 setter 定义的属性:设置属性值
  • 格式为“on xyz”的事件:将处理程序附加到“xyz”事件
  • 格式为“as xyz”的行为:附加名为“xyz”的行为
  • 行为的属性:设置行为属性值

不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行 $component->property = $value; 时会隐式调用。

另请参见 __get().

public void __set ( $name, $value )
$name string

属性名称或事件名称

$value 混合

属性值

抛出 yii\base\UnknownPropertyException

如果未定义属性

抛出 yii\base\InvalidCallException

如果属性是只读的。

                public function __set($name, $value)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        // set property
        $this->$setter($value);
        return;
    } elseif (strncmp($name, 'on ', 3) === 0) {
        // on event: attach event handler
        $this->on(trim(substr($name, 3)), $value);
        return;
    } elseif (strncmp($name, 'as ', 3) === 0) {
        // as behavior: attach behavior
        $name = trim(substr($name, 3));
        $this->attachBehavior($name, $value instanceof Behavior ? $value : Yii::createObject($value));
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = $value;
            return;
        }
    }
    if (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}

            
__unset() 公共方法

定义于: yii\base\Component::__unset()

将组件属性设置为 null。

此方法将按以下顺序检查并相应地执行

  • 由 setter 定义的属性:将属性值设置为 null
  • 行为的属性:将属性值设置为 null

不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行 unset($component->property) 时会隐式调用。

另请参见 https://php.ac.cn/manual/en/function.unset.php.

public void __unset ( $name )
$name string

属性名称

抛出 yii\base\InvalidCallException

如果属性是只读的。

                public function __unset($name)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter(null);
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = null;
            return;
        }
    }
    throw new InvalidCallException('Unsetting an unknown or read-only property: ' . get_class($this) . '::' . $name);
}

            
afterRun() 公共方法 (自版本 2.0.11 起可用)

定义于: yii\base\Widget::afterRun()

此方法在执行部件后立即调用。

此方法将触发 EVENT_AFTER_RUN 事件。该方法的返回值将用作小部件的返回值。

如果覆盖此方法,代码应如下所示

public function afterRun($result)
{
    $result = parent::afterRun($result);
    // your custom code here
    return $result;
}
public mixed afterRun ( $result )
$result 混合

小部件返回值。

返回值 混合

已处理的小部件结果。

                public function afterRun($result)
{
    $event = new WidgetEvent();
    $event->result = $result;
    $this->trigger(self::EVENT_AFTER_RUN, $event);
    return $event->result;
}

            
attachBehavior() 公共方法

定义于: yii\base\Component::attachBehavior()

将行为附加到此组件。

此方法将根据给定的配置创建行为对象。之后,行为对象将通过调用 yii\base\Behavior::attach() 方法附加到此组件。

另请参见 detachBehavior().

public yii\base\Behavior attachBehavior ( $name, $behavior )
$name string

行为的名称。

$behavior string|array|yii\base\Behavior

行为配置。这可以是以下之一

返回值 yii\base\Behavior

行为对象

                public function attachBehavior($name, $behavior)
{
    $this->ensureBehaviors();
    return $this->attachBehaviorInternal($name, $behavior);
}

            
attachBehaviors() 公共方法

定义于: yii\base\Component::attachBehaviors()

将行为列表附加到组件。

每个行为都以其名称为索引,并且应该是一个 yii\base\Behavior 对象、一个指定行为类的字符串,或一个创建行为的配置数组。

另请参见 attachBehavior().

public void attachBehaviors ( $behaviors )
$behaviors array

要附加到组件的行为列表

                public function attachBehaviors($behaviors)
{
    $this->ensureBehaviors();
    foreach ($behaviors as $name => $behavior) {
        $this->attachBehaviorInternal($name, $behavior);
    }
}

            
beforeRun() 公共方法 (自版本 2.0.11 起可用)

定义于: yii\base\Widget::beforeRun()

此方法在执行部件之前立即调用。

此方法将触发 EVENT_BEFORE_RUN 事件。该方法的返回值将决定小部件是否应该继续运行。

覆盖此方法时,请确保您调用父实现,如下所示

public function beforeRun()
{
    if (!parent::beforeRun()) {
        return false;
    }

    // your custom code here

    return true; // or false to not run the widget
}
public boolean beforeRun ( )
返回值 boolean

小部件是否应该继续执行。

                public function beforeRun()
{
    $event = new WidgetEvent();
    $this->trigger(self::EVENT_BEFORE_RUN, $event);
    return $event->isValid;
}

            
begin() 公共静态方法

定义于: yii\base\Widget::begin()

开始一个部件。

此方法创建一个调用类的实例。它将把配置应用于创建的实例。稍后应调用匹配的 end() 调用。由于某些小部件可能使用输出缓冲,因此 end() 调用应在同一个视图中进行,以避免破坏输出缓冲的嵌套。

另请参见 end().

public static static begin ( $config = [] )
$config array

将用于初始化对象属性的键值对

返回值 yii\base\Widget

新创建的小部件实例

                public static function begin($config = [])
{
    $config['class'] = get_called_class();
    /* @var $widget Widget */
    $widget = Yii::createObject($config);
    self::$stack[] = $widget;
    return $widget;
}

            
behaviors() 公共方法

定义于: yii\base\Component::behaviors()

返回此组件应表现为的行为列表。

子类可以覆盖此方法以指定它们想要表现出的行为。

此方法的返回值应该是一个行为对象或配置的数组,以行为名称为索引。行为配置可以是一个指定行为类的字符串,也可以是一个如下结构的数组

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

请注意,行为类必须扩展自 yii\base\Behavior。行为可以使用名称或匿名方式附加。当使用名称作为数组键时,使用此名称,行为以后可以使用 getBehavior() 检索,或使用 detachBehavior() 分离。匿名行为无法检索或分离。

在此方法中声明的行为将自动附加到组件(按需)。

public array behaviors ( )
返回值 array

行为配置。

                public function behaviors()
{
    return [];
}

            
calculateRowHeight() 受保护方法

计算行的高度。

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

protected integer calculateRowHeight ( $row )
$row array
返回值 integer

每个单元格的最大行数

                protected function calculateRowHeight($row)
{
    $rowsPerCell = array_map(function ($size, $columnWidth) {
        if (is_array($columnWidth)) {
            $rows = 0;
            foreach ($columnWidth as $width) {
                $rows +=  $size == 2 ? 0 : ceil($width / ($size - 2));
            }
            return $rows;
        }
        return $size == 2 || $columnWidth == 0 ? 0 : ceil($columnWidth / ($size - 2));
    }, $this->columnWidths, array_map(function ($val) {
        if (is_array($val)) {
            return array_map('yii\helpers\Console::ansiStrwidth', $val);
        }
        if (is_string($val)) {
            return array_map('yii\helpers\Console::ansiStrwidth', explode(PHP_EOL, $val));
        }
        return Console::ansiStrwidth($val);
    }, $row));
    return max($rowsPerCell);
}

            
calculateRowsSize() 受保护方法

计算要在控制台中绘制列锚点的大小。

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

受保护 void calculateRowsSize ( )

                protected function calculateRowsSize()
{
    $this->columnWidths = $columns = [];
    $totalWidth = 0;
    $screenWidth = $this->getScreenWidth() - self::CONSOLE_SCROLLBAR_OFFSET;
    $headerCount = count($this->headers);
    if (empty($this->rows)) {
        $rowColCount = 0;
    } else {
        $rowColCount = max(array_map('count', $this->rows));
    }
    $count = max($headerCount, $rowColCount);
    for ($i = 0; $i < $count; $i++) {
        $columns[] = ArrayHelper::getColumn($this->rows, $i);
        if ($i < $headerCount) {
            $columns[$i][] = $this->headers[$i];
        }
    }
    foreach ($columns as $column) {
        $columnWidth = max(array_map(function ($val) {
            if (is_array($val)) {
                return max(array_map('yii\helpers\Console::ansiStrwidth', $val)) + Console::ansiStrwidth($this->listPrefix);
            }
            if (is_string($val)) {
                return max(array_map('yii\helpers\Console::ansiStrwidth', explode(PHP_EOL, $val)));
            }
            return Console::ansiStrwidth($val);
        }, $column)) + 2;
        $this->columnWidths[] = $columnWidth;
        $totalWidth += $columnWidth;
    }
    if ($totalWidth > $screenWidth) {
        $minWidth = 3;
        $fixWidths = [];
        $relativeWidth = $screenWidth / $totalWidth;
        foreach ($this->columnWidths as $j => $width) {
            $scaledWidth = (int) ($width * $relativeWidth);
            if ($scaledWidth < $minWidth) {
                $fixWidths[$j] = 3;
            }
        }
        $totalFixWidth = array_sum($fixWidths);
        $relativeWidth = ($screenWidth - $totalFixWidth) / ($totalWidth - $totalFixWidth);
        foreach ($this->columnWidths as $j => $width) {
            if (!array_key_exists($j, $fixWidths)) {
                $this->columnWidths[$j] = (int) ($width * $relativeWidth);
            }
        }
    }
}

            
canGetProperty() 公共方法

定义于: yii\base\Component::canGetProperty()

返回一个值,指示是否可以读取属性。

如果属性可读,则满足以下条件之一:

  • 该类有一个与指定名称关联的 getter 方法(在这种情况下,属性名称不区分大小写);
  • 该类有一个与指定名称匹配的成员变量(当 $checkVars 为 true 时);
  • 附加的行为具有给定名称的可读属性(当 $checkBehaviors 为 true 时)。

另请参阅 canSetProperty().

public boolean canGetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

属性名称

$checkVars boolean

是否将成员变量视为属性

$checkBehaviors boolean

是否将行为的属性视为此组件的属性

返回值 boolean

属性是否可读

                public function canGetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canGetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
canSetProperty() 公共方法

定义于: yii\base\Component::canSetProperty()

返回一个值,指示是否可以设置属性。

如果属性可写,则满足以下条件之一:

  • 该类有一个与指定名称关联的 setter 方法(在这种情况下,属性名称不区分大小写);
  • 该类有一个与指定名称匹配的成员变量(当 $checkVars 为 true 时);
  • 附加的行为具有给定名称的可写属性(当 $checkBehaviors 为 true 时)。

另请参阅 canGetProperty().

public boolean canSetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

属性名称

$checkVars boolean

是否将成员变量视为属性

$checkBehaviors boolean

是否将行为的属性视为此组件的属性

返回值 boolean

属性是否可写

                public function canSetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canSetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
className() 公共静态方法
自 2.0.14 版本起已弃用。在 PHP >=5.5 上,请使用 ::class 代替。

定义于: yii\base\BaseObject::className()

返回此类的完全限定名。

public static string className ( )
返回值 string

此类的完全限定名称。

                public static function className()
{
    return get_called_class();
}

            
detachBehavior() 公共方法

定义于: yii\base\Component::detachBehavior()

从组件中分离行为。

将调用行为的 yii\base\Behavior::detach() 方法。

public yii\base\Behavior|null detachBehavior ( $name )
$name string

行为的名称。

返回值 yii\base\Behavior|null

已分离的行为。如果行为不存在,则为 null。

                public function detachBehavior($name)
{
    $this->ensureBehaviors();
    if (isset($this->_behaviors[$name])) {
        $behavior = $this->_behaviors[$name];
        unset($this->_behaviors[$name]);
        $behavior->detach();
        return $behavior;
    }
    return null;
}

            
detachBehaviors() 公共方法

定义于: yii\base\Component::detachBehaviors()

从组件中分离所有行为。

public void detachBehaviors ( )

                public function detachBehaviors()
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $name => $behavior) {
        $this->detachBehavior($name);
    }
}

            
end() 公共静态方法

定义于: yii\base\Widget::end()

结束一个部件。

请注意,小部件的渲染结果将直接回显。

另请参阅 begin().

public static static end ( )
返回值 yii\base\Widget

已结束的小部件实例。

抛出 yii\base\InvalidCallException

如果 begin()end() 调用未正确嵌套

                public static function end()
{
    if (!empty(self::$stack)) {
        $widget = array_pop(self::$stack);
        $calledClass = get_called_class();
        if (Yii::$container->has($calledClass) && isset(Yii::$container->getDefinitions()[$calledClass]['class'])) {
            $calledClass = Yii::$container->getDefinitions()[$calledClass]['class'];
        }
        if (get_class($widget) === $calledClass) {
            /* @var $widget Widget */
            if ($widget->beforeRun()) {
                $result = $widget->run();
                $result = $widget->afterRun($result);
                echo $result;
            }
            return $widget;
        }
        throw new InvalidCallException('Expecting end() of ' . get_class($widget) . ', found ' . get_called_class());
    }
    throw new InvalidCallException('Unexpected ' . get_called_class() . '::end() call. A matching begin() is not found.');
}

            
ensureBehaviors() 公共方法

定义于: yii\base\Component::ensureBehaviors()

确保在 behaviors() 中声明的行为附加到此组件。

public void ensureBehaviors ( )

                public function ensureBehaviors()
{
    if ($this->_behaviors === null) {
        $this->_behaviors = [];
        foreach ($this->behaviors() as $name => $behavior) {
            $this->attachBehaviorInternal($name, $behavior);
        }
    }
}

            
getBehavior() 公共方法

定义于: yii\base\Component::getBehavior()

返回命名的行为对象。

public yii\base\Behavior|null getBehavior ( $name )
$name string

行为名称

返回值 yii\base\Behavior|null

行为对象,如果行为不存在,则为 null

                public function getBehavior($name)
{
    $this->ensureBehaviors();
    return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
}

            
getBehaviors() 公共方法

定义于: yii\base\Component::getBehaviors()

返回附加到此组件的所有行为。

public yii\base\Behavior[] getBehaviors ( )
返回值 yii\base\Behavior[]

附加到此组件的行为列表

                public function getBehaviors()
{
    $this->ensureBehaviors();
    return $this->_behaviors;
}

            
getId() 公共方法

定义于: yii\base\Widget::getId()

返回部件的 ID。

public string|null getId ( $autoGenerate true )
$autoGenerate boolean

如果以前未设置 ID,是否生成 ID

返回值 string|null

部件的 ID。

                public function getId($autoGenerate = true)
{
    if ($autoGenerate && $this->_id === null) {
        $this->_id = static::$autoIdPrefix . static::$counter++;
    }
    return $this->_id;
}

            
getScreenWidth() 受保护方法

获取屏幕宽度。

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

protected integer getScreenWidth ( )
返回值 integer

屏幕宽度

                protected function getScreenWidth()
{
    if (!$this->screenWidth) {
        $size = Console::getScreenSize();
        $this->screenWidth = isset($size[0])
            ? $size[0]
            : self::DEFAULT_CONSOLE_SCREEN_WIDTH + self::CONSOLE_SCROLLBAR_OFFSET;
    }
    return $this->screenWidth;
}

            
getView() 公共方法

定义于: yii\base\Widget::getView()

返回可用于渲染视图或视图文件的视图对象。

render()renderFile() 方法将使用此视图对象来实现实际的视图渲染。 如果未设置,它将默认为 "view" 应用程序组件。

public yii\web\View getView ( )
返回值 yii\web\View

可用于渲染视图或视图文件的视图对象。

                public function getView()
{
    if ($this->_view === null) {
        $this->_view = Yii::$app->getView();
    }
    return $this->_view;
}

            
getViewPath() public method

Defined in: yii\base\Widget::getViewPath()

返回包含此部件视图文件的目录。

默认实现返回包含小部件类文件目录下的 'views' 子目录。

public string getViewPath ( )
返回值 string

包含此部件视图文件的目录。

                public function getViewPath()
{
    $class = new ReflectionClass($this);
    return dirname($class->getFileName()) . DIRECTORY_SEPARATOR . 'views';
}

            
hasEventHandlers() public method

Defined in: yii\base\Component::hasEventHandlers()

返回一个值,指示是否有任何处理程序附加到命名的事件。

public boolean hasEventHandlers ( $name )
$name string

事件名称

返回值 boolean

事件是否有任何处理程序附加。

                public function hasEventHandlers($name)
{
    $this->ensureBehaviors();
    if (!empty($this->_events[$name])) {
        return true;
    }
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (!empty($handlers) && StringHelper::matchWildcard($wildcard, $name)) {
            return true;
        }
    }
    return Event::hasHandlers($this, $name);
}

            
hasMethod() public method

Defined in: yii\base\Component::hasMethod()

返回一个值,指示是否定义了方法。

方法定义如果

  • 类具有指定名称的方法
  • 附加的行为具有指定名称的方法(当 $checkBehaviors 为真时)。
public boolean hasMethod ( $name, $checkBehaviors true )
$name string

属性名称

$checkBehaviors boolean

是否将行为的方法视为此组件的方法

返回值 boolean

方法是否已定义

                public function hasMethod($name, $checkBehaviors = true)
{
    if (method_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->hasMethod($name)) {
                return true;
            }
        }
    }
    return false;
}

            
hasProperty() public method

Defined in: yii\base\Component::hasProperty()

返回一个值,指示是否为此组件定义了属性。

属性定义如果

  • 类具有与指定名称关联的 getter 或 setter 方法(在这种情况下,属性名称不区分大小写);
  • 该类有一个与指定名称匹配的成员变量(当 $checkVars 为 true 时);
  • 附加的行为具有指定名称的属性(当 $checkBehaviors 为真时)。

另请参阅

public boolean hasProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

属性名称

$checkVars boolean

是否将成员变量视为属性

$checkBehaviors boolean

是否将行为的属性视为此组件的属性

返回值 boolean

属性是否已定义

                public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
{
    return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
}

            
init() public method

Defined in: yii\base\Widget::init()

初始化对象。

此方法在构造函数结束时调用。 默认实现将触发 EVENT_INIT 事件。

public void init ( )

                public function init()
{
    parent::init();
    $this->trigger(self::EVENT_INIT);
}

            
off() public method

Defined in: yii\base\Component::off()

从此组件中分离现有的事件处理程序。

此方法与 on() 相反。

注意:如果为事件名称传递通配符模式,则只删除使用此通配符注册的处理程序,而使用与该通配符匹配的普通名称注册的处理程序将保留。

另请参阅 on()

public boolean off ( $name, $handler null )
$name string

事件名称

$handler callable|null

要删除的事件处理程序。 如果它为 null,则将删除附加到命名事件的所有处理程序。

返回值 boolean

如果找到并分离了处理程序

                public function off($name, $handler = null)
{
    $this->ensureBehaviors();
    if (empty($this->_events[$name]) && empty($this->_eventWildcards[$name])) {
        return false;
    }
    if ($handler === null) {
        unset($this->_events[$name], $this->_eventWildcards[$name]);
        return true;
    }
    $removed = false;
    // plain event names
    if (isset($this->_events[$name])) {
        foreach ($this->_events[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_events[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_events[$name] = array_values($this->_events[$name]);
            return true;
        }
    }
    // wildcard event names
    if (isset($this->_eventWildcards[$name])) {
        foreach ($this->_eventWildcards[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_eventWildcards[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_eventWildcards[$name] = array_values($this->_eventWildcards[$name]);
            // remove empty wildcards to save future redundant regex checks:
            if (empty($this->_eventWildcards[$name])) {
                unset($this->_eventWildcards[$name]);
            }
        }
    }
    return $removed;
}

            
on() public method

Defined in: yii\base\Component::on()

将事件处理程序附加到事件。

事件处理程序必须是有效的 PHP 回调。 以下是几个示例

function ($event) { ... }         // anonymous function
[$object, 'handleClick']          // $object->handleClick()
['Page', 'handleClick']           // Page::handleClick()
'handleClick'                     // global function handleClick()

事件处理程序必须使用以下签名定义,

function ($event)

其中 $event 是一个 yii\base\Event 对象,其中包含与事件相关的参数。

从 2.0.14 版本开始,您可以将事件名称指定为通配符模式

$component->on('event.group.*', function ($event) {
    Yii::trace($event->name . ' is triggered.');
});

另请参阅 off()

public void on ( $name, $handler, $data null, $append true )
$name string

事件名称

$handler callable

事件处理程序

$data 混合

触发事件时传递给事件处理程序的数据。 当调用事件处理程序时,可以通过 yii\base\Event::$data 访问此数据。

$append boolean

是否将新的事件处理程序附加到现有处理程序列表的末尾。 如果为 false,则新的处理程序将插入到现有处理程序列表的开头。

                public function on($name, $handler, $data = null, $append = true)
{
    $this->ensureBehaviors();
    if (strpos($name, '*') !== false) {
        if ($append || empty($this->_eventWildcards[$name])) {
            $this->_eventWildcards[$name][] = [$handler, $data];
        } else {
            array_unshift($this->_eventWildcards[$name], [$handler, $data]);
        }
        return;
    }
    if ($append || empty($this->_events[$name])) {
        $this->_events[$name][] = [$handler, $data];
    } else {
        array_unshift($this->_events[$name], [$handler, $data]);
    }
}

            
render() public method

Defined in: yii\base\Widget::render()

渲染视图。

要渲染的视图可以以下列格式之一指定

  • 路径别名(例如 "@app/views/site/index");
  • 应用程序中的绝对路径(例如 "//site/index"):视图名称以双斜杠开头。 实际的视图文件将在应用程序的 视图路径 下查找。
  • 模块中的绝对路径(例如 "/site/index"):视图名称以单个斜杠开头。 实际的视图文件将在当前活动模块的 视图路径 下查找。
  • 相对路径(例如 "index"):实际的视图文件将在 $viewPath 下查找。

如果视图名称不包含文件扩展名,它将使用默认扩展名 .php

public string render ( $view, $params = [] )
$view string

视图名称。

$params array

应该在视图中可用的参数(名称-值对)。

返回值 string

渲染结果。

抛出 yii\base\InvalidArgumentException

如果视图文件不存在。

                public function render($view, $params = [])
{
    return $this->getView()->render($view, $params, $this);
}

            
renderFile() public method

Defined in: yii\base\Widget::renderFile()

渲染视图文件。

public string renderFile ( $file, $params = [] )
$file string

要渲染的视图文件。 这可以是文件路径或 路径别名

$params array

应该在视图中可用的参数(名称-值对)。

返回值 string

渲染结果。

抛出 yii\base\InvalidArgumentException

如果视图文件不存在。

                public function renderFile($file, $params = [])
{
    return $this->getView()->renderFile($file, $params, $this);
}

            
renderRow() protected method

将一行数据渲染成字符串。

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

受保护的 字符串 renderRow ( 数组 $row, $spanLeft, $spanMiddle, $spanRight )
$row array

数据行

$spanLeft string

左侧边框字符

$spanMiddle string

中间边框字符

$spanRight string

右侧边框字符

                protected function renderRow(array $row, $spanLeft, $spanMiddle, $spanRight)
{
    $size = $this->columnWidths;
    $buffer = '';
    $arrayPointer = [];
    $renderedChunkTexts = [];
    for ($i = 0, ($max = $this->calculateRowHeight($row)) ?: $max = 1; $i < $max; $i++) {
        $buffer .= $spanLeft . ' ';
        foreach ($size as $index => $cellSize) {
            $cell = isset($row[$index]) ? $row[$index] : null;
            $prefix = '';
            if ($index !== 0) {
                $buffer .= $spanMiddle . ' ';
            }
            $arrayFromMultilineString = false;
            if (is_string($cell)) {
                $cellLines = explode(PHP_EOL, $cell);
                if (count($cellLines) > 1) {
                    $cell = $cellLines;
                    $arrayFromMultilineString = true;
                }
            }
            if (is_array($cell)) {
                if (empty($renderedChunkTexts[$index])) {
                    $renderedChunkTexts[$index] = '';
                    $start = 0;
                    $prefix = $arrayFromMultilineString ? '' : $this->listPrefix;
                    if (!isset($arrayPointer[$index])) {
                        $arrayPointer[$index] = 0;
                    }
                } else {
                    $start = mb_strwidth($renderedChunkTexts[$index], Yii::$app->charset);
                }
                $chunk = Console::ansiColorizedSubstr(
                    $cell[$arrayPointer[$index]],
                    $start,
                    $cellSize - 2 - Console::ansiStrwidth($prefix)
                );
                $renderedChunkTexts[$index] .= Console::stripAnsiFormat($chunk);
                $fullChunkText = Console::stripAnsiFormat($cell[$arrayPointer[$index]]);
                if (isset($cell[$arrayPointer[$index] + 1]) && $renderedChunkTexts[$index] === $fullChunkText) {
                    $arrayPointer[$index]++;
                    $renderedChunkTexts[$index] = '';
                }
            } else {
                $chunk = Console::ansiColorizedSubstr($cell, ($cellSize * $i) - ($i * 2), $cellSize - 2);
            }
            $chunk = $prefix . $chunk;
            $repeat = $cellSize - Console::ansiStrwidth($chunk) - 1;
            $buffer .= $chunk;
            if ($repeat >= 0) {
                $buffer .= str_repeat(' ', $repeat);
            }
        }
        $buffer .= "$spanRight\n";
    }
    return $buffer;
}

            
renderSeparator() 受保护方法

渲染分隔符。

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

受保护的 字符串 renderSeparator ( $spanLeft, $spanMid, $spanMidMid, $spanRight )
$spanLeft string

左侧边框字符

$spanMid string

中间边框字符

$spanMidMid string

中间-中间边框字符

$spanRight string

右侧边框字符

返回值 string

生成的分割行

                protected function renderSeparator($spanLeft, $spanMid, $spanMidMid, $spanRight)
{
    $separator = $spanLeft;
    foreach ($this->columnWidths as $index => $rowSize) {
        if ($index !== 0) {
            $separator .= $spanMid;
        }
        $separator .= str_repeat($spanMidMid, $rowSize);
    }
    $separator .= $spanRight . "\n";
    return $separator;
}

            
run() 公共方法

公共的 字符串 run ( )
返回值 string

渲染后的表格

                public function run()
{
    $this->calculateRowsSize();
    $headerCount = count($this->headers);
    $buffer = $this->renderSeparator(
        $this->chars[self::CHAR_TOP_LEFT],
        $this->chars[self::CHAR_TOP_MID],
        $this->chars[self::CHAR_TOP],
        $this->chars[self::CHAR_TOP_RIGHT]
    );
    // Header
    if ($headerCount > 0) {
        $buffer .= $this->renderRow(
            $this->headers,
            $this->chars[self::CHAR_LEFT],
            $this->chars[self::CHAR_MIDDLE],
            $this->chars[self::CHAR_RIGHT]
        );
    }
    // Content
    foreach ($this->rows as $i => $row) {
        if ($i > 0 || $headerCount > 0) {
            $buffer .= $this->renderSeparator(
                $this->chars[self::CHAR_LEFT_MID],
                $this->chars[self::CHAR_MID_MID],
                $this->chars[self::CHAR_MID],
                $this->chars[self::CHAR_RIGHT_MID]
            );
        }
        $buffer .= $this->renderRow(
            $row,
            $this->chars[self::CHAR_LEFT],
            $this->chars[self::CHAR_MIDDLE],
            $this->chars[self::CHAR_RIGHT]
        );
    }
    $buffer .= $this->renderSeparator(
        $this->chars[self::CHAR_BOTTOM_LEFT],
        $this->chars[self::CHAR_BOTTOM_MID],
        $this->chars[self::CHAR_BOTTOM],
        $this->chars[self::CHAR_BOTTOM_RIGHT]
    );
    return $buffer;
}

            
setChars() 公共方法

设置表格字符。

公共的 $this setChars ( 数组 $chars )
$chars array

表格字符

                public function setChars(array $chars)
{
    $this->chars = $chars;
    return $this;
}

            
setHeaders() 公共方法

设置表格表头。

公共的 $this setHeaders ( 数组 $headers )
$headers array

表格表头

                public function setHeaders(array $headers)
{
    $this->headers = array_values($headers);
    return $this;
}

            
setId() 公共方法

定义于: yii\base\Widget::setId()

设置部件的 ID。

公共的 setId ( $value )
$value string

小部件的 ID。

                public function setId($value)
{
    $this->_id = $value;
}

            
setListPrefix() 公共方法

设置列表前缀。

公共的 $this setListPrefix ( $listPrefix )
$listPrefix string

列表前缀

                public function setListPrefix($listPrefix)
{
    $this->listPrefix = $listPrefix;
    return $this;
}

            
setRows() 公共方法

设置表格行。

公共的 $this setRows ( 数组 $rows )
$rows array

表格行

                public function setRows(array $rows)
{
    $this->rows = array_map(function ($row) {
        return array_map(function ($value) {
            return empty($value) && !is_numeric($value)
                ? ' '
                :  (is_array($value)
                    ? array_values($value)
                    : $value);
        }, array_values($row));
    }, $rows);
    return $this;
}

            
setScreenWidth() 公共方法

设置屏幕宽度。

公共的 $this setScreenWidth ( $width )
$width integer

屏幕宽度

                public function setScreenWidth($width)
{
    $this->screenWidth = $width;
    return $this;
}

            
setView() 公共方法

定义于: yii\base\Widget::setView()

设置此部件要使用的视图对象。

公共的 setView ( $view )
$view yii\base\View

可用于渲染视图或视图文件的视图对象。

                public function setView($view)
{
    $this->_view = $view;
}

            
trigger() 公共方法

定义于: yii\base\Component::trigger()

触发事件。

此方法表示事件的发生。它调用事件的所有附加处理程序,包括类级别的处理程序。

公共的 trigger ( $name, yii\base\Event $event null )
$name string

事件名称

$event yii\base\Event|null

事件实例。如果未设置,将创建一个默认的 yii\base\Event 对象。

                public function trigger($name, Event $event = null)
{
    $this->ensureBehaviors();
    $eventHandlers = [];
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (StringHelper::matchWildcard($wildcard, $name)) {
            $eventHandlers[] = $handlers;
        }
    }
    if (!empty($this->_events[$name])) {
        $eventHandlers[] = $this->_events[$name];
    }
    if (!empty($eventHandlers)) {
        $eventHandlers = call_user_func_array('array_merge', $eventHandlers);
        if ($event === null) {
            $event = new Event();
        }
        if ($event->sender === null) {
            $event->sender = $this;
        }
        $event->handled = false;
        $event->name = $name;
        foreach ($eventHandlers as $handler) {
            $event->data = $handler[1];
            call_user_func($handler[0], $event);
            // stop further handling if the event is handled
            if ($event->handled) {
                return;
            }
        }
    }
    // invoke class-level attached handlers
    Event::trigger($this, $name, $event);
}

            
widget() 公共静态方法

定义于: yii\base\Widget::widget()

创建部件实例并运行它。

小部件渲染结果由此方法返回。

公共静态的 字符串 widget ( $config = [] )
$config array

将用于初始化对象属性的键值对

返回值 string

小部件的渲染结果。

抛出 可抛出异常

                public static function widget($config = [])
{
    ob_start();
    ob_implicit_flush(false);
    try {
        /* @var $widget Widget */
        $config['class'] = get_called_class();
        $widget = Yii::createObject($config);
        $out = '';
        if ($widget->beforeRun()) {
            $result = $widget->run();
            $out = $widget->afterRun($result);
        }
    } catch (\Exception $e) {
        // close the output buffer opened above if it has not been closed already
        if (ob_get_level() > 0) {
            ob_end_clean();
        }
        throw $e;
    } catch (\Throwable $e) {
        // close the output buffer opened above if it has not been closed already
        if (ob_get_level() > 0) {
            ob_end_clean();
        }
        throw $e;
    }
    return ob_get_clean() . $out;
}