CDetailView

$this->widget('zii.widgets.CDetailView', array(
    'data'=>$model,
    'attributes'=>array(
        'title',             // title attribute (in plain text)
        'owner.name',        // an attribute of the related object "owner"
        'description:html',  // description attribute in HTML
        array(               // related city displayed as a link
            'label'=>'City',
            'type'=>'raw',
            'value'=>CHtml::link(CHtml::encode($model->city->name),
                                 array('city/view','id'=>$model->city->id)),
        ),
    ),
));

Property Details

attributes property

public array $attributes;

a list of attributes to be displayed in the detail view. Each array element represents the specification for displaying one particular attribute.

An attribute can be specified as a string in the format of "Name:Type:Label". Both "Type" and "Label" are optional.

"Name" refers to the attribute name. It can be either a property (e.g. "title") or a sub-property (e.g. "owner.username").

"Label" represents the label for the attribute display. If it is not given, "Name" will be used to generate the appropriate label.

"Type" represents the type of the attribute. It determines how the attribute value should be formatted and displayed. It is defaulted to be 'text'. "Type" should be recognizable by the formatter. In particular, if "Type" is "xyz", then the "formatXyz" method of formatter will be invoked to format the attribute value for display. By default when CFormatter is used, these "Type" values are valid: raw, text, ntext, html, date, time, datetime, boolean, number, email, image, url. For more details about these types, please refer to CFormatter.

An attribute can also be specified in terms of an array with the following elements:

• label: the label associated with the attribute. If this is not specified, the following "name" element will be used to generate an appropriate label.
• name: the name of the attribute. This can be either a property or a sub-property of the model. If the below "value" element is specified, this will be ignored.
• value: the value to be displayed. If this is not specified, the above "name" element will be used to retrieve the corresponding attribute value for display. Note that this value will be formatted according to the "type" option as described below. This can also be an anonymous function whose return value will be used as a value. The signature of the function should be function($data) where data refers to the data property of the detail view widget.
• type: the type of the attribute that determines how the attribute value would be formatted. Please see above for possible values.
• cssClass: the CSS class to be used for this item. This option is available since version 1.1.3.
• template: the template used to render the attribute. If this is not specified, itemTemplate will be used instead. For more details on how to set this option, please refer to itemTemplate. This option is available since version 1.1.1.
• visible: whether the attribute is visible. If set to false, the table row for the attribute will not be rendered. This option is available since version 1.1.5.

baseScriptUrl property

public string $baseScriptUrl;

the base script URL for all detail view resources (e.g. javascript, CSS file, images). Defaults to null, meaning using the integrated detail view resources (which are published as assets).

cssFile property

public string $cssFile;

the URL of the CSS file used by this detail view. Defaults to null, meaning using the integrated CSS file. If this is set false, you are responsible to explicitly include the necessary CSS file in your page.

data property

public mixed $data;

the data model whose details are to be displayed. This can be either a CModel instance (e.g. a CActiveRecord object or a CFormModel object) or an associative array.

formatter property

public CFormatter getFormatter()
public void setFormatter(CFormatter $value)

the formatter instance. Defaults to the 'format' application component.

htmlOptions property

public array $htmlOptions;

the HTML options used for tagName

itemCssClass property

public array $itemCssClass;

the CSS class names for the items displaying attribute values. If multiple CSS class names are given, they will be assigned to the items sequentially and repeatedly. Defaults to array('odd', 'even').

itemTemplate property

public string $itemTemplate;

the template used to render a single attribute. Defaults to a table row. These tokens are recognized: "{class}", "{label}" and "{value}". They will be replaced with the CSS class name for the item, the label and the attribute value, respectively.

nullDisplay property

public string $nullDisplay;

the text to be displayed when an attribute value is null. Defaults to "Not set".

tagName property

public string $tagName;

the name of the tag for rendering the detail view. Defaults to 'table'. If set to null, no tag will be rendered.

Method Details

getFormatter() method

public CFormatter getFormatter()

public function getFormatter()
{
    if($this->_formatter===null)
        $this->_formatter=Yii::app()->format;
    return $this->_formatter;
}

