Class yii\grid\GridView

All Classes | Properties | Methods | Events | Constants

Inheritance	yii\grid\GridView » yii\widgets\BaseListView » yii\base\Widget » yii\base\Component » yii\base\BaseObject
Implements	yii\base\Configurable, yii\base\ViewContextInterface
Available since version	2.0
****	https://github.com/yiisoft/yii2/blob/master/framework/grid/GridView.php

The GridView widget is used to display data in a grid.

It provides features like sorting, paging and also filtering the data.

A basic usage looks like the following:

php

<?= GridView::widget([
    'dataProvider' => $dataProvider,
    'columns' => [
        'id',
        'name',
        'created\_at:datetime',
        // ...
    ],
]) ?>

The columns of the grid table are configured in terms of yii\grid\Column classes, which are configured via $columns.

The look and feel of a grid view can be customized using the large amount of properties.

For more details and usage information on GridView, see the guide article on data widgets.

Public Properties

Property	Type	Description	Defined By
$afterRow	Closure	An anonymous function that is called once AFTER rendering each data model.	yii\grid\GridView
$autoIdPrefix	string	The prefix to the automatically generated widget IDs.	yii\base\Widget
$beforeRow	Closure	An anonymous function that is called once BEFORE rendering each data model.	yii\grid\GridView
$behaviors	yii\base\Behavior[]	List of behaviors attached to this component.	yii\base\Component
$caption	string	The caption of the grid table	yii\grid\GridView
$captionOptions	array	The HTML attributes for the caption element.	yii\grid\GridView
$columns	array	Grid column configuration.	yii\grid\GridView
$dataColumnClass	string	The default data column class if the class name is not explicitly specified when configuring a data column.	yii\grid\GridView
$dataProvider	yii\data\DataProviderInterface	The data provider for the view.	yii\widgets\BaseListView
$emptyCell	string	The HTML display when the content of a cell is empty.	yii\grid\GridView
$emptyText	string	false	The HTML content to be displayed when $dataProvider does not have any data.
$emptyTextOptions	array	The HTML attributes for the emptyText of the list view.	yii\widgets\BaseListView
$filterErrorOptions	array	The options for rendering every filter error message.	yii\grid\GridView
$filterErrorSummaryOptions	array	The options for rendering the filter error summary.	yii\grid\GridView
$filterModel	yii\base\Model	null	The model that keeps the user-entered filter data.
$filterOnFocusOut	boolean	Whatever to apply filters on losing focus.	yii\grid\GridView
$filterPosition	string	Whether the filters should be displayed in the grid view.	yii\grid\GridView
$filterRowOptions	array	The HTML attributes for the filter row element.	yii\grid\GridView
$filterSelector	string	Additional jQuery selector for selecting filter input fields	yii\grid\GridView
$filterUrl	string	array	null
$footerRowOptions	array	The HTML attributes for the table footer row.	yii\grid\GridView
$formatter	array	yii\i18n\Formatter	null
$headerRowOptions	array	The HTML attributes for the table header row.	yii\grid\GridView
$id	string	null	ID of the widget.
$layout	string	The layout that determines how different sections of the grid view should be organized.	yii\grid\GridView
$options	array	The HTML attributes for the container tag of the grid view.	yii\grid\GridView
$pager	array	The configuration for the pager widget.	yii\widgets\BaseListView
$placeFooterAfterBody	boolean	Whether to place footer after body in DOM if $showFooter is true	yii\grid\GridView
$rowOptions	array	Closure	The HTML attributes for the table body rows.
$showFooter	boolean	Whether to show the footer section of the grid table.	yii\grid\GridView
$showHeader	boolean	Whether to show the header section of the grid table.	yii\grid\GridView
$showOnEmpty	boolean	Whether to show the grid view if $dataProvider returns no data.	yii\grid\GridView
$sorter	array	The configuration for the sorter widget.	yii\widgets\BaseListView
$summary	string	The HTML content to be displayed as the summary of the list view.	yii\widgets\BaseListView
$summaryOptions	array	The HTML attributes for the summary of the list view.	yii\widgets\BaseListView
$tableOptions	array	The HTML attributes for the grid table element.	yii\grid\GridView
$view	yii\web\View	The view object that can be used to render views or view files.	yii\base\Widget
$viewPath	string	The directory containing the view files for this widget.	yii\base\Widget

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 grid view.	yii\grid\GridView
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
renderCaption()	Renders the caption element.	yii\grid\GridView
renderColumnGroup()	Renders the column group HTML.	yii\grid\GridView
renderEmpty()	Renders the HTML content indicating that the list view has no data.	yii\widgets\BaseListView
renderErrors()	Renders validator errors of filter model.	yii\grid\GridView
renderFile()	Renders a view file.	yii\base\Widget
renderFilters()	Renders the filter.	yii\grid\GridView
renderItems()	Renders the data models for the grid view.	yii\grid\GridView
renderPager()	Renders the pager.	yii\widgets\BaseListView
renderSection()	Renders a section of the specified name.	yii\grid\GridView
renderSorter()	Renders the sorter.	yii\widgets\BaseListView
renderSummary()	Renders the summary text.	yii\widgets\BaseListView
renderTableBody()	Renders the table body.	yii\grid\GridView
renderTableFooter()	Renders the table footer.	yii\grid\GridView
renderTableHeader()	Renders the table header.	yii\grid\GridView
renderTableRow()	Renders a table row with the given data model and key.	yii\grid\GridView
run()	Runs the widget.	yii\grid\GridView
setId()	Sets the ID of the widget.	yii\base\Widget
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
createDataColumn()	Creates a yii\grid\DataColumn object based on a string in the format of "attribute:format:label".	yii\grid\GridView
getClientOptions()	Returns the options for the grid view JS widget.	yii\grid\GridView
guessColumns()	This function tries to guess the columns to show from the given data if $columns are not explicitly specified.	yii\grid\GridView
initColumns()	Creates column objects and initializes them.	yii\grid\GridView

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	Defined By
FILTER_POS_BODY	'body'	yii\grid\GridView
FILTER_POS_FOOTER	'footer'	yii\grid\GridView
FILTER_POS_HEADER	'header'	yii\grid\GridView

