Postcode Class Reference

Inheritance diagram for Postcode:

Public Member Functions
	__construct (MagentoTimezone $localeDate, PsrLogger $logger, ResolverInterface $localeResolver, DirectoryHelper $directoryHelper)
	validateValue ($value)
	extractValue (RequestInterface $request)
	compactValue ($value)
	restoreValue ($value)
	outputValue ($format=AttributeDataFactory::OUTPUT_FORMAT_TEXT)
Public Member Functions inherited from AbstractData
	__construct (\Magento\Framework\Stdlib\DateTime\TimezoneInterface $localeDate, \Psr\Log\LoggerInterface $logger, \Magento\Framework\Locale\ResolverInterface $localeResolver)
	setAttribute (\Magento\Eav\Model\Entity\Attribute\AbstractAttribute $attribute)
	getAttribute ()
	setRequestScope ($scope)
	setRequestScopeOnly ($flag)
	setEntity (\Magento\Framework\Model\AbstractModel $entity)
	getEntity ()
	setExtractedData (array $data)
	getExtractedData ($index=null)
	setIsAjaxRequest ($flag=true)
	getIsAjaxRequest ()
	extractValue (RequestInterface $request)
	validateValue ($value)
	compactValue ($value)
	restoreValue ($value)
	outputValue ($format=\Magento\Eav\Model\AttributeDataFactory::OUTPUT_FORMAT_TEXT)

Protected Attributes
	$directoryHelper
Protected Attributes inherited from AbstractData
	$_attribute
	$_entity
	$_requestScope
	$_requestScopeOnly = true
	$_isAjax = false
	$_extractedData = []
	$_dateFilterFormat
	$_localeDate
	$_localeResolver
	$_logger

Additional Inherited Members
Protected Member Functions inherited from AbstractData
	_applyInputFilter ($value)
	_getFormFilter ()
	_dateFilterFormat ($format=null)
	_applyOutputFilter ($value)
	_validateInputRule ($value)
	_getRequestValue (RequestInterface $request)

Detailed Description

Customer Address Postal/Zip Code Attribute Data Model This Data Model Has to Be Set Up in additional EAV attribute table

Definition at line 19 of file Postcode.php.

Constructor & Destructor Documentation

__construct()

__construct	(	MagentoTimezone	$localeDate,
		PsrLogger	$logger,
		ResolverInterface	$localeResolver,
		DirectoryHelper	$directoryHelper
	)

Parameters

MagentoTimezone	$localeDate
PsrLogger	$logger
ResolverInterface	$localeResolver
DirectoryHelper	$directoryHelper

Definition at line 32 of file Postcode.php.

      {
        $this->directoryHelper = $directoryHelper;
        parent::__construct($localeDate, $logger, $localeResolver);
    }

Member Function Documentation

compactValue()

compactValue

(

$value

)

Export attribute value to entity model

Parameters

array | string

$value

Returns

$this

Definition at line 87 of file Postcode.php.

    {
        if ($value !== false) {
            $this->getEntity()->setDataUsingMethod($this->getAttribute()->getAttributeCode(), $value);
        }
        return $this;
    }

extractValue()

extractValue

(

RequestInterface

$request

)

Extract data from request and return value

Parameters

RequestInterface

$request

Returns

array|string

Definition at line 75 of file Postcode.php.

    {
        $value = $this->_getRequestValue($request);
        return $this->_applyInputFilter($value);
    }

outputValue()

outputValue

(

$format = AttributeDataFactory::OUTPUT_FORMAT_TEXT

)

Return formated attribute value from entity model

Parameters

string

$format

Returns

string|array @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 113 of file Postcode.php.

    {
        $value = $this->getEntity()
            ->getData($this->getAttribute()->getAttributeCode());
        $value = $this->_applyOutputFilter($value);
        return $value;
    }

restoreValue()

restoreValue

(

$value

)

Restore attribute value from SESSION to entity model

Parameters

array | string

$value

Returns

$this

Definition at line 101 of file Postcode.php.

    {
        return $this->compactValue($value);
    }

validateValue()

validateValue

(

$value

)

Validate postal/zip code Return true and skip validation if country zip code is optional

Parameters

array | string

$value

Returns

array|bool

Definition at line 49 of file Postcode.php.

    {
        $attribute = $this->getAttribute();

        $countryId = $this->getExtractedData('country_id');
        if ($this->directoryHelper->isZipCodeOptional($countryId)) {
            return true;
        }

        $errors = [];
        if (empty($value) && $value !== '0') {
            $label = __($attribute->getStoreLabel());
            $errors[] = __('"%1" is a required value.', $label);
        }
        if (count($errors) == 0) {
            return true;
        }
        return $errors;
    }

Field Documentation

$directoryHelper

$directoryHelper

protected

Definition at line 24 of file Postcode.php.

---

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

• vendor/magento/module-customer/Model/Attribute/Data/Postcode.php