Inheritance diagram for Country:

Public Member Functions
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Locale\ListsInterface $localeLists, \Magento\Directory\Model\Country\FormatFactory $formatFactory, \Magento\Directory\Model\ResourceModel\Region\CollectionFactory $regionCollectionFactory, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	loadByCode ($code)

	getRegions ()

	getLoadedRegionCollection ()

	getRegionCollection ()

	formatAddress (\Magento\Framework\DataObject $address, $html=false)

	getFormats ()

	getFormat ($type)

	getName ($locale=null)

Public Member Functions inherited from AbstractModel
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	__sleep ()

	__wakeup ()

	setIdFieldName ($name)

	getIdFieldName ()

	getId ()

	setId ($value)

	isDeleted ($isDeleted=null)

	hasDataChanges ()

	setData ($key, $value=null)

	unsetData ($key=null)

	setDataChanges ($value)

	getOrigData ($key=null)

	setOrigData ($key=null, $data=null)

	dataHasChangedFor ($field)

	getResourceName ()

	getResourceCollection ()

	getCollection ()

	load ($modelId, $field=null)

	beforeLoad ($identifier, $field=null)

	afterLoad ()

	isSaveAllowed ()

	setHasDataChanges ($flag)

	save ()

	afterCommitCallback ()

	isObjectNew ($flag=null)

	beforeSave ()

	validateBeforeSave ()

	getCacheTags ()

	cleanModelCache ()

	afterSave ()

	delete ()

	beforeDelete ()

	afterDelete ()

	afterDeleteCommit ()

	getResource ()

	getEntityId ()

	setEntityId ($entityId)

	clearInstance ()

	getStoredData ()

	getEventPrefix ()

Public Member Functions inherited from DataObject
	__construct (array $data=[])

	addData (array $arr)

	setData ($key, $value=null)

	unsetData ($key=null)

	getData ($key='', $index=null)

	getDataByPath ($path)

	getDataByKey ($key)

	setDataUsingMethod ($key, $args=[])

	getDataUsingMethod ($key, $args=null)

	hasData ($key='')

	toArray (array $keys=[])

	convertToArray (array $keys=[])

	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	toJson (array $keys=[])

	convertToJson (array $keys=[])

	toString ($format='')

	__call ($method, $args)

	isEmpty ()

	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')

	debug ($data=null, &$objects=[])

	offsetSet ($offset, $value)

	offsetExists ($offset)

	offsetUnset ($offset)

	offsetGet ($offset)

Static Public Attributes
static	$_format = []

Protected Member Functions
	_construct ()

Protected Member Functions inherited from AbstractModel
	_construct ()

	_init ($resourceModel)

	_setResourceModel ($resourceName, $collectionName=null)

	_getResource ()

	_getEventData ()

	_beforeLoad ($modelId, $field=null)

	_afterLoad ()

	_hasModelChanged ()

	_getValidatorBeforeSave ()

	_createValidatorBeforeSave ()

	_getValidationRulesBeforeSave ()

	_clearReferences ()

	_clearData ()

Protected Member Functions inherited from DataObject
	_getData ($key)

	_underscore ($name)

Protected Attributes
	$_localeLists

	$_formatFactory

	$_regionCollectionFactory

Protected Attributes inherited from AbstractModel
	$_eventPrefix = 'core_abstract'

	$_eventObject = 'object'

	$_idFieldName = 'id'

	$_hasDataChanges = false

	$_origData

	$_isDeleted = false

	$_resource

	$_resourceCollection

	$_resourceName

	$_collectionName

	$_cacheTag = false

	$_dataSaveAllowed = true

	$_isObjectNew = null

	$_validatorBeforeSave = null

	$_eventManager

	$_cacheManager

	$_registry

	$_logger

	$_appState

	$_actionValidator

	$storedData = []

Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Country model

@method string getCountryId() @method \Magento\Directory\Model\Country setCountryId(string $value)

@api

Since: 100.0.2 @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 19 of file Country.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\Model\Context	$context,
		\Magento\Framework\Registry	$registry,
		\Magento\Framework\Locale\ListsInterface	$localeLists,
		\Magento\Directory\Model\Country\FormatFactory	$formatFactory,
		\Magento\Directory\Model\ResourceModel\Region\CollectionFactory	$regionCollectionFactory,
		\Magento\Framework\Model\ResourceModel\AbstractResource	$resource = `null`,
		\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection = `null`,
		array	$data = `[]`
	)

Parameters

\Magento\Framework\Model\Context	$context
\Magento\Framework\Registry	$registry
\Magento\Framework\Locale\ListsInterface	$localeLists
Country\FormatFactory	$formatFactory
\Magento\Directory\Model\ResourceModel\Region\CollectionFactory	$regionCollectionFactory
\Magento\Framework\Model\ResourceModel\AbstractResource	$resource
\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection
array	$data

