GridFieldRefundAction::getColumnContent() - Code Metrics - Inspection of "Fix composer issues" - bummzack/silverstripe-omnipay-ui - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( bb4762...ee0943 )

by Roman

created 2021-06-23 18:51 UTC

GridFieldRefundAction::getColumnContent() B

↳ Parent: GridFieldRefundAction

Complexity

Conditions	6
Paths	6

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	52
rs	8.425
c	0
b	0
f	0
cc	6
nc	6
nop	3

How to fix Long Method

<?php
namespace Bummzack\SsOmnipayUI\GridField;

use SilverStripe\Forms\GridField\GridField;
use SilverStripe\Forms\GridField\GridField_ActionProvider;
use SilverStripe\Forms\GridField\GridField_FormAction;
use SilverStripe\Omnipay\GatewayInfo;
use SilverStripe\Omnipay\Model\Payment;
use SilverStripe\Omnipay\Service\ServiceFactory;
use SilverStripe\Omnipay\Exception\Exception;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\FieldType\DBMoney;
use SilverStripe\ORM\ValidationException;
use SilverStripe\View\Requirements;

/**
 * A GridField button that can be used to refund a payment
 *
 * @package SilverStripe\Omnipay\Admin\GridField
 */
class GridFieldRefundAction extends GridFieldPaymentAction implements GridField_ActionProvider
{
    /**
     * Which GridField actions are this component handling
     *
     * @param GridField $gridField
     * @return array
     */
    public function getActions($gridField)
    {
        return array('refundpayment');
    }

    /**
     *
     * @param GridField $gridField
     * @param DataObject $record
     * @param string $columnName
     * @return string|null - the HTML for the column
     */
    public function getColumnContent($gridField, $record, $columnName)
    {
        if (!($record instanceof Payment)) {
            return null;
        }

        if (!$record->canRefund()) {
            return null;
        }

        Requirements::css('bummzack/silverstripe-omnipay-ui: client/dist/css/omnipay-ui-cms.css');
        Requirements::javascript('bummzack/silverstripe-omnipay-ui: client/dist/javascript/omnipay-ui-cms.js');
        Requirements::add_i18n_javascript('bummzack/silverstripe-omnipay-ui: client/dist/javascript/lang');

        $infoText = '';
        switch (GatewayInfo::refundMode($record->Gateway)) {
            case GatewayInfo::MULTIPLE:
                $infoText = 'MultiRefundInfo';
                break;
            case GatewayInfo::PARTIAL:
                $infoText = 'SingleRefundInfo';
                break;
            case GatewayInfo::FULL:
                $infoText = 'FullRefundInfo';
                break;
        }

        /** @var DBMoney $money */
        $money = $record->dbObject('Money');

        /** @var GridField_FormAction $field */
        $field = GridField_FormAction::create(
            $gridField,
            'RefundPayment' . $record->ID,
            false,
            'refundpayment',
            array('RecordID' => $record->ID)
        )
            ->addExtraClass('gridfield-button-refund payment-dialog-button')
            ->setAttribute('title', _t('GridFieldRefundAction.Title', 'Refund Payment'))
            ->setAttribute('data-icon', 'button-refund')
            ->setAttribute('data-dialog', json_encode(array(
                'maxAmount' => $money->Nice(),
                'maxAmountNum' => $money->getAmount(),
                'hasAmountField' => $record->canRefund(null, true),
                'infoTextKey' => $infoText,
                'buttonTextKey' => 'RefundAmount'
            )))
            ->setDescription(_t('GridFieldRefundAction.Description', 'Refund a captured payment'));

        return $field->Field();
    }

    /**
     * Handle the actions and apply any changes to the GridField
     *
     * @param GridField $gridField
     * @param string $actionName
     * @param mixed $arguments
     * @param array $data - form data
     * @return void
     * @throws ValidationException when there was an error
     * @throws \SilverStripe\Omnipay\Exception\InvalidConfigurationException
     */
    public function handleAction(GridField $gridField, $actionName, $arguments, $data)
    {
        if ($actionName == 'refundpayment') {
            $item = $gridField->getList()->byID($arguments['RecordID']);
            if (!($item instanceof Payment)) {
                return;
            }

            $serviceData = array_intersect_key($data, array('amount' => null));

            /** @var ServiceFactory $factory */
            $factory = ServiceFactory::create();
            $refundService = $factory->getService($item, ServiceFactory::INTENT_REFUND);

            try {
                $serviceResponse = $refundService->initiate($serviceData);
            } catch (Exception $ex) {
                throw new ValidationException($ex->getMessage(), 0);
            }

            if ($serviceResponse->isError()) {
                throw new ValidationException(
                    _t('GridFieldRefundAction.RefundError', 'Unable to refund payment. An error occurred.'),
                    0
                );
            }
        }
    }
}