init() method

public void init()

public function init()
{
    if($this->data===null)
        throw new CException(Yii::t('zii','Please specify the "data" property.'));
    if($this->attributes===null)
    {
        if($this->data instanceof CModel)
            $this->attributes=$this->data->attributeNames();
        elseif(is_array($this->data))
            $this->attributes=array_keys($this->data);
        else
            throw new CException(Yii::t('zii','Please specify the "attributes" property.'));
    }
    if($this->nullDisplay===null)
        $this->nullDisplay='<span class="null">'.Yii::t('zii','Not set').'</span>';
    if(isset($this->htmlOptions['id']))
        $this->id=$this->htmlOptions['id'];
    else
        $this->htmlOptions['id']=$this->id;

    if($this->baseScriptUrl===null)
        $this->baseScriptUrl=Yii::app()->getAssetManager()->publish(Yii::getPathOfAlias('zii.widgets.assets')).'/detailview';

    if($this->cssFile!==false)
    {
        if($this->cssFile===null)
            $this->cssFile=$this->baseScriptUrl.'/styles.css';
        Yii::app()->getClientScript()->registerCssFile($this->cssFile);
    }
}

Initializes the detail view. This method will initialize required property values.

renderItem() method (available since v1.1.11)

protected void renderItem(array $options, string $templateData)

protected function renderItem($options,$templateData)
{
    echo strtr(isset($options['template']) ? $options['template'] : $this->itemTemplate,$templateData);
}

This method is used by run() to render item row

run() method

public void run()

public function run()
{
    $formatter=$this->getFormatter();
    if ($this->tagName!==null)
        echo CHtml::openTag($this->tagName,$this->htmlOptions);

    $i=0;
    $n=is_array($this->itemCssClass) ? count($this->itemCssClass) : 0;

    foreach($this->attributes as $attribute)
    {
        if(is_string($attribute))
        {
            if(!preg_match('/^([\w\.]+)(:(\w*))?(:(.*))?$/',$attribute,$matches))
                throw new CException(Yii::t('zii','The attribute must be specified in the format of "Name:Type:Label", where "Type" and "Label" are optional.'));
            $attribute=array(
                'name'=>$matches[1],
                'type'=>isset($matches[3]) ? $matches[3] : 'text',
            );
            if(isset($matches[5]))
                $attribute['label']=$matches[5];
        }

        if(isset($attribute['visible']) && !$attribute['visible'])
            continue;

        $tr=array('{label}'=>'', '{class}'=>$n ? $this->itemCssClass[$i%$n] : '');
        if(isset($attribute['cssClass']))
            $tr['{class}']=$attribute['cssClass'].' '.($n ? $tr['{class}'] : '');

        if(isset($attribute['label']))
            $tr['{label}']=$attribute['label'];
        elseif(isset($attribute['name']))
        {
            if($this->data instanceof CModel)
                $tr['{label}']=$this->data->getAttributeLabel($attribute['name']);
            else
                $tr['{label}']=ucwords(trim(strtolower(str_replace(array('-','_','.'),' ',preg_replace('/(?<![A-Z])[A-Z]/', ' \0', $attribute['name'])))));
        }

        if(!isset($attribute['type']))
            $attribute['type']='text';
        if(isset($attribute['value']))
            $value=is_object($attribute['value']) && get_class($attribute['value']) === 'Closure' ? call_user_func($attribute['value'],$this->data) : $attribute['value'];
        elseif(isset($attribute['name']))
            $value=CHtml::value($this->data,$attribute['name']);
        else
            $value=null;

        $tr['{value}']=$value===null ? $this->nullDisplay : $formatter->format($value,$attribute['type']);

        $this->renderItem($attribute, $tr);

        $i++;
    }

    if ($this->tagName!==null)
        echo CHtml::closeTag($this->tagName);
}

Renders the detail view. This is the main entry of the whole detail view rendering.

setFormatter() method

public void setFormatter(CFormatter $value)

public function setFormatter($value)
{
    $this->_formatter=$value;
}