0 追蹤者

類別 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 自動生成的 Widget 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 Widget 的 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 包含此 Widget 視圖檔案的目錄。 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() 此方法在 Widget 執行後立即調用。 yii\base\Widget
attachBehavior() 將行為附加到此組件。 yii\base\Component
attachBehaviors() 將行為列表附加到組件。 yii\base\Component
beforeRun() 此方法在 Widget 執行前立即調用。 yii\base\Widget
begin() 開始一個 Widget。 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() 結束一個 Widget。 yii\base\Widget
ensureBehaviors() 確保在 behaviors() 中宣告的行為已附加到此組件。 yii\base\Component
getBehavior() 傳回指定的行為物件。 yii\base\Component
getBehaviors() 傳回附加到此組件的所有行為。 yii\base\Component
getId() 傳回 Widget 的 ID。 yii\base\Widget
getView() 傳回可用於呈現視圖或視圖檔案的視圖物件。 yii\base\Widget
getViewPath() 傳回包含此 Widget 視圖檔案的目錄。 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

Protected Methods

隱藏繼承的方法

方法 描述 定義於
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

Events

Hide inherited events

Event 類型 描述 定義於
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

Constants

Hide inherited constants

Constant Value 描述 定義於
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

Property Details

隱藏繼承的屬性

$chars protected property (available since version 2.0.19)

表格字元

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 property (available since version 2.0.19)

表格欄寬

protected array $columnWidths = []
$headers protected property (available since version 2.0.19)

表格標題

protected array $headers = []
$listPrefix protected property (available since version 2.0.19)

列表前綴

protected string $listPrefix '• '
$rows protected property (available since version 2.0.19)

表格列

protected array $rows = []
$screenWidth protected property (available since version 2.0.19)

螢幕寬度

protected integer $screenWidth null

Method Details

隱藏繼承的方法

__call() public method

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

呼叫指定的非類別方法。

此方法將檢查任何附加的行為是否具有指定的名稱方法,並在可用的情況下執行它。

請勿直接呼叫此方法,因為它是一個 PHP 魔術方法,當呼叫未知的方法時,它會被隱式呼叫。

public mixed __call ( $name, $params )
$name string

方法名稱

$params array

方法參數

return mixed

方法傳回值

throws 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() public method

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

在透過複製現有物件建立物件後,會呼叫此方法。

它會移除所有行為,因為這些行為都附加到舊的物件。

public void __clone ( )

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

            
__construct() public method

Defined in: yii\base\BaseObject::__construct()

建構子。

預設實作會執行兩件事

  • 使用給定的組態 $config 初始化物件。
  • 呼叫 init()

如果在子類別中覆寫此方法,建議

  • 建構子的最後一個參數是組態陣列,如同此處的 $config
  • 在建構子的結尾呼叫父類別實作。
public void __construct ( $config = [] )
$config array

將用於初始化物件屬性的名稱-值組

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

            
__get() public method

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

傳回組件屬性的值。

此方法將依以下順序檢查並採取相應的動作

  • getter 定義的屬性:傳回 getter 結果
  • 行為的屬性:傳回行為屬性值

請勿直接呼叫此方法,因為它是一個 PHP 魔術方法,當執行 $value = $component->property; 時,它會被隱式呼叫。

另請參閱 __set()

public mixed __get ( $name )
$name string

屬性名稱

return mixed

屬性值或行為屬性的值

throws yii\base\UnknownPropertyException

如果未定義屬性

throws 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() public method

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

檢查屬性是否已設定,即已定義且非 null。

此方法將依以下順序檢查並採取相應的動作

  • setter 定義的屬性:傳回屬性是否已設定
  • 行為的屬性:傳回屬性是否已設定
  • 針對不存在的屬性傳回 false

請勿直接呼叫此方法,因為它是一個 PHP 魔術方法,當執行 isset($component->property) 時,它會被隱式呼叫。

另請參閱 https://php.dev.org.tw/manual/en/function.isset.php

public boolean __isset ( $name )
$name string

屬性名稱或事件名稱

return 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() public method

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

設定組件屬性的值。

