Class yii\grid\DataColumn

All Classes | Properties | Methods
Inheritanceyii\grid\DataColumn » yii\grid\Column » yii\base\BaseObject
Implementsyii\base\Configurable
Available since version2.0
Source Code https://github.com/yiisoft/yii2/blob/master/framework/grid/DataColumn.php

DataColumn is the default column type for the yii\grid\GridView widget.

It is used to show data columns and allows sorting and filtering them.

A simple data column definition refers to an attribute in the data model of the GridView's data provider. The name of the attribute is specified by $attribute.

By setting $value and $label, the header and cell content can be customized.

A data column differentiates between the data cell value and the data cell content. The cell value is an un-formatted value that may be used for calculation, while the actual cell content is a formatted version of that value which may contain HTML markup.

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

Public Properties

Hide inherited properties

Property Type Description Defined By
$attribute string The attribute name associated with this column. yii\grid\DataColumn
$content callable This is a callable that will be used to generate the content of each cell. yii\grid\Column
$contentOptions array|Closure The HTML attributes for the data cell tag. yii\grid\Column
$enableSorting boolean Whether to allow sorting by this column. yii\grid\DataColumn
$encodeLabel boolean Whether the header label should be HTML-encoded. yii\grid\DataColumn
$filter string|array|null|false The HTML code representing a filter input (e.g. a text field, a dropdown list) that is used for this data column. yii\grid\DataColumn
$filterAttribute string|null The attribute name of the yii\grid\GridView::$filterModel associated with this column. yii\grid\DataColumn
$filterInputOptions array The HTML attributes for the filter input fields. yii\grid\DataColumn
$filterOptions array The HTML attributes for the filter cell tag. yii\grid\Column
$footer string The footer cell content. yii\grid\Column
$footerOptions array The HTML attributes for the footer cell tag. yii\grid\Column
$format string|array|Closure In which format should the value of each data model be displayed as (e.g. "raw", "text", "html", ['date', 'php:Y-m-d']). yii\grid\DataColumn
$grid yii\grid\GridView The grid view object that owns this column. yii\grid\Column
$header string|null The header cell content. yii\grid\Column
$headerOptions array The HTML attributes for the header cell tag. yii\grid\Column
$label string|null Label to be displayed in the header cell and also to be used as the sorting link label when sorting is enabled for this column. yii\grid\DataColumn
$options array The HTML attributes for the column group tag. yii\grid\Column
$sortLinkOptions array The HTML attributes for the link tag in the header cell generated by yii\data\Sort::link() when sorting is enabled for this column. yii\grid\DataColumn
$value string|Closure|null An anonymous function or a string that is used to determine the value to display in the current column. yii\grid\DataColumn
$visible boolean Whether this column is visible. yii\grid\Column

Public Methods

Hide inherited methods

Method Description Defined By
__call() Calls the named method which is not a class method. yii\base\BaseObject
__construct() Constructor. yii\base\BaseObject
__get() Returns the value of an object property. yii\base\BaseObject
__isset() Checks if a property is set, i.e. defined and not null. yii\base\BaseObject
__set() Sets value of an object property. yii\base\BaseObject
__unset() Sets an object property to null. yii\base\BaseObject
canGetProperty() Returns a value indicating whether a property can be read. yii\base\BaseObject
canSetProperty() Returns a value indicating whether a property can be set. yii\base\BaseObject
className() Returns the fully qualified name of this class. yii\base\BaseObject
getDataCellValue() Returns the data cell value. yii\grid\DataColumn
hasMethod() Returns a value indicating whether a method is defined. yii\base\BaseObject
hasProperty() Returns a value indicating whether a property is defined. yii\base\BaseObject
init() Initializes the object. yii\grid\DataColumn
renderDataCell() Renders a data cell. yii\grid\Column
renderFilterCell() Renders the filter cell. yii\grid\Column
renderFooterCell() Renders the footer cell. yii\grid\Column
renderHeaderCell() Renders the header cell. yii\grid\Column

Protected Methods

Hide inherited methods

Method Description Defined By
getHeaderCellLabel() Returns header cell label. yii\grid\DataColumn
renderDataCellContent() Renders the data cell content. yii\grid\DataColumn
renderFilterCellContent() Renders the filter cell content. yii\grid\DataColumn
renderFooterCellContent() Renders the footer cell content. yii\grid\Column
renderHeaderCellContent() Renders the header cell content. yii\grid\DataColumn

Property Details

