hiqdev\higrid\DetailView

Complexity

Total Complexity

9

Size/Duplication

Total Lines	95
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	5

Test Coverage

Coverage

0%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	init()	0	9	2
A	run()	0	11	2
A	renderColumn()	0	11	2
A	createDataColumn()	0	8	3

<?php
/**
 * Advanced Grid for Yii2.
 *
 * @link      https://github.com/hiqdev/yii2-higrid
 * @package   yii2-higrid
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2015-2017, HiQDev (http://hiqdev.com/)
 */

namespace hiqdev\higrid;

use Yii;
use yii\base\InvalidConfigException;
use yii\data\ArrayDataProvider;
use yii\helpers\ArrayHelper;
use yii\helpers\Html;

/**
 * DetailView displays the detail of a single data [[Model]].
 *
 * [[hiqdev\higrid\DetailView]] is similar to [[yii\widgets\DetailView]] but uses [[Column]]
 * to show header and data part of given [[Model]].
 *
 * The contents of the detail table are configured in terms of [[Column]]
 * classes, which are configured via $columns.
 * Helps reuse your code by defining [[Column]]s once and reusing them for
 * both GridView and DetailView. Filter and footer part of [[Column]] are
 * not used.
 *
 * A typical usage of DetailView is as follows:
 *
 * ```php
 * echo DetailView::widget([
 *     'model' => $model,
 *     'columns' => [
 *         '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
 *         [
 *             'class' => ActionColumn::class,
 *         ],
 *     ],
 * ]);
 * ```
 *
 * @author Andrii Vasyliev <sol@hiqdev.com>
 */
class DetailView extends GridView
{
    /**
     * @var array|object the data model whose details are to be displayed. This can be a [[Model]] instance,
     *                   an associative array, an object that implements [[Arrayable]] interface or simply an object with defined
     *                   public accessible non-static properties.
     */
    public $model;
    /**
     * @var string|callable the template used to render a single attribute. If a string, the token `{label}`
     *                      and `{value}` will be replaced with the label and the value of the corresponding attribute.
     *                      If a callback (e.g. an anonymous function), the signature must be as follows:
     *
     * ```php
     * function ($attribute, $index, $widget)
     * ```
     *
     * where `$attribute` refer to the specification of the attribute being rendered, `$index` is the zero-based
     * index of the attribute in the [[attributes]] array, and `$widget` refers to this widget instance.
     */
    public $template = '<tr>{label}{value}</tr>';
    /**
     * @var array the HTML attributes for the container tag of this widget. The "tag" option specifies
     *            what container tag should be used. It defaults to "table" if not set.
     *
     * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
     */
    public $options = ['class' => 'table table-striped table-bordered table-condensed detail-view'];

    /**
     * Initializes dataProvider.
     */
    public function init()
    {
        if ($this->model === null) {
            throw new InvalidConfigException('Please specify the "model" property.');
        }

        $this->dataProvider = new ArrayDataProvider(['allModels' => [$this->model]]);
        parent::init();
    }

    /**
     * Renders the detail view.
     * This is the main entry of the whole detail view rendering.
     */
    public function run()
    {
        $rows = [];
        $i = 0;
        foreach ($this->columns as $column) {
            $rows[] = $this->renderColumn($column, $i++);
        }

        $tag = ArrayHelper::remove($this->options, 'tag', 'table');
        return Html::tag($tag, implode("\n", $rows), $this->options);
    }

    /**
     * Renders a single column.
     *
     * @param DataColumn $column the specification of the column to be rendered
     * @param int $index the zero-based index of the column in the [[columns]] array
     *
     * @return string the rendering result
     */
    protected function renderColumn($column, $index)
    {
        if (is_string($this->template)) {
            return strtr($this->template, [
                '{label}' => $column->renderHeaderCell(),
                '{value}' => $column->renderDataCell($this->model, $this->model->getPrimaryKey(), 0),
            ]);
        }

        return call_user_func($this->template, $column, $index, $this);
    }

    /**
     * @var GridView object to be used for DataColumn creation
     */
    public $grid;

    /**
     * {@inheritdoc}
     */
    protected function createDataColumn($text)
    {
        if ($this->grid && method_exists($this->grid, 'createDataColumn')) {
            return call_user_func([$this->grid, 'createDataColumn'], $text);
        }

        return parent::createDataColumn($text);
    }
}