hipanel\widgets\combo\ObjectCombo

Complexity

Total Complexity

9

Size/Duplication

Total Lines	87
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	run()	0	12	1
A	getClasses()	0	15	4
A	getClassOptions()	0	9	2
A	getLabel()	0	4	2

<?php
/**
 * HiPanel core package
 *
 * @link      https://hipanel.com/
 * @package   hipanel-core
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2014-2019, HiQDev (http://hiqdev.com/)
 */

namespace hipanel\widgets\combo;

use hipanel\modules\client\widgets\combo\ClientCombo;
use hipanel\modules\domain\widgets\combo\DomainCombo;
use hipanel\modules\domain\widgets\combo\ZoneCombo;
use hipanel\modules\finance\widgets\combo\PlanCombo;
use hipanel\modules\hosting\widgets\combo\AccountCombo;
use hipanel\modules\server\widgets\combo\ServerCombo;
use hipanel\modules\stock\widgets\combo\PartCombo;
use Yii;
use yii\bootstrap\InputWidget;

/**
 * Class BaseObjectSelector.
 */
class ObjectCombo extends InputWidget
{
    /**
     * @var string
     */
    public $class_attribute = 'class';

    /**
     * @var string
     */
    public $class_attribute_name = 'class';

    /**
     * @var string Normally, when $model already has $attribute property filled,
     * and the $attribute is some ID, it will be resolved to name with an AJAX query.
     * In case page that contains this combo has a lot of inputs (e.g. bulk edit form)
     * each will produce an AJAX query, that will last forever.
     *
     * In case $model already has a name, corresponding to that ID (stored in $attribute),
     * you can help Combo by hinting that attribute name and thus preventing AJAX queries.
     */
    public $selectedAttributeName;

    /**
     * @var array
     */
    public $knownClasses = [
        'client' => ['alias' => '@client', 'combo' => ClientCombo::class],
        'device' => ['alias' => '@server', 'combo' => ServerCombo::class],
        'domain' => ['alias' => '@domain', 'combo' => DomainCombo::class],
        'zone' => ['alias' => '@domain', 'combo' => ZoneCombo::class],
        'part' => ['alias' => '@part', 'combo' => PartCombo::class],
        'account' => ['alias' => '@account', 'combo' => AccountCombo::class],
        'plan' => ['alias' => '@plan', 'combo' => PlanCombo::class],
    ];

    /**
     * {@inheritdoc}
     */
    public function run()
    {
        return $this->render('ObjectCombo', [
            'model' => $this->model,
            'attribute' => $this->attribute,
            'classOptions' => $this->getClassOptions(),
            'classes' => $this->getClasses(),
            'class_attribute' => $this->model->{$this->class_attribute},
            'class_attribute_name' => $this->class_attribute_name,
            'selectedAttributeName' => $this->selectedAttributeName,
        ]);
    }

    private function getClasses(): array
    {
        $classes = [];
        foreach ($this->knownClasses as $class => $options) {
            if (!Yii::getAlias($options['alias'], false)) {
                continue;
            }
            if ($options['combo']) {
                $options['comboOptions'] = get_class_vars($options['combo']);
            }
            $classes[$class] = $options;
        }

        return $classes;
    }

    private function getClassOptions(): array
    {
        $dropDownOptions = [];
        foreach ($this->getClasses() as $class => $options) {
            $dropDownOptions[$class] = Yii::t('hipanel.object-combo', $this->getLabel($class));
        }

        return $dropDownOptions;
    }

    /**
     * @param string $class
     * @return string
     */
    private function getLabel($class): string
    {
        return $class === 'device' ? 'Server' : ucfirst($class);
    }
}