1			<?php
2			namespace Bummzack\SsOmnipayUI\GridField;
3
4			use SilverStripe\Forms\GridField\GridField;
5			use SilverStripe\Forms\GridField\GridField_ActionProvider;
6			use SilverStripe\Forms\GridField\GridField_FormAction;
7			use SilverStripe\Omnipay\GatewayInfo;
8			use SilverStripe\Omnipay\Model\Payment;
9			use SilverStripe\Omnipay\Service\ServiceFactory;
10			use SilverStripe\Omnipay\Exception\Exception;
11			use SilverStripe\ORM\DataObject;
12			use SilverStripe\ORM\FieldType\DBMoney;
13			use SilverStripe\ORM\ValidationException;
14			use SilverStripe\View\Requirements;
15
16			/**
17			* A GridField button that can be used to refund a payment
18			*
19			* @package SilverStripe\Omnipay\Admin\GridField
20			*/
21			class GridFieldRefundAction extends GridFieldPaymentAction implements GridField_ActionProvider
22			{
23			/**
24			* Which GridField actions are this component handling
25			*
26			* @param GridField $gridField
27			* @return array
28			*/
29			public function getActions($gridField)
30			{
31			return array('refundpayment');
32			}
33
34			/**
35			*
36			* @param GridField $gridField
37			* @param DataObject $record
38			* @param string $columnName
39			* @return string\|null - the HTML for the column
40			*/
41			public function getColumnContent($gridField, $record, $columnName)
42			{
43			if (!($record instanceof Payment)) {
44			return null;
45			}
46
47			if (!$record->canRefund()) {
48			return null;
49			}
50
51			Requirements::css('bummzack/silverstripe-omnipay-ui: client/dist/css/omnipay-ui-cms.css');
52			Requirements::javascript('bummzack/silverstripe-omnipay-ui: client/dist/javascript/omnipay-ui-cms.js');
53			Requirements::add_i18n_javascript('bummzack/silverstripe-omnipay-ui: client/dist/javascript/lang');
54
55			$infoText = '';
56			switch (GatewayInfo::refundMode($record->Gateway)) {
57			case GatewayInfo::MULTIPLE:
58			$infoText = 'MultiRefundInfo';
59			break;
60			case GatewayInfo::PARTIAL:
61			$infoText = 'SingleRefundInfo';
62			break;
63			case GatewayInfo::FULL:
64			$infoText = 'FullRefundInfo';
65			break;
66			}
67
68			/** @var DBMoney $money */
69			$money = $record->dbObject('Money');
70
71			/** @var GridField_FormAction $field */
72			$field = GridField_FormAction::create(
73			$gridField,
74			'RefundPayment' . $record->ID,
75			false,
76			'refundpayment',
77			array('RecordID' => $record->ID)
78			)
79			->addExtraClass('gridfield-button-refund payment-dialog-button')
80			->setAttribute('title', _t('GridFieldRefundAction.Title', 'Refund Payment'))
81			->setAttribute('data-icon', 'button-refund')
82			->setAttribute('data-dialog', json_encode(array(
83			'maxAmount' => $money->Nice(),
84			'maxAmountNum' => $money->getAmount(),
85			'hasAmountField' => $record->canRefund(null, true),
86			'infoTextKey' => $infoText,
87			'buttonTextKey' => 'RefundAmount'
88			)))
89			->setDescription(_t('GridFieldRefundAction.Description', 'Refund a captured payment'));
90
91			return $field->Field();
92			}
93
94			/**
95			* Handle the actions and apply any changes to the GridField
96			*
97			* @param GridField $gridField
98			* @param string $actionName
99			* @param mixed $arguments
100			* @param array $data - form data
101			* @return void
102			* @throws ValidationException when there was an error
103			* @throws \SilverStripe\Omnipay\Exception\InvalidConfigurationException
104			*/
105			public function handleAction(GridField $gridField, $actionName, $arguments, $data)
106			{
107			if ($actionName == 'refundpayment') {
108			$item = $gridField->getList()->byID($arguments['RecordID']);
109			if (!($item instanceof Payment)) {
110			return;
111			}
112
113			$serviceData = array_intersect_key($data, array('amount' => null));
114
115			/** @var ServiceFactory $factory */
116			$factory = ServiceFactory::create();
117			$refundService = $factory->getService($item, ServiceFactory::INTENT_REFUND);
118
119			try {
120			$serviceResponse = $refundService->initiate($serviceData);
121			} catch (Exception $ex) {
122			throw new ValidationException($ex->getMessage(), 0);
123			}
124
125			if ($serviceResponse->isError()) {
126			throw new ValidationException(
127			_t('GridFieldRefundAction.RefundError', 'Unable to refund payment. An error occurred.'),
128			0
129			);
130			}
131			}
132			}
133			}
134

bummzack / silverstripe-omnipay-ui

Push — master ( bb4762...ee0943 )

GridFieldRefundAction::getColumnContent() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like