/
Field.php
188 lines (170 loc) · 5.96 KB
/
Field.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
<?php
/**
* Copyright © 2015 Magento. All rights reserved.
* See COPYING.txt for license details.
*/
// @codingStandardsIgnoreFile
/**
* Abstract config form element renderer
*
* @author Magento Core Team <core@magentocommerce.com>
*
*/
namespace Magento\Config\Block\System\Config\Form;
/**
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
* @SuppressWarnings(PHPMD.NumberOfChildren)
*/
class Field extends \Magento\Backend\Block\Template implements \Magento\Framework\Data\Form\Element\Renderer\RendererInterface
{
/**
* Retrieve element HTML markup
*
* @param \Magento\Framework\Data\Form\Element\AbstractElement $element
* @return string
*/
protected function _getElementHtml(\Magento\Framework\Data\Form\Element\AbstractElement $element)
{
return $element->getElementHtml();
}
/**
* Retrieve HTML markup for given form element
*
* @param \Magento\Framework\Data\Form\Element\AbstractElement $element
* @return string
*/
public function render(\Magento\Framework\Data\Form\Element\AbstractElement $element)
{
$isCheckboxRequired = $this->_isInheritCheckboxRequired($element);
// Disable element if value is inherited from other scope. Flag has to be set before the value is rendered.
if ($element->getInherit() == 1 && $isCheckboxRequired) {
$element->setDisabled(true);
}
$html = '<td class="label"><label for="' .
$element->getHtmlId() .
'">' .
$element->getLabel() .
'</label></td>';
$html .= $this->_renderValue($element);
if ($isCheckboxRequired) {
$html .= $this->_renderInheritCheckbox($element);
}
$html .= $this->_renderScopeLabel($element);
$html .= $this->_renderHint($element);
return $this->_decorateRowHtml($element, $html);
}
/**
* Render element value
*
* @param \Magento\Framework\Data\Form\Element\AbstractElement $element
* @return string
*/
protected function _renderValue(\Magento\Framework\Data\Form\Element\AbstractElement $element)
{
if ($element->getTooltip()) {
$html = '<td class="value with-tooltip">';
$html .= $this->_getElementHtml($element);
$html .= '<div class="tooltip"><span class="help"><span></span></span>';
$html .= '<div class="tooltip-content">' . $element->getTooltip() . '</div></div>';
} else {
$html = '<td class="value">';
$html .= $this->_getElementHtml($element);
}
if ($element->getComment()) {
$html .= '<p class="note"><span>' . $element->getComment() . '</span></p>';
}
$html .= '</td>';
return $html;
}
/**
* Render inheritance checkbox (Use Default or Use Website)
*
* @param \Magento\Framework\Data\Form\Element\AbstractElement $element
* @return string
*/
protected function _renderInheritCheckbox(\Magento\Framework\Data\Form\Element\AbstractElement $element)
{
$htmlId = $element->getHtmlId();
$namePrefix = preg_replace('#\[value\](\[\])?$#', '', $element->getName());
$checkedHtml = $element->getInherit() == 1 ? 'checked="checked"' : '';
$html = '<td class="use-default">';
$html .= '<input id="' .
$htmlId .
'_inherit" name="' .
$namePrefix .
'[inherit]" type="checkbox" value="1"' .
' class="checkbox config-inherit" ' .
$checkedHtml .
' onclick="toggleValueElements(this, Element.previous(this.parentNode))" /> ';
$html .= '<label for="' . $htmlId . '_inherit" class="inherit">' . $this->_getInheritCheckboxLabel(
$element
) . '</label>';
$html .= '</td>';
return $html;
}
/**
* Check if inheritance checkbox has to be rendered
*
* @param \Magento\Framework\Data\Form\Element\AbstractElement $element
* @return bool
*/
protected function _isInheritCheckboxRequired(\Magento\Framework\Data\Form\Element\AbstractElement $element)
{
return $element->getCanUseWebsiteValue() || $element->getCanUseDefaultValue();
}
/**
* Retrieve label for the inheritance checkbox
*
* @param \Magento\Framework\Data\Form\Element\AbstractElement $element
* @return string
*/
protected function _getInheritCheckboxLabel(\Magento\Framework\Data\Form\Element\AbstractElement $element)
{
$checkboxLabel = __('Use Default');
if ($element->getCanUseWebsiteValue()) {
$checkboxLabel = __('Use Website');
}
return $checkboxLabel;
}
/**
* Render scope label
*
* @param \Magento\Framework\Data\Form\Element\AbstractElement $element
* @return string
*/
protected function _renderScopeLabel(\Magento\Framework\Data\Form\Element\AbstractElement $element)
{
$html = '<td class="scope-label">';
if ($element->getScope() && false == $this->_storeManager->isSingleStoreMode()) {
$html .= $element->getScopeLabel();
}
$html .= '</td>';
return $html;
}
/**
* Render field hint
*
* @param \Magento\Framework\Data\Form\Element\AbstractElement $element
* @return string
*/
protected function _renderHint(\Magento\Framework\Data\Form\Element\AbstractElement $element)
{
$html = '<td class="">';
if ($element->getHint()) {
$html .= '<div class="hint"><div style="display: none;">' . $element->getHint() . '</div></div>';
}
$html .= '</td>';
return $html;
}
/**
* Decorate field row html
*
* @param \Magento\Framework\Data\Form\Element\AbstractElement $element
* @param string $html
* @return string
*/
protected function _decorateRowHtml($element, $html)
{
return '<tr id="row_' . $element->getHtmlId() . '">' . $html . '</tr>';
}
}