此方法將依以下順序檢查並採取相應的動作

  • setter 定義的屬性:設定屬性值
  • 格式為 "on xyz" 的事件:將處理常式附加到事件 "xyz"
  • 格式為 "as xyz" 的行為:附加名為 "xyz" 的行為
  • 行為的屬性:設定行為屬性值

請勿直接呼叫此方法,因為它是一個 PHP 魔術方法,當執行 $component->property = $value; 時,它會被隱式呼叫。

另請參閱 __get()

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

屬性名稱或事件名稱

$value mixed

屬性值

throws yii\base\UnknownPropertyException

如果未定義屬性

throws 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() public method

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

將組件屬性設定為 null。

此方法將依以下順序檢查並採取相應的動作

  • setter 定義的屬性:將屬性值設定為 null
  • 行為的屬性:將屬性值設定為 null

請勿直接呼叫此方法,因為它是一個 PHP 魔術方法,當執行 unset($component->property) 時,它會被隱式呼叫。

另請參閱 https://php.dev.org.tw/manual/en/function.unset.php

public void __unset ( $name )
$name string

屬性名稱

throws 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() public method (available since version 2.0.11)

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

此方法在 Widget 執行後立即調用。

此方法將觸發 EVENT_AFTER_RUN 事件。此方法的傳回值將用作小工具的傳回值。

如果您覆寫此方法,您的程式碼應如下所示

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

小工具傳回結果。

return mixed

處理後的小工具結果。

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

            
attachBehavior() public method

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

將行為附加到此組件。

此方法將根據給定的組態建立行為物件。之後,將透過呼叫 yii\base\Behavior::attach() 方法將行為物件附加到此元件。

另請參閱 detachBehavior()

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

行為的名稱。

$behavior string|array|yii\base\Behavior

行為組態。可以是以下其中之一

return yii\base\Behavior

行為物件

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

            
attachBehaviors() public method

Defined in: 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() public method (available since version 2.0.11)

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

此方法在 Widget 執行前立即調用。

此方法將觸發 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 ( )
return boolean

小工具是否應繼續執行。

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

            
begin() public static method

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

開始一個 Widget。

此方法會建立呼叫類別的實例。它會將組態套用至建立的實例。稍後應呼叫相符的 end() 呼叫。由於某些小工具可能會使用輸出緩衝,因此應在相同的視圖中進行 end() 呼叫,以避免中斷輸出緩衝的巢狀結構。

另請參閱 end()

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

將用於初始化物件屬性的名稱-值組

return 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() public method

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

傳回此組件應表現為的行為列表。

子類別可以覆寫此方法,以指定它們想要作為的行為。

此方法的傳回值應為行為物件或組態的陣列,並依行為名稱編製索引。行為組態可以是指定行為類別的字串,或是以下結構的陣列

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

請注意,行為類別必須繼承自 yii\base\Behavior。行為可以使用名稱或匿名方式附加。當使用名稱作為陣列索引鍵時,使用此名稱,稍後可以使用 getBehavior() 擷取行為,或使用 detachBehavior() 分離行為。匿名行為無法擷取或分離。

在此方法中宣告的行為將自動(依需求)附加到元件。

public array behaviors ( )
return array

行為組態。

                public function behaviors()
{
    return [];
}

            
calculateRowHeight() protected method

計算列的高度。

另請參閱 yii\console\widgets\Table::render()

protected integer calculateRowHeight ( $row )
$row array
return 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() protected method

計算列的大小,以便在主控台中繪製欄位的錨點。

另請參閱 yii\console\widgets\Table::render()

protected 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() public method

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

傳回一個值,指示是否可以讀取屬性。

如果符合以下條件,則可以讀取屬性

  • 類別具有與指定名稱相關聯的 getter 方法(在這種情況下,屬性名稱不區分大小寫);
  • 類別具有帶有指定名稱的成員變數(當 $checkVars 為 true 時);
  • 附加的行為具有給定名稱的可讀屬性(當 $checkBehaviors 為 true 時)。

另請參閱 canSetProperty()

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

屬性名稱

$checkVars boolean

是否將成員變數視為屬性

$checkBehaviors boolean

