API Documentation
\

\AddressFormatCore

Summary

Methods
Properties
Constants
checkFormatFields()
getErrorList()
cleanOrderedAddress()
getFormattedAddressFieldsValues()
generateAddress()
generateAddressSmarty()
getValidateFields()
getLiableClass()
getOrderedAddressFields()
getFormattedLayoutData()
getAddressCountryFormat()
getFormat()
getFieldsRequired()
$id_address_format
$id_country
$format
$definition
$requireFormFieldsList
$forbiddenPropertyList
$forbiddenClassList
_CLEANING_REGEX_
_checkValidateClassField()
_checkLiableAssociation()
_setOriginalDisplayFormat()
_getFormatDB()
$_errorFormatList
N/A
No private methods found
No private properties found
N/A

Constants

_CLEANING_REGEX_

_CLEANING_REGEX_

Properties

$id_address_format

$id_address_format : integer

Type

integer

$id_country

$id_country : integer

Type

integer

$format

$format : string

Type

string

$definition

$definition :

Type

$requireFormFieldsList

$requireFormFieldsList :

Type

$forbiddenPropertyList

$forbiddenPropertyList :

Type

$forbiddenClassList

$forbiddenClassList :

Type

$_errorFormatList

$_errorFormatList :

Type

Methods

checkFormatFields()

checkFormatFields()

getErrorList()

getErrorList()

cleanOrderedAddress()

cleanOrderedAddress(  $orderedAddressField)

Parameters

$orderedAddressField

getFormattedAddressFieldsValues()

getFormattedAddressFieldsValues(  $address,   $addressFormat,   $id_lang = null)

Parameters

$address
$addressFormat
$id_lang

generateAddress()

generateAddress(\Address  $address,   $patternRules = array(),   $newLine = "\r\n",   $separator = ' ',   $style = array()) : string

Generates the full address text

Parameters

\Address $address
$patternRules
$newLine
$separator
$style

Returns

string

generateAddressSmarty()

generateAddressSmarty(  $params,   $smarty)

Parameters

$params
$smarty

getValidateFields()

getValidateFields(  $className) : array

Returns selected fields required for an address in an array according to a selection hash

Parameters

$className

Returns

array —

String values

getLiableClass()

getLiableClass(  $className)

Parameters

$className

getOrderedAddressFields()

getOrderedAddressFields(  $id_country,   $split_all = false,   $cleaned = false) : Array

Returns address format fields in array by country

Parameters

$id_country
$split_all
$cleaned

Returns

Array —

String field address format

getFormattedLayoutData()

getFormattedLayoutData(  $address)

Parameters

$address

getAddressCountryFormat()

getAddressCountryFormat(  $id_country) : String

Returns address format by country if not defined using default country

Parameters

$id_country

Returns

String —

field address format

getFormat()

getFormat(  $id_country) : String

Returns address format by country

Parameters

$id_country

Returns

String —

field address format

getFieldsRequired()

getFieldsRequired()

_checkValidateClassField()

_checkValidateClassField(  $className,   $fieldName,   $isIdField)

Parameters

$className
$fieldName
$isIdField

_checkLiableAssociation()

_checkLiableAssociation(  $patternName,   $fieldsValidate)

Parameters

$patternName
$fieldsValidate

_setOriginalDisplayFormat()

_setOriginalDisplayFormat(  $formattedValueList,   $currentLine,   $currentKeyList)

Parameters

$formattedValueList
$currentLine
$currentKeyList

_getFormatDB()

_getFormatDB(  $id_country)

Parameters

$id_country