Hide inherited properties

$attribute public property

The attribute name associated with this column. When neither $content nor $value is specified, the value of the specified attribute will be retrieved from each data model and displayed.

Also, if $label is not specified, the label associated with the attribute will be displayed.

public string $attribute = null
$enableSorting public property

Whether to allow sorting by this column. If true and $attribute is found in the sort definition of yii\grid\GridView::$dataProvider, then the header cell of this column will contain a link that may trigger the sorting when being clicked.

public boolean $enableSorting = true
$encodeLabel public property (available since version 2.0.1)

Whether the header label should be HTML-encoded.

See also $label.

public boolean $encodeLabel = true
$filter public property

The HTML code representing a filter input (e.g. a text field, a dropdown list) that is used for this data column. This property is effective only when yii\grid\GridView::$filterModel is set.

  • If this property is not set, a text field will be generated as the filter input with attributes defined with $filterInputOptions. See yii\helpers\BaseHtml::activeInput() for details on how an active input tag is generated.
  • If this property is an array, a dropdown list will be generated that uses this property value as the list options.
  • If you don't want a filter for this data column, set this value to be false.
public string|array|null|false $filter = null
$filterAttribute public property (available since version 2.0.41)

The attribute name of the yii\grid\GridView::$filterModel associated with this column. If not set, will have the same value as $attribute.

public string|null $filterAttribute = null
$filterInputOptions public property

The HTML attributes for the filter input fields. This property is used in combination with the $filter property. When $filter is not set or is an array, this property will be used to render the HTML attributes for the generated filter input fields.

Empty id in the default value ensures that id would not be obtained from the model attribute thus providing better performance.

See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.

public array $filterInputOptions = [
    'class' => 'form-control',
    'id' => null,
]
$format public property

In which format should the value of each data model be displayed as (e.g. "raw", "text", "html", ['date', 'php:Y-m-d']). Supported formats are determined by the formatter used by the yii\grid\GridView. Default format is "text" which will format the value as an HTML-encoded plain text when yii\i18n\Formatter is used as the formatter of the GridView.

See also yii\i18n\Formatter::format().

public string|array|Closure $format = 'text'
$label public property

Label to be displayed in the header cell and also to be used as the sorting link label when sorting is enabled for this column. If it is not set and the models provided by the GridViews data provider are instances of yii\db\ActiveRecord, the label will be determined using yii\db\ActiveRecord::getAttributeLabel(). Otherwise yii\helpers\Inflector::camel2words() will be used to get a label.

public string|null $label = null
$sortLinkOptions public property

The HTML attributes for the link tag in the header cell generated by yii\data\Sort::link() when sorting is enabled for this column.

See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.

public array $sortLinkOptions = []
$value public property

An anonymous function or a string that is used to determine the value to display in the current column.

If this is an anonymous function, it will be called for each row and the return value will be used as the value to display for every data model. The signature of this function should be: function ($model, $key, $index, $column). Where $model, $key, and $index refer to the model, key and index of the row currently being rendered and $column is a reference to the yii\grid\DataColumn object.

You may also set this property to a string representing the attribute name to be displayed in this column. This can be used when the attribute to be displayed is different from the $attribute that is used for sorting and filtering.

If this is not set, $model[$attribute] will be used to obtain the value, where $attribute is the value of $attribute.

public string|Closure|null $value = null

Method Details

Hide inherited methods

__call() public method

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

Calls the named method which is not a class method.

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

 

                public function __call($name, $params)
{
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
__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

 

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

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

Returns the value of an object property.

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

See also __set().

public mixed __get ( $name )
$name string

The property name
return mixed

The property value
throws yii\base\UnknownPropertyException

if the property is not defined
throws yii\base\InvalidCallException

if the property is write-only

 

                public function __get($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter();
    } elseif (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\BaseObject::__isset()

Checks if a property is set, i.e. defined and not null.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing isset($object->property).

Note that if the property is not defined, false will be returned.

See also https://www.php.net/manual/en/function.isset.php.

public boolean __isset ( $name )
$name string

The property name or the event name
return boolean

Whether the named property is set (not null).

 

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    return false;
}
__set() public method

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

Sets value of an object property.

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

See also __get().

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 function __set($name, $value)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter($value);
    } elseif (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    } else {
        throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
    }
}
__unset() public method

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

Sets an object property to null.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing unset($object->property).

Note that if the property is not defined, this method will do nothing. If the property is read-only, it will throw an exception.

