Class kartik\detail\DetailView

List of form inputs (dropdown based)

The active form instance

List of form inputs (non dropdown based)

Internally processed HTML attributes for each table row. Defaults settings from $rowOptions.

The HTML attributes for the alert block container which will display any alert messages received on update or delete of record. This will not be displayed if there are no alert messages.

The alert flash message settings.

This will be set as $key => $value, pairs where:

• $key: string, flash message key e.g. error, success.
• $value: string|array, of CSS classes for the flash message e.g. ['alert', 'alert-danger']. This defaults to the following setting:

[
    'kv-detail-error' => ['alert', 'alert-danger'],
    'kv-detail-success' => ['alert', 'alert-success'],
    'kv-detail-info' =>  ['alert', 'alert-info'],
    'kv-detail-warning' =>  ['alert', 'alert-warning'],
]

The widget settings for each bootstrap alert displayed in the alert container block.

The CSS class in options within this property will be auto derived and appended.

• For update, the error messages will be displayed, only if you have set messages using Yii::$app->session->setFlash. The CSS class for the error block will be auto-derived based on flash message type using alertMessageSettings.
• For delete, the error messages will be displayed based on the ajax response. The ajax response should be an object that contain the following settings:
  • success: boolean, whether the ajax delete is successful.
  • messages: array|object,the list of messages to display as key value pairs. The key must be one of the message keys in the alertMessageSettings, and the value must be the message content to be displayed.

Whether to convert array values to string using print_r.

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 "attribute", "attribute:format" or "attribute:format:label", where "attribute" refers to the attribute name, and "format" represents the format of the attribute. The "format" is passed to the yii\i18n\Formatter::format() method to format an attribute value into a displayable text. Please refer to yii\i18n\Formatter for the supported types. Both "format" and "label" are optional. They will take default values if absent.

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

• attribute: string|Closure, the attribute name. This is required if either "label" or "value" is not specified.
• label: string|Closure, the label associated with the attribute. If this is not specified, it will be generated from the attribute name.
• value: mixed|Closure, the value to be displayed. If this is not specified, it will be retrieved from $model using the attribute name by calling yii\helpers\ArrayHelper::getValue(). Note that this value will be formatted into a displayable text according to the "format" option.
• format: mixed|Closure, the type of the value that determines how the value would be formatted into a displayable text. Please refer to yii\i18n\Formatter for supported types.
• visible: boolean|Closure, whether the attribute is visible. If set to false, the attribute will NOT be displayed.

Additional special settings are:

• viewModel: Model|Closure, the model to be used for this attribute in VIEW mode. This will override the model setting at the widget level. If not set, the widget model setting will be used.
• editModel: Model|Closure, the model to be used for this attribute in EDIT mode. This will override the model setting at the widget level. If not set, the widget model setting will be used.
• rowOptions: array|Closure, HTML attributes for the row (if not set, this will be defaulted to the rowOptions set at the widget level)
• labelColOptions: array|Closure, HTML attributes for the label column (if not set, this will be defaulted to the labelColOptions set at the widget level)
• valueColOptions: array|Closure, HTML attributes for the value column (if not set, this will be defaulted to valueColOptions set at the widget level)
• group: boolean|Closure, whether to group the selection by merging the label and value into a single column.
• groupOptions: array|Closure, HTML attributes for the grouped/merged column when group is set to true.
• type: string|Closure, the input type for rendering the attribute in edit mode. Must be one of the INPUT_ constants.
• displayOnly: boolean|Closure, if the input is to be set to as display only in edit mode.
• widgetOptions: array|Closure_, the widget options if you set type to INPUT_WIDGET. The following special options are recognized:
  • class: _string the fully namespaced widget class.
