SWP\Component\TemplatesSystem\Gimme\Widget\AbstractWidgetHandler

Complexity

Total Complexity

10

Size/Duplication

Total Lines	71
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getExpectedParameters()	0	4	1
A	__construct()	0	4	1
B	getModelParameter()	0	16	5
A	isVisible()	0	4	1
A	getAllParametersWithValue()	0	9	2

<?php

/**
 * This file is part of the Superdesk Web Publisher Templates System.
 *
 * Copyright 2015 Sourcefabric z.ú. and contributors.
 *
 * For the full copyright and license information, please see the
 * AUTHORS and LICENSE files distributed with this source code.
 *
 * @copyright 2015 Sourcefabric z.ú
 * @license http://www.superdesk.org/license
 */

namespace SWP\Component\TemplatesSystem\Gimme\Widget;

use SWP\Component\TemplatesSystem\Gimme\Model\WidgetModelInterface;

abstract class AbstractWidgetHandler implements WidgetHandlerInterface
{
    protected static $expectedParameters = [];

    protected $widgetModel;

    /**
     * @return array
     */
    public static function getExpectedParameters()
    {
        return static::$expectedParameters;
    }

    /**
     * AbstractWidgetHandler constructor.
     *
     * @param WidgetModelInterface $widgetModel
     */
    public function __construct(WidgetModelInterface $widgetModel)
    {
        $this->widgetModel = $widgetModel;
    }

    /**
     * @param $name
     *
     * @return string
     */
    protected function getModelParameter($name)
    {
        if (isset($this->widgetModel->getParameters()[$name])) {
            return $this->widgetModel->getParameters()[$name];
        }

        // Get default value
        if (isset(self::getExpectedParameters()[$name])) {
            $parameterMetaData = self::getExpectedParameters()[$name];
            if (is_array($parameterMetaData) && isset($parameterMetaData['default'])) {
                return $parameterMetaData['default'];
            }
        }

        return;
    }

    /**
     * Check if widget should be rendered.
     *
     * @return bool
     */
    public function isVisible()
    {
        return $this->widgetModel->getVisible();
    }

    /**
     * Returns associative array with all expected parameters and their values.
     *
     * @return array
     */
    protected function getAllParametersWithValue()
    {
        $all = array();
        foreach (self::getExpectedParameters() as $key => $value) {
            $all[$key] = $this->getModelParameter($key);
        }

        return $all;
    }
}