Your IP : 216.73.216.220
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Config\Model\Config\Structure;
use Magento\Config\Model\Config\StructureElementInterface;
use Magento\Framework\App\Config\ScopeConfigInterface;
use Magento\Store\Model\StoreManagerInterface;
use Magento\Framework\App\ObjectManager;
/**
* Abstract element.
* phpcs:disable Magento2.Classes.AbstractApi
* @api
* @since 100.0.2
*/
abstract class AbstractElement implements StructureElementInterface
{
/**
* Element data
*
* @var array
*/
protected $_data = [];
/**
* Current configuration scope
*
* @var string
*/
protected $_scope;
/**
* Store manager
*
* @var \Magento\Store\Model\StoreManagerInterface
*/
protected $_storeManager;
/**
* @var \Magento\Framework\Module\Manager
*/
protected $moduleManager;
/**
* @var ElementVisibilityInterface
*/
private $elementVisibility;
/**
* @param \Magento\Store\Model\StoreManagerInterface $storeManager
* @param \Magento\Framework\Module\Manager $moduleManager
*/
public function __construct(StoreManagerInterface $storeManager, \Magento\Framework\Module\Manager $moduleManager)
{
$this->_storeManager = $storeManager;
$this->moduleManager = $moduleManager;
}
/**
* Translate element attribute
*
* @param string $code
* @return \Magento\Framework\Phrase|string
*/
protected function _getTranslatedAttribute($code)
{
if (false == array_key_exists($code, $this->_data)) {
return '';
}
return __($this->_data[$code]);
}
/**
* Set element data
*
* @param array $data
* @param string $scope
* @return void
*/
public function setData(array $data, $scope)
{
$this->_data = $data;
$this->_scope = $scope;
}
/**
* Retrieve flyweight data
*
* @return array
*/
public function getData()
{
return $this->_data;
}
/**
* Retrieve element id
*
* @return string
*/
public function getId()
{
return $this->_data['id'] ?? '';
}
/**
* Retrieve element label
*
* @return string
*/
public function getLabel()
{
return $this->_getTranslatedAttribute('label');
}
/**
* Retrieve element label
*
* @return string
*/
public function getComment()
{
return $this->_getTranslatedAttribute('comment');
}
/**
* Retrieve frontend model class name
*
* @return string
*/
public function getFrontendModel()
{
return $this->_data['frontend_model'] ?? '';
}
/**
* Retrieve arbitrary element attribute
*
* @param string $key
* @return mixed
*/
public function getAttribute($key)
{
return array_key_exists($key, $this->_data) ? $this->_data[$key] : null;
}
/**
* Check whether element should be displayed
*
* @return bool
*/
public function isVisible()
{
if ($this->getElementVisibility()->isHidden($this->getPath())) {
return false;
}
if (isset($this->_data['if_module_enabled']) &&
!$this->moduleManager->isOutputEnabled($this->_data['if_module_enabled'])) {
return false;
}
$showInScope = [
\Magento\Store\Model\ScopeInterface::SCOPE_STORE => $this->_hasVisibilityValue('showInStore'),
\Magento\Store\Model\ScopeInterface::SCOPE_WEBSITE => $this->_hasVisibilityValue('showInWebsite'),
ScopeConfigInterface::SCOPE_TYPE_DEFAULT => $this->_hasVisibilityValue('showInDefault'),
];
if ($this->_storeManager->isSingleStoreMode()) {
$result = !$this->_hasVisibilityValue('hide_in_single_store_mode') && array_sum($showInScope);
return $result;
}
return !empty($showInScope[$this->_scope]);
}
/**
* Retrieve value of visibility flag
*
* @param string $key
* @return bool
*/
protected function _hasVisibilityValue($key)
{
return isset($this->_data[$key]) && $this->_data[$key];
}
/**
* Retrieve css class of a tab
*
* @return string
*/
public function getClass()
{
return $this->_data['class'] ?? '';
}
/**
* Retrieve config path for given id
*
* @param string $fieldId
* @param string $fieldPrefix
* @return string
*/
protected function _getPath($fieldId, $fieldPrefix = '')
{
$path = isset($this->_data['path']) ? $this->_data['path'] : '';
return $path . '/' . $fieldPrefix . $fieldId;
}
/**
* Retrieve element config path
*
* @param string $fieldPrefix
* @return string
*/
public function getPath($fieldPrefix = '')
{
return $this->_getPath($this->getId(), $fieldPrefix);
}
/**
* Get 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;
}
}