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

Подробное описание свойств

attributes свойство

public array $attributes;

список атрибутов, которые должны отображаться в представлении деталей. Каждый элемент массива представляет собой описание для отображения одного конкретного атрибута.

Атрибут можно указать как строку в формате "Имя:Тип:Метка". Оба "Тип" и "Метка" необязательны.

"Имя" относится к имени атрибута. Это может быть свойство (например, "title") или подсвойство (например, "owner.username").

"Метка" представляет собой метку для отображения атрибута. Если она не указана, будет использовано "Имя" для генерации соответствующей метки.

"Тип" представляет тип атрибута. Он определяет, как значение атрибута должно быть отформатировано и отображено. По умолчанию он равен 'text'. "Тип" должен быть распознаваем форматировщиком. В частности, если "Тип" равен "xyz", то метод "formatXyz" форматировщика будет вызван для форматирования значения атрибута для отображения. По умолчанию, когда используется CFormatter, допустимы следующие значения "Тип": raw, text, ntext, html, date, time, datetime, boolean, number, email, image, url. Дополнительные сведения об этих типах см. в CFormatter.

Атрибут также можно указать в виде массива со следующими элементами:

• метка: метка, связанная с атрибутом. Если она не указана, будет использовано следующее значение "имя" для генерации соответствующей метки.
• имя: имя атрибута. Это может быть свойство или подсвойство модели. Если ниже указан элемент "значение", этот элемент будет проигнорирован.
• значение: значение, подлежащее отображению. Если оно не указано, вышеуказанный элемент "имя" будет использован для получения соответствующего значения атрибута для отображения. Обратите внимание, что это значение будет отформатировано в соответствии с параметром "тип", как описано ниже. Это также может быть анонимная функция, возвращаемое значение которой будет использовано в качестве значения. Подпись функции должна быть function($data), где данные относятся к свойству данных виджета представления деталей.
• тип: тип атрибута, который определяет, как будет отформатировано значение атрибута. Возможные значения см. выше.
• cssClass: CSS-класс, который должен использоваться для этого элемента. Этот параметр доступен с версии 1.1.3.
• шаблон: шаблон, используемый для рендеринга атрибута. Если он не указан, будет использован itemTemplate. Дополнительные сведения о том, как задать этот параметр, см. в itemTemplate. Этот параметр доступен с версии 1.1.1.
• отображать: отображать ли атрибут. Если установлено значение false, строка таблицы для атрибута не будет рендериться. Этот параметр доступен с версии 1.1.5.

baseScriptUrl свойство

public string $baseScriptUrl;

базовый URL скрипта для всех ресурсов представления деталей (например, файлы javascript, CSS, изображения). По умолчанию null, что означает использование интегрированных ресурсов представления деталей (которые публикуются как ресурсы).

cssFile свойство

public string $cssFile;

URL файла CSS, используемого этим представлением деталей. По умолчанию null, что означает использование интегрированного файла CSS. Если это значение установлено в false, вы отвечаете за явное включение необходимого файла CSS в вашу страницу.

data свойство

public mixed $data;

модель данных, детали которой должны быть отображены. Это может быть экземпляр CModel (например, объект CActiveRecord или объект CFormModel) или ассоциативный массив.

formatter свойство

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

экземпляр форматировщика. По умолчанию компонент приложения 'format'.

htmlOptions свойство

public array $htmlOptions;

HTML-параметры, используемые для tagName

itemCssClass свойство

public array $itemCssClass;

имена CSS-классов для элементов, отображающих значения атрибутов. Если задано несколько имён CSS-классов, они будут присваиваться элементам последовательно и многократно. По умолчанию array('odd', 'even').

itemTemplate свойство

public string $itemTemplate;

шаблон, используемый для рендеринга отдельного атрибута. По умолчанию строка таблицы. Эти токены распознаются: "{class}", "{label}" и "{value}". Они будут заменены именем CSS-класса для элемента, меткой и значением атрибута соответственно.

nullDisplay свойство

public string $nullDisplay;

текст, который будет отображаться, когда значение атрибута равно null. По умолчанию "Не задано".

tagName свойство

public string $tagName;

имя тега для рендеринга представления деталей. По умолчанию 'table'. Если установлено в null, тег не будет рендериться.

Подробное описание методов

getFormatter() метод

public CFormatter getFormatter()

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

init() метод

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

Инициализирует представление деталей. Этот метод инициализирует необходимые значения свойств.

renderItem() метод (доступен с версии 1.1.11)

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

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

Этот метод используется методом run() для рендеринга строки элемента.

run() метод

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

Отображает представление деталей. Это главный вход для всего рендеринга представления деталей.

setFormatter() метод

public void setFormatter(CFormatter $value)

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