Skip to content

Commit 447aca6

Browse files
srenonsrenon
committed
Add support for 2.3.x
1 parent b503f06 commit 447aca6

File tree

9 files changed

+152
-55
lines changed

9 files changed

+152
-55
lines changed

‎Block/Adminhtml/System/Config/Form/Composer/Version.php

Lines changed: 36 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -7,34 +7,51 @@
77

88
namespace MagePal\CheckoutSuccessMiscScript\Block\Adminhtml\System\Config\Form\Composer;
99

10-
class Version extends \Magento\Config\Block\System\Config\Form\Field
10+
use Exception;
11+
use Magento\Backend\Block\Template\Context;
12+
use Magento\Config\Block\System\Config\Form\Field;
13+
use Magento\Framework\App\DeploymentConfig;
14+
use Magento\Framework\Component\ComponentRegistrar;
15+
use Magento\Framework\Component\ComponentRegistrarInterface;
16+
use Magento\Framework\Data\Form\Element\AbstractElement;
17+
use Magento\Framework\Exception\LocalizedException;
18+
use Magento\Framework\Filesystem\Directory\ReadFactory;
19+
use Magento\Framework\Phrase;
20+
21+
/**
22+
* Class Version
23+
* @package MagePal\CheckoutSuccessMiscScript\Block\Adminhtml\System\Config\Form\Composer
24+
*/
25+
class Version extends Field
1126
{
1227

1328
/**
14-
* @var \Magento\Framework\App\DeploymentConfig
29+
* @var DeploymentConfig
1530
*/
1631
protected $deploymentConfig;
1732

1833
/**
19-
* @var \Magento\Framework\Component\ComponentRegistrarInterface
34+
* @var ComponentRegistrarInterface
2035
*/
2136
protected $componentRegistrar;
2237

2338
/**
24-
* @var \Magento\Framework\Filesystem\Directory\ReadFactory
39+
* @var ReadFactory
2540
*/
2641
protected $readFactory;
2742

2843
/**
29-
* @param \Magento\Framework\App\DeploymentConfig $deploymentConfig
30-
* @param \Magento\Framework\Component\ComponentRegistrarInterface $componentRegistrar
31-
* @param \Magento\Framework\Filesystem\Directory\ReadFactory $readFactory
44+
* @param Context $context
45+
* @param DeploymentConfig $deploymentConfig
46+
* @param ComponentRegistrarInterface $componentRegistrar
47+
* @param ReadFactory $readFactory
48+
* @param array $data
3249
*/
3350
public function __construct(
34-
\Magento\Backend\Block\Template\Context $context,
35-
\Magento\Framework\App\DeploymentConfig $deploymentConfig,
36-
\Magento\Framework\Component\ComponentRegistrarInterface $componentRegistrar,
37-
\Magento\Framework\Filesystem\Directory\ReadFactory $readFactory,
51+
Context $context,
52+
DeploymentConfig $deploymentConfig,
53+
ComponentRegistrarInterface $componentRegistrar,
54+
ReadFactory $readFactory,
3855
array $data = []
3956
) {
4057
$this->deploymentConfig = $deploymentConfig;
@@ -46,11 +63,11 @@ public function __construct(
4663
/**
4764
* Render button
4865
*
49-
* @param \Magento\Framework\Data\Form\Element\AbstractElement $element
66+
* @param AbstractElement $element
5067
* @return string
51-
* @throws \Magento\Framework\Exception\LocalizedException
68+
* @throws LocalizedException
5269
*/
53-
public function render(\Magento\Framework\Data\Form\Element\AbstractElement $element)
70+
public function render(AbstractElement $element)
5471
{
5572
// Remove scope label
5673
$element->unsScope()->unsCanUseWebsiteValue()->unsCanUseDefaultValue();
@@ -60,11 +77,11 @@ public function render(\Magento\Framework\Data\Form\Element\AbstractElement $ele
6077
/**
6178
* Return element html
6279
*
63-
* @param \Magento\Framework\Data\Form\Element\AbstractElement $element
80+
* @param AbstractElement $element
6481
* @return string
6582
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
6683
*/
67-
protected function _getElementHtml(\Magento\Framework\Data\Form\Element\AbstractElement $element)
84+
protected function _getElementHtml(AbstractElement $element)
6885
{
6986
return 'v' . $this->getVersion();
7087
}
@@ -93,12 +110,12 @@ public function getModuleName()
93110
* Get module composer version
94111
*
95112
* @param $moduleName
96-
* @return \Magento\Framework\Phrase|string|void
113+
* @return Phrase|string|void
97114
*/
98115
public function getComposerVersion($moduleName)
99116
{
100117
$path = $this->componentRegistrar->getPath(
101-
\Magento\Framework\Component\ComponentRegistrar::MODULE,
118+
ComponentRegistrar::MODULE,
102119
$moduleName
103120
);
104121

@@ -110,7 +127,7 @@ public function getComposerVersion($moduleName)
110127
$data = json_decode($composerJsonData);
111128
return !empty($data->version) ? $data->version : __('Unknown');
112129
}
113-
} catch (\Exception $e) {
130+
} catch (Exception $e) {
114131
//
115132
}
116133

‎Block/Adminhtml/System/Config/Form/Field/MiscScript.php

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,16 @@
77

88
namespace MagePal\CheckoutSuccessMiscScript\Block\Adminhtml\System\Config\Form\Field;
99

10+
use Exception;
11+
use Magento\Backend\Block\Template\Context;
1012
use Magento\Config\Block\System\Config\Form\Field\FieldArray\AbstractFieldArray;
13+
use Magento\Framework\View\Element\AbstractBlock;
14+
use MagePal\CheckoutSuccessMiscScript\Helper\Data;
15+
1116

1217
/**
13-
* Class Locations Backend system config array field renderer
18+
* Class MiscScript
19+
* @package MagePal\CheckoutSuccessMiscScript\Block\Adminhtml\System\Config\Form\Field
1420
*/
1521
class MiscScript extends AbstractFieldArray
1622
{
@@ -21,13 +27,19 @@ class MiscScript extends AbstractFieldArray
2127
protected $_template = 'MagePal_CheckoutSuccessMiscScript::system/config/form/field/array.phtml';
2228

2329
/**
24-
* @var \MagePal\CheckoutSuccessMiscScript\Helper\Data
30+
* @var Data
2531
*/
2632
protected $helper;
2733

34+
/**
35+
* MiscScript constructor.
36+
* @param Context $context
37+
* @param Data $helper
38+
* @param array $data
39+
*/
2840
public function __construct(
29-
\Magento\Backend\Block\Template\Context $context,
30-
\MagePal\CheckoutSuccessMiscScript\Helper\Data $helper,
41+
Context $context,
42+
Data $helper,
3143
array $data = []
3244
) {
3345
$this->helper = $helper;
@@ -71,6 +83,9 @@ protected function _construct()
7183
parent::_construct();
7284
}
7385

86+
/**
87+
* @return string
88+
*/
7489
public function getTemplateButtonList()
7590
{
7691
$html = '';
@@ -99,15 +114,20 @@ public function addColumn($name, $params)
99114
'type' => $this->_getParam($params, 'type', 'text'),
100115
'renderer' => false,
101116
];
102-
if (!empty($params['renderer']) && $params['renderer'] instanceof \Magento\Framework\View\Element\AbstractBlock) {
117+
if (!empty($params['renderer']) && $params['renderer'] instanceof AbstractBlock) {
103118
$this->_columns[$name]['renderer'] = $params['renderer'];
104119
}
105120
}
106121

122+
/**
123+
* @param string $columnName
124+
* @return mixed|string
125+
* @throws Exception
126+
*/
107127
public function renderCellTemplate($columnName)
108128
{
109129
if (empty($this->_columns[$columnName])) {
110-
throw new \Exception('Wrong column name specified.');
130+
throw new Exception('Wrong column name specified.');
111131
}
112132
$column = $this->_columns[$columnName];
113133
$inputName = $this->_getCellInputElementName($columnName);

‎Block/Adminhtml/System/Config/Form/Module/Version.php

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,22 +7,32 @@
77

88
namespace MagePal\CheckoutSuccessMiscScript\Block\Adminhtml\System\Config\Form\Module;
99

10-
class Version extends \Magento\Config\Block\System\Config\Form\Field
10+
use Magento\Backend\Block\Template\Context;
11+
use Magento\Config\Block\System\Config\Form\Field;
12+
use Magento\Framework\Data\Form\Element\AbstractElement;
13+
use Magento\Framework\Exception\LocalizedException;
14+
use Magento\Framework\Module\ModuleListInterface;
15+
16+
/**
17+
* Class Version
18+
* @package MagePal\CheckoutSuccessMiscScript\Block\Adminhtml\System\Config\Form\Module
19+
*/
20+
class Version extends Field
1121
{
1222

1323
/**
14-
* @var \Magento\Framework\Module\ModuleListInterface
24+
* @var ModuleListInterface
1525
*/
1626
protected $_moduleList;
1727

1828
/**
19-
* @param \Magento\Backend\Block\Template\Context $context
20-
* @param \Magento\Framework\Module\ModuleListInterface $moduleList
29+
* @param Context $context
30+
* @param ModuleListInterface $moduleList
2131
* @param array $data
2232
*/
2333
public function __construct(
24-
\Magento\Backend\Block\Template\Context $context,
25-
\Magento\Framework\Module\ModuleListInterface $moduleList,
34+
Context $context,
35+
ModuleListInterface $moduleList,
2636
array $data = []
2737
) {
2838
parent::__construct($context, $data);
@@ -32,11 +42,11 @@ public function __construct(
3242
/**
3343
* Render button
3444
*
35-
* @param \Magento\Framework\Data\Form\Element\AbstractElement $element
45+
* @param AbstractElement $element
3646
* @return string
37-
* @throws \Magento\Framework\Exception\LocalizedException
47+
* @throws LocalizedException
3848
*/
39-
public function render(\Magento\Framework\Data\Form\Element\AbstractElement $element)
49+
public function render(AbstractElement $element)
4050
{
4151
// Remove scope label
4252
$element->unsScope()->unsCanUseWebsiteValue()->unsCanUseDefaultValue();
@@ -46,11 +56,11 @@ public function render(\Magento\Framework\Data\Form\Element\AbstractElement $ele
4656
/**
4757
* Return element html
4858
*
49-
* @param \Magento\Framework\Data\Form\Element\AbstractElement $element
59+
* @param AbstractElement $element
5060
* @return string
5161
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
5262
*/
53-
protected function _getElementHtml(\Magento\Framework\Data\Form\Element\AbstractElement $element)
63+
protected function _getElementHtml(AbstractElement $element)
5464
{
5565
return 'v' . $this->getVersion();
5666
}

‎Block/Checkout/Success.php

Lines changed: 27 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,42 +7,56 @@
77

88
namespace MagePal\CheckoutSuccessMiscScript\Block\Checkout;
99

10+
use Magento\Checkout\Model\Session;
1011
use Magento\Framework\View\Element\Template;
1112
use Magento\Framework\View\Element\Template\Context;
13+
use Magento\Sales\Api\Data\OrderInterface;
14+
use Magento\Sales\Api\OrderRepositoryInterface;
15+
use MagePal\CheckoutSuccessMiscScript\Helper\Data;
1216

17+
/**
18+
* Class Success
19+
* @package MagePal\CheckoutSuccessMiscScript\Block\Checkout
20+
*/
1321
class Success extends Template
1422
{
1523
/**
16-
* @var \Magento\Checkout\Model\Session
24+
* @var Session
1725
*/
1826
protected $checkoutSession;
1927

2028
/**
21-
* @var \MagePal\CheckoutSuccessMiscScript\Helper\Data
29+
* @var Data
2230
*/
2331
protected $helper;
2432

2533
/**
26-
* @var \Magento\Sales\Api\OrderRepositoryInterface
34+
* @var OrderRepositoryInterface
2735
*/
2836
protected $orderRepository;
2937

38+
/**
39+
* @var OrderInterface
40+
*/
3041
protected $order;
3142

43+
/**
44+
* @var arrau
45+
*/
3246
protected $templateArray;
3347

3448
/**
3549
* @param Context $context
36-
* @param \MagePal\CheckoutSuccessMiscScript\Helper\Data $helper
37-
* @param \Magento\Checkout\Model\Session $checkoutSession
38-
* @param \Magento\Sales\Api\OrderRepositoryInterface $orderRepository
50+
* @param Data $helper
51+
* @param Session $checkoutSession
52+
* @param OrderRepositoryInterface $orderRepository
3953
* @param array $data
4054
*/
4155
public function __construct(
4256
Context $context,
43-
\MagePal\CheckoutSuccessMiscScript\Helper\Data $helper,
44-
\Magento\Checkout\Model\Session $checkoutSession,
45-
\Magento\Sales\Api\OrderRepositoryInterface $orderRepository,
57+
Data $helper,
58+
Session $checkoutSession,
59+
OrderRepositoryInterface $orderRepository,
4660
array $data = []
4761
) {
4862
$this->helper = $helper;
@@ -51,6 +65,9 @@ public function __construct(
5165
parent::__construct($context, $data);
5266
}
5367

68+
/**
69+
* @return string
70+
*/
5471
protected function _toHtml()
5572
{
5673
if (!$this->helper->isEnabled()) {
@@ -61,7 +78,7 @@ protected function _toHtml()
6178
}
6279

6380
/**
64-
* @return \Magento\Sales\Api\Data\OrderInterface
81+
* @return OrderInterface
6582
*/
6683
protected function getOrder()
6784
{

0 commit comments

Comments
 (0)