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-customer/Model/Address/ |
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Customer\Model\Address;
use Magento\Customer\Api\AddressMetadataInterface;
use Magento\Customer\Api\Data\AddressInterface;
use Magento\Customer\Api\Data\AddressInterfaceFactory;
use Magento\Customer\Api\Data\RegionInterface;
use Magento\Customer\Api\Data\RegionInterfaceFactory;
use Magento\Customer\Model\Data\Address as AddressData;
use Magento\Framework\App\ObjectManager;
use Magento\Framework\Model\AbstractExtensibleModel;
/**
* Address abstract model
*
* @method string getPrefix()
* @method string getSuffix()
* @method string getFirstname()
* @method string getMiddlename()
* @method string getLastname()
* @method string getCountryId()
* @method string getCity()
* @method string getTelephone()
* @method string getCompany()
* @method string getFax()
* @method string getPostcode()
* @method bool getShouldIgnoreValidation()
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
*
* @api
* @since 100.0.2
*/
class AbstractAddress extends AbstractExtensibleModel implements AddressModelInterface
{
/**
* Possible customer address types
*/
public const TYPE_BILLING = 'billing';
public const TYPE_SHIPPING = 'shipping';
/**
* Prefix of model events
*
* @var string
*/
protected $_eventPrefix = 'customer_address';
/**
* Name of event object
*
* @var string
*/
protected $_eventObject = 'customer_address';
/**
* Directory country models
*
* @var \Magento\Directory\Model\Country[]
*/
protected static $_countryModels = [];
/**
* Directory region models
*
* @var \Magento\Directory\Model\Region[]
*/
protected static $_regionModels = [];
/**
* @var \Magento\Directory\Helper\Data
*/
protected $_directoryData = null;
/**
* @var \Magento\Eav\Model\Config
*/
protected $_eavConfig;
/**
* @var Config
*/
protected $_addressConfig;
/**
* @var \Magento\Directory\Model\RegionFactory
*/
protected $_regionFactory;
/**
* @var \Magento\Directory\Model\CountryFactory
*/
protected $_countryFactory;
/**
* @var AddressMetadataInterface
*/
protected $metadataService;
/**
* @var AddressInterfaceFactory
*/
protected $addressDataFactory;
/**
* @var RegionInterfaceFactory
*/
protected $regionDataFactory;
/**
* @var \Magento\Framework\Api\DataObjectHelper
*/
protected $dataObjectHelper;
/** @var CompositeValidator */
private $compositeValidator;
/**
* @var array
*/
private array $regionIdCountry = [];
/**
* @param \Magento\Framework\Model\Context $context
* @param \Magento\Framework\Registry $registry
* @param \Magento\Framework\Api\ExtensionAttributesFactory $extensionFactory
* @param \Magento\Framework\Api\AttributeValueFactory $customAttributeFactory
* @param \Magento\Directory\Helper\Data $directoryData
* @param \Magento\Eav\Model\Config $eavConfig
* @param Config $addressConfig
* @param \Magento\Directory\Model\RegionFactory $regionFactory
* @param \Magento\Directory\Model\CountryFactory $countryFactory
* @param AddressMetadataInterface $metadataService
* @param AddressInterfaceFactory $addressDataFactory
* @param RegionInterfaceFactory $regionDataFactory
* @param \Magento\Framework\Api\DataObjectHelper $dataObjectHelper
* @param \Magento\Framework\Model\ResourceModel\AbstractResource $resource
* @param \Magento\Framework\Data\Collection\AbstractDb $resourceCollection
* @param array $data
* @param CompositeValidator $compositeValidator
*
* @SuppressWarnings(PHPMD.ExcessiveParameterList)
*/
public function __construct(
\Magento\Framework\Model\Context $context,
\Magento\Framework\Registry $registry,
\Magento\Framework\Api\ExtensionAttributesFactory $extensionFactory,
\Magento\Framework\Api\AttributeValueFactory $customAttributeFactory,
\Magento\Directory\Helper\Data $directoryData,
\Magento\Eav\Model\Config $eavConfig,
Config $addressConfig,
\Magento\Directory\Model\RegionFactory $regionFactory,
\Magento\Directory\Model\CountryFactory $countryFactory,
AddressMetadataInterface $metadataService,
AddressInterfaceFactory $addressDataFactory,
RegionInterfaceFactory $regionDataFactory,
\Magento\Framework\Api\DataObjectHelper $dataObjectHelper,
\Magento\Framework\Model\ResourceModel\AbstractResource $resource = null,
\Magento\Framework\Data\Collection\AbstractDb $resourceCollection = null,
array $data = [],
CompositeValidator $compositeValidator = null
) {
$this->_directoryData = $directoryData;
$data = $this->_implodeArrayField($data);
$this->_eavConfig = $eavConfig;
$this->_addressConfig = $addressConfig;
$this->_regionFactory = $regionFactory;
$this->_countryFactory = $countryFactory;
$this->metadataService = $metadataService;
$this->addressDataFactory = $addressDataFactory;
$this->regionDataFactory = $regionDataFactory;
$this->dataObjectHelper = $dataObjectHelper;
$this->compositeValidator = $compositeValidator ?: ObjectManager::getInstance()
->get(CompositeValidator::class);
parent::__construct(
$context,
$registry,
$extensionFactory,
$customAttributeFactory,
$resource,
$resourceCollection,
$data
);
}
/**
* Get full customer name
*
* @return string
*/
public function getName()
{
$name = '';
if ($this->_eavConfig->getAttribute('customer_address', 'prefix')->getIsVisible() && $this->getPrefix()) {
$name .= __($this->getPrefix()) . ' ';
}
$name .= $this->getFirstname();
$middleName = $this->_eavConfig->getAttribute('customer_address', 'middlename');
if ($middleName->getIsVisible() && $this->getMiddlename()) {
$name .= ' ' . $this->getMiddlename();
}
$name .= ' ' . $this->getLastname();
if ($this->_eavConfig->getAttribute('customer_address', 'suffix')->getIsVisible() && $this->getSuffix()) {
$name .= ' ' . __($this->getSuffix());
}
return $name;
}
/**
* Retrieve street field of an address
*
* @return string[]
*/
public function getStreet()
{
if (is_array($this->getStreetFull())) {
return $this->getStreetFull();
}
return explode("\n", $this->getStreetFull());
}
/**
* Get street line by number
*
* @param int $number
* @return string
*/
public function getStreetLine($number)
{
$lines = $this->getStreet();
return $lines[$number - 1] ?? '';
}
/**
* Retrieve text of street lines, concatenated using LF symbol
*
* @return string
*/
public function getStreetFull()
{
$street = $this->getData('street');
return is_array($street) ? implode("\n", $street) : ($street ?? '');
}
/**
* Alias for a street setter. To be used though setDataUsingMethod('street_full', $value).
*
* @param string|string[] $street
* @return $this
*/
public function setStreetFull($street)
{
return $this->setStreet($street);
}
/**
* Non-magic setter for a street field
*
* @param string|string[] $street
* @return $this
*/
public function setStreet($street)
{
$this->setData('street', $street);
return $this;
}
/**
* Enforce format of the street field or other multiline custom attributes
*
* @param array|string $key
* @param array|string|null $value
*
* @return \Magento\Framework\DataObject
*/
public function setData($key, $value = null)
{
if (is_array($key)) {
$key = $this->_implodeArrayField($key);
} elseif (is_array($value) && $this->isAddressMultilineAttribute($key)) {
$value = $this->_implodeArrayValues($value);
} elseif (self::CUSTOM_ATTRIBUTES === $key && is_array($value)) {
foreach ($value as &$attribute) {
$attribute = is_array($attribute) ? $attribute : $attribute->__toArray();
$attribute = $this->processCustomAttribute($attribute);
}
}
return parent::setData($key, $value);
}
/**
* Check that address can have multiline attribute by this code (as street or some custom attribute)
*
* @param string $code
* @return bool
*/
protected function isAddressMultilineAttribute($code)
{
return $code == 'street' || in_array($code, $this->getCustomAttributesCodes());
}
/**
* Implode value of the array field, if it is present among other fields
*
* @param array $data
* @return array
*/
protected function _implodeArrayField(array $data)
{
foreach ($data as $key => $value) {
if (is_array($value) && $this->isAddressMultilineAttribute($key)) {
$data[$key] = $this->_implodeArrayValues($data[$key]);
}
}
return $data;
}
/**
* Combine values of field lines into a single string
*
* @param string[]|string $value
* @return string
*/
protected function _implodeArrayValues($value)
{
if (is_array($value)) {
if (!count($value)) {
return '';
}
$isScalar = true;
foreach ($value as $val) {
if (!is_scalar($val)) {
$isScalar = false;
break;
}
}
if ($isScalar) {
$value = trim(implode("\n", $value));
}
}
return $value;
}
/**
* Create fields street1, street2, etc.
*
* To be used in controllers for views data
*
* @return $this
*/
public function explodeStreetAddress()
{
$streetLines = $this->getStreet();
foreach ($streetLines as $i => $line) {
$this->setData('street' . ($i + 1), $line);
}
return $this;
}
/**
* Retrieve region name
*
* @return string
*/
public function getRegion()
{
$regionId = $this->getData('region_id');
$region = $this->getData('region');
if (!$regionId && is_numeric($region)) {
if ($this->getRegionModel($region)->getCountryId() == $this->getCountryId()) {
$this->setData('region', $this->getRegionModel($region)->getName());
$this->setData('region_id', $region);
}
} elseif ($regionId) {
if ($this->getRegionModel($regionId)->getCountryId() == $this->getCountryId()) {
$this->setData('region', $this->getRegionModel($regionId)->getName());
}
} elseif (is_string($region)) {
$this->setData('region', $region);
} elseif (!$regionId && is_array($region)) {
$this->setData('region', $regionId);
}
return $this->getData('region');
}
/**
* Return 2 letter state code if available, otherwise full region name
*
* @return string
*/
public function getRegionCode()
{
$regionId = $this->getData('region_id');
$region = $this->getData('region');
if (!$regionId && is_numeric($region)) {
$regionId = $this->getRegionIdByCode(
(string)$region,
(string)$this->getCountryId()
);
if ($regionId) {
$this->setData('region_code', $region);
} elseif ($this->getRegionModel($region)->getCountryId() == $this->getCountryId()) {
$this->setData('region_code', $this->getRegionModel($region)->getCode());
}
} elseif ($regionId) {
if ($this->getRegionModel($regionId)->getCountryId() == $this->getCountryId()) {
$this->setData('region_code', $this->getRegionModel($regionId)->getCode());
}
} elseif (is_string($region)) {
$this->setData('region_code', $region);
}
return $this->getData('region_code');
}
/**
* Return Region ID
*
* @return int
*/
public function getRegionId()
{
$regionId = $this->getData('region_id');
if ($regionId) {
return $regionId;
}
$region = $this->getData('region');
if (is_numeric($region)) {
$regionId = $this->getRegionIdByCode(
(string)$region,
(string)$this->getCountryId()
);
if ($regionId) {
$this->setData('region_id', $regionId);
$this->unsRegion();
} else {
$this->setData('region_id', $region);
}
} else {
$regionId = $this->getRegionIdByCode(
(string)$this->getRegionCode(),
(string)$this->getCountryId()
);
$this->setData('region_id', $regionId);
}
return $regionId;
}
/**
* Returns region id.
*
* @param string $regionCode
* @param string $countryId
* @return int|null
*/
private function getRegionIdByCode(string $regionCode, string $countryId): ?int
{
$key = $countryId . '_' . $regionCode;
if (!array_key_exists($key, $this->regionIdCountry)) {
$regionModel = $this->_createRegionInstance()->loadByCode(
$regionCode,
$countryId
);
$this->regionIdCountry[$key] = $regionModel->getId() ? (int)$regionModel->getId() : null;
}
return $this->regionIdCountry[$key];
}
/**
* Get country
*
* @return string
*/
public function getCountry()
{
$country = $this->getCountryId();
return $country ? $country : $this->getData('country');
}
/**
* Retrieve country model
*
* @return \Magento\Directory\Model\Country
*/
public function getCountryModel()
{
if (!isset(self::$_countryModels[$this->getCountryId()])) {
$country = $this->_createCountryInstance();
$country->load($this->getCountryId());
self::$_countryModels[$this->getCountryId()] = $country;
}
return self::$_countryModels[$this->getCountryId()];
}
/**
* Retrieve country model
*
* @param int|null $regionId
* @return \Magento\Directory\Model\Region
*/
public function getRegionModel($regionId = null)
{
if ($regionId === null) {
$regionId = $this->getRegionId();
}
if (!isset(self::$_regionModels[$regionId])) {
$region = $this->_createRegionInstance();
$region->load($regionId);
self::$_regionModels[$regionId] = $region;
}
return self::$_regionModels[$regionId];
}
/**
* Format address in a specific way
*
* Deprecated, use this code instead:
* $renderer = $this->_addressConfig->getFormatByCode('html')->getRenderer();
* $addressMapper = \Magento\Customer\Model\Address\Mapper type
* $addressData = $addressMapper->toFlatArray($address);
* $formattedAddress = $renderer->renderArray($addressData);
*
* @param string $type
* @return string|null
*/
public function format($type)
{
if (!($formatType = $this->getConfig()->getFormatByCode($type)) || !$formatType->getRenderer()) {
return null;
}
$this->_eventManager->dispatch('customer_address_format', ['type' => $formatType, 'address' => $this]);
return $formatType->getRenderer()->render($this);
}
/**
* Retrieve address config object
*
* @return Config
*/
public function getConfig()
{
return $this->_addressConfig;
}
/**
* Processing object before save data
*
* @return $this
*/
public function beforeSave()
{
parent::beforeSave();
$this->getRegion();
return $this;
}
/**
* Create address data object based on current address model.
*
* @param int|null $defaultBillingAddressId
* @param int|null $defaultShippingAddressId
*
* @return AddressInterface
* Use Api/Data/AddressInterface as a result of service operations. Don't rely on the model to provide
* the instance of Api/Data/AddressInterface
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
* @throws \Magento\Framework\Exception\LocalizedException
*/
public function getDataModel($defaultBillingAddressId = null, $defaultShippingAddressId = null)
{
$addressId = $this->getId();
$attributes = $this->metadataService->getAllAttributesMetadata();
$addressData = [];
foreach ($attributes as $attribute) {
$code = $attribute->getAttributeCode();
if ($this->getData($code) !== null) {
if ($code === AddressInterface::STREET) {
$addressData[$code] = $this->getDataUsingMethod($code);
} else {
$addressData[$code] = $this->getData($code);
}
}
}
/** @var RegionInterface $region */
$region = $this->regionDataFactory->create();
$region->setRegion($this->getRegion())
->setRegionCode($this->getRegionCode())
->setRegionId($this->getRegionId());
$addressData[AddressData::REGION] = $region;
$addressDataObject = $this->addressDataFactory->create();
$this->dataObjectHelper->populateWithArray(
$addressDataObject,
$addressData,
\Magento\Customer\Api\Data\AddressInterface::class
);
if ($addressId) {
$addressDataObject->setId($addressId);
}
if ($this->getCustomerId() || $this->getParentId()) {
$customerId = $this->getCustomerId() ?: $this->getParentId();
$addressDataObject->setCustomerId($customerId);
if ($defaultBillingAddressId == $addressId) {
$addressDataObject->setIsDefaultBilling(true);
}
if ($defaultShippingAddressId == $addressId) {
$addressDataObject->setIsDefaultShipping(true);
}
}
return $addressDataObject;
}
/**
* Validate address attribute values.
*
* @return array|bool
*/
public function validate()
{
if ($this->getShouldIgnoreValidation()) {
return true;
}
$errors = $this->compositeValidator->validate($this);
if (empty($errors)) {
return true;
}
return $errors;
}
/**
* Create region instance
*
* @return \Magento\Directory\Model\Region
*/
protected function _createRegionInstance()
{
return $this->_regionFactory->create();
}
/**
* Create country instance
*
* @return \Magento\Directory\Model\Country
*/
protected function _createCountryInstance()
{
return $this->_countryFactory->create();
}
/**
* Unset Region from address
*
* @return $this
* @since 101.0.0
*/
public function unsRegion()
{
return $this->unsetData("region");
}
/**
* Is company required
*
* @return bool
* @throws \Magento\Framework\Exception\LocalizedException
* @since 101.0.0
*/
protected function isCompanyRequired()
{
return ($this->_eavConfig->getAttribute('customer_address', 'company')->getIsRequired());
}
/**
* Is telephone required
*
* @return bool
* @throws \Magento\Framework\Exception\LocalizedException
* @since 101.0.0
*/
protected function isTelephoneRequired()
{
return ($this->_eavConfig->getAttribute('customer_address', 'telephone')->getIsRequired());
}
/**
* Is fax required
*
* @return bool
* @throws \Magento\Framework\Exception\LocalizedException
* @since 101.0.0
*/
protected function isFaxRequired()
{
return ($this->_eavConfig->getAttribute('customer_address', 'fax')->getIsRequired());
}
/**
* Unify attribute format.
*
* @param array $attribute
* @return array
*/
private function processCustomAttribute(array $attribute): array
{
if (isset($attribute['attribute_code']) &&
isset($attribute['value']) &&
is_array($attribute['value']) &&
$this->isAddressMultilineAttribute($attribute['attribute_code'])
) {
$attribute['value'] = $this->_implodeArrayValues($attribute['value']);
}
return $attribute;
}
}