Information Class Reference

Public Member Functions
	__construct (Renderer $renderer, RegionFactory $regionFactory, CountryFactory $countryFactory)
	getStoreInformationObject (Store $store)
	getFormattedAddress (Store $store)

Data Fields
const	XML_PATH_STORE_INFO_NAME = 'general/store_information/name'
const	XML_PATH_STORE_INFO_PHONE = 'general/store_information/phone'
const	XML_PATH_STORE_INFO_HOURS = 'general/store_information/hours'
const	XML_PATH_STORE_INFO_STREET_LINE1 = 'general/store_information/street_line1'
const	XML_PATH_STORE_INFO_STREET_LINE2 = 'general/store_information/street_line2'
const	XML_PATH_STORE_INFO_CITY = 'general/store_information/city'
const	XML_PATH_STORE_INFO_POSTCODE = 'general/store_information/postcode'
const	XML_PATH_STORE_INFO_REGION_CODE = 'general/store_information/region_id'
const	XML_PATH_STORE_INFO_COUNTRY_CODE = 'general/store_information/country_id'
const	XML_PATH_STORE_INFO_VAT_NUMBER = 'general/store_information/merchant_vat_number'

Protected Attributes
	$renderer
	$countryFactory
	$regionFactory

Detailed Description

Store information class used to retrieve and format store information as set in store config

@api

Since

100.0.2

Definition at line 20 of file Information.php.

Constructor & Destructor Documentation

__construct()

__construct	(	Renderer	$renderer,
		RegionFactory	$regionFactory,
		CountryFactory	$countryFactory
	)

Parameters

Renderer	$renderer
RegionFactory	$regionFactory
CountryFactory	$countryFactory

Definition at line 64 of file Information.php.

      {
        $this->renderer = $renderer;
        $this->regionFactory = $regionFactory;
        $this->countryFactory = $countryFactory;
    }

Member Function Documentation

getFormattedAddress()

getFormattedAddress

(

Store

$store

)

Retrieve formatted store address from config

Parameters

Store

$store

Returns

string

Definition at line 112 of file Information.php.

    {
        return $this->renderer->format($this->getStoreInformationObject($store));
    }

getStoreInformationObject()

getStoreInformationObject

(

Store

$store

)

Retrieve generic object with all the misc store information values

Parameters

Store

$store

Returns

DataObject

Definition at line 80 of file Information.php.

    {
        $info = new DataObject([
            'name' => $store->getConfig(self::XML_PATH_STORE_INFO_NAME),
            'phone' => $store->getConfig(self::XML_PATH_STORE_INFO_PHONE),
            'hours' => $store->getConfig(self::XML_PATH_STORE_INFO_HOURS),
            'street_line1' => $store->getConfig(self::XML_PATH_STORE_INFO_STREET_LINE1),
            'street_line2' => $store->getConfig(self::XML_PATH_STORE_INFO_STREET_LINE2),
            'city' => $store->getConfig(self::XML_PATH_STORE_INFO_CITY),
            'postcode' => $store->getConfig(self::XML_PATH_STORE_INFO_POSTCODE),
            'region_id' => $store->getConfig(self::XML_PATH_STORE_INFO_REGION_CODE),
            'country_id' => $store->getConfig(self::XML_PATH_STORE_INFO_COUNTRY_CODE),
            'vat_number' => $store->getConfig(self::XML_PATH_STORE_INFO_VAT_NUMBER),
        ]);

        if ($info->getRegionId()) {
            $info->setRegion($this->regionFactory->create()->load($info->getRegionId())->getName());
        }

        if ($info->getCountryId()) {
            $info->setCountry($this->countryFactory->create()->loadByCode($info->getCountryId())->getName());
        }

        return $info;
    }

Field Documentation

$countryFactory

$countryFactory

protected

Definition at line 52 of file Information.php.

$regionFactory

$regionFactory

protected

Definition at line 57 of file Information.php.

$renderer

$renderer

protected

#- #-

Definition at line 47 of file Information.php.

XML_PATH_STORE_INFO_CITY

const XML_PATH_STORE_INFO_CITY = 'general/store_information/city'

Definition at line 35 of file Information.php.

XML_PATH_STORE_INFO_COUNTRY_CODE

const XML_PATH_STORE_INFO_COUNTRY_CODE = 'general/store_information/country_id'

Definition at line 41 of file Information.php.

XML_PATH_STORE_INFO_HOURS

const XML_PATH_STORE_INFO_HOURS = 'general/store_information/hours'

Definition at line 29 of file Information.php.

XML_PATH_STORE_INFO_NAME

const XML_PATH_STORE_INFO_NAME = 'general/store_information/name'

#+ Configuration paths

Definition at line 25 of file Information.php.

XML_PATH_STORE_INFO_PHONE

const XML_PATH_STORE_INFO_PHONE = 'general/store_information/phone'

Definition at line 27 of file Information.php.

XML_PATH_STORE_INFO_POSTCODE

const XML_PATH_STORE_INFO_POSTCODE = 'general/store_information/postcode'

Definition at line 37 of file Information.php.

XML_PATH_STORE_INFO_REGION_CODE

const XML_PATH_STORE_INFO_REGION_CODE = 'general/store_information/region_id'

Definition at line 39 of file Information.php.

XML_PATH_STORE_INFO_STREET_LINE1

const XML_PATH_STORE_INFO_STREET_LINE1 = 'general/store_information/street_line1'

Definition at line 31 of file Information.php.

XML_PATH_STORE_INFO_STREET_LINE2

const XML_PATH_STORE_INFO_STREET_LINE2 = 'general/store_information/street_line2'

Definition at line 33 of file Information.php.

XML_PATH_STORE_INFO_VAT_NUMBER

const XML_PATH_STORE_INFO_VAT_NUMBER = 'general/store_information/merchant_vat_number'

Definition at line 43 of file Information.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/module-store/Model/Information.php