micetm\timeline\Timeline

Complexity

Total Complexity

19

Size/Duplication

Total Lines	130
Duplicated Lines	0 %

Importance

Changes	6
Bugs	0	Features	1

10 Methods

Rating	Name	Duplication	Size	Complexity
B	renderItems()	0	27	7
A	run()	0	4	1
A	constructIcon()	0	7	1
A	constructTime()	0	6	1
A	replaceMacros()	0	3	1
A	constructHeader()	0	10	2
A	getMacros()	0	3	2
A	constructBody()	0	3	1
A	constructBodyLayout()	0	3	1
A	getBody()	0	3	2

<?php

namespace micetm\timeline;

use Yii;
use yii\base\InvalidConfigException;
use yii\base\Widget;
use yii\helpers\Html;

class Timeline extends Widget
{
    public $items = [];

    public $eventIcons = [];

    public $startMacros = '{';

    public $endMacros = '}';

    /**
     * Path to view for rendering $model->body
     *
     * The widget includes a 'timeline_body' view that displays an array of the following structure
     * [
     *     'key' => [
     *         'old' => 'oldValue',
     *         'new' => 'newValue'
     *     ]
     * ]
     *
     * @var string | null
     */
    public $bodyLayout = null;

    protected $defaultIcons = [
        'update' => 'fa fa-pencil bg-orange',
        'create' => 'fa fa-check bg-green',
        'delete' => 'fa fa-trash bg-red',
        'default' => 'fa fa-check'
    ];

    /**
     * Renders the widget.
     */
    public function run()
    {
        $this->eventIcons = array_merge($this->defaultIcons, $this->eventIcons);
        return $this->renderItems();
    }

    /**
     * Renders tab items as specified on [[items]].
     * @return string the rendering result.
     * @throws InvalidConfigException.
     */
    protected function renderItems()
    {
        $lis = [];
        foreach ($this->items as $model) {
            $nodes = [];
            if (!isset($date) || $date != Yii::$app->formatter->asDate($model->log_date)) {
                $date = Yii::$app->formatter->asDate($model->log_date);
                $lis[] = Html::tag('li', Html::tag('span', $date, ["class" => "bg-blue"]), ["class" => "time-label"]);
            }

            $nodes[] = $this->constructIcon($model->action);
            $timelineItem = [];
            $timelineItem[] = $this->constructTime($model->log_date);

            if ($model->title) {
                $timelineItem[] = $this->constructHeader($model);
            }
            if ($model->body) {
                $timelineItem[] = $this->bodyLayout
                    ? $this->constructBodyLayout($model)
                    : $this->constructBody($model);
            }
            $nodes[] = Html::tag('div', implode("\n", $timelineItem), ['class' => 'timeline-item']);
            $lis[] = Html::tag('li', implode("\n", $nodes));
        }
        $lis[] = Html::tag('li', Html::tag('i', '', ["class" => "fa fa-clock-o"]));
        return Html::tag('ul', implode("\n", $lis), ['class' => "timeline"]);
    }


    protected function constructIcon($action)
    {
        return Html::tag(
            'i',
            '',
            [
                'class' => $this->eventIcons[$action] ?? $this->eventIcons['default']
            ]
        );
    }

    protected function constructTime($time)
    {
        $nodes = [];
        $nodes[] = Html::tag('i', '', ['class' => 'fa fa-clock-o']);
        $nodes[] = Yii::$app->formatter->asTime($time);
        return Html::tag('span', implode("\n", $nodes), ['class' => 'time']);
    }

    protected function constructHeader($model)
    {
        $macros = $this->getMacros($model);
        if (isset($macros['admin_name'])) {
            $macros['admin_name'] = Html::a(
                $macros['admin_name'],
                ['/user/view', 'id' => $macros['admin_id'] ?? '']
            );
        }
        return Html::tag('h3', $this->replaceMacros($model->title, $macros), ['class' => 'timeline-header']);
    }

    protected function constructBody($model)
    {
        return Html::tag('h3', $this->replaceMacros($model->body, $this->getMacros($model)), ['class' => 'timeline-header']);
    }

    protected function constructBodyLayout($model)
    {
        return $this->render($this->bodyLayout, ['items' => $this->getBody($model)]);
    }

    protected function replaceMacros($template, $replacement)
    {
        return \Yii::t('timeline', $template, $replacement);
    }

    protected function getMacros($model)
    {
        return method_exists($model, 'getMacros') ? $model->getMacros() : $model->macros;
    }

    protected function getBody($model)
    {
        return method_exists($model, 'getBody') ? $model->getBody() : $model->body;
    }
}