magento2/app/code/Magento/Config/Model/Config.php
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Config\Model;
use Magento\Config\Model\Config\Reader\Source\Deployed\SettingChecker;
use Magento\Config\Model\Config\Structure\Element\Group;
use Magento\Config\Model\Config\Structure\Element\Field;
use Magento\Framework\App\ObjectManager;
/**
* Backend config model
* Used to save configuration
*
* @author Magento Core Team <core@magentocommerce.com>
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
* @api
* @since 100.0.2
*/
class Config extends \Magento\Framework\DataObject
{
/**
* Config data for sections
*
* @var array
*/
protected $_configData;
/**
* Event dispatcher
*
* @var \Magento\Framework\Event\ManagerInterface
*/
protected $_eventManager;
/**
* System configuration structure
*
* @var \Magento\Config\Model\Config\Structure
*/
protected $_configStructure;
/**
* Application config
*
* @var \Magento\Framework\App\Config\ScopeConfigInterface
*/
protected $_appConfig;
/**
* Global factory
*
* @var \Magento\Framework\App\Config\ScopeConfigInterface
*/
protected $_objectFactory;
/**
* TransactionFactory
*
* @var \Magento\Framework\DB\TransactionFactory
*/
protected $_transactionFactory;
/**
* Config data loader
*
* @var \Magento\Config\Model\Config\Loader
*/
protected $_configLoader;
/**
* Config data factory
*
* @var \Magento\Framework\App\Config\ValueFactory
*/
protected $_configValueFactory;
/**
* @var \Magento\Store\Model\StoreManagerInterface
*/
protected $_storeManager;
/**
* @var Config\Reader\Source\Deployed\SettingChecker
*/
private $settingChecker;
/**
* @param \Magento\Framework\App\Config\ReinitableConfigInterface $config
* @param \Magento\Framework\Event\ManagerInterface $eventManager
* @param \Magento\Config\Model\Config\Structure $configStructure
* @param \Magento\Framework\DB\TransactionFactory $transactionFactory
* @param \Magento\Config\Model\Config\Loader $configLoader
* @param \Magento\Framework\App\Config\ValueFactory $configValueFactory
* @param \Magento\Store\Model\StoreManagerInterface $storeManager
* @param Config\Reader\Source\Deployed\SettingChecker|null $settingChecker
* @param array $data
*/
public function __construct(
\Magento\Framework\App\Config\ReinitableConfigInterface $config,
\Magento\Framework\Event\ManagerInterface $eventManager,
\Magento\Config\Model\Config\Structure $configStructure,
\Magento\Framework\DB\TransactionFactory $transactionFactory,
\Magento\Config\Model\Config\Loader $configLoader,
\Magento\Framework\App\Config\ValueFactory $configValueFactory,
\Magento\Store\Model\StoreManagerInterface $storeManager,
SettingChecker $settingChecker = null,
array $data = []
) {
parent::__construct($data);
$this->_eventManager = $eventManager;
$this->_configStructure = $configStructure;
$this->_transactionFactory = $transactionFactory;
$this->_appConfig = $config;
$this->_configLoader = $configLoader;
$this->_configValueFactory = $configValueFactory;
$this->_storeManager = $storeManager;
$this->settingChecker = $settingChecker ?: ObjectManager::getInstance()->get(SettingChecker::class);
}
/**
* Save config section
* Require set: section, website, store and groups
*
* @throws \Exception
* @return $this
*/
public function save()
{
$this->initScope();
$sectionId = $this->getSection();
$groups = $this->getGroups();
if (empty($groups)) {
return $this;
}
$oldConfig = $this->_getConfig(true);
/** @var \Magento\Framework\DB\Transaction $deleteTransaction */
$deleteTransaction = $this->_transactionFactory->create();
/** @var \Magento\Framework\DB\Transaction $saveTransaction */
$saveTransaction = $this->_transactionFactory->create();
$changedPaths = [];
// Extends for old config data
$extraOldGroups = [];
foreach ($groups as $groupId => $groupData) {
$this->_processGroup(
$groupId,
$groupData,
$groups,
$sectionId,
$extraOldGroups,
$oldConfig,
$saveTransaction,
$deleteTransaction
);
$groupChangedPaths = $this->getChangedPaths($sectionId, $groupId, $groupData, $oldConfig, $extraOldGroups);
$changedPaths = \array_merge($changedPaths, $groupChangedPaths);
}
try {
$deleteTransaction->delete();
$saveTransaction->save();
// re-init configuration
$this->_appConfig->reinit();
// website and store codes can be used in event implementation, so set them as well
$this->_eventManager->dispatch(
"admin_system_config_changed_section_{$this->getSection()}",
[
'website' => $this->getWebsite(),
'store' => $this->getStore(),
'changed_paths' => $changedPaths,
]
);
} catch (\Exception $e) {
// re-init configuration
$this->_appConfig->reinit();
throw $e;
}
return $this;
}
/**
* Map field name if they were cloned
*
* @param Group $group
* @param string $fieldId
* @return string
*/
private function getOriginalFieldId(Group $group, string $fieldId): string
{
if ($group->shouldCloneFields()) {
$cloneModel = $group->getCloneModel();
/** @var \Magento\Config\Model\Config\Structure\Element\Field $field */
foreach ($group->getChildren() as $field) {
foreach ($cloneModel->getPrefixes() as $prefix) {
if ($prefix['field'] . $field->getId() === $fieldId) {
$fieldId = $field->getId();
break(2);
}
}
}
}
return $fieldId;
}
/**
* Get field object
*
* @param string $sectionId
* @param string $groupId
* @param string $fieldId
* @return Field
*/
private function getField(string $sectionId, string $groupId, string $fieldId): Field
{
/** @var \Magento\Config\Model\Config\Structure\Element\Group $group */
$group = $this->_configStructure->getElement($sectionId . '/' . $groupId);
$fieldPath = $group->getPath() . '/' . $this->getOriginalFieldId($group, $fieldId);
$field = $this->_configStructure->getElement($fieldPath);
return $field;
}
/**
* Get field path
*
* @param Field $field
* @param string $fieldId Need for support of clone_field feature
* @param array &$oldConfig Need for compatibility with _processGroup()
* @param array &$extraOldGroups Need for compatibility with _processGroup()
* @return string
*/
private function getFieldPath(Field $field, string $fieldId, array &$oldConfig, array &$extraOldGroups): string
{
$path = $field->getGroupPath() . '/' . $fieldId;
/**
* Look for custom defined field path
*/
$configPath = $field->getConfigPath();
if ($configPath && strrpos($configPath, '/') > 0) {
// Extend old data with specified section group
$configGroupPath = substr($configPath, 0, strrpos($configPath, '/'));
if (!isset($extraOldGroups[$configGroupPath])) {
$oldConfig = $this->extendConfig($configGroupPath, true, $oldConfig);
$extraOldGroups[$configGroupPath] = true;
}
$path = $configPath;
}
return $path;
}
/**
* Check is config value changed
*
* @param array $oldConfig
* @param string $path
* @param array $fieldData
* @return bool
*/
private function isValueChanged(array $oldConfig, string $path, array $fieldData): bool
{
if (isset($oldConfig[$path]['value'])) {
$result = !isset($fieldData['value']) || $oldConfig[$path]['value'] !== $fieldData['value'];
} else {
$result = empty($fieldData['inherit']);
}
return $result;
}
/**
* Get changed paths
*
* @param string $sectionId
* @param string $groupId
* @param array $groupData
* @param array &$oldConfig
* @param array &$extraOldGroups
* @return array
*/
private function getChangedPaths(
string $sectionId,
string $groupId,
array $groupData,
array &$oldConfig,
array &$extraOldGroups
): array {
$changedPaths = [];
if (isset($groupData['fields'])) {
foreach ($groupData['fields'] as $fieldId => $fieldData) {
$field = $this->getField($sectionId, $groupId, $fieldId);
$path = $this->getFieldPath($field, $fieldId, $oldConfig, $extraOldGroups);
if ($this->isValueChanged($oldConfig, $path, $fieldData)) {
$changedPaths[] = $path;
}
}
}
if (isset($groupData['groups'])) {
$subSectionId = $sectionId . '/' . $groupId;
foreach ($groupData['groups'] as $subGroupId => $subGroupData) {
$subGroupChangedPaths = $this->getChangedPaths(
$subSectionId,
$subGroupId,
$subGroupData,
$oldConfig,
$extraOldGroups
);
$changedPaths = \array_merge($changedPaths, $subGroupChangedPaths);
}
}
return $changedPaths;
}
/**
* Process group data
*
* @param string $groupId
* @param array $groupData
* @param array $groups
* @param string $sectionPath
* @param array &$extraOldGroups
* @param array &$oldConfig
* @param \Magento\Framework\DB\Transaction $saveTransaction
* @param \Magento\Framework\DB\Transaction $deleteTransaction
* @return void
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
* @SuppressWarnings(PHPMD.NPathComplexity)
*/
protected function _processGroup(
$groupId,
array $groupData,
array $groups,
$sectionPath,
array &$extraOldGroups,
array &$oldConfig,
\Magento\Framework\DB\Transaction $saveTransaction,
\Magento\Framework\DB\Transaction $deleteTransaction
) {
$groupPath = $sectionPath . '/' . $groupId;
if (isset($groupData['fields'])) {
/** @var \Magento\Config\Model\Config\Structure\Element\Group $group */
$group = $this->_configStructure->getElement($groupPath);
// set value for group field entry by fieldname
// use extra memory
$fieldsetData = [];
foreach ($groupData['fields'] as $fieldId => $fieldData) {
$fieldsetData[$fieldId] = $fieldData['value'] ?? null;
}
foreach ($groupData['fields'] as $fieldId => $fieldData) {
$isReadOnly = $this->settingChecker->isReadOnly(
$groupPath . '/' . $fieldId,
$this->getScope(),
$this->getScopeCode()
);
if ($isReadOnly) {
continue;
}
$field = $this->getField($sectionPath, $groupId, $fieldId);
/** @var \Magento\Framework\App\Config\ValueInterface $backendModel */
$backendModel = $field->hasBackendModel()
? $field->getBackendModel()
: $this->_configValueFactory->create();
if (!isset($fieldData['value'])) {
$fieldData['value'] = null;
}
$data = [
'field' => $fieldId,
'groups' => $groups,
'group_id' => $group->getId(),
'scope' => $this->getScope(),
'scope_id' => $this->getScopeId(),
'scope_code' => $this->getScopeCode(),
'field_config' => $field->getData(),
'fieldset_data' => $fieldsetData,
];
$backendModel->addData($data);
$this->_checkSingleStoreMode($field, $backendModel);
$path = $this->getFieldPath($field, $fieldId, $extraOldGroups, $oldConfig);
$backendModel->setPath($path)->setValue($fieldData['value']);
$inherit = !empty($fieldData['inherit']);
if (isset($oldConfig[$path])) {
$backendModel->setConfigId($oldConfig[$path]['config_id']);
/**
* Delete config data if inherit
*/
if (!$inherit) {
$saveTransaction->addObject($backendModel);
} else {
$deleteTransaction->addObject($backendModel);
}
} elseif (!$inherit) {
$backendModel->unsConfigId();
$saveTransaction->addObject($backendModel);
}
}
}
if (isset($groupData['groups'])) {
foreach ($groupData['groups'] as $subGroupId => $subGroupData) {
$this->_processGroup(
$subGroupId,
$subGroupData,
$groups,
$groupPath,
$extraOldGroups,
$oldConfig,
$saveTransaction,
$deleteTransaction
);
}
}
}
/**
* Load config data for section
*
* @return array
*/
public function load()
{
if ($this->_configData === null) {
$this->initScope();
$this->_configData = $this->_getConfig(false);
}
return $this->_configData;
}
/**
* Extend config data with additional config data by specified path
*
* @param string $path Config path prefix
* @param bool $full Simple config structure or not
* @param array $oldConfig Config data to extend
* @return array
*/
public function extendConfig($path, $full = true, $oldConfig = [])
{
$extended = $this->_configLoader->getConfigByPath($path, $this->getScope(), $this->getScopeId(), $full);
if (is_array($oldConfig) && !empty($oldConfig)) {
return $oldConfig + $extended;
}
return $extended;
}
/**
* Add data by path section/group/field
*
* @param string $path
* @param mixed $value
* @return void
* @throws \UnexpectedValueException
*/
public function setDataByPath($path, $value)
{
$path = trim($path);
if ($path === '') {
throw new \UnexpectedValueException('Path must not be empty');
}
$pathParts = explode('/', $path);
$keyDepth = count($pathParts);
if ($keyDepth !== 3) {
throw new \UnexpectedValueException(
"Allowed depth of configuration is 3 (<section>/<group>/<field>). Your configuration depth is "
. $keyDepth . " for path '$path'"
);
}
$data = [
'section' => $pathParts[0],
'groups' => [
$pathParts[1] => [
'fields' => [
$pathParts[2] => ['value' => $value],
],
],
],
];
$this->addData($data);
}
/**
* Get scope name and scopeId
* @todo refactor to scope resolver
* @return void
*/
private function initScope()
{
if ($this->getSection() === null) {
$this->setSection('');
}
if ($this->getWebsite() === null) {
$this->setWebsite('');
}
if ($this->getStore() === null) {
$this->setStore('');
}
if ($this->getStore()) {
$scope = 'stores';
$store = $this->_storeManager->getStore($this->getStore());
$scopeId = (int)$store->getId();
$scopeCode = $store->getCode();
} elseif ($this->getWebsite()) {
$scope = 'websites';
$website = $this->_storeManager->getWebsite($this->getWebsite());
$scopeId = (int)$website->getId();
$scopeCode = $website->getCode();
} else {
$scope = 'default';
$scopeId = 0;
$scopeCode = '';
}
$this->setScope($scope);
$this->setScopeId($scopeId);
$this->setScopeCode($scopeCode);
}
/**
* Return formatted config data for current section
*
* @param bool $full Simple config structure or not
* @return array
*/
protected function _getConfig($full = true)
{
return $this->_configLoader->getConfigByPath(
$this->getSection(),
$this->getScope(),
$this->getScopeId(),
$full
);
}
/**
* Set correct scope if isSingleStoreMode = true
*
* @param \Magento\Config\Model\Config\Structure\Element\Field $fieldConfig
* @param \Magento\Framework\App\Config\ValueInterface $dataObject
* @return void
*/
protected function _checkSingleStoreMode(
\Magento\Config\Model\Config\Structure\Element\Field $fieldConfig,
$dataObject
) {
$isSingleStoreMode = $this->_storeManager->isSingleStoreMode();
if (!$isSingleStoreMode) {
return;
}
if (!$fieldConfig->showInDefault()) {
$websites = $this->_storeManager->getWebsites();
$singleStoreWebsite = array_shift($websites);
$dataObject->setScope('websites');
$dataObject->setWebsiteCode($singleStoreWebsite->getCode());
$dataObject->setScopeCode($singleStoreWebsite->getCode());
$dataObject->setScopeId($singleStoreWebsite->getId());
}
}
/**
* Get config data value
*
* @param string $path
* @param null|bool &$inherit
* @param null|array $configData
* @return \Magento\Framework\Simplexml\Element
*/
public function getConfigDataValue($path, &$inherit = null, $configData = null)
{
$this->load();
if ($configData === null) {
$configData = $this->_configData;
}
if (isset($configData[$path])) {
$data = $configData[$path];
$inherit = false;
} else {
$data = $this->_appConfig->getValue($path, $this->getScope(), $this->getScopeCode());
$inherit = true;
}
return $data;
}
}
0 Comments