Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory : /home/corals/old/vendor/magento/module-directory/Block/ |
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);
namespace Magento\Directory\Block;
/**
* Directory data block
*
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
*/
class Data extends \Magento\Framework\View\Element\Template
{
/**
* @var \Magento\Framework\App\Cache\Type\Config
*/
protected $_configCacheType;
/**
* @var \Magento\Directory\Model\ResourceModel\Region\CollectionFactory
*/
protected $_regionCollectionFactory;
/**
* @var \Magento\Directory\Model\ResourceModel\Country\CollectionFactory
*/
protected $_countryCollectionFactory;
/**
* @var \Magento\Framework\Json\EncoderInterface
*/
protected $_jsonEncoder;
/**
* @var \Magento\Directory\Helper\Data
*/
protected $directoryHelper;
/**
* @var \Magento\Framework\Serialize\SerializerInterface
*/
private $serializer;
/**
* @param \Magento\Framework\View\Element\Template\Context $context
* @param \Magento\Directory\Helper\Data $directoryHelper
* @param \Magento\Framework\Json\EncoderInterface $jsonEncoder
* @param \Magento\Framework\App\Cache\Type\Config $configCacheType
* @param \Magento\Directory\Model\ResourceModel\Region\CollectionFactory $regionCollectionFactory
* @param \Magento\Directory\Model\ResourceModel\Country\CollectionFactory $countryCollectionFactory
* @param array $data
*/
public function __construct(
\Magento\Framework\View\Element\Template\Context $context,
\Magento\Directory\Helper\Data $directoryHelper,
\Magento\Framework\Json\EncoderInterface $jsonEncoder,
\Magento\Framework\App\Cache\Type\Config $configCacheType,
\Magento\Directory\Model\ResourceModel\Region\CollectionFactory $regionCollectionFactory,
\Magento\Directory\Model\ResourceModel\Country\CollectionFactory $countryCollectionFactory,
array $data = []
) {
parent::__construct($context, $data);
$this->directoryHelper = $directoryHelper;
$this->_jsonEncoder = $jsonEncoder;
$this->_configCacheType = $configCacheType;
$this->_regionCollectionFactory = $regionCollectionFactory;
$this->_countryCollectionFactory = $countryCollectionFactory;
}
/**
* Returns load url for regions
*
* @return string
*/
public function getLoadrRegionUrl()
{
return $this->getUrl('directory/json/countryRegion');
}
/**
* Returns country collection instance
*
* @return \Magento\Directory\Model\ResourceModel\Country\Collection
*/
public function getCountryCollection()
{
$collection = $this->getData('country_collection');
if ($collection === null) {
$collection = $this->_countryCollectionFactory->create()->loadByStore();
$this->setData('country_collection', $collection);
}
return $collection;
}
/**
* Retrieve list of top destinations countries
*
* @return array
*/
protected function getTopDestinations()
{
$destinations = (string)$this->_scopeConfig->getValue(
'general/country/destinations',
\Magento\Store\Model\ScopeInterface::SCOPE_STORE
);
return !empty($destinations) ? explode(',', $destinations) : [];
}
/**
* Returns country html select
*
* @param null|string $defValue
* @param string $name
* @param string $id
* @param string $title
* @return string
*/
public function getCountryHtmlSelect($defValue = null, $name = 'country_id', $id = 'country', $title = 'Country')
{
\Magento\Framework\Profiler::start('TEST: ' . __METHOD__, ['group' => 'TEST', 'method' => __METHOD__]);
if ($defValue === null) {
$defValue = $this->getCountryId();
}
$cacheKey = 'DIRECTORY_COUNTRY_SELECT_STORE_' . $this->_storeManager->getStore()->getCode();
$cache = $this->_configCacheType->load($cacheKey);
if ($cache) {
$options = $this->getSerializer()->unserialize($cache);
} else {
$options = $this->getCountryCollection()
->setForegroundCountries($this->getTopDestinations())
->toOptionArray();
$this->_configCacheType->save($this->getSerializer()->serialize($options), $cacheKey);
}
$html = $this->getLayout()->createBlock(
\Magento\Framework\View\Element\Html\Select::class
)->setName(
$name
)->setId(
$id
)->setTitle(
$this->escapeHtmlAttr(__($title))
)->setValue(
$defValue
)->setOptions(
$options
)->setExtraParams(
'data-validate="{\'validate-select\':true}"'
)->getHtml();
\Magento\Framework\Profiler::stop('TEST: ' . __METHOD__);
return $html;
}
/**
* Returns region collection
*
* @return \Magento\Directory\Model\ResourceModel\Region\Collection
*/
public function getRegionCollection()
{
$collection = $this->getData('region_collection');
if ($collection === null) {
$collection = $this->_regionCollectionFactory->create()->addCountryFilter($this->getCountryId())->load();
$this->setData('region_collection', $collection);
}
return $collection;
}
/**
* Returns region html select
*
* @return string
* @deprecated 100.3.3
* @see getRegionSelect() method for more configurations
*/
public function getRegionHtmlSelect()
{
return $this->getRegionSelect();
}
/**
* Returns region html select
*
* @param null|int $value
* @param string $name
* @param string $id
* @param string $title
* @return string
*/
public function getRegionSelect(
?int $value = null,
string $name = 'region',
string $id = 'state',
string $title = 'State/Province'
): string {
\Magento\Framework\Profiler::start('TEST: ' . __METHOD__, ['group' => 'TEST', 'method' => __METHOD__]);
if ($value === null) {
$value = (int)$this->getRegionId();
}
$cacheKey = 'DIRECTORY_REGION_SELECT_STORE' . $this->_storeManager->getStore()->getId();
$cache = $this->_configCacheType->load($cacheKey);
if ($cache) {
$options = $this->getSerializer()->unserialize($cache);
} else {
$options = $this->getRegionCollection()->toOptionArray();
$this->_configCacheType->save($this->getSerializer()->serialize($options), $cacheKey);
}
$html = $this->getLayout()->createBlock(
\Magento\Framework\View\Element\Html\Select::class
)->setName(
$name
)->setTitle(
__($title)
)->setId(
$id
)->setClass(
'required-entry validate-state'
)->setValue(
$value
)->setOptions(
$options
)->getHtml();
\Magento\Framework\Profiler::start('TEST: ' . __METHOD__, ['group' => 'TEST', 'method' => __METHOD__]);
return $html;
}
/**
* Returns country id
*
* @return string
*/
public function getCountryId()
{
$countryId = $this->getData('country_id');
if ($countryId === null) {
$countryId = $this->directoryHelper->getDefaultCountry();
}
return $countryId;
}
/**
* Returns regions js
*
* @return string
*/
public function getRegionsJs()
{
\Magento\Framework\Profiler::start('TEST: ' . __METHOD__, ['group' => 'TEST', 'method' => __METHOD__]);
$regionsJs = $this->getData('regions_js');
if (!$regionsJs) {
$countryIds = [];
foreach ($this->getCountryCollection() as $country) {
$countryIds[] = $country->getCountryId();
}
$collection = $this->_regionCollectionFactory->create()->addCountryFilter($countryIds)->load();
$regions = [];
foreach ($collection as $region) {
if (!$region->getRegionId()) {
continue;
}
$regions[$region->getCountryId()][$region->getRegionId()] = [
'code' => $region->getCode(),
'name' => $region->getName(),
];
}
$regionsJs = $this->_jsonEncoder->encode($regions);
}
\Magento\Framework\Profiler::stop('TEST: ' . __METHOD__);
return $regionsJs;
}
/**
* Get serializer
*
* @return \Magento\Framework\Serialize\SerializerInterface
* @deprecated 100.2.0
*/
private function getSerializer()
{
if ($this->serializer === null) {
$this->serializer = \Magento\Framework\App\ObjectManager::getInstance()
->get(\Magento\Framework\Serialize\SerializerInterface::class);
}
return $this->serializer;
}
}