Partial Column

Partial Column

List Column

The partial column will render the column content using a partial or view file. The path value can refer to a partial view file otherwise the column name is used as the partial name. The default scope for the view path is the controller's view path.

content:
    label: Content
    type: partial
    path: content_column

The following properties are supported.

Property Description
path path to a partial view file or view template code, defaults to the column name with column_ as a prefix.

When the path is set to an unqualified file name (a file name without a directory path and extension), the source path is determined to be in the model or controller directories. The following example will check for the partial file at ../models/mymodel/_column_for_content.php or ../controllers/mycontroller/_column_for_content.php.

content:
    type: partial
    path: column_for_content

You may specify a fully qualified path to access partials outside the model or controller directories. This can be useful for sharing partials between definitions.

content:
    label: Content
    type: partial
    path: $/acme/blog/partials/_content_column.php

Inside the partial these variables are available.

  • $value is the default cell value
  • $record is the model used for the cell
  • $column is the configured class object Backend\Classes\ListColumn

Here is an some example contents of the _content_column.php file.

<?php if ($record->is_active): ?>
    <?= e($value) ?>
<?php endif ?>

# Using View Templates

You may pass a view template code as the path to access view service templates inside the plugin. The following code would be found at the path plugins/acme/blog/views/listcolumns/content.php.

content:
    label: Content
    type: partial
    path: acme.blog::listcolumns.content

The path must contain the :: characters to activate the view service.

# See Also

On This Page