Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
Public Member Functions | Protected Member Functions
Region Class Reference
Inheritance diagram for Region:
AbstractModel DataObject

Public Member Functions

 getName ()
 
 loadByCode ($code, $countryId)
 
 loadByName ($name, $countryId)
 
- 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)
 

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)
 

Additional Inherited Members

- 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 = []
 
- Static Protected Attributes inherited from DataObject
static $_underscoreCache = []
 

Detailed Description

Region

@method string getRegionId() @method string getCountryId() @method \Magento\Directory\Model\Region setCountryId(string $value) @method string getCode() @method \Magento\Directory\Model\Region setCode(string $value) @method string getDefaultName() @method \Magento\Directory\Model\Region setDefaultName(string $value)

@api

Since
100.0.2

Definition at line 23 of file Region.php.

Member Function Documentation

◆ _construct()

_construct ( )
protected
Returns
void

Definition at line 28 of file Region.php.

29  {
30  $this->_init(\Magento\Directory\Model\ResourceModel\Region::class);
31  }

◆ getName()

getName ( )

Retrieve region name

If name is not declared, then default_name is used

Returns
string

Definition at line 40 of file Region.php.

41  {
42  $name = $this->getData('name');
43  if ($name === null) {
44  $name = $this->getData('default_name');
45  }
46  return $name;
47  }
getData($key='', $index=null)
Definition: DataObject.php:119
if(!isset($_GET['name'])) $name
Definition: log.php:14

◆ loadByCode()

loadByCode (   $code,
  $countryId 
)

Load region by code

Parameters
string$code
string$countryId
Returns
$this

Definition at line 56 of file Region.php.

57  {
58  if ($code) {
59  $this->_getResource()->loadByCode($this, $code, $countryId);
60  }
61  return $this;
62  }
$code
Definition: info.phtml:12

◆ loadByName()

loadByName (   $name,
  $countryId 
)

Load region by name

Parameters
string$name
string$countryId
Returns
$this

Definition at line 71 of file Region.php.

72  {
73  $this->_getResource()->loadByName($this, $name, $countryId);
74  return $this;
75  }
if(!isset($_GET['name'])) $name
Definition: log.php:14

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