Property Details

php

$afterRow public property

An anonymous function that is called once AFTER rendering each data model. It should have the similar signature as $rowOptions. The return result of the function will be rendered directly.

public Closure $afterRow = null

php

$beforeRow public property

An anonymous function that is called once BEFORE rendering each data model. It should have the similar signature as $rowOptions. The return result of the function will be rendered directly.

public Closure $beforeRow = null

php

$caption public property

The caption of the grid table

Method Details

php

__call() public method

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

Calls the named method which is not a class method.

This method will check if any attached behavior has the named method and will execute it if available.

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

public	mixed	__call ( $name, $params )
$name	string	The method name
$params	array	Method parameters
return	mixed	The method return value
throws	yii\base\UnknownMethodException	when calling unknown method

php

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()");
}

php

__clone() public method

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

This method is called after the object is created by cloning an existing one.

It removes all behaviors because they are attached to the old object.

public void __clone ( )

php

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

php

__construct() public method

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

Constructor.

The default implementation does two things:

Initializes the object with the given configuration $config.
Call init().

If this method is overridden in a child class, it is recommended that

the last parameter of the constructor is a configuration array, like $config here.
call the parent implementation at the end of the constructor.

public	void	__construct ( $config = [] )
$config	array	Name-value pairs that will be used to initialize the object properties

php

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

php

__get() public method

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

Returns the value of a component property.

This method will check in the following order and act accordingly:

a property defined by a getter: return the getter result
a property of a behavior: return the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $component->property;.

public	mixed	__get ( $name )
$name	string	The property name
return	mixed	The property value or the value of a behavior's property
throws	yii\base\UnknownPropertyException	if the property is not defined
throws	yii\base\InvalidCallException	if the property is write-only.

public	boolean	__isset ( $name )
$name	string	The property name or the event name
return	boolean	Whether the named property is set

public	void	__set ( $name, $value )
$name	string	The property name or the event name
$value	mixed	The property value
throws	yii\base\UnknownPropertyException	if the property is not defined
throws	yii\base\InvalidCallException	if the property is read-only.

public	void	__unset ( $name )
$name	string	The property name
throws	yii\base\InvalidCallException	if the property is read only.

public	mixed	afterRun ( $result )
$result	mixed	The widget return result.
return	mixed	The processed widget result.

public	yii\base\Behavior	attachBehavior ( $name, $behavior )
$name	string	The name of the behavior.
$behavior	string	array
return	yii\base\Behavior	The behavior object

public	void	attachBehaviors ( $behaviors )
$behaviors	array	List of behaviors to be attached to the component

public	boolean	beforeRun ( )
return	boolean	Whether the widget should continue to be executed.

public	array	behaviors ()
return	array	The behavior configurations.

