hipanel\modules\finance\widgets\PayButtonComment

Complexity

Total Complexity

12

Size/Duplication

Total Lines	115
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

0%

Importance

Changes

0

9 Methods

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

<?php
/**
 * Finance module for HiPanel
 *
 * @link      https://github.com/hiqdev/hipanel-module-finance
 * @package   hipanel-module-finance
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2015-2017, HiQDev (http://hiqdev.com/)
 */

namespace hipanel\modules\finance\widgets;

use hiqdev\yii2\merchant\widgets\PayButton;
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
     */
    public function __construct(Event $event, $config = [])
    {
        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_*' => 'paypal',
            'bitpay_*' => 'bitpay',
        ];
    }

    /**
     * Returns the view name for the specified $merchant.
     * @param string $merchant
     * @return string|null
     * @see commentViews
     */
    public function getCommentView($merchant)
    {
        foreach ($this->commentViews as $pattern => $view) {
            if (fnmatch($pattern, $merchant)) {
                return $view;
            }
        }

        return 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';
    }

    /**
     * @return PayButton
     */
    public function getPayButton()
    {
        return $this->event->sender;
    }
}