Класс yii\widgets\DetailView

DetailView отображает детали одного элемента данных $model.

DetailView лучше всего использовать для отображения модели в стандартном формате (например, каждый атрибут модели отображается как строка в таблице.) Модель может быть экземпляром yii\base\Model или ассоциативным массивом.

DetailView использует свойство $attributes для определения, какие атрибуты модели должны быть отображены и как они должны быть отформатированы.

Типичное использование DetailView выглядит следующим образом:

echo DetailView::widget([
    'model' => $model,
    'attributes' => [
        'title',               // title attribute (in plain text)
        'description:html',    // description attribute in HTML
        [                      // the owner name of the model
            'label' => 'Owner',
            'value' => $model->owner->name,
        ],
        'created_at:datetime', // creation date formatted as datetime
    ],
]);

Для получения более подробной информации и руководства по использованию DetailView, ознакомьтесь со статьей руководства по виджетам вывода данных.

Публичные свойства

Публичные методы

Защищённые методы

События

Подробности свойств

$attributes public property

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

Атрибут может быть указан как строка в формате attribute, attribute:format или attribute:format:label, где attribute относится к имени атрибута, а format представляет формат атрибута. format передаётся методу yii\i18n\Formatter::format() для форматирования значения атрибута в отображаемый текст. Обратитесь к yii\i18n\Formatter за поддержанными типами. Как format, так и label являются необязательными. Они примут значения по умолчанию, если отсутствуют.

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

• attribute: имя атрибута. Требуется, если не указано ни label, ни value.
• label: метка, связанная с атрибутом. Если не указана, она будет сгенерирована из имени атрибута.

• value: значение, подлежащее отображению. Если не указано, оно будет извлечено из $model с использованием имени атрибута, вызывая yii\helpers\ArrayHelper::getValue(). Обратите внимание, что это значение будет отформатировано в отображаемый текст в соответствии с опцией format. Начиная с версии 2.0.11, оно может быть определено как замыкание со следующими параметрами:

  function ($model, $widget)
  

  $model относится к отображаемой модели, а $widget — это экземпляр виджета DetailView.

• format: тип значения, определяющий, как значение будет отформатировано в отображаемый текст. Обратитесь к yii\i18n\Formatter за информацией о поддерживаемых типах.
• visible: отображается ли атрибут. Если установлено в false, атрибут НЕ будет отображён.
• contentOptions: HTML-атрибуты для настройки тега значения. Например: ['class' => 'bg-red']. Обратитесь к yii\helpers\BaseHtml::renderTagAttributes() за информацией о поддерживаемом синтаксисе.
• captionOptions: HTML-атрибуты для настройки тега метки. Например: ['class' => 'bg-red']. Обратитесь к yii\helpers\BaseHtml::renderTagAttributes() за информацией о поддерживаемом синтаксисе.

public array $attributes = null

$formatter свойство public

Форматировщик, используемый для форматирования значений атрибутов модели в отображаемые тексты. Это может быть либо экземпляр yii\i18n\Formatter, либо массив настроек для создания экземпляра yii\i18n\Formatter. Если это свойство не установлено, будет использован компонент приложения formatter.

public array|yii\i18n\Formatter $formatter = null

$model свойство public

Модель данных, подробности которой должны быть отображены. Это может быть экземпляр yii\base\Model, ассоциативный массив, объект, реализующий интерфейс yii\base\Arrayable, или просто объект с определенными общедоступными (public) доступными нестатическими свойствами.

public array|object $model = null

$options свойство public

HTML-атрибуты для тега контейнера этого виджета. Опция tag задаёт тег контейнера, который следует использовать. По умолчанию, если не задано, используется table.

См. также yii\helpers\Html::renderTagAttributes() для получения подробностей о том, как рендерятся атрибуты.

public array $options = ['class' => 'table table-striped table-bordered detail-view']

$template свойство public

Шаблон, используемый для отображения отдельного атрибута. Если строка, токены {label} и {value} будут заменены меткой и значением соответствующего атрибута. Если обратный вызов (например, анонимная функция), сигнатура должна быть следующей:

function ($attribute, $index, $widget)

где $attribute относится к спецификации отображаемого атрибута, $index — нулевой индекс атрибута в массиве $attributes, а $widget — экземпляр этого виджета.

Начиная с версии 2.0.10, доступны токены {captionOptions} и {contentOptions}, которые будут представлять HTML-атрибуты HTML-контейнерных элементов для метки и значения.

public string|callable $template = '<tr><th{captionOptions}>{label}</th><td{contentOptions}>{value}</td></tr>'

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