public	boolean	canGetProperty ($name, $checkVars = true, $checkBehaviors = true)
$name	string	The property name
$checkVars	boolean	Whether to treat member variables as properties
$checkBehaviors	boolean	Whether to treat behaviors' properties as properties of this component
return	boolean	Whether the property can be read

public	boolean	canSetProperty ($name, $checkVars = true, $checkBehaviors = true)
$name	string	The property name
$checkVars	boolean	Whether to treat member variables as properties
$checkBehaviors	boolean	Whether to treat behaviors' properties as properties of this component
return	boolean	Whether the property can be written

public static	string	className ( )
return	string	The fully qualified name of this class.

protected	yii\grid\DataColumn	createDataColumn ( $text )
$text	string	The column specification string
return	yii\grid\DataColumn	The column instance
throws	yii\base\InvalidConfigException	if the column specification is invalid

$name	string	The behavior's name.
return	yii\base\Behavior`\`null	The detached behavior. Null if the behavior does not exist.

public	static	end ( )
return	yii\base\Widget	The widget instance that is ended.
throws	yii\base\InvalidCallException	if begin() and end() calls are not properly nested

$name	string	The behavior name
return	yii\base\Behavior`\`null	The behavior object, or null if the behavior does not exist

public	yii\base\Behavior[]	getBehaviors ()
return	yii\base\Behavior[]	List of behaviors attached to this component

protected	array	getClientOptions ()
return	array	The options

public	string`\`null	getId ( $autoGenerate = true )
$autoGenerate	boolean	Whether to generate an ID if it is not set previously
return	string`\`null	ID of the widget.

public	yii\web\View	getView ()
return	yii\web\View	The view object that can be used to render views or view files.

public	string	getViewPath ()
return	string	The directory containing the view files for this widget.

public	boolean	hasMethod ( $name, $checkBehaviors = true )
$name	string	The property name
$checkBehaviors	boolean	Whether to treat behaviors' methods as methods of this component
return	boolean	Whether the method is defined

public	boolean	hasProperty ( $name, $checkVars = true, $checkBehaviors = true )
$name	string	The property name
$checkVars	boolean	Whether to treat member variables as properties
$checkBehaviors	boolean	Whether to treat behaviors' properties as properties of this component
return	boolean	Whether the property is defined

public	boolean	off ( $name, $handler = null )
$name	string	Event name
$handler	callable	null
return	boolean	If a handler is found and detached

public	string	render ( $view, $params = [] )
$view	string	The view name.
$params	array	The parameters (name-value pairs) that should be made available in the view.
return	string	The rendering result.
throws	yii\base\InvalidArgumentException	if the view file does not exist.

public	boolean	string renderCaption ()
return	boolean`\`string	The rendered caption element or false if no caption element should be rendered.

public	boolean`\`string	renderColumnGroup ()
return	boolean	string

See also $emptyText.

public	string	renderEmpty ()
return	string	The rendering result

php

public function renderEmpty()
{
    if ($this->emptyText === false) {
        return '';
    }
    $options = $this->emptyTextOptions;
    $tag = ArrayHelper::remove($options, 'tag', 'div');
    return Html::tag($tag, $this->emptyText, $options);
}

php

renderErrors() public method

Renders validator errors of filter model.

public	string	renderErrors ()
return	string	The rendering result.

php

public function renderErrors()
{
    if ($this->filterModel instanceof Model && $this->filterModel->hasErrors()) {
        return Html::errorSummary($this->filterModel, $this->filterErrorSummaryOptions);
    }
    return '';
}

php

renderFile() public method

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

Renders a view file.

public	string	renderFile ( $file, $params = [] )
$file	string	The view file to be rendered. This can be either a file path or a path alias.
$params	array	The parameters (name-value pairs) that should be made available in the view.
return	string	The rendering result.
throws	yii\base\InvalidArgumentException	if the view file does not exist.

php

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

php

renderFilters() public method

Renders the filter.

public	string	renderFilters ()
return	string	The rendering result.

php

public function renderFilters()
{
    if ($this->filterModel !== null) {
        $cells = [];
        foreach ($this->columns as $column) {
            /\* @var $column Column \*/
            $cells[] = $column->renderFilterCell();
        }
        return Html::tag('tr', implode('', $cells), $this->filterRowOptions);
    }
    return '';
}

php

renderItems() public method

Renders the data models for the grid view.

public	string	renderItems ()
return	string	The HTML code of table

php

public function renderItems()
{
    $caption = $this->renderCaption();
    $columnGroup = $this->renderColumnGroup();
    $tableHeader = $this->showHeader ? $this->renderTableHeader() : false;
    $tableBody = $this->renderTableBody();
    $tableFooter = false;
    $tableFooterAfterBody = false;
    if ($this->showFooter) {
        if ($this->placeFooterAfterBody) {
            $tableFooterAfterBody = $this->renderTableFooter();
        } else {
            $tableFooter = $this->renderTableFooter();
        }
    }
    $content = array\_filter([
        $caption,
        $columnGroup,
        $tableHeader,
        $tableFooter,
        $tableBody,
        $tableFooterAfterBody,
    ]);
    return Html::tag('table', implode("\n", $content), $this->tableOptions);
}

php

renderPager() public method

Defined in: yii\widgets\BaseListView::renderPager()

Renders the pager.

public	string	renderPager ()
return	string	The rendering result

php

public function renderPager()
{
    $pagination = $this->dataProvider->getPagination();
    if ($pagination === false || $this->dataProvider->getCount() <= 0) {
        return '';
    }
    /\* @var $class LinkPager \*/
    $pager = $this->pager;
    $class = ArrayHelper::remove($pager, 'class', LinkPager::className());
    $pager['pagination'] = $pagination;
    $pager['view'] = $this->getView();
    return $class::widget($pager);
}

php

renderSection() public method

Renders a section of the specified name.

If the named section is not supported, false will be returned.

public	string`\`boolean	renderSection ( $name )
$name	string	The section name, e.g., {summary}, {items}.
return	string`\`boolean	The rendering result of the section, or false if the named section is not supported.

php

public function renderSection($name)
{
    switch ($name) {
        case '{errors}':
            return $this->renderErrors();
        default:
            return parent::renderSection($name);
    }
}

php

renderSorter() public method

Defined in: yii\widgets\BaseListView::renderSorter()

Renders the sorter.

public	string	renderSorter ()
return	string	The rendering result

php

public function renderSorter()
{
    $sort = $this->dataProvider->getSort();
    if ($sort === false || empty($sort->attributes) || $this->dataProvider->getCount() <= 0) {
        return '';
    }
    /\* @var $class LinkSorter \*/
    $sorter = $this->sorter;
    $class = ArrayHelper::remove($sorter, 'class', LinkSorter::className());
    $sorter['sort'] = $sort;
    $sorter['view'] = $this->getView();
    return $class::widget($sorter);
}

php

renderSummary() public method

Defined in: yii\widgets\BaseListView::renderSummary()

Renders the summary text.

public void renderSummary ( )

php

public function renderSummary()
{
    $count = $this->dataProvider->getCount();
    if ($count <= 0) {
        return '';
    }
    $summaryOptions = $this->summaryOptions;
    $tag = ArrayHelper::remove($summaryOptions, 'tag', 'div');
    if (($pagination = $this->dataProvider->getPagination()) !== false) {
        $totalCount = $this->dataProvider->getTotalCount();
        $begin = $pagination->getPage() \* $pagination->pageSize + 1;
        $end = $begin + $count - 1;
        if ($begin > $end) {
            $begin = $end;
        }
        $page = $pagination->getPage() + 1;
        $pageCount = $pagination->pageCount;
        if (($summaryContent = $this->summary) === null) {
            return Html::tag($tag, Yii::t('yii', 'Showing <b>{begin, number}-{end, number}</b> of <b>{totalCount, number}</b> {totalCount, plural, one{item} other{items}}.', [
                    'begin' => $begin,
                    'end' => $end,
                    'count' => $count,
                    'totalCount' => $totalCount,
                    'page' => $page,
                    'pageCount' => $pageCount,
                ]), $summaryOptions);
        }
    } else {
        $begin = $page = $pageCount = 1;
        $end = $totalCount = $count;
        if (($summaryContent = $this->summary) === null) {
            return Html::tag($tag, Yii::t('yii', 'Total <b>{count, number}</b> {count, plural, one{item} other{items}}.', [
                'begin' => $begin,
                'end' => $end,
                'count' => $count,
                'totalCount' => $totalCount,
                'page' => $page,
                'pageCount' => $pageCount,
            ]), $summaryOptions);
        }
    }
    if ($summaryContent === '') {
        return '';
    }
    return Html::tag($tag, Yii::$app->getI18n()->format($summaryContent, [
        'begin' => $begin,
        'end' => $end,
        'count' => $count,
        'totalCount' => $totalCount,
        'page' => $page,
        'pageCount' => $pageCount,
    ], Yii::$app->language), $summaryOptions);
}

php

renderTableBody() public method

Renders the table body.

public	string	renderTableBody ()
return	string	The rendering result.

php

public function renderTableBody()
{
    $models = array\_values($this->dataProvider->getModels());
    $keys = $this->dataProvider->getKeys();
    $rows = [];
    foreach ($models as $index => $model) {
        $key = $keys[$index];
        if ($this->beforeRow !== null) {
            $row = call\_user\_func($this->beforeRow, $model, $key, $index, $this);
            if (!empty($row)) {
                $rows[] = $row;
            }
        }
        $rows[] = $this->renderTableRow($model, $key, $index);
        if ($this->afterRow !== null) {
            $row = call\_user\_func($this->afterRow, $model, $key, $index, $this);
            if (!empty($row)) {
                $rows[] = $row;
            }
        }
    }
    if (empty($rows) && $this->emptyText !== false) {
        $colspan = count($this->columns);
        return "<tbody>\n<tr><td colspan=\"$colspan\">" . $this->renderEmpty() . "</td></tr>\n</tbody>";
    }
    return "<tbody>\n" . implode("\n", $rows) . "\n</tbody>";
}

php

renderTableFooter() public method

Renders the table footer.

public	string	renderTableFooter ()
return	string	The rendering result.

php

public function renderTableFooter()
{
    $cells = [];
    foreach ($this->columns as $column) {
        /\* @var $column Column \*/
        $cells[] = $column->renderFooterCell();
    }
    $content = Html::tag('tr', implode('', $cells), $this->footerRowOptions);
    if ($this->filterPosition === self::FILTER\_POS\_FOOTER) {
        $content .= $this->renderFilters();
    }
    return "<tfoot>\n" . $content . "\n</tfoot>";
}

php

renderTableHeader() public method

Renders the table header.

public	string	renderTableHeader ()
return	string	The rendering result.

php

public function renderTableHeader()
{
    $cells = [];
    foreach ($this->columns as $column) {
        /\* @var $column Column \*/
        $cells[] = $column->renderHeaderCell();
    }
    $content = Html::tag('tr', implode('', $cells), $this->headerRowOptions);
    if ($this->filterPosition === self::FILTER\_POS\_HEADER) {
        $content = $this->renderFilters() . $content;
    } elseif ($this->filterPosition === self::FILTER\_POS\_BODY) {
        $content .= $this->renderFilters();
    }
    return "<thead>\n" . $content . "\n</thead>";
}

php

renderTableRow() public method

Renders a table row with the given data model and key.

public	string	renderTableRow ( $model, $key, $index )
$model	mixed	The data model to be rendered
$key	mixed	The key associated with the data model
$index	integer	The zero-based index of the data model among the model array returned by $dataProvider.
return	string	The rendering result

php

public function renderTableRow($model, $key, $index)
{
    $cells = [];
    /\* @var $column Column \*/
    foreach ($this->columns as $column) {
        $cells[] = $column->renderDataCell($model, $key, $index);
    }
    if ($this->rowOptions instanceof Closure) {
        $options = call\_user\_func($this->rowOptions, $model, $key, $index, $this);
    } else {
        $options = $this->rowOptions;
    }
    $options['data-key'] = is\_array($key) ? json\_encode($key) : (string) $key;
    return Html::tag('tr', implode('', $cells), $options);
}

php

run() public method

Runs the widget.

public void run ( )

php

public function run()
{
    $view = $this->getView();
    GridViewAsset::register($view);
    $id = $this->options['id'];
    $options = Json::htmlEncode(array\_merge($this->getClientOptions(), ['filterOnFocusOut' => $this->filterOnFocusOut]));
    $view->registerJs("jQuery('#$id').yiiGridView($options);");
    parent::run();
}

php

setId() public method

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

Sets the ID of the widget.

public	void	setId ( $value )
$value	string	Id of the widget.

php

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

php

setView() public method

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

Sets the view object to be used by this widget.

public	void	setView ( $view )
$view	yii\base\View	The view object that can be used to render views or view files.

php

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

php

trigger() public method

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

Triggers an event.

This method represents the happening of an event. It invokes all attached handlers for the event including class-level handlers.

public	void	trigger ( $name, yii\base\Event $event = null )
$name	string	The event name
$event	yii\base\Event	null

php

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

php

widget() public static method

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

Creates a widget instance and runs it.

The widget rendering result is returned by this method.

public static	string	widget ( $config = [] )
$config	array	Name-value pairs that will be used to initialize the object properties
return	string	The rendering result of the widget.
throws	Throwable

php

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

Class yii\grid\GridView ​

Public Properties ​

Public Methods ​

Protected Methods ​

Events ​

Constants ​

Property Details ​

Method Details ​