是否將行為的屬性視為此元件的屬性

return 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() public method

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

傳回一個值,指示是否可以設定屬性。

如果符合以下條件,則可以寫入屬性

  • 類別具有與指定名稱相關聯的 setter 方法(在這種情況下,屬性名稱不區分大小寫);
  • 類別具有帶有指定名稱的成員變數(當 $checkVars 為 true 時);
  • 附加的行為具有給定名稱的可寫入屬性(當 $checkBehaviors 為 true 時)。

另請參閱 canGetProperty()

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

屬性名稱

$checkVars boolean

是否將成員變數視為屬性

$checkBehaviors boolean

是否將行為的屬性視為此元件的屬性

return 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() public static method
自 2.0.14 版本起已過時。在 PHP >=5.5 上,請改用 ::class

Defined in: yii\base\BaseObject::className()

傳回此類別的完整限定名稱。

public static string className ( )
return string

此類別的完整限定名稱。

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

            
detachBehavior() public method

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

從組件中分離行為。

將會調用行為的 yii\base\Behavior::detach() 方法。

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

行為的名稱。

return 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() public method

定義於: yii\base\Component::detachBehaviors()

從組件中分離所有行為。

public void detachBehaviors ( )

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

            
end() public static method

定義於: yii\base\Widget::end()

結束一個 Widget。

請注意,小組件的渲染結果會直接輸出。

另請參閱 begin()

public static static end ( )
return yii\base\Widget

已結束的小組件實例。

throws 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() public method

定義於: 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() public method

定義於: yii\base\Component::getBehavior()

傳回指定的行為物件。

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

行為名稱

return yii\base\Behavior|null

行為物件,如果行為不存在則為 null

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

            
getBehaviors() public method

定義於: yii\base\Component::getBehaviors()

傳回附加到此組件的所有行為。

public yii\base\Behavior[] getBehaviors ( )
return yii\base\Behavior[]

附加到此組件的行為列表

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

            
getId() public method

定義於: yii\base\Widget::getId()

傳回 Widget 的 ID。

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

是否在先前未設定 ID 的情況下產生 ID

return string|null

Widget 的 ID。

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

            
getScreenWidth() protected method

取得螢幕寬度。

如果無法判斷螢幕寬度,將設定預設值 123

protected integer getScreenWidth ( )
return 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() public method

定義於: yii\base\Widget::getView()

傳回可用於呈現視圖或視圖檔案的視圖物件。

render()renderFile() 方法將使用此視圖物件來實作實際的視圖渲染。如果未設定,它將預設為 "view" 應用程式組件。

public yii\web\View getView ( )
return yii\web\View

可用於呈現視圖或視圖檔案的視圖物件。

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

            
getViewPath() public method

定義於: yii\base\Widget::getViewPath()

傳回包含此 Widget 視圖檔案的目錄。

預設實作會傳回包含小組件類別檔案的目錄下的 'views' 子目錄。

public string getViewPath ( )
return string

包含此 Widget 視圖檔案的目錄。

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

            
hasEventHandlers() public method

定義於: yii\base\Component::hasEventHandlers()

傳回值以指示是否有名稱事件附加任何處理常式。

public boolean hasEventHandlers ( $name )
$name string

事件名稱

return 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

定義於: yii\base\Component::hasMethod()

傳回值以指示是否已定義方法。

如果符合以下條件,則方法已定義

  • 類別具有具有指定名稱的方法
  • 附加的行為具有給定名稱的方法 (當 $checkBehaviors 為 true 時)。
public boolean hasMethod ( $name, $checkBehaviors true )
$name string

屬性名稱

$checkBehaviors boolean

是否將行為的方法視為此組件的方法

return 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

定義於: yii\base\Component::hasProperty()

傳回值以指示是否為此元件定義屬性。

如果符合以下條件,則屬性已定義

  • 類別具有與指定名稱關聯的 getter 或 setter 方法 (在這種情況下,屬性名稱不區分大小寫);
  • 類別具有帶有指定名稱的成員變數(當 $checkVars 為 true 時);
  • 附加的行為具有給定名稱的屬性 (當 $checkBehaviors 為 true 時)。

