Class yii\console\widgets\Table
| Inheritance | yii\console\widgets\Table » yii\base\Widget » yii\base\Component » yii\base\BaseObject |
|---|---|
| Implements | yii\base\Configurable, yii\base\ViewContextInterface |
| Available since version | 2.0.13 |
| Source Code | https://github.com/yiisoft/yii2/blob/master/framework/console/widgets/Table.php |
Table class displays a table in console.
For example,
$table = new Table();
echo $table
->setHeaders(['test1', 'test2', 'test3'])
->setRows([
['col1', 'col2', 'col3'],
['col1', 'col2', ['col3-0', 'col3-1', 'col3-2']],
])
->run();
or
echo Table::widget([
'headers' => ['test1', 'test2', 'test3'],
'rows' => [
['col1', 'col2', 'col3'],
['col1', 'col2', ['col3-0', 'col3-1', 'col3-2']],
],
]);
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $autoIdPrefix | string | The prefix to the automatically generated widget IDs. | yii\base\Widget |
| $behaviors | yii\base\Behavior[] | List of behaviors attached to this component. This property is read-only. | yii\base\Component |
| $counter | integer | A counter used to generate $id for widgets. | yii\base\Widget |
| $id | string|null | ID of the widget. Note that the type of this property differs in getter and setter. See getId() and setId() for details. | yii\base\Widget |
| $stack | yii\base\Widget[] | The widgets that are currently being rendered (not ended). | yii\base\Widget |
| $view | yii\web\View | The view object that can be used to render views or view files. Note that the type of this property differs in getter and setter. See getView() and setView() for details. | yii\base\Widget |
| $viewPath | string | The directory containing the view files for this widget. This property is read-only. | yii\base\Widget |
Protected Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $chars | array | Table chars | yii\console\widgets\Table |
| $columnWidths | array | Table column widths | yii\console\widgets\Table |
| $headers | array | Table headers | yii\console\widgets\Table |
| $listPrefix | string | List prefix | yii\console\widgets\Table |
| $rows | array | Table rows | yii\console\widgets\Table |
| $screenWidth | integer | Screen width | yii\console\widgets\Table |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | yii\base\Component |
| __clone() | This method is called after the object is created by cloning an existing one. | yii\base\Component |
| __construct() | Constructor. | yii\base\BaseObject |
| __get() | Returns the value of a component property. | yii\base\Component |
| __isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Component |
| __set() | Sets the value of a component property. | yii\base\Component |
| __unset() | Sets a component property to be null. | yii\base\Component |
| afterRun() | This method is invoked right after a widget is executed. | yii\base\Widget |
| attachBehavior() | Attaches a behavior to this component. | yii\base\Component |
| attachBehaviors() | Attaches a list of behaviors to the component. | yii\base\Component |
| beforeRun() | This method is invoked right before the widget is executed. | yii\base\Widget |
| begin() | Begins a widget. | yii\base\Widget |
| behaviors() | Returns a list of behaviors that this component should behave as. | yii\base\Component |
| canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\Component |
| canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Component |
| className() | Returns the fully qualified name of this class. | yii\base\BaseObject |
| detachBehavior() | Detaches a behavior from the component. | yii\base\Component |
| detachBehaviors() | Detaches all behaviors from the component. | yii\base\Component |
| end() | Ends a widget. | yii\base\Widget |
| ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\base\Component |
| getBehavior() | Returns the named behavior object. | yii\base\Component |
| getBehaviors() | Returns all behaviors attached to this component. | yii\base\Component |
| getId() | Returns the ID of the widget. | yii\base\Widget |
| getView() | Returns the view object that can be used to render views or view files. | yii\base\Widget |
| getViewPath() | Returns the directory containing the view files for this widget. | yii\base\Widget |
| hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. | yii\base\Component |
| hasMethod() | Returns a value indicating whether a method is defined. | yii\base\Component |
| hasProperty() | Returns a value indicating whether a property is defined for this component. | yii\base\Component |
| init() | Initializes the object. | yii\base\Widget |
| off() | Detaches an existing event handler from this component. | yii\base\Component |
| on() | Attaches an event handler to an event. | yii\base\Component |
| render() | Renders a view. | yii\base\Widget |
| renderFile() | Renders a view file. | yii\base\Widget |
| run() | yii\console\widgets\Table | |
| setChars() | Set table chars. | yii\console\widgets\Table |
| setHeaders() | Set table headers. | yii\console\widgets\Table |
| setId() | Sets the ID of the widget. | yii\base\Widget |
| setListPrefix() | Set list prefix. | yii\console\widgets\Table |
| setRows() | Set table rows. | yii\console\widgets\Table |
| setScreenWidth() | Set screen width. | yii\console\widgets\Table |
| setView() | Sets the view object to be used by this widget. | yii\base\Widget |
| trigger() | Triggers an event. | yii\base\Component |
| widget() | Creates a widget instance and runs it. | yii\base\Widget |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| calculateRowHeight() | Calculate the height of a row. | yii\console\widgets\Table |
| calculateRowsSize() | Calculate the size of rows to draw anchor of columns in console. | yii\console\widgets\Table |
| getScreenWidth() | Getting screen width. | yii\console\widgets\Table |
| renderRow() | Renders a row of data into a string. | yii\console\widgets\Table |
| renderSeparator() | Renders separator. | yii\console\widgets\Table |
Events
| Event | Type | Description | Defined By |
|---|---|---|---|
| EVENT_AFTER_RUN | yii\base\WidgetEvent | An event raised right after executing a widget. (available since version 2.0.11) | yii\base\Widget |
| EVENT_BEFORE_RUN | yii\base\WidgetEvent | An event raised right before executing a widget. (available since version 2.0.11) | yii\base\Widget |
| EVENT_INIT | yii\base\Event | An event that is triggered when the widget is initialized via init(). (available since version 2.0.11) | yii\base\Widget |
Constants
| Constant | Value | Description | Defined By |
|---|---|---|---|
| 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
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 => '│']
Table column widths
Table headers
List prefix
Table rows
Screen width
Method Details
Calculate the height of a row.
See also yii\console\widgets\Table::render().
| protected integer calculateRowHeight ( $row ) | ||
| $row | array | |
| return | integer | Maximum row per cell |
|---|---|---|
Calculate the size of rows to draw anchor of columns in console.
See also yii\console\widgets\Table::render().
| protected void calculateRowsSize ( ) |
Getting screen width.
If it is not able to determine screen width, default value 123 will be set.
| protected integer getScreenWidth ( ) | ||
| return | integer | Screen width |
|---|---|---|
Renders a row of data into a string.
See also yii\console\widgets\Table::render().
| protected string renderRow ( array $row, $spanLeft, $spanMiddle, $spanRight ) | ||
| $row | array | Row of data |
| $spanLeft | string | Character for left border |
| $spanMiddle | string | Character for middle border |
| $spanRight | string | Character for right border |
Renders separator.
See also yii\console\widgets\Table::render().
| protected string renderSeparator ( $spanLeft, $spanMid, $spanMidMid, $spanRight ) | ||
| $spanLeft | string | Character for left border |
| $spanMid | string | Character for middle border |
| $spanMidMid | string | Character for middle-middle border |
| $spanRight | string | Character for right border |
| return | string | The generated separator row |
|---|---|---|
| public string run ( ) | ||
| return | string | The rendered table |
|---|---|---|
Set table chars.
| public $this setChars ( array $chars ) | ||
| $chars | array | Table chars |
Set table headers.
| public $this setHeaders ( array $headers ) | ||
| $headers | array | Table headers |
Set list prefix.
| public $this setListPrefix ( $listPrefix ) | ||
| $listPrefix | string | List prefix |
Set table rows.
| public $this setRows ( array $rows ) | ||
| $rows | array | Table rows |
Set screen width.
| public $this setScreenWidth ( $width ) | ||
| $width | integer | Screen width |
Signup or Login in order to comment.