See also https://www.php.net/manual/en/function.unset.php.

public void __unset ( $name )
$name string

The property name
throws yii\base\InvalidCallException

if the property is read only.

 

                public function __unset($name)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter(null);
    } elseif (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Unsetting read-only property: ' . get_class($this) . '::' . $name);
    }
}
canGetProperty() public method

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

Returns a value indicating whether a property can be read.

A property is readable if:

  • the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);

See also canSetProperty().

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

The property name
$checkVars boolean

Whether to treat member variables as properties
return boolean

Whether the property can be read

 

                public function canGetProperty($name, $checkVars = true)
{
    return method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name);
}
canSetProperty() public method

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

Returns a value indicating whether a property can be set.

A property is writable if:

  • the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);

See also canGetProperty().

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

The property name
$checkVars boolean

Whether to treat member variables as properties
return boolean

Whether the property can be written

 

                public function canSetProperty($name, $checkVars = true)
{
    return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}
className() public static method
Deprecated since 2.0.14. On PHP >=5.5, use ::class instead.

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

Returns the fully qualified name of this class.

public static string className ( )
return string

The fully qualified name of this class.

 

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

Returns the data cell value.

public string getDataCellValue ( $model, $key, $index )
$model mixed

The data model
$key mixed

The key associated with the data model
$index integer

The zero-based index of the data model among the models array returned by yii\grid\GridView::$dataProvider.
return string

The data cell value

 

                public function getDataCellValue($model, $key, $index)
{
    if ($this->value !== null) {
        if (is_string($this->value)) {
            return ArrayHelper::getValue($model, $this->value);
        }
        return call_user_func($this->value, $model, $key, $index, $this);
    } elseif ($this->attribute !== null) {
        return ArrayHelper::getValue($model, $this->attribute);
    }
    return null;
}
getHeaderCellLabel() protected method (available since version 2.0.8)

Returns header cell label.

This method may be overridden to customize the label of the header cell.

protected string getHeaderCellLabel ( )
return string

Label

 

                protected function getHeaderCellLabel()
{
    $provider = $this->grid->dataProvider;
    if ($this->label === null) {
        if ($this->attribute === null) {
            $label = '';
        } elseif ($provider instanceof ActiveDataProvider && $provider->query instanceof ActiveQueryInterface) {
            /* @var $modelClass Model */
            $modelClass = $provider->query->modelClass;
            $model = $modelClass::instance();
            $label = $model->getAttributeLabel($this->attribute);
        } elseif ($provider instanceof ArrayDataProvider && $provider->modelClass !== null) {
            /* @var $modelClass Model */
            $modelClass = $provider->modelClass;
            $model = $modelClass::instance();
            $label = $model->getAttributeLabel($this->attribute);
        } elseif ($this->grid->filterModel !== null && $this->grid->filterModel instanceof Model) {
            $label = $this->grid->filterModel->getAttributeLabel($this->filterAttribute);
        } else {
            $models = $provider->getModels();
            if (($model = reset($models)) instanceof Model) {
                /* @var $model Model */
                $label = $model->getAttributeLabel($this->attribute);
            } else {
                $label = Inflector::camel2words($this->attribute);
            }
        }
    } else {
        $label = $this->label;
    }
    return $label;
}
hasMethod() public method

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

Returns a value indicating whether a method is defined.

The default implementation is a call to php function method_exists(). You may override this method when you implemented the php magic method __call().

public boolean hasMethod ( $name )
$name string

The method name
return boolean

Whether the method is defined

 

                public function hasMethod($name)
{
    return method_exists($this, $name);
}
hasProperty() public method

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

Returns a value indicating whether a property is defined.

A property is defined if:

  • the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);

See also:

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

The property name
$checkVars boolean

Whether to treat member variables as properties
return boolean

Whether the property is defined

 

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

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

public void init ( )

                public function init()
{
    parent::init();
    if ($this->filterAttribute === null) {
        $this->filterAttribute = $this->attribute;
    }
}
renderDataCell() public method

Defined in: yii\grid\Column::renderDataCell()

Renders a data cell.

public string renderDataCell ( $model, $key, $index )
$model mixed

The data model being rendered
$key mixed

The key associated with the data model
$index integer

The zero-based index of the data item among the item array returned by yii\grid\GridView::$dataProvider.
return string

