hipanel\modules\finance\widgets\PayButtonComment

Complexity

Total Complexity

10

Size/Duplication

Total Lines	98
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

0%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	init()	0	6	1
A	run()	0	4	1
A	getDefaultCommentViews()	0	4	1
A	getCommentView()	0	4	2
A	renderComment()	0	14	2
A	getMerchantName()	0	4	1
A	getViewPath()	0	4	1

<?php

namespace hipanel\modules\finance\widgets;

use yii\base\Event;
use yii\base\Widget;

class PayButtonComment extends Widget
{
    /**
     * @var Event
     */
    protected $event;

    /**
     * @var array
     */
    public $commentViews = [];

    /**
     * PayButtonCommentHandler constructor
     * @param Event $event The original event, triggered by [[hiqdev\yii2\merchant\widgets\PayButton]]
     * @param array $config
     */
    function __construct(Event $event, $config = [])

It is generally recommended to explicitly declare the visibility for methods.

    {
        parent::__construct($config);

        $this->event = $event;
    }

    /**
     * @inheritdoc
     */
    public function init()
    {
        parent::init();

        $this->commentViews = array_merge($this->getDefaultCommentViews(), $this->commentViews);
    }

    /**
     * @inheritdoc
     */
    public function run()
    {
        return $this->renderComment();
    }

    /**
     * Array of default comment views
     * @return array
     */
    protected function getDefaultCommentViews()
    {
        return ['paypal_usd' => 'paypal'];
    }

    /**
     * Returns the view name for the specified $merchant
     * @param string $merchant
     * @return string|null
     * @see commentViews
     */
    public function getCommentView($merchant)
    {
        return isset($this->commentViews[$merchant]) ? $this->commentViews[$merchant] : null;
    }

    /**
     * Method renders comment from the view, specified in
     * @return string
     */
    protected function renderComment()
    {
        $merchant = $this->getMerchantName();

        if (($view = $this->getCommentView($merchant)) === null) {
            return '';
        }

        return $this->render($view, [
            'merchant' => $merchant,
            'widget' => $this,
            'event' => $this->event,
        ]);
    }

    /**
     * Method provides the merchant name
     * @return string
     */
    protected function getMerchantName()
    {
        return $this->event->sender->getMerchantName();
    }

    /**
     * @return string the view path that may be prefixed to a relative view name.
     */
    public function getViewPath()
    {
        return parent::getViewPath() . DIRECTORY_SEPARATOR . 'payButtonComments';
    }
}