另請參閱

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

屬性名稱

$checkVars boolean

是否將成員變數視為屬性

$checkBehaviors boolean

是否將行為的屬性視為此元件的屬性

return boolean

屬性是否已定義

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

            
init() public method

定義於: yii\base\Widget::init()

初始化物件。

此方法在建構函式結束時呼叫。預設實作將觸發 EVENT_INIT 事件。

public void init ( )

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

            
off() public method

定義於: yii\base\Component::off()

從此元件分離現有的事件處理常式。

此方法與 on() 相反。

注意:如果為事件名稱傳遞了萬用字元模式,則只會移除使用此萬用字元註冊的處理常式,而使用與此萬用字元匹配的純名稱註冊的處理常式將保留。

另請參閱 on()

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

事件名稱

$handler callable|null

要移除的事件處理常式。如果為 null,則將移除附加到具名事件的所有處理常式。

return 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

定義於: 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 可呼叫

事件處理常式

$data mixed

在觸發事件時要傳遞給事件處理常式的資料。當調用事件處理常式時,可以透過 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

定義於: yii\base\Widget::render()

渲染視圖。

要渲染的視圖可以使用以下格式之一指定

  • 路徑別名 (例如 "@app/views/site/index");
  • 應用程式內的絕對路徑 (例如 "//site/index"):視圖名稱以雙斜線開頭。實際的視圖檔案將在應用程式的 視圖路徑 下尋找。
  • 模組內的絕對路徑 (例如 "/site/index"):視圖名稱以單斜線開頭。實際的視圖檔案將在目前活動模組的 視圖路徑 下尋找。
  • 相對路徑 (例如 "index"):實際的視圖檔案將在 $viewPath 下尋找。

如果視圖名稱不包含檔案副檔名,它將使用預設副檔名 .php

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

視圖名稱。

$params array

應在視圖中提供的參數 (名稱-值對)。

return string

渲染結果。

throws yii\base\InvalidArgumentException

如果視圖檔案不存在。

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

            
renderFile() public method

定義於: yii\base\Widget::renderFile()

渲染視圖檔案。

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

要渲染的視圖檔案。這可以是檔案路徑或 路徑別名

$params array

應在視圖中提供的參數 (名稱-值對)。

return string

渲染結果。

throws yii\base\InvalidArgumentException

如果視圖檔案不存在。

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

            
renderRow() protected method

將資料列渲染成字串。

另請參閱 yii\console\widgets\Table::render()

protected string renderRow ( array $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() protected method

渲染分隔符。

另請參閱 yii\console\widgets\Table::render()

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

左邊框字元

$spanMid string

中間邊框字元

$spanMidMid string

中間-中間邊框字元

$spanRight string

右邊框字元

return 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() public method

public string run ( )
return 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() public method

設定表格字元。

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

表格字元

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

            
setHeaders() public method

設定表格標頭。

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

表格標題

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

            
setId() public method

定義於: yii\base\Widget::setId()

設定小工具的 ID。

public void setId ( $value )
$value string

小組件的 ID。

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

            
setListPrefix() public method

設定列表前綴。

public $this setListPrefix ( $listPrefix )
$listPrefix string

列表前綴

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

            
setRows() public method

設定表格列。

public $this setRows ( array $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() public method

設定螢幕寬度。

public $this setScreenWidth ( $width )
$width integer

螢幕寬度

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

            
setView() public method

定義於: yii\base\Widget::setView()

設定此小工具要使用的視圖物件。

public void setView ( $view )
$view yii\base\View

可用於呈現視圖或視圖檔案的視圖物件。

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

            
trigger() public method

定義於: yii\base\Component::trigger()

觸發事件。

此方法表示事件的發生。它會調用事件的所有附加處理常式,包括類別層級的處理常式。

public void 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() public static method

定義於: yii\base\Widget::widget()

建立並執行小工具實例。

小組件渲染結果由此方法傳回。

public static string widget ( $config = [] )
$config array

將用於初始化物件屬性的名稱-值組

return string

小組件的渲染結果。

throws Throwable

                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;
}