The rendering result

 

                public function renderDataCell($model, $key, $index)
{
    if ($this->contentOptions instanceof Closure) {
        $options = call_user_func($this->contentOptions, $model, $key, $index, $this);
    } else {
        $options = $this->contentOptions;
    }
    return Html::tag('td', $this->renderDataCellContent($model, $key, $index), $options);
}
renderDataCellContent() protected method

Renders the data cell content.

protected string renderDataCellContent ( $model, $key, $index )
$model mixed

The data model
$key mixed

The key associated with the data model
$index integer

The zero-based index of the data model among the models array returned by yii\grid\GridView::$dataProvider.
return string

The rendering result

 

                protected function renderDataCellContent($model, $key, $index)
{
    if ($this->content === null) {
        return $this->grid->formatter->format($this->getDataCellValue($model, $key, $index), $this->format);
    }
    return parent::renderDataCellContent($model, $key, $index);
}
renderFilterCell() public method

Defined in: yii\grid\Column::renderFilterCell()

Renders the filter cell.

public void renderFilterCell ( )

                public function renderFilterCell()
{
    return Html::tag('td', $this->renderFilterCellContent(), $this->filterOptions);
}
renderFilterCellContent() protected method

Renders the filter cell content.

The default implementation simply renders a space. This method may be overridden to customize the rendering of the filter cell (if any).

protected string renderFilterCellContent ( )
return string

The rendering result

 

                protected function renderFilterCellContent()
{
    if (is_string($this->filter)) {
        return $this->filter;
    }
    $model = $this->grid->filterModel;
    if ($this->filter !== false && $model instanceof Model && $this->filterAttribute !== null && $model->isAttributeActive($this->filterAttribute)) {
        if ($model->hasErrors($this->filterAttribute)) {
            Html::addCssClass($this->filterOptions, 'has-error');
            $error = ' ' . Html::error($model, $this->filterAttribute, $this->grid->filterErrorOptions);
        } else {
            $error = '';
        }
        if (is_array($this->filter)) {
            $options = array_merge(['prompt' => '', 'strict' => true], $this->filterInputOptions);
            return Html::activeDropDownList($model, $this->filterAttribute, $this->filter, $options) . $error;
        } elseif ($this->format === 'boolean') {
            $options = array_merge(['prompt' => '', 'strict' => true], $this->filterInputOptions);
            return Html::activeDropDownList($model, $this->filterAttribute, [
                1 => $this->grid->formatter->booleanFormat[1],
                0 => $this->grid->formatter->booleanFormat[0],
            ], $options) . $error;
        }
        $options = array_merge(['maxlength' => true], $this->filterInputOptions);
        return Html::activeTextInput($model, $this->filterAttribute, $options) . $error;
    }
    return parent::renderFilterCellContent();
}
renderFooterCell() public method

Defined in: yii\grid\Column::renderFooterCell()

Renders the footer cell.

public void renderFooterCell ( )

                public function renderFooterCell()
{
    return Html::tag('td', $this->renderFooterCellContent(), $this->footerOptions);
}
renderFooterCellContent() protected method

Defined in: yii\grid\Column::renderFooterCellContent()

Renders the footer cell content.

The default implementation simply renders $footer. This method may be overridden to customize the rendering of the footer cell.

protected string renderFooterCellContent ( )
return string

The rendering result

 

                protected function renderFooterCellContent()
{
    return $this->footer !== null && trim($this->footer) !== '' ? $this->footer : $this->grid->emptyCell;
}
renderHeaderCell() public method

Defined in: yii\grid\Column::renderHeaderCell()

Renders the header cell.

public void renderHeaderCell ( )

                public function renderHeaderCell()
{
    return Html::tag('th', $this->renderHeaderCellContent(), $this->headerOptions);
}
renderHeaderCellContent() protected method

Renders the header cell content.

The default implementation simply renders $header. This method may be overridden to customize the rendering of the header cell.

protected string renderHeaderCellContent ( )
return string

The rendering result

 

                protected function renderHeaderCellContent()
{
    if ($this->header !== null || $this->label === null && $this->attribute === null) {
        return parent::renderHeaderCellContent();
    }
    $label = $this->getHeaderCellLabel();
    if ($this->encodeLabel) {
        $label = Html::encode($label);
    }
    if (
        $this->attribute !== null && $this->enableSorting &&
        ($sort = $this->grid->dataProvider->getSort()) !== false && $sort->hasAttribute($this->attribute)
    ) {
        return $sort->link($this->attribute, array_merge($this->sortLinkOptions, ['label' => $label]));
    }
    return $label;
}