Home » Documentation » Class Reference » CDataColumn

CDataColumn

Package	zii.widgets.grid
Inheritance	class CDataColumn » CGridColumn » CComponent
Since	1.1
Version	$Id: CDataColumn.php 194 2010-06-25 00:51:58Z qiang.xue $

CDataColumn represents a grid view column that is associated with a data attribute or expression.

Either name or value should be specified. The former specifies a data attribute name, while the latter a PHP expression whose value should be rendered instead.

The property sortable determines whether the grid view can be sorted according to this column. Note that the name should always be set if the column needs to be sortable. The name value will be used by CSort to render a clickable link in the header cell to trigger the sorting.

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
cssClassExpression	string	a PHP expression that is evaluated for every data cell and whose result is used as the CSS class name for the data cell.	CGridColumn
filter	mixed	the HTML code representing a filter input (e.	CDataColumn
footer	string	the footer cell text.	CGridColumn
footerHtmlOptions	array	the HTML options for the footer cell tag.	CGridColumn
grid	CGridView	the grid view object that owns this column.	CGridColumn
hasFooter	boolean	whether this column has a footer cell.	CGridColumn
header	string	the header cell text.	CGridColumn
headerHtmlOptions	array	the HTML options for the header cell tag.	CGridColumn
htmlOptions	array	the HTML options for the data cell tags.	CGridColumn
id	string	the ID of this column.	CGridColumn
name	string	the attribute name of the data model.	CDataColumn
sortable	boolean	whether the column is sortable.	CDataColumn
type	string	the type of the attribute value.	CDataColumn
value	string	a PHP expression that will be evaluated for every data cell and whose result will be rendered as the content of the data cells.	CDataColumn
visible	boolean	whether this column is visible.	CGridColumn

Public Methods

Hide inherited methods

Method	Description	Defined By
__call()	Calls the named method which is not a class method.	CComponent
__construct()	Constructor.	CGridColumn
__get()	Returns a property value, an event handler list or a behavior based on its name.	CComponent
__isset()	Checks if a property value is null.	CComponent
__set()	Sets value of a component property.	CComponent
__unset()	Sets a component property to be null.	CComponent
asa()	Returns the named behavior object.	CComponent
attachBehavior()	Attaches a behavior to this component.	CComponent
attachBehaviors()	Attaches a list of behaviors to the component.	CComponent
attachEventHandler()	Attaches an event handler to an event.	CComponent
canGetProperty()	Determines whether a property can be read.	CComponent
canSetProperty()	Determines whether a property can be set.	CComponent
detachBehavior()	Detaches a behavior from the component.	CComponent
detachBehaviors()	Detaches all behaviors from the component.	CComponent
detachEventHandler()	Detaches an existing event handler.	CComponent
disableBehavior()	Disables an attached behavior.	CComponent
disableBehaviors()	Disables all behaviors attached to this component.	CComponent
enableBehavior()	Enables an attached behavior.	CComponent
enableBehaviors()	Enables all behaviors attached to this component.	CComponent
evaluateExpression()	Evaluates a PHP expression or callback under the context of this component.	CComponent
getEventHandlers()	Returns the list of attached event handlers for an event.	CComponent
getHasFooter()		CGridColumn
hasEvent()	Determines whether an event is defined.	CComponent
hasEventHandler()	Checks whether the named event has attached handlers.	CComponent
hasProperty()	Determines whether a property is defined.	CComponent
init()	Initializes the column.	CDataColumn
raiseEvent()	Raises an event.	CComponent
renderDataCell()	Renders a data cell.	CGridColumn
renderFilterCell()	Renders the filter cell.	CGridColumn
renderFooterCell()	Renders the footer cell.	CGridColumn
renderHeaderCell()	Renders the header cell.	CGridColumn

Protected Methods

Hide inherited methods

Method	Description	Defined By
renderDataCellContent()	Renders the data cell content.	CDataColumn
renderFilterCellContent()	Renders the filter cell content.	CDataColumn
renderFooterCellContent()	Renders the footer cell content.	CGridColumn
renderHeaderCellContent()	Renders the header cell content.	CDataColumn

Property Details

filter property (available since v1.1.1)

public mixed $filter;

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 CGridView::enableFiltering is set true. If this property is not set, a text field will be generated as the filter input; If this property is an array, a dropdown list will be generated that uses this property value as the list options.

name property

public string $name;

the attribute name of the data model. The corresponding attribute value will be rendered in each data cell. If value is specified, this property will be ignored unless the column needs to be sortable.

Method Details

init() method

public void init()

Initializes the column.

renderDataCellContent() method

protected void renderDataCellContent(integer $row, mixed $data)
$row	integer	the row number (zero-based)
$data	mixed	the data associated with the row

Renders the data cell content. This method evaluates value or name and renders the result.

renderFilterCellContent() method (available since v1.1.1)

protected void renderFilterCellContent()

Renders the filter cell content. This method will render the filter as is if it is a string. If filter is an array, it is assumed to be a list of options, and a dropdown selector will be rendered. Otherwise if filter is not false, a text field is rendered.

renderHeaderCellContent() method

protected void renderHeaderCellContent()

Renders the header cell content. This method will render a link that can trigger the sorting if the column is sortable.

Total 2 comments:

#1355

typo

by donnut at 4:00am on April 6, 2010.

the layout of the filter and footer properties seem to be misformed.

#1684

conditional statements inside of 'value'

by edwaa at 7:10am on July 15, 2010.

use the shorthand if-statement notation

expr ? true-expr : false-expr