• items: array|Closure, the list of data items for dropDownList, listBox, checkboxList & radioList
• inputType: string|Closure, the HTML 5 input type if type is set to INPUT_HTML5.
• inputContainer: array|Closure, HTML attributes for the input container
• inputWidth: string|Closure, the width of the container holding the input, should be appended along with the width unit (px or %) - this property is deprecated since v1.7.7
• fieldConfig: array|Closure, optional, the Active field configuration.
• options: array|Closure, optional, the HTML attributes for the input.
• updateAttr: string|Closure, optional, the name of the attribute to be updated, when in edit mode. This will default to the attribute setting.
• updateMarkup: string|Closure, the raw markup to render in edit mode. If not set, this normally will be automatically generated based on attribute or updateAttr setting. If this is set it will override the default markup.

Note that all of the attribute properties above can also be setup as a Closure callback with the signature function($form, $widget), where:

• $form: ActiveForm, is the current active form object in the detail view.
• $widget: DetailView, is the current detail view widget instance.

Whether the grid view will have Bootstrap table styling.

Whether the grid table will have a bordered style. Applicable only if $bootstrap is true.

The options for the button toolbar container

The buttons to show when in view mode. The following tokens will be parsed and replaced:

• {view}: the view button
• {update}: the update button
• {delete}: the delete button
• {save}: the save button

The buttons template to show when in edit mode. The following tokens will be parsed and replaced:

• {view}: the view button
• {update}: the update button
• {reset}: the reset button
• {delete}: the delete button
• {save}: the save button

HTML attributes for the child table (applicable when using with multiple child columns).

Whether the grid table will have a condensed style. Applicable only if $bootstrap is true.

The HTML attributes for the widget container

The HTML attributes for the edit button. The following special options are recognized:

• label: string, the delete button label. This will not be HTML encoded.
  • Defaults to <i class="fas fa-trash-alt"></i> for Bootstrap 4.x & Bootstrap 5.x.
  • Defaults to <i class="glyphicon glyphicon-trash"></i> for Bootstrap 3.x.
• url: string, the delete button url. Defaults to #.
• params: array, the parameters to the delete action and their values to be passed via ajax which you must set as key value pairs. This will be automatically json string encoded, so to escape javascript variables & methods you can use yii\web\JsExpression
• ajaxSettings: array, the ajax settings if you choose to override the delete ajax settings.
• confirm: string, the confirmation message before triggering delete. Defaults to Are you sure you want to delete this item? (will be translated for your locale language set).
• showErrorStack: boolean, whether to show the complete error stack. Defaults to false.

The HTML attributes for the container displaying the EDIT mode attributes.

The HTML attributes for the container displaying the EDIT mode buttons.

Whether to enable edit mode for the detail view.

The fade animation delay in microseconds when toggling between the view and edit modes.

The form widget class name (extending from yii\widgets\ActiveForm) to be used for editing

The options for the yii\widgets\ActiveForm instance that will be generated in edit mode based on $formClass.

The horizontal alignment for the label column

Whether to hide all alerts. Defaults to false.

Whether to hide rows in view mode if value is null or empty.

Whether the grid table will highlight row on hover. Applicable only if $bootstrap is true.

Configuration settings for the kartik\dialog\Dialog widget that will be used to render alerts and confirmation dialog prompts.

See also http://demos.krajee.com/dialog.

The HTML attributes for the label column

The main template to render the detail view. The following tokens will be parsed and replaced:

• {detail}: will be replaced by the rendered detail view
• {buttons}: the buttons to be displayed as set in $buttons1 or $buttons2.

The mode for the Detail View when its initialized

Whether to show values as not set if empty string

The HTML attributes for the detail view table

The panel settings for displaying the grid view within a bootstrap styled panel. This property is therefore applicable only if $bootstrap property is true. The following array keys can be configured:

• type: string, the panel contextual type. Set it to one of the TYPE constants. If not set, will default to TYPE_DEFAULT.
• options: array, the HTML attributes for the panel container. If the class is not set, it will be auto derived using the panel type and $panelCssPrefix specific to the configured bootstrap version.
• heading: string|boolean, the panel heading. If set to false, will not be displayed.
• headingOptions: array, HTML attributes for the panel heading container. Defaults to:
  • ['class'=>'card-heading {COLOR}'] for Bootstrap 4.x & Bootstrap 5.x. The {COLOR} token will be auto calculated and replaced based on the type setting.
  • ['class'=>'panel-heading'] for Bootstrap 3.x.

