Your IP : 216.73.216.81
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Config\Block\System\Config;
use Magento\Config\App\Config\Type\System;
use Magento\Config\Model\Config\Reader\Source\Deployed\SettingChecker;
use Magento\Config\Model\Config\Structure\ElementVisibilityInterface;
use Magento\Framework\App\Config\Data\ProcessorInterface;
use Magento\Framework\App\Config\ScopeConfigInterface;
use Magento\Framework\App\DeploymentConfig;
use Magento\Framework\App\ObjectManager;
use Magento\Framework\DataObject;
/**
* System config form block
*
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
* @SuppressWarnings(PHPMD.DepthOfInheritance)
* @api
* @since 100.0.2
*/
class Form extends \Magento\Backend\Block\Widget\Form\Generic
{
public const SCOPE_DEFAULT = 'default';
public const SCOPE_WEBSITES = 'websites';
public const SCOPE_STORES = 'stores';
/**
* Config data array
*
* @var array
*/
protected $_configData;
/**
* Backend config data instance
*
* @var \Magento\Config\Model\Config
*/
protected $_configDataObject;
/**
* Default fieldset rendering block
*
* @var \Magento\Config\Block\System\Config\Form\Fieldset
*/
protected $_fieldsetRenderer;
/**
* Default field rendering block
*
* @var \Magento\Config\Block\System\Config\Form\Field
*/
protected $_fieldRenderer;
/**
* List of fieldset
*
* @var array
*/
protected $_fieldsets = [];
/**
* Translated scope labels
*
* @var array
*/
protected $_scopeLabels = [];
/**
* Backend Config model factory
*
* @var \Magento\Config\Model\Config\Factory
*/
protected $_configFactory;
/**
* Magento\Framework\Data\FormFactory
*
* @var \Magento\Framework\Data\FormFactory
*/
protected $_formFactory;
/**
* System config structure
*
* @var \Magento\Config\Model\Config\Structure
*/
protected $_configStructure;
/**
* Form fieldset factory
*
* @var \Magento\Config\Block\System\Config\Form\Fieldset\Factory
*/
protected $_fieldsetFactory;
/**
* Form field factory
*
* @var \Magento\Config\Block\System\Config\Form\Field\Factory
*/
protected $_fieldFactory;
/**
* @var SettingChecker
*/
private $settingChecker;
/**
* @var DeploymentConfig
*/
private $appConfig;
/**
* Checks visibility status of form elements on Stores > Settings > Configuration page in Admin Panel
* by their paths in the system.xml structure.
*
* @var ElementVisibilityInterface
*/
private $elementVisibility;
/**
* @param \Magento\Backend\Block\Template\Context $context
* @param \Magento\Framework\Registry $registry
* @param \Magento\Framework\Data\FormFactory $formFactory
* @param \Magento\Config\Model\Config\Factory $configFactory
* @param \Magento\Config\Model\Config\Structure $configStructure
* @param \Magento\Config\Block\System\Config\Form\Fieldset\Factory $fieldsetFactory
* @param \Magento\Config\Block\System\Config\Form\Field\Factory $fieldFactory
* @param array $data
* @param SettingChecker|null $settingChecker
*/
public function __construct(
\Magento\Backend\Block\Template\Context $context,
\Magento\Framework\Registry $registry,
\Magento\Framework\Data\FormFactory $formFactory,
\Magento\Config\Model\Config\Factory $configFactory,
\Magento\Config\Model\Config\Structure $configStructure,
\Magento\Config\Block\System\Config\Form\Fieldset\Factory $fieldsetFactory,
\Magento\Config\Block\System\Config\Form\Field\Factory $fieldFactory,
array $data = [],
SettingChecker $settingChecker = null
) {
parent::__construct($context, $registry, $formFactory, $data);
$this->_configFactory = $configFactory;
$this->_configStructure = $configStructure;
$this->_fieldsetFactory = $fieldsetFactory;
$this->_fieldFactory = $fieldFactory;
$this->settingChecker = $settingChecker ?: ObjectManager::getInstance()->get(SettingChecker::class);
$this->_scopeLabels = [
self::SCOPE_DEFAULT => __('[GLOBAL]'),
self::SCOPE_WEBSITES => __('[WEBSITE]'),
self::SCOPE_STORES => __('[STORE VIEW]'),
];
}
/**
* Initialize objects required to render config form
*
* @return $this
*/
protected function _initObjects()
{
$this->_configDataObject = $this->_configFactory->create(
[
'data' => [
'section' => $this->getSectionCode(),
'website' => $this->getWebsiteCode(),
'store' => $this->getStoreCode(),
],
]
);
$this->_configData = $this->_configDataObject->load();
$this->_fieldsetRenderer = $this->_fieldsetFactory->create();
$this->_fieldRenderer = $this->_fieldFactory->create();
return $this;
}
/**
* Initialize form
*
* @return $this
*/
public function initForm()
{
$this->_initObjects();
/** @var \Magento\Framework\Data\Form $form */
$form = $this->_formFactory->create();
/** @var $section \Magento\Config\Model\Config\Structure\Element\Section */
$section = $this->_configStructure->getElement($this->getSectionCode());
if ($section && $section->isVisible($this->getWebsiteCode(), $this->getStoreCode())) {
foreach ($section->getChildren() as $group) {
$this->_initGroup($group, $section, $form);
}
}
$this->setForm($form);
return $this;
}
/**
* Initialize config field group
*
* @param \Magento\Config\Model\Config\Structure\Element\Group $group
* @param \Magento\Config\Model\Config\Structure\Element\Section $section
* @param \Magento\Framework\Data\Form\AbstractForm $form
* @return void
*/
protected function _initGroup(
\Magento\Config\Model\Config\Structure\Element\Group $group,
\Magento\Config\Model\Config\Structure\Element\Section $section,
\Magento\Framework\Data\Form\AbstractForm $form
) {
$frontendModelClass = $group->getFrontendModel();
$fieldsetRenderer = $frontendModelClass ? $this->_layout->getBlockSingleton(
$frontendModelClass
) : $this->_fieldsetRenderer;
$fieldsetRenderer->setForm($this);
$fieldsetRenderer->setConfigData($this->_configData);
$fieldsetRenderer->setGroup($group);
$fieldsetConfig = [
'legend' => $group->getLabel(),
'comment' => $group->getComment(),
'expanded' => $group->isExpanded(),
'group' => $group->getData(),
];
$fieldset = $form->addFieldset($this->_generateElementId($group->getPath()), $fieldsetConfig);
$fieldset->setRenderer($fieldsetRenderer);
$group->populateFieldset($fieldset);
$this->_addElementTypes($fieldset);
$dependencies = $group->getDependencies($this->getStoreCode());
$elementName = $this->_generateElementName($group->getPath());
$elementId = $this->_generateElementId($group->getPath());
$this->_populateDependenciesBlock($dependencies, $elementId, $elementName);
if ($group->shouldCloneFields()) {
$cloneModel = $group->getCloneModel();
foreach ($cloneModel->getPrefixes() as $prefix) {
$this->initFields($fieldset, $group, $section, $prefix['field'], $prefix['label']);
}
} else {
$this->initFields($fieldset, $group, $section);
}
$this->_fieldsets[$group->getId()] = $fieldset;
}
/**
* Return dependency block object
*
* @return \Magento\Backend\Block\Widget\Form\Element\Dependence
*/
protected function _getDependence()
{
if (!$this->getChildBlock('element_dependence')) {
$this->addChild('element_dependence', \Magento\Backend\Block\Widget\Form\Element\Dependence::class);
}
return $this->getChildBlock('element_dependence');
}
/**
* Initialize config group fields
*
* @param \Magento\Framework\Data\Form\Element\Fieldset $fieldset
* @param \Magento\Config\Model\Config\Structure\Element\Group $group
* @param \Magento\Config\Model\Config\Structure\Element\Section $section
* @param string $fieldPrefix
* @param string $labelPrefix
* @return $this
*/
public function initFields(
\Magento\Framework\Data\Form\Element\Fieldset $fieldset,
\Magento\Config\Model\Config\Structure\Element\Group $group,
\Magento\Config\Model\Config\Structure\Element\Section $section,
$fieldPrefix = '',
$labelPrefix = ''
) {
if (!$this->_configDataObject) {
$this->_initObjects();
}
// Extends for config data
$extraConfigGroups = [];
/** @var $element \Magento\Config\Model\Config\Structure\Element\Field */
foreach ($group->getChildren() as $element) {
if ($element instanceof \Magento\Config\Model\Config\Structure\Element\Group) {
$this->_initGroup($element, $section, $fieldset);
} else {
$path = $element->getConfigPath() ?: $element->getPath($fieldPrefix);
if ($element->getSectionId() != $section->getId()) {
$groupPath = $element->getGroupPath();
if (!isset($extraConfigGroups[$groupPath])) {
$this->_configData = $this->_configDataObject->extendConfig(
$groupPath,
false,
$this->_configData
);
$extraConfigGroups[$groupPath] = true;
}
}
$this->_initElement($element, $fieldset, $path, $fieldPrefix, $labelPrefix);
}
}
return $this;
}
/**
* Initialize form element
*
* @param \Magento\Config\Model\Config\Structure\Element\Field $field
* @param \Magento\Framework\Data\Form\Element\Fieldset $fieldset
* @param string $path
* @param string $fieldPrefix
* @param string $labelPrefix
* @return void
*/
protected function _initElement(
\Magento\Config\Model\Config\Structure\Element\Field $field,
\Magento\Framework\Data\Form\Element\Fieldset $fieldset,
$path,
$fieldPrefix = '',
$labelPrefix = ''
) {
$inherit = !array_key_exists($path, $this->_configData);
$data = $this->getFieldData($field, $path);
$fieldRendererClass = $field->getFrontendModel();
if ($fieldRendererClass) {
$fieldRenderer = $this->_layout->getBlockSingleton($fieldRendererClass);
} else {
$fieldRenderer = $this->_fieldRenderer;
}
$fieldRenderer->setForm($this);
$fieldRenderer->setConfigData($this->_configData);
$elementName = $this->_generateElementName($field->getPath(), $fieldPrefix);
$elementId = $this->_generateElementId($field->getPath($fieldPrefix));
$dependencies = $field->getDependencies($fieldPrefix, $this->getStoreCode());
$this->_populateDependenciesBlock($dependencies, $elementId, $elementName);
$sharedClass = $this->_getSharedCssClass($field);
$requiresClass = $this->_getRequiresCssClass($field, $fieldPrefix);
$isReadOnly = $this->isReadOnly($field, $path);
$formField = $fieldset->addField(
$elementId,
$field->getType(),
[
'name' => $elementName,
'label' => $field->getLabel($labelPrefix),
'comment' => $field->getComment($data),
'tooltip' => $field->getTooltip(),
'hint' => $field->getHint(),
'value' => $data,
'inherit' => $inherit,
'class' => $field->getFrontendClass() . $sharedClass . $requiresClass,
'field_config' => $field->getData(),
'scope' => $this->getScope(),
'scope_id' => $this->getScopeId(),
'scope_label' => $this->getScopeLabel($field),
'can_use_default_value' => $this->canUseDefaultValue($field->showInDefault()),
'can_use_website_value' => $this->canUseWebsiteValue($field->showInWebsite()),
'can_restore_to_default' => $this->isCanRestoreToDefault($field->canRestore()),
'disabled' => $isReadOnly,
'is_disable_inheritance' => $isReadOnly
]
);
$field->populateInput($formField);
if ($field->hasValidation()) {
$formField->addClass($field->getValidation());
}
if ($field->getType() == 'multiselect') {
$formField->setCanBeEmpty($field->canBeEmpty());
}
if ($field->hasOptions()) {
$formField->setValues($field->getOptions());
}
$formField->setRenderer($fieldRenderer);
}
/**
* Get data of field by path
*
* @param \Magento\Config\Model\Config\Structure\Element\Field $field
* @param string $path
* @return mixed|null|string
*/
private function getFieldData(\Magento\Config\Model\Config\Structure\Element\Field $field, $path)
{
$data = $this->getAppConfigDataValue($path);
$placeholderValue = $this->settingChecker->getPlaceholderValue(
$path,
$this->getScope(),
$this->getStringScopeCode()
);
if ($placeholderValue) {
$data = $placeholderValue;
}
if ($data === null) {
$path = $field->getConfigPath() !== null ? $field->getConfigPath() : $path;
$data = $this->getConfigValue($path);
if ($field->hasBackendModel()) {
$backendModel = $field->getBackendModel();
// Backend models which implement ProcessorInterface are processed by ScopeConfigInterface
if (!$backendModel instanceof ProcessorInterface) {
if (array_key_exists($path, $this->_configData)) {
$data = $this->_configData[$path];
}
$backendModel->setPath($path)
->setValue($data)
->setWebsite($this->getWebsiteCode())
->setStore($this->getStoreCode())
->afterLoad();
$data = $backendModel->getValue();
}
}
}
return $data;
}
/**
* Retrieve Scope string code
*
* @return string
*/
private function getStringScopeCode()
{
$scopeCode = $this->getData('scope_string_code');
if (null === $scopeCode) {
if ($this->getStoreCode()) {
$scopeCode = $this->_storeManager->getStore($this->getStoreCode())->getCode();
} elseif ($this->getWebsiteCode()) {
$scopeCode = $this->_storeManager->getWebsite($this->getWebsiteCode())->getCode();
} else {
$scopeCode = '';
}
$this->setData('scope_string_code', $scopeCode);
}
return $scopeCode;
}
/**
* Populate dependencies block
*
* @param array $dependencies
* @param string $elementId
* @param string $elementName
* @return void
*/
protected function _populateDependenciesBlock(array $dependencies, $elementId, $elementName)
{
foreach ($dependencies as $dependentField) {
/** @var $dependentField \Magento\Config\Model\Config\Structure\Element\Dependency\Field */
$fieldNameFrom = $this->_generateElementName($dependentField->getId(), null, '_');
$this->_getDependence()->addFieldMap(
$elementId,
$elementName
)->addFieldMap(
$this->_generateElementId($dependentField->getId()),
$fieldNameFrom
)->addFieldDependence(
$elementName,
$fieldNameFrom,
$dependentField
);
}
}
/**
* Generate element name
*
* @param string $elementPath
* @param string $fieldPrefix
* @param string $separator
* @return string
*/
protected function _generateElementName($elementPath, $fieldPrefix = '', $separator = '/')
{
$part = explode($separator, $elementPath);
array_shift($part);
//shift section name
$fieldId = array_pop($part);
//shift filed id
$groupName = implode('][groups][', $part);
$name = 'groups[' . $groupName . '][fields][' . $fieldPrefix . $fieldId . '][value]';
return $name;
}
/**
* Generate element id
*
* @param string $path
* @return string
*/
protected function _generateElementId($path)
{
return $path !== null ? str_replace('/', '_', $path) : '';
}
/**
* Get config value
*
* @param string $path
* @return mixed
*/
public function getConfigValue($path)
{
return $this->_scopeConfig->getValue($path, $this->getScope(), $this->getScopeCode());
}
/**
* @inheritdoc
*/
protected function _beforeToHtml()
{
$this->initForm();
return parent::_beforeToHtml();
}
/**
* Append dependence block at then end of form block
*
* @param string $html
* @return string
*/
protected function _afterToHtml($html)
{
if ($this->_getDependence()) {
$html .= $this->_getDependence()->toHtml();
}
$html = parent::_afterToHtml($html);
return $html;
}
/**
* Check if can use default value
*
* @param int $fieldValue
* @return boolean
*/
public function canUseDefaultValue($fieldValue)
{
if ($this->getScope() == self::SCOPE_STORES && $fieldValue) {
return true;
}
if ($this->getScope() == self::SCOPE_WEBSITES && $fieldValue) {
return true;
}
return false;
}
/**
* Check if can use website value
*
* @param int $fieldValue
* @return boolean
*/
public function canUseWebsiteValue($fieldValue)
{
if ($this->getScope() == self::SCOPE_STORES && $fieldValue) {
return true;
}
return false;
}
/**
* Check if can use restore value
*
* @param int $fieldValue
* @return bool
* @since 100.1.0
*/
public function isCanRestoreToDefault($fieldValue)
{
if ($this->getScope() == self::SCOPE_DEFAULT && $fieldValue) {
return true;
}
return false;
}
/**
* Retrieve current scope
*
* @return string
*/
public function getScope()
{
$scope = $this->getData('scope');
if ($scope === null) {
if ($this->getStoreCode()) {
$scope = self::SCOPE_STORES;
} elseif ($this->getWebsiteCode()) {
$scope = self::SCOPE_WEBSITES;
} else {
$scope = self::SCOPE_DEFAULT;
}
$this->setScope($scope);
}
return $scope;
}
/**
* Retrieve label for scope
*
* @param \Magento\Config\Model\Config\Structure\Element\Field $field
* @return string
*/
public function getScopeLabel(\Magento\Config\Model\Config\Structure\Element\Field $field)
{
$showInStore = $field->showInStore();
$showInWebsite = $field->showInWebsite();
if ($showInStore == 1) {
return $this->_scopeLabels[self::SCOPE_STORES];
} elseif ($showInWebsite == 1) {
return $this->_scopeLabels[self::SCOPE_WEBSITES];
}
return $this->_scopeLabels[self::SCOPE_DEFAULT];
}
/**
* Get current scope code
*
* @return string
*/
public function getScopeCode()
{
$scopeCode = $this->getData('scope_code');
if ($scopeCode === null) {
if ($this->getStoreCode()) {
$scopeCode = $this->getStoreCode();
} elseif ($this->getWebsiteCode()) {
$scopeCode = $this->getWebsiteCode();
} else {
$scopeCode = '';
}
$this->setScopeCode($scopeCode);
}
return $scopeCode;
}
/**
* Get current scope code
*
* @return int|string
*/
public function getScopeId()
{
$scopeId = $this->getData('scope_id');
if ($scopeId === null) {
if ($this->getStoreCode()) {
$scopeId = $this->_storeManager->getStore($this->getStoreCode())->getId();
} elseif ($this->getWebsiteCode()) {
$scopeId = $this->_storeManager->getWebsite($this->getWebsiteCode())->getId();
} else {
$scopeId = '';
}
$this->setScopeId($scopeId);
}
return $scopeId;
}
/**
* Get additional element types
*
* @return array
*/
protected function _getAdditionalElementTypes()
{
return [
'allowspecific' => \Magento\Config\Block\System\Config\Form\Field\Select\Allowspecific::class,
'image' => \Magento\Config\Block\System\Config\Form\Field\Image::class,
'file' => \Magento\Config\Block\System\Config\Form\Field\File::class
];
}
/**
* Temporary moved those $this->getRequest()->getParam('blabla') from the code across this block
* to getBlala() methods to be later set from controller with setters
*/
/**
* Enter description here...
*
* @TODO delete this methods when {^see above^} is done
* @return string
* @SuppressWarnings(PHPMD.RequestAwareBlockMethod)
*/
public function getSectionCode()
{
return $this->getRequest()->getParam('section', '');
}
/**
* Enter description here...
*
* @TODO delete this methods when {^see above^} is done
* @return string
* @SuppressWarnings(PHPMD.RequestAwareBlockMethod)
*/
public function getWebsiteCode()
{
return $this->getRequest()->getParam('website', '');
}
/**
* Enter description here...
*
* @TODO delete this methods when {^see above^} is done
* @return string
* @SuppressWarnings(PHPMD.RequestAwareBlockMethod)
*/
public function getStoreCode()
{
return $this->getRequest()->getParam('store', '');
}
/**
* Get css class for "shared" functionality
*
* @param \Magento\Config\Model\Config\Structure\Element\Field $field
* @return string
*/
protected function _getSharedCssClass(\Magento\Config\Model\Config\Structure\Element\Field $field)
{
$sharedClass = '';
if ($field->getAttribute('shared') && $field->getConfigPath()) {
$sharedClass = ' shared shared-' . str_replace('/', '-', $field->getConfigPath());
return $sharedClass;
}
return $sharedClass;
}
/**
* Get css class for "requires" functionality
*
* @param \Magento\Config\Model\Config\Structure\Element\Field $field
* @param string $fieldPrefix
* @return string
*/
protected function _getRequiresCssClass(\Magento\Config\Model\Config\Structure\Element\Field $field, $fieldPrefix)
{
$requiresClass = '';
$requiredPaths = array_merge($field->getRequiredFields($fieldPrefix), $field->getRequiredGroups($fieldPrefix));
if (!empty($requiredPaths)) {
$requiresClass = ' requires';
foreach ($requiredPaths as $requiredPath) {
$requiresClass .= ' requires-' . $this->_generateElementId($requiredPath);
}
return $requiresClass;
}
return $requiresClass;
}
/**
* Retrieve Deployment Configuration object.
*
* @deprecated 100.1.2
* @return DeploymentConfig
*/
private function getAppConfig()
{
if ($this->appConfig === null) {
$this->appConfig = ObjectManager::getInstance()->get(DeploymentConfig::class);
}
return $this->appConfig;
}
/**
* Check Path is Readonly
*
* @param \Magento\Config\Model\Config\Structure\Element\Field $field
* @param string $path
* @return boolean
*/
private function isReadOnly(\Magento\Config\Model\Config\Structure\Element\Field $field, $path)
{
$isReadOnly = $this->settingChecker->isReadOnly(
$path,
ScopeConfigInterface::SCOPE_TYPE_DEFAULT
);
if (!$isReadOnly) {
$isReadOnly = $this->getElementVisibility()->isDisabled($field->getPath())
?: $this->settingChecker->isReadOnly($path, $this->getScope(), $this->getStringScopeCode());
}
return $isReadOnly;
}
/**
* Retrieve deployment config data value by path
*
* @param string $path
* @return null|string
*/
private function getAppConfigDataValue($path)
{
$appConfig = $this->getAppConfig()->get(System::CONFIG_TYPE);
$scope = $this->getScope();
$scopeCode = $this->getStringScopeCode();
if ($scope === ScopeConfigInterface::SCOPE_TYPE_DEFAULT) {
$data = new DataObject(isset($appConfig[$scope]) ? $appConfig[$scope] : []);
} else {
$data = new DataObject(isset($appConfig[$scope][$scopeCode]) ? $appConfig[$scope][$scopeCode] : []);
}
return $data->getData($path);
}
/**
* Gets instance of ElementVisibilityInterface.
*
* @return ElementVisibilityInterface
* @deprecated 101.0.0 Added to not break backward compatibility of the constructor signature
* by injecting the new dependency directly.
* The method can be removed in a future major release, when constructor signature can be changed.
* @since 101.0.0
*/
public function getElementVisibility()
{
if (null === $this->elementVisibility) {
$this->elementVisibility = ObjectManager::getInstance()->get(ElementVisibilityInterface::class);
}
return $this->elementVisibility;
}
}