# Class yii\grid\Column

Inheritance | yii\grid\Column » yii\base\BaseObject
Implements | yii\base\Configurable
Subclasses | yii\grid\ActionColumn, yii\grid\CheckboxColumn, yii\grid\DataColumn, yii\grid\RadioButtonColumn, yii\grid\SerialColumn
Available since version | 2.0
Source Code | https://github.com/yiisoft/yii2/blob/master/framework/grid/Column.php

Column is the base class of all yii\grid\GridView column classes.

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

## Public Properties

Hide inherited properties

Property | Type | Description | Defined By
--- | --- | --- | ---
$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
$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
$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
$options | array | The HTML attributes for the column group tag. | yii\grid\Column
$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
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\base\BaseObject
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\Column
renderDataCellContent() | Renders the data cell content. | yii\grid\Column
renderFilterCellContent() | Renders the filter cell content. | yii\grid\Column
renderFooterCellContent() | Renders the footer cell content. | yii\grid\Column
renderHeaderCellContent() | Renders the header cell content. | yii\grid\Column

## Property Details

Hide inherited properties

$content public property

This is a callable that will be used to generate the content of each cell. The signature of the function should be the following: `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\Column object.

public callable $content = null
$contentOptions public property

The HTML attributes for the data cell tag. This can either be an array of attributes or an anonymous function (Closure) that returns such an array. The signature of the function should be the following: `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\Column object. A function may be used to assign different attributes to different rows based on the data in that row.

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

public array|Closure $contentOptions = []
$filterOptions public property

The HTML attributes for the filter cell tag.

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

public array $filterOptions = []
$footer public property

The footer cell content. Note that it will not be HTML-encoded.

public string $footer = null
$footerOptions public property

The HTML attributes for the footer cell tag.

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

public array $footerOptions = []
$grid public property

The grid view object that owns this column.

public yii\grid\GridView $grid = null
$header public property

The header cell content. Note that it will not be HTML-encoded.

public string|null $header = null
$headerOptions public property

The HTML attributes for the header cell tag.

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

public array $headerOptions = []
$options public property

The HTML attributes for the column group tag.

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

public array $options = []
$visible public property

Whether this column is visible. Defaults to true.

public boolean $visible = true

## 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

Source code

                    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

Source code

                    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

Source code

                    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).

Source code

                    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

Source code

                    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.

Source code

                    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

Source code

                    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

Source code

                    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.

Source code

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

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

Source code

                    protected function getHeaderCellLabel()
    {
        return $this->grid->emptyCell;
    }

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

Source code

                    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:

- canGetProperty()
- canSetProperty()

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

Source code

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

init() public method

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

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 ( )

Source code

                    public function init()
    {
    }

renderDataCell() public method

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

Source code

                    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

Source code

                    protected function renderDataCellContent($model, $key, $index)
    {
        if ($this->content !== null) {
            return call_user_func($this->content, $model, $key, $index, $this);
        }
        return $this->grid->emptyCell;
    }

renderFilterCell() public method

Renders the filter cell.

public void renderFilterCell ( )

Source code

                    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

Source code

                    protected function renderFilterCellContent()
    {
        return $this->grid->emptyCell;
    }

renderHeaderCell() public method

Renders the header cell.

public void renderHeaderCell ( )

Source code

                    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

Source code

                    protected function renderHeaderCellContent()
    {
        return $this->header !== null && trim($this->header) !== '' ? $this->header : $this->getHeaderCellLabel();
    }