• titleOptions: array, HTML attributes for the panel title container. The following tags are specially parsed:

  • tag: string, the HTML tag to render the title. Defaults to:
    • span for Bootstrap 4.x & Bootstrap 5.x.
    • h3 for Bootstrap 3.x.

  The titleOptions defaults to:

  • [] for Bootstrap 4.x & Bootstrap 5.x.
  • ['class'=>'panel-title'] for Bootstrap 3.x.
• footer: string|boolean, the panel footer. If set to false will not be displayed.
• footerOptions: array, HTML attributes for the panel footer container. Defaults to:
  • ['class'=>'card-footer'] for Bootstrap 4.x & Bootstrap 5.x.
  • ['class'=>'panel-footer'] for Bootstrap 3.x.
• before: string|boolean, content to be placed before/above the grid (after the header). To not display this section, set this to false.
• beforeOptions: array, HTML attributes for the before text. If the class is not set, it will default to kv-panel-before.
• after: string|boolean, any content to be placed after/below the grid (before the footer). To not display this section, set this to false.
• afterOptions: array, HTML attributes for the after text. If the class is not set, it will default to kv-panel-after.

The CSS class prefix to apply to the bootstrap panel container (applicable when $panel is configured).

The template for rendering the panel heading. The following special tokens are recognized and will be replaced:

• {title}: string, which will render the panel heading title content.
• {buttons}: string, which will render the buttons in the panel heading toolbar based on the $buttons1 or $buttons2 property.].

Bootstrap panel options.

The template for rendering the grid within a bootstrap styled panel / card layout. The following special tokens are recognized and will be replaced:

• {prefix}: the CSS prefix name as set in $panelCssPrefix.
• {type}: the panel type that will append the bootstrap contextual CSS.
• {panelHeading}: the panel heading content.
• {panelBefore}: the content before panel.
• {panelAfter}: the content after panel.
• {panelFooter}: the panel footer content.
• {items}: the detail view items.
• {buttons}: buttons to be displayed as set in $buttons1 or $buttons2.
• {title}: the panel heading title content.

The HTML attributes for the reset button. This button will reset the form in edit mode. The following special options are recognized:

• label: string, the reset button label. This will not be HTML encoded.
  • Defaults to <i class="fas fa-ban"></i> for Bootstrap 4.x & Bootstrap 5.x.
  • Defaults to <i class="glyphicon glyphicon-ban-circle"></i> for Bootstrap 3.x.

Whether the grid table will have a responsive style. Applicable only if $bootstrap is true.

The HTML attributes for each attribute row

The HTML attributes for the save button. This will default to a form submit button. The following special options are recognized:

• label: string, the save button label. This will not be HTML encoded. Defaults to:
  • <i class="fas fa-save"></i> for Bootstrap 4.x & Bootstrap 5.x.
  • <i class="glyphicon glyphicon-floppy-disk"></i> for Bootstrap 3.x.

Whether to show form error summary as part of the error alert. Defaults to false.

Whether the grid table will have a striped style. Applicable only if $bootstrap is true.

The HTML attributes for the table container

Whether to display bootstrap style tooltips for titles on hover of buttons.

The HTML attributes for the update button. This button will toggle the edit mode on. The following special options are recognized:

• label: the update button label. This will not be HTML encoded.
  • Defaults to <i class="fas fa-pencil-alt"></i> for Bootstrap 4.x & Bootstrap 5.x.
  • Defaults to <i class="glyphicon glyphicon-pencil"></i> for Bootstrap 3.x.

The vertical alignment for the label column

The HTML attributes for the value column

The HTML attributes for the container displaying the VIEW mode attributes.

The HTML attributes for the container displaying the VIEW mode buttons.

The HTML attributes for the view button. This will toggle the view from edit mode to view mode. The following special options are recognized:

• label: the save button label. This will not be HTML encoded.
  • Defaults to <i class="fas fa-eye"></i> for Bootstrap 4.x & Bootstrap 5.x.
  • Defaults to <i class="glyphicon glyphicon-eye-open"></i> for Bootstrap 3.x.