Definition at line 51 of file Country.php.

       {
         parent::__construct($context, $registry, $resource, $resourceCollection, $data);
         $this->_localeLists = $localeLists;
         $this->_formatFactory = $formatFactory;
         $this->_regionCollectionFactory = $regionCollectionFactory;
     }

Member Function Documentation

◆ _construct()

_construct ( )

protected

Returns: void

Definition at line 70 of file Country.php.

     {
         $this->_init(\Magento\Directory\Model\ResourceModel\Country::class);
     }

◆ formatAddress()

formatAddress	(	\Magento\Framework\DataObject	$address,
			$html = `false`
	)

Parameters

\Magento\Framework\DataObject	$address
bool	$html

Returns: string

Definition at line 122 of file Country.php.

     {
         //TODO: is it still used?
         $address->getRegion();
         $address->getCountry();
 
         $template = $this->getData('address_template_' . ($html ? 'html' : 'plain'));
         if (empty($template)) {
             if (!$this->getId()) {
                 $template = '{{firstname}} {{lastname}}';
             } elseif (!$html) {
                 $template = "{{firstname}} {{lastname}}
 {{company}}
 {{street1}}
 {{street2}}
 {{city}}, {{region}} {{postcode}}";
             } else {
                 $template = "{{firstname}} {{lastname}}<br/>
 {{street}}<br/>
 {{city}}, {{region}} {{postcode}}<br/>
 T: {{telephone}}";
             }
         }
 
         $filter = new \Magento\Framework\Filter\Template\Simple();
         $addressText = $filter->setData($address->getData())->filter($template);
 
         if ($html) {
             $addressText = preg_replace('#(<br\s*/?>\s*){2,}#im', '<br/>', $addressText);
         } else {
             $addressText = preg_replace('#(\n\s*){2,}#m', "\n", $addressText);
         }
 
         return $addressText;
     }

◆ getFormat()

getFormat ( $type )

Retrieve country format

Parameters

string $type

Returns: \Magento\Directory\Model\Country\Format|null

Definition at line 184 of file Country.php.

     {
         if ($this->getFormats()) {
             foreach ($this->getFormats() as $format) {
                 if ($format->getType() == $type) {
                     return $format;
                 }
             }
         }
         return null;
     }

◆ getFormats()

getFormats ( )

Retrieve country formats

Returns: \Magento\Directory\Model\ResourceModel\Country\Format\Collection

Definition at line 163 of file Country.php.

     {
         if (!isset(self::$_format[$this->getId()]) && $this->getId()) {
             self::$_format[$this->getId()] = $this->_formatFactory->create()->getCollection()->setCountryFilter(
                 $this
             )->load();
         }
 
         if (isset(self::$_format[$this->getId()])) {
             return self::$_format[$this->getId()];
         }
 
         return null;
     }

◆ getLoadedRegionCollection()

getLoadedRegionCollection ( )

Returns: \Magento\Directory\Model\ResourceModel\Region\Collection

Definition at line 100 of file Country.php.

     {
         $collection = $this->getRegionCollection();
         $collection->load();
         return $collection;
     }

◆ getName()

getName ( $locale = null )

Get country name

Returns: string

Definition at line 201 of file Country.php.

     {
         if ($locale == null) {
             $cache_key = 'name_default';
         } else {
             $cache_key = 'name_' . $locale;
         }
 
         if (!$this->getData($cache_key)) {
             $this->setData($cache_key, $this->_localeLists->getCountryTranslation($this->getId(), $locale));
         }
         return $this->getData($cache_key);
     }

◆ getRegionCollection()

getRegionCollection ( )

Returns: \Magento\Directory\Model\ResourceModel\Region\Collection

Definition at line 110 of file Country.php.

     {
         $collection = $this->_regionCollectionFactory->create();
         $collection->addCountryFilter($this->getId());
         return $collection;
     }

◆ getRegions()

getRegions ( )

Get regions

Returns: \Magento\Directory\Model\ResourceModel\Region\Collection

Definition at line 92 of file Country.php.

     {
         return $this->getLoadedRegionCollection();
     }

◆ loadByCode()

loadByCode ( $code )

Load country by code

Parameters

string $code

Returns: $this

Definition at line 81 of file Country.php.

     {
         $this->_getResource()->loadByCode($this, $code);
         return $this;
     }

Field Documentation

◆ $_format

$_format = []

static

Definition at line 24 of file Country.php.

◆ $_formatFactory

$_formatFactory

protected

Definition at line 34 of file Country.php.

◆ $_localeLists

$_localeLists

protected

Definition at line 29 of file Country.php.

◆ $_regionCollectionFactory

$_regionCollectionFactory

protected

Definition at line 39 of file Country.php.

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

vendor/magento/module-directory/Model/Country.php

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _construct()

◆ formatAddress()

◆ getFormat()

◆ getFormats()

◆ getLoadedRegionCollection()

◆ getName()

◆ getRegionCollection()

◆ getRegions()

◆ loadByCode()

Field Documentation

◆ $_format

◆ $_formatFactory

◆ $_localeLists

◆ $_regionCollectionFactory