- Class name: AddressFormatCore
- Parent class: ObjectModel
- Source: classes/AddressFormat.php line 28
- $_errorFormatList
- $definition
- $forbiddenClassList
- $forbiddenPropertyList
- $format
- $id_address_format
- $id_country
- $requireFormFieldsList
- $def
- $fieldsRequired
- $fieldsRequiredDatabase
- $fieldsRequiredLang
- $fieldsSize
- $fieldsSizeLang
- $fieldsValidate
- $fieldsValidateLang
- $id
- $id_lang
- $id_shop
- $identifier
- $image_dir
- $image_format
- $table
- $tables
- $webserviceParameters
- __construct
- _checkLiableAssociation
- _checkValidateClassField
- _getFormatDB
- _setOriginalDisplayFormat
- add
- addFieldsRequiredDatabase
- associateTo
- checkFormatFields
- cleanOrderedAddress
- clearCache
- delete
- deleteImage
- deleteSelection
- displayFieldName
- duplicateShops
- existsInDatabase
- formatFields
- formatValue
- generateAddress
- generateAddressSmarty
- getAddressCountryFormat
- getDefinition
- getErrorList
- getFieldByLang
- getFields
- getFieldsLang
- getFieldsRequiredDatabase
- getFormat
- getFormattedAddressFieldsValues
- getFormattedLayoutData
- getLiableClass
- getOrderedAddressFields
- getTranslationsFields
- getValidateFields
- getValidationRules
- getWebserviceObjectList
- getWebserviceParameters
- hydrate
- hydrateCollection
- isAssociatedToGroupShop
- isAssociatedToShop
- isCurrentlyUsed
- isLangMultishop
- makeTranslationFields
- save
- setDefinitionRetrocompatibility
- toggleStatus
- update
- validateControler
- validateController
- validateField
- validateFields
- validateFieldsLang
const _CLEANING_REGEX_ = '#([^\w:_]+)#i'
- Source: classes/AddressFormat.php line 97.
private mixed $_errorFormatList = array()
- Visibility: private
- Source: classes/AddressFormat.php line 39.
public mixed $definition = array('table' => 'address_format', 'primary' => 'id_country', 'fields' => array('format' => array('type' => self::TYPE_STRING, 'validate' => 'isGenericName', 'required' => true), 'id_country' => array('type' => self::TYPE_INT)))
- Visibility: public
- This property is static.
- Source: classes/AddressFormat.php line 44.
public mixed $forbiddenClassList = array('Manufacturer', 'Supplier')
- Visibility: public
- This property is static.
- Source: classes/AddressFormat.php line 93.
public mixed $forbiddenPropertyList = array('deleted', 'date_add', 'other', 'alias', 'secure_key', 'note', 'newsletter', 'ip_registration_newsletter', 'newsletter_date_add', 'optin', 'passwd', 'last_passwd_gen', 'active', 'is_guest', 'date_upd', 'years', 'days', 'months', 'description', 'meta_description', 'short_description', 'link_rewrite', 'meta_title', 'meta_keywords', 'display_tax_label', 'need_zip_code', 'contains_states', 'call_prefixes', 'call_prefix')
- Visibility: public
- This property is static.
- Source: classes/AddressFormat.php line 62.
public string $format
- Visibility: public
- Source: classes/AddressFormat.php line 37.
public integer $id_address_format
- Visibility: public
- Source: classes/AddressFormat.php line 31.
public integer $id_country
- Visibility: public
- Source: classes/AddressFormat.php line 34.
public mixed $requireFormFieldsList = array('firstname', 'name', 'address1', 'city', 'postcode', 'Country:name', 'State:name')
- Visibility: public
- This property is static.
- Source: classes/AddressFormat.php line 53.
protected array $def
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 122.
protected mixed $fieldsRequired = array()
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 72.
protected mixed $fieldsRequiredDatabase = null
- Visibility: protected
- This property is static.
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 57.
protected mixed $fieldsRequiredLang = array()
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 87.
protected mixed $fieldsSize = array()
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 77.
protected mixed $fieldsSizeLang = array()
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 92.
protected mixed $fieldsValidate = array()
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 82.
protected mixed $fieldsValidateLang = array()
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 97.
public integer $id
- Visibility: public
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 48.
protected integer $id_lang = null
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 51.
protected mixed $id_shop = null
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 53.
protected mixed $identifier
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 67.
protected string $image_dir = null
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 108.
protected string $image_format = 'jpg'
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 111.
protected mixed $table
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 62.
protected mixed $tables = array()
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 102.
protected array $webserviceParameters = array()
- Visibility: protected
- This property is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 105.
mixed ObjectModelCore::__construct(integer $id, integer $id_lang, integer $id_shop)
Build object
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 150
- $id integer - Existing object id in order to load object (optional)
- $id_lang integer - Required if object is multilingual (optional)
- $id_shop integer - ID shop for objects with multishop on langs
mixed AddressFormatCore::_checkLiableAssociation($patternName, $fieldsValidate)
- Visibility: protected
- Source: classes/AddressFormat.php line 145
- $patternName mixed
- $fieldsValidate mixed
mixed AddressFormatCore::_checkValidateClassField($className, $fieldName, $isIdField)
- Visibility: protected
- Source: classes/AddressFormat.php line 106
- $className mixed
- $fieldName mixed
- $isIdField mixed
mixed AddressFormatCore::_getFormatDB($id_country)
- Visibility: protected
- Source: classes/AddressFormat.php line 517
- $id_country mixed
mixed AddressFormatCore::_setOriginalDisplayFormat($formattedValueList, $currentLine, $currentKeyList)
- Visibility: protected
- This method is static.
- Source: classes/AddressFormat.php line 232
- $formattedValueList mixed
- $currentLine mixed
- $currentKeyList mixed
boolean ObjectModelCore::add(boolean $autodate, boolean $null_values)
Add current object to database
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 372
- $autodate boolean
- $null_values boolean
mixed ObjectModelCore::addFieldsRequiredDatabase($fields)
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 925
- $fields mixed
boolean ObjectModelCore::associateTo(integer|array $id_shops, string $type)
This function associate an item to its context
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 973
- $id_shops integer|array
- $type string
mixed AddressFormatCore::checkFormatFields()
- Visibility: public
- Source: classes/AddressFormat.php line 190
mixed AddressFormatCore::cleanOrderedAddress($orderedAddressField)
- Visibility: public
- This method is static.
- Source: classes/AddressFormat.php line 267
- $orderedAddressField mixed
mixed ObjectModelCore::clearCache($all)
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 939
- $all mixed
boolean ObjectModelCore::delete()
Delete current object from database
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 521
boolean ObjectModelCore::deleteImage()
Delete images associated with the object
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1047
boolean ObjectModelCore::deleteSelection(array $selection)
Delete several objects from database
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 559
- $selection array
mixed ObjectModelCore::displayFieldName($field, $class, $htmlentities, \Context $context)
- Visibility: public
- This method is static.
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 757
- $field mixed
- $class mixed
- $htmlentities mixed
- $context Context
mixed ObjectModelCore::duplicateShops($id)
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1017
- $id mixed
boolean ObjectModelCore::existsInDatabase(integer $id_entity, string $table)
Specify if an ObjectModel is already in database
- Visibility: public
- This method is static.
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1081
- $id_entity integer
- $table string
array ObjectModelCore::formatFields(integer $id_lang)
- Visibility: protected
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 272
- $id_lang integer - If this parameter is given, only take lang fields
mixed ObjectModelCore::formatValue(mixed $value, integer $type, $with_quotes)
Format a data
- Visibility: public
- This method is static.
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 319
- $value mixed
- $type integer
- $with_quotes mixed
string AddressFormatCore::generateAddress(\Address $address, $patternRules, $newLine, $separator, $style)
Generates the full address text
- Visibility: public
- This method is static.
- Source: classes/AddressFormat.php line 347
- $address Address
- $patternRules mixed
- $newLine mixed
- $separator mixed
- $style mixed
mixed AddressFormatCore::generateAddressSmarty($params, $smarty)
- Visibility: public
- This method is static.
- Source: classes/AddressFormat.php line 374
- $params mixed
- $smarty mixed
String AddressFormatCore::getAddressCountryFormat($id_country)
Returns address format by country if not defined using default country
- Visibility: public
- This method is static.
- Source: classes/AddressFormat.php line 491
- $id_country mixed
array ObjectModelCore::getDefinition(string $class, string $field)
Get object definition
- Visibility: public
- This method is static.
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1184
- $class string - Name of object
- $field string - Name of field if we want the definition of one field only
mixed AddressFormatCore::getErrorList()
- Visibility: public
- Source: classes/AddressFormat.php line 222
mixed ObjectModelCore::getFieldByLang($field_name, null $id_lang)
Return the field value for the specified language if the field is multilang, else the field value.
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1261
- $field_name mixed
- $id_lang null
array ObjectModelCore::getFields()
Prepare fields for ObjectModel class (add, update) All fields are verified (pSQL, intval.
..)
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 234
array ObjectModelCore::getFieldsLang()
Prepare multilang fields
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 249
mixed ObjectModelCore::getFieldsRequiredDatabase($all)
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 917
- $all mixed
String AddressFormatCore::getFormat($id_country)
Returns address format by country
- Visibility: public
- Source: classes/AddressFormat.php line 508
- $id_country mixed
mixed AddressFormatCore::getFormattedAddressFieldsValues($address, $addressFormat, $id_lang)
- Visibility: public
- This method is static.
- Source: classes/AddressFormat.php line 289
- $address mixed
- $addressFormat mixed
- $id_lang mixed
mixed AddressFormatCore::getFormattedLayoutData($address)
- Visibility: public
- This method is static.
- Source: classes/AddressFormat.php line 472
- $address mixed
mixed AddressFormatCore::getLiableClass($className)
- Visibility: public
- This method is static.
- Source: classes/AddressFormat.php line 416
- $className mixed
Array AddressFormatCore::getOrderedAddressFields($id_country, $split_all, $cleaned)
Returns address format fields in array by country
- Visibility: public
- This method is static.
- Source: classes/AddressFormat.php line 450
- $id_country mixed
- $split_all mixed
- $cleaned mixed
mixed ObjectModelCore::getTranslationsFields($fields_array)
- Visibility: protected
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 595
- $fields_array mixed
array AddressFormatCore::getValidateFields($className)
Returns selected fields required for an address in an array according to a selection hash
- Visibility: public
- This method is static.
- Source: classes/AddressFormat.php line 389
- $className mixed
array ObjectModelCore::getValidationRules(string $class)
Returns object validation rules (fields validity)
- Visibility: public
- This method is static.
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 130
- $class string - Child class name for static use (optional)
mixed ObjectModelCore::getWebserviceObjectList($sql_join, $sql_filter, $sql_sort, $sql_limit)
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 890
- $sql_join mixed
- $sql_filter mixed
- $sql_sort mixed
- $sql_limit mixed
mixed ObjectModelCore::getWebserviceParameters($ws_params_attribute_name)
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 816
- $ws_params_attribute_name mixed
mixed ObjectModelCore::hydrate(array $data, integer $id_lang)
Fill an object with given data. Data must be an array with this syntax: array(objProperty => value, objProperty2 => value, etc.)
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1116
- $data array
- $id_lang integer
array ObjectModelCore::hydrateCollection(string $class, array $datas, integer $id_lang)
Fill (hydrate) a list of objects in order to get a collection of these objects
- Visibility: public
- This method is static.
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1135
- $class string - Class of objects to hydrate
- $datas array - List of data (multi-dimensional array)
- $id_lang integer
boolean ObjectModelCore::isAssociatedToGroupShop(integer $id_group_shop)
Check if current object is associated to a group shop
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1003
- $id_group_shop integer
boolean ObjectModelCore::isAssociatedToShop(integer $id_shop)
Check if current object is associated to a shop
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 954
- $id_shop integer
boolean ObjectModelCore::isCurrentlyUsed(string $table, boolean $has_active_column)
This method is allow to know if a entity is currently used
- Visibility: public
- This method is static.
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1099
- $table string - name of table linked to entity
- $has_active_column boolean - true if the table has an active column
mixed ObjectModelCore::isLangMultishop()
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1037
mixed ObjectModelCore::makeTranslationFields($fields, $fields_array, $id_language)
- Visibility: protected
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 611
- $fields mixed
- $fields_array mixed
- $id_language mixed
boolean ObjectModelCore::save(boolean $null_values, boolean $autodate)
Save current object to database (add or update)
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 360
- $null_values boolean
- $autodate boolean
mixed ObjectModelCore::setDefinitionRetrocompatibility()
Retrocompatibility for classes without $definition static Remove this in 1.6 !
- Visibility: protected
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 1207
boolean ObjectModelCore::toggleStatus()
Toggle object status in database
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 575
boolean ObjectModelCore::update(boolean $null_values)
Update current object to database
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 446
- $null_values boolean
mixed ObjectModelCore::validateControler($htmlentities)
TODO: refactor rename all calls to this to validateController
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 772
- $htmlentities mixed
mixed ObjectModelCore::validateController($htmlentities)
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 778
- $htmlentities mixed
boolean|string ObjectModelCore::validateField(string $field, mixed $value, integer $id_lang)
Validate a single field
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 710
- $field string - Field name
- $value mixed - Field value
- $id_lang integer
boolean|string ObjectModelCore::validateFields(boolean $die, boolean $error_return)
Check for fields validity before database interaction
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 649
- $die boolean
- $error_return boolean
boolean|string ObjectModelCore::validateFieldsLang(boolean $die, boolean $error_return)
Check for multilingual fields validity before database interaction
- Visibility: public
- This method is defined by ObjectModelCore.
- Source: classes/ObjectModel.php line 675
- $die boolean
- $error_return boolean