Itstructure\FieldWidgets\TableMultilanguage

Complexity

Total Complexity

4

Size/Duplication

Total Lines	82
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	setModel()	0	3	1
A	setLanguageModel()	0	3	1
A	run()	0	10	2

<?php

namespace Itstructure\FieldWidgets;

use yii\base\{Model, Widget, InvalidConfigException};
use Itstructure\FieldWidgets\interfaces\LanguageListInterface;

/**
 * Class TableMultilanguage
 * The output widget class for each specified translation list field.
 *
 * @property LanguageListInterface $languageModel
 * @property array $fields
 * @property Model $model
 *
 * @package Itstructure\FieldWidgets
 */
class TableMultilanguage extends Widget
{
    /**
     * Language model.
     * For multilanguage mode.
     *
     * @var LanguageListInterface
     */
    private $languageModel;

    /**
     * Field list
     * For each field, you must specify its name: name. Optional parameter: label.
     * To get the value of a field from other parts, you need to specify the path with the combination of entities through the point.
     * Example:
     * fields => [
     *      [
     *          'name' => 'id',
     *          'label' => 'Name',
     *      ],
     *      [
     *          'name' => 'title',
     *          'label' => 'Title',
     *      ],
     *      [
     *          'name' => 'posts.tag',
     *          'label' => 'Post tags',
     *      ]
     * ];
     *
     * @var array
     */
    public $fields = [];

    /**
     * Model for current fields.
     *
     * @var Model
     */
    private $model;

    /**
     * Sets the language model.
     *
     * @param mixed $languageModel
     *
     * @return void
     */
    public function setLanguageModel(LanguageListInterface $languageModel): void
    {
        $this->languageModel = $languageModel;
    }

    /**
     * Sets the model of the current fields.
     *
     * @param Model $model
     *
     * @return void
     */
    public function setModel(Model $model): void
    {
        $this->model = $model;
    }

    /**
     * Starts output for each specified field of the translation list.
     *
     * @throws InvalidConfigException
     *
     * @return string
     */
    public function run(): string
    {
        if (null === $this->languageModel) {
            throw new InvalidConfigException('Language model is not defined.');
        }

        return $this->render('tableMultilanguage', [
            'languageModel' => $this->languageModel,
            'fields'        => $this->fields,
            'model'         => $this->